blob: bc4bc45036ce8e7638e7142dda6f6dd86a7c9758 [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 Moolenaard881d152022-05-13 13:50:36 +01001054 if (eap->cmdidx == CMD_def && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001055 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001056 }
1057
Bram Moolenaard881d152022-05-13 13:50:36 +01001058 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001059 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001060 // Check for ":cmd v =<< [trim] EOF"
1061 // and ":cmd [a, b] =<< [trim] EOF"
1062 // and "lines =<< [trim] EOF" for Vim9
1063 // Where "cmd" can be "let", "var", "final" or "const".
1064 arg = skipwhite(skiptowhite(p));
1065 if (*arg == '[')
1066 arg = vim_strchr(arg, ']');
1067 if (arg != NULL)
1068 {
1069 int found = (eap->cmdidx == CMD_def && arg[0] == '='
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001070 && arg[1] == '<' && arg[2] =='<');
1071
Bram Moolenaard881d152022-05-13 13:50:36 +01001072 if (!found)
1073 // skip over the argument after "cmd"
1074 arg = skipwhite(skiptowhite(arg));
1075 if (found || (arg[0] == '=' && arg[1] == '<'
1076 && arg[2] =='<'
1077 && (checkforcmd(&p, "let", 2)
1078 || checkforcmd(&p, "var", 3)
1079 || checkforcmd(&p, "final", 5)
1080 || checkforcmd(&p, "const", 5))))
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001081 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001082 p = skipwhite(arg + 3);
1083 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001084 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001085 if (STRNCMP(p, "trim", 4) == 0)
1086 {
1087 // Ignore leading white space.
1088 p = skipwhite(p + 4);
1089 heredoc_trimmed = vim_strnsave(theline,
1090 skipwhite(theline) - theline);
1091 continue;
1092 }
1093 if (STRNCMP(p, "eval", 4) == 0)
1094 {
1095 // Ignore leading white space.
1096 p = skipwhite(p + 4);
1097 continue;
1098 }
1099 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001100 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001101 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1102 getline_options = GETLINE_NONE;
1103 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001104 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001105 }
1106 }
1107 }
1108
1109 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001110 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001111 goto theend;
1112
Bram Moolenaar20677332021-06-06 17:02:53 +02001113 if (heredoc_concat_len > 0)
1114 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001115 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001116 // to be used for the instruction later.
1117 ga_concat(&heredoc_ga, theline);
1118 ga_concat(&heredoc_ga, (char_u *)"\n");
1119 p = vim_strsave((char_u *)"");
1120 }
1121 else
1122 {
1123 // Copy the line to newly allocated memory. get_one_sourceline()
1124 // allocates 250 bytes per line, this saves 80% on average. The
1125 // cost is an extra alloc/free.
1126 p = vim_strsave(theline);
1127 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001128 if (p == NULL)
1129 goto theend;
1130 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1131
1132 // Add NULL lines for continuation lines, so that the line count is
1133 // equal to the index in the growarray.
1134 while (sourcing_lnum_off-- > 0)
1135 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1136
1137 // Check for end of eap->arg.
1138 if (line_arg != NULL && *line_arg == NUL)
1139 line_arg = NULL;
1140 }
1141
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001142 // Return OK when no error was detected.
1143 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001144 ret = OK;
1145
1146theend:
1147 vim_free(skip_until);
1148 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001149 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001150 need_wait_return |= saved_wait_return;
1151 return ret;
1152}
1153
1154/*
1155 * Handle the body of a lambda. *arg points to the "{", process statements
1156 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001157 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001158 * When successful "rettv" is set to a funcref.
1159 */
1160 static int
1161lambda_function_body(
1162 char_u **arg,
1163 typval_T *rettv,
1164 evalarg_T *evalarg,
1165 garray_T *newargs,
1166 garray_T *argtypes,
1167 int varargs,
1168 garray_T *default_args,
1169 char_u *ret_type)
1170{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001171 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001172 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001173 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001174 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001175 exarg_T eap;
1176 garray_T newlines;
1177 char_u *cmdline = NULL;
1178 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001179 partial_T *pt;
1180 char_u *name;
1181 int lnum_save = -1;
1182 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1183
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001184 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1185 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001186 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001187 return FAIL;
1188 }
1189
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001190 CLEAR_FIELD(eap);
1191 eap.cmdidx = CMD_block;
1192 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001193 eap.cmdlinep = &cmdline;
1194 eap.skip = !evaluate;
1195 if (evalarg->eval_cctx != NULL)
1196 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1197 else
1198 {
1199 eap.getline = evalarg->eval_getline;
1200 eap.cookie = evalarg->eval_cookie;
1201 }
1202
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001203 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001204 if (get_function_body(&eap, &newlines, NULL,
1205 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001207
1208 // When inside a lambda must add the function lines to evalarg.eval_ga.
1209 evalarg->eval_break_count += newlines.ga_len;
1210 if (gap->ga_itemsize > 0)
1211 {
1212 int idx;
1213 char_u *last;
1214 size_t plen;
1215 char_u *pnl;
1216
1217 for (idx = 0; idx < newlines.ga_len; ++idx)
1218 {
1219 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1220
Bram Moolenaarecb66452021-05-18 15:09:18 +02001221 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001222 goto erret;
1223
1224 // Going to concatenate the lines after parsing. For an empty or
1225 // comment line use an empty string.
1226 // Insert NL characters at the start of each line, the string will
1227 // be split again later in .get_lambda_tv().
1228 if (*p == NUL || vim9_comment_start(p))
1229 p = (char_u *)"";
1230 plen = STRLEN(p);
1231 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1232 if (pnl != NULL)
1233 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001234 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1235 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001237 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001238 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001239 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001240 // more is following after the "}", which was skipped
1241 last = cmdline;
1242 else
1243 // nothing is following the "}"
1244 last = (char_u *)"}";
1245 plen = STRLEN(last);
1246 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1247 if (pnl != NULL)
1248 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001249 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1250 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001251 }
1252
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001253 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001254 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001255 garray_T *tfgap = &evalarg->eval_tofree_ga;
1256
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001257 // Something comes after the "}".
1258 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001259
1260 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001261 if (ga_grow(tfgap, 1) == OK)
1262 {
1263 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1264 evalarg->eval_using_cmdline = TRUE;
1265 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001266 }
1267 else
1268 *arg = (char_u *)"";
1269
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001270 if (!evaluate)
1271 {
1272 ret = OK;
1273 goto erret;
1274 }
1275
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001276 name = get_lambda_name();
1277 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1278 if (ufunc == NULL)
1279 goto erret;
1280 set_ufunc_name(ufunc, name);
1281 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001283 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001284 ufunc->uf_refcount = 1;
1285 ufunc->uf_args = *newargs;
1286 newargs->ga_data = NULL;
1287 ufunc->uf_def_args = *default_args;
1288 default_args->ga_data = NULL;
1289 ufunc->uf_func_type = &t_func_any;
1290
1291 // error messages are for the first function line
1292 lnum_save = SOURCING_LNUM;
1293 SOURCING_LNUM = sourcing_lnum_top;
1294
1295 // parse argument types
1296 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1297 {
1298 SOURCING_LNUM = lnum_save;
1299 goto erret;
1300 }
1301
1302 // parse the return type, if any
1303 if (parse_return_type(ufunc, ret_type) == FAIL)
1304 goto erret;
1305
1306 pt = ALLOC_CLEAR_ONE(partial_T);
1307 if (pt == NULL)
1308 goto erret;
1309 pt->pt_func = ufunc;
1310 pt->pt_refcount = 1;
1311
1312 ufunc->uf_lines = newlines;
1313 newlines.ga_data = NULL;
1314 if (sandbox)
1315 ufunc->uf_flags |= FC_SANDBOX;
1316 if (!ASCII_ISUPPER(*ufunc->uf_name))
1317 ufunc->uf_flags |= FC_VIM9;
1318 ufunc->uf_script_ctx = current_sctx;
1319 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1320 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1321 set_function_type(ufunc);
1322
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001323 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1324
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001325 rettv->vval.v_partial = pt;
1326 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001327 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001328 ret = OK;
1329
1330erret:
1331 if (lnum_save >= 0)
1332 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001333 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001334 if (newargs != NULL)
1335 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001336 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001337 if (ufunc != NULL)
1338 {
1339 func_clear(ufunc, TRUE);
1340 func_free(ufunc, TRUE);
1341 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001342 return ret;
1343}
1344
1345/*
1346 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001347 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001348 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001349 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1350 */
1351 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001352get_lambda_tv(
1353 char_u **arg,
1354 typval_T *rettv,
1355 int types_optional,
1356 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001357{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001358 int evaluate = evalarg != NULL
1359 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 garray_T newargs;
1361 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001362 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001363 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001364 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001366 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001368 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001370 char_u *s;
1371 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001372 int *old_eval_lavars = eval_lavars_used;
1373 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001374 char_u *tofree1 = NULL;
1375 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001376 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001377 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001378 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001379 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001380 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001381
Bram Moolenaar4525a572022-02-13 11:57:33 +00001382 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001383 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001384
1385 ga_init(&newargs);
1386 ga_init(&newlines);
1387
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001388 // First, check if this is really a lambda expression. "->" or "=>" must
1389 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001390 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001391 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001392 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001393 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001394 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001395 {
1396 if (types_optional)
1397 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001398 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001399 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001400
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001401 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001402 if (evaluate)
1403 pnewargs = &newargs;
1404 else
1405 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001406 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001407 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001408 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001409 &varargs, &default_args,
1410 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001411 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001412 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001413 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001414 {
1415 if (types_optional)
1416 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001417 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001418 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001419 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001420 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001421
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001422 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1423 if (ret_type != NULL)
1424 {
1425 ret_type = vim_strsave(ret_type);
1426 tofree2 = ret_type;
1427 }
1428
Bram Moolenaare38eab22019-12-05 21:50:01 +01001429 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001430 if (evaluate)
1431 eval_lavars_used = &eval_lavars;
1432
Bram Moolenaar65c44152020-12-24 15:14:01 +01001433 *arg = skipwhite_and_linebreak(*arg, evalarg);
1434
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001435 // Recognize "{" as the start of a function body.
1436 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001437 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001438 if (evalarg == NULL)
1439 // cannot happen?
1440 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001441 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001442 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1443 types_optional ? &argtypes : NULL, varargs,
1444 &default_args, ret_type) == FAIL)
1445 goto errret;
1446 goto theend;
1447 }
1448 if (default_args.ga_len > 0)
1449 {
1450 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001451 goto errret;
1452 }
1453
Bram Moolenaare38eab22019-12-05 21:50:01 +01001454 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001455 start = *arg;
1456 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001457 if (ret == FAIL)
1458 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001459 if (evalarg != NULL)
1460 {
1461 // avoid that the expression gets freed when another line break follows
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001462 tofree1 = evalarg->eval_tofree;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001463 evalarg->eval_tofree = NULL;
1464 }
1465
Bram Moolenaar65c44152020-12-24 15:14:01 +01001466 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001467 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001468 *arg = skipwhite_and_linebreak(*arg, evalarg);
1469 if (**arg != '}')
1470 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001471 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001472 goto errret;
1473 }
1474 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001475 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001476
1477 if (evaluate)
1478 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001479 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001480 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001481 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001482 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001483 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001484
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001485 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001486 if (fp == NULL)
1487 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001488 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001489 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001490 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001491 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001492
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001493 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001494 if (ga_grow(&newlines, 1) == FAIL)
1495 goto errret;
1496
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001497 // If there are line breaks, we need to split up the string.
1498 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001499 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001500 line_end = end;
1501
1502 // Add "return " before the expression (or the first line).
1503 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001504 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001505 if (p == NULL)
1506 goto errret;
1507 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1508 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001509 vim_strncpy(p + 7, start, line_end - start);
1510
1511 if (line_end != end)
1512 {
1513 // Add more lines, split by line breaks. Thus is used when a
1514 // lambda with { cmds } is encountered.
1515 while (*line_end == '\n')
1516 {
1517 if (ga_grow(&newlines, 1) == FAIL)
1518 goto errret;
1519 start = line_end + 1;
1520 line_end = vim_strchr(start, '\n');
1521 if (line_end == NULL)
1522 line_end = end;
1523 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1524 vim_strnsave(start, line_end - start);
1525 }
1526 }
1527
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001528 if (strstr((char *)p + 7, "a:") == NULL)
1529 // No a: variables are used for sure.
1530 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001531
1532 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001533 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001534 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001535 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001536 if (types_optional)
1537 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001538 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001539 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001540 goto errret;
1541 if (ret_type != NULL)
1542 {
1543 fp->uf_ret_type = parse_type(&ret_type,
1544 &fp->uf_type_list, TRUE);
1545 if (fp->uf_ret_type == NULL)
1546 goto errret;
1547 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001548 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001549 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001550 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001551
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001553 if (current_funccal != NULL && eval_lavars)
1554 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001555 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001556 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001557 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001558 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001559
1560#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 if (prof_def_func())
1562 func_do_profile(fp);
1563#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001564 if (sandbox)
1565 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001566 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001567 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001568 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001569 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001570 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001571 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001572 // Use the line number of the arguments.
1573 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001575 function_using_block_scopes(fp, evalarg->eval_cstack);
1576
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001577 pt->pt_func = fp;
1578 pt->pt_refcount = 1;
1579 rettv->vval.v_partial = pt;
1580 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001581
1582 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001583 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001585theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001586 eval_lavars_used = old_eval_lavars;
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001587 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001588 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001589 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001590 vim_free(tofree1);
1591 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001592 if (types_optional)
1593 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001594
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001595 return OK;
1596
1597errret:
1598 ga_clear_strings(&newargs);
1599 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001600 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001601 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001602 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001603 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001604 if (fp != NULL)
1605 vim_free(fp->uf_arg_types);
1606 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001607 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001608 vim_free(pt);
Bram Moolenaarefaaaa62020-07-08 22:24:09 +02001609 if (evalarg != NULL && evalarg->eval_tofree == NULL)
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001610 evalarg->eval_tofree = tofree1;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001611 else
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001612 vim_free(tofree1);
1613 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001614 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001615 return FAIL;
1616}
1617
1618/*
1619 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1620 * name it contains, otherwise return "name".
1621 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1622 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001623 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1624 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001625 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001626 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627 */
1628 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001629deref_func_name(
1630 char_u *name,
1631 int *lenp,
1632 partial_T **partialp,
1633 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001634 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001635 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001636 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637{
1638 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001639 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001640 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001641 char_u *s = NULL;
1642 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001643 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001644
1645 if (partialp != NULL)
1646 *partialp = NULL;
1647
1648 cc = name[*lenp];
1649 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001650
Bram Moolenaar71f21932022-01-07 18:20:55 +00001651 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001652 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001653 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001654 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001655 tv = &v->di_tv;
1656 }
1657 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1658 {
1659 imported_T *import;
1660 char_u *p = name;
1661 int len = *lenp;
1662
1663 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001664 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001665 p = name + 2;
1666 len -= 2;
1667 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001668 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001669
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001670 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001671 if (import != NULL)
1672 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001673 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001674 if (new_function)
1675 semsg(_(e_redefining_imported_item_str), name);
1676 else
1677 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001678 name[len] = cc;
1679 *lenp = 0;
1680 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001681 }
1682 }
1683
1684 if (tv != NULL)
1685 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001686 if (found_var != NULL)
1687 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001688 if (tv->v_type == VAR_FUNC)
1689 {
1690 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001691 {
1692 *lenp = 0;
1693 return (char_u *)""; // just in case
1694 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001695 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001696 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001698
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001699 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001700 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001701 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001702
1703 if (pt == NULL)
1704 {
1705 *lenp = 0;
1706 return (char_u *)""; // just in case
1707 }
1708 if (partialp != NULL)
1709 *partialp = pt;
1710 s = partial_name(pt);
1711 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001712 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001713
1714 if (s != NULL)
1715 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001716 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001717 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001718 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001719
1720 if (sv != NULL)
1721 *type = sv->sv_type;
1722 }
1723 return s;
1724 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 }
1726
1727 return name;
1728}
1729
1730/*
1731 * Give an error message with a function name. Handle <SNR> things.
1732 * "ermsg" is to be passed without translation, use N_() instead of _().
1733 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001734 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001735emsg_funcname(char *ermsg, char_u *name)
1736{
Bram Moolenaar54598062022-01-13 12:05:09 +00001737 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001738
Bram Moolenaar54598062022-01-13 12:05:09 +00001739 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001740 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001741 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001742 if (p != name)
1743 vim_free(p);
1744}
1745
1746/*
1747 * Allocate a variable for the result of a function.
1748 * Return OK or FAIL.
1749 */
1750 int
1751get_func_tv(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001752 char_u *name, // name of the function
1753 int len, // length of "name" or -1 to use strlen()
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001754 typval_T *rettv,
Bram Moolenaar6ed88192019-05-11 18:37:44 +02001755 char_u **arg, // argument, pointing to the '('
Bram Moolenaare6b53242020-07-01 17:28:33 +02001756 evalarg_T *evalarg, // for line continuation
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001757 funcexe_T *funcexe) // various values
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758{
1759 char_u *argp;
1760 int ret = OK;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001761 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1762 int argcount = 0; // number of arguments found
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001763 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001764 int evaluate = evalarg == NULL
1765 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001766
1767 /*
1768 * Get the arguments.
1769 */
1770 argp = *arg;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00001771 while (argcount < MAX_FUNC_ARGS - (funcexe->fe_partial == NULL ? 0
1772 : funcexe->fe_partial->pt_argc))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001773 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001774 // skip the '(' or ',' and possibly line breaks
1775 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1776
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001777 if (*argp == ')' || *argp == ',' || *argp == NUL)
1778 break;
Bram Moolenaare6b53242020-07-01 17:28:33 +02001779 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001780 {
1781 ret = FAIL;
1782 break;
1783 }
1784 ++argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001785 // The comma should come right after the argument, but this wasn't
1786 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001787 if (vim9script)
1788 {
1789 if (*argp != ',' && *skipwhite(argp) == ',')
1790 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001791 if (evaluate)
1792 semsg(_(e_no_white_space_allowed_before_str_str),
1793 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001794 ret = FAIL;
1795 break;
1796 }
1797 }
1798 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001799 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001800 if (*argp != ',')
1801 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001802 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1803 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001804 if (evaluate)
1805 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001806 ret = FAIL;
1807 break;
1808 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001809 }
Bram Moolenaare6b53242020-07-01 17:28:33 +02001810 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001811 if (*argp == ')')
1812 ++argp;
1813 else
1814 ret = FAIL;
1815
1816 if (ret == OK)
1817 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001818 int i = 0;
1819 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001820
1821 if (get_vim_var_nr(VV_TESTING))
1822 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001823 // Prepare for calling test_garbagecollect_now(), need to know
1824 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001825 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001826 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001827 for (i = 0; i < argcount; ++i)
1828 if (ga_grow(&funcargs, 1) == OK)
1829 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1830 &argvars[i];
1831 }
1832
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001833 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001834 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001835 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001836 // An error in a builtin function does not return FAIL, but we do
1837 // want to abort further processing if an error was given.
1838 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001839 clear_tv(rettv);
1840 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001841
1842 funcargs.ga_len -= i;
1843 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001844 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001845 {
1846 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001847 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001848 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001849 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001850 }
1851
1852 while (--argcount >= 0)
1853 clear_tv(&argvars[argcount]);
1854
Bram Moolenaar4525a572022-02-13 11:57:33 +00001855 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001856 *arg = argp;
1857 else
1858 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001859 return ret;
1860}
1861
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001862/*
1863 * Return TRUE if "p" starts with "<SID>" or "s:".
1864 * Only works if eval_fname_script() returned non-zero for "p"!
1865 */
1866 static int
1867eval_fname_sid(char_u *p)
1868{
1869 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1870}
1871
1872/*
1873 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1874 * Change <SNR>123_name() to K_SNR 123_name().
1875 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1876 * (slow).
1877 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001878 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001879fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1880{
1881 int llen;
1882 char_u *fname;
1883 int i;
1884
1885 llen = eval_fname_script(name);
1886 if (llen > 0)
1887 {
1888 fname_buf[0] = K_SPECIAL;
1889 fname_buf[1] = KS_EXTRA;
1890 fname_buf[2] = (int)KE_SNR;
1891 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001892 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001893 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001894 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001895 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001896 else
1897 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001898 sprintf((char *)fname_buf + 3, "%ld_",
1899 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001900 i = (int)STRLEN(fname_buf);
1901 }
1902 }
1903 if (i + STRLEN(name + llen) < FLEN_FIXED)
1904 {
1905 STRCPY(fname_buf + i, name + llen);
1906 fname = fname_buf;
1907 }
1908 else
1909 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001910 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001911 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001912 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001913 else
1914 {
1915 *tofree = fname;
1916 mch_memmove(fname, fname_buf, (size_t)i);
1917 STRCPY(fname + i, name + llen);
1918 }
1919 }
1920 }
1921 else
1922 fname = name;
1923 return fname;
1924}
1925
1926/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001927 * Concatenate the script ID and function name into "<SNR>99_name".
1928 * "buffer" must have size MAX_FUNC_NAME_LEN.
1929 */
1930 void
1931func_name_with_sid(char_u *name, int sid, char_u *buffer)
1932{
1933 // A script-local function is stored as "<SNR>99_name".
1934 buffer[0] = K_SPECIAL;
1935 buffer[1] = KS_EXTRA;
1936 buffer[2] = (int)KE_SNR;
1937 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1938 (long)sid, name);
1939}
1940
1941/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001942 * Find a function "name" in script "sid".
1943 */
1944 static ufunc_T *
1945find_func_with_sid(char_u *name, int sid)
1946{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001947 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001948 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001949
Bram Moolenaarb8822442022-01-11 15:24:05 +00001950 if (!SCRIPT_ID_VALID(sid))
1951 return NULL; // not in a script
1952
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001953 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001954 hi = hash_find(&func_hashtab, buffer);
1955 if (!HASHITEM_EMPTY(hi))
1956 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001957 return NULL;
1958}
1959
1960/*
1961 * Find a function "name" in script "sid" prefixing the autoload prefix.
1962 */
1963 static ufunc_T *
1964find_func_with_prefix(char_u *name, int sid)
1965{
1966 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001967 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001968 scriptitem_T *si;
1969
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001970 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001971 return NULL; // already has the prefix
1972 if (!SCRIPT_ID_VALID(sid))
1973 return NULL; // not in a script
1974 si = SCRIPT_ITEM(sid);
1975 if (si->sn_autoload_prefix != NULL)
1976 {
1977 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1978 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001979 char_u *namep;
1980
1981 // skip a "<SNR>99_" prefix
1982 namep = untrans_function_name(name);
1983 if (namep == NULL)
1984 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001985
1986 // An exported function in an autoload script is stored as
1987 // "dir#path#name".
1988 if (len < sizeof(buffer))
1989 auto_name = buffer;
1990 else
1991 auto_name = alloc(len);
1992 if (auto_name != NULL)
1993 {
1994 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001995 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001996 hi = hash_find(&func_hashtab, auto_name);
1997 if (auto_name != buffer)
1998 vim_free(auto_name);
1999 if (!HASHITEM_EMPTY(hi))
2000 return HI2UF(hi);
2001 }
2002 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002003
2004 return NULL;
2005}
2006
2007/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002008 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002009 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2010 * functions.
2011 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002012 * Return NULL for unknown function.
2013 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002014 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002015find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016{
2017 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002018 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002019
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002020 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002021 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002022 // Find script-local function before global one.
2023 if (in_vim9script() && eval_isnamec1(*name)
2024 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002025 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002026 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2027 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002028 if (func != NULL)
2029 return func;
2030 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002031 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2032 {
2033 char_u *p = name + 5;
2034 long sid;
2035
2036 // printable "<SNR>123_Name" form
2037 sid = getdigits(&p);
2038 if (*p == '_')
2039 {
2040 func = find_func_with_sid(p + 1, (int)sid);
2041 if (func != NULL)
2042 return func;
2043 }
2044 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002045 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002046
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002047 if ((flags & FFED_NO_GLOBAL) == 0)
2048 {
2049 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002050 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002051 if (!HASHITEM_EMPTY(hi))
2052 return HI2UF(hi);
2053 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002054
Bram Moolenaarb8822442022-01-11 15:24:05 +00002055 // Find autoload function if this is an autoload script.
2056 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2057 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002058}
2059
2060/*
2061 * Find a function by name, return pointer to it in ufuncs.
2062 * "cctx" is passed in a :def function to find imported functions.
2063 * Return NULL for unknown or dead function.
2064 */
2065 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002066find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002067{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002068 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002069
2070 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2071 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002072 return NULL;
2073}
2074
2075/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002076 * Return TRUE if "ufunc" is a global function.
2077 */
2078 int
2079func_is_global(ufunc_T *ufunc)
2080{
2081 return ufunc->uf_name[0] != K_SPECIAL;
2082}
2083
2084/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002085 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2086 */
2087 int
2088func_requires_g_prefix(ufunc_T *ufunc)
2089{
2090 return ufunc->uf_name[0] != K_SPECIAL
2091 && (ufunc->uf_flags & FC_LAMBDA) == 0
2092 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2093}
2094
2095/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002096 * Copy the function name of "fp" to buffer "buf".
2097 * "buf" must be able to hold the function name plus three bytes.
2098 * Takes care of script-local function names.
2099 */
2100 static void
2101cat_func_name(char_u *buf, ufunc_T *fp)
2102{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002103 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002104 {
2105 STRCPY(buf, "<SNR>");
2106 STRCAT(buf, fp->uf_name + 3);
2107 }
2108 else
2109 STRCPY(buf, fp->uf_name);
2110}
2111
2112/*
2113 * Add a number variable "name" to dict "dp" with value "nr".
2114 */
2115 static void
2116add_nr_var(
2117 dict_T *dp,
2118 dictitem_T *v,
2119 char *name,
2120 varnumber_T nr)
2121{
2122 STRCPY(v->di_key, name);
2123 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2124 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2125 v->di_tv.v_type = VAR_NUMBER;
2126 v->di_tv.v_lock = VAR_FIXED;
2127 v->di_tv.vval.v_number = nr;
2128}
2129
2130/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002131 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002132 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002133 static void
2134free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002135{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002136 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002137
2138 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2139 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002140 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002141
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 // When garbage collecting a funccall_T may be freed before the
2143 // function that references it, clear its uf_scoped field.
2144 // The function may have been redefined and point to another
2145 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002146 if (fp != NULL && fp->uf_scoped == fc)
2147 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002148 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002149 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002150
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002151 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002152 vim_free(fc);
2153}
2154
2155/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002156 * Free "fc" and what it contains.
2157 * Can be called only when "fc" is kept beyond the period of it called,
2158 * i.e. after cleanup_function_call(fc).
2159 */
2160 static void
2161free_funccal_contents(funccall_T *fc)
2162{
2163 listitem_T *li;
2164
2165 // Free all l: variables.
2166 vars_clear(&fc->l_vars.dv_hashtab);
2167
2168 // Free all a: variables.
2169 vars_clear(&fc->l_avars.dv_hashtab);
2170
2171 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002172 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002173 clear_tv(&li->li_tv);
2174
2175 free_funccal(fc);
2176}
2177
2178/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002179 * Handle the last part of returning from a function: free the local hashtable.
2180 * Unless it is still in use by a closure.
2181 */
2182 static void
2183cleanup_function_call(funccall_T *fc)
2184{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002185 int may_free_fc = fc->fc_refcount <= 0;
2186 int free_fc = TRUE;
2187
Bram Moolenaar6914c642017-04-01 21:21:30 +02002188 current_funccal = fc->caller;
2189
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002190 // Free all l: variables if not referred.
2191 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2192 vars_clear(&fc->l_vars.dv_hashtab);
2193 else
2194 free_fc = FALSE;
2195
2196 // If the a:000 list and the l: and a: dicts are not referenced and
2197 // there is no closure using it, we can free the funccall_T and what's
2198 // in it.
2199 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2200 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002201 else
2202 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002203 int todo;
2204 hashitem_T *hi;
2205 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002206
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002207 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002208
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002209 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002210 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2211 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2212 {
2213 if (!HASHITEM_EMPTY(hi))
2214 {
2215 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002216 di = HI2DI(hi);
2217 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002218 }
2219 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002220 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002221
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002222 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2223 fc->l_varlist.lv_first = NULL;
2224 else
2225 {
2226 listitem_T *li;
2227
2228 free_fc = FALSE;
2229
2230 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002231 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002232 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002233 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002234
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002235 if (free_fc)
2236 free_funccal(fc);
2237 else
2238 {
2239 static int made_copy = 0;
2240
2241 // "fc" is still in use. This can happen when returning "a:000",
2242 // assigning "l:" to a global variable or defining a closure.
2243 // Link "fc" in the list for garbage collection later.
2244 fc->caller = previous_funccal;
2245 previous_funccal = fc;
2246
2247 if (want_garbage_collect)
2248 // If garbage collector is ready, clear count.
2249 made_copy = 0;
2250 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002251 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002252 // We have made a lot of copies, worth 4 Mbyte. This can happen
2253 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002254 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002255 // too much memory.
2256 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002257 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002258 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002259 }
2260}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002261
2262/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002263 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2264 */
2265 static int
2266numbered_function(char_u *name)
2267{
2268 return isdigit(*name)
2269 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2270}
2271
2272/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002273 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002274 * 1. ordinary names, function defined with :function or :def;
2275 * can start with "<SNR>123_" literally or with K_SPECIAL.
2276 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002277 * For the first we only count the name stored in func_hashtab as a reference,
2278 * using function() does not count as a reference, because the function is
2279 * looked up by name.
2280 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002281 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002282func_name_refcount(char_u *name)
2283{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002284 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002285}
2286
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002287/*
2288 * Unreference "fc": decrement the reference count and free it when it
2289 * becomes zero. "fp" is detached from "fc".
2290 * When "force" is TRUE we are exiting.
2291 */
2292 static void
2293funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2294{
2295 funccall_T **pfc;
2296 int i;
2297
2298 if (fc == NULL)
2299 return;
2300
2301 if (--fc->fc_refcount <= 0 && (force || (
2302 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2303 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2304 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2305 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2306 {
2307 if (fc == *pfc)
2308 {
2309 *pfc = fc->caller;
2310 free_funccal_contents(fc);
2311 return;
2312 }
2313 }
2314 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2315 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2316 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2317}
2318
2319/*
2320 * Remove the function from the function hashtable. If the function was
2321 * deleted while it still has references this was already done.
2322 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2323 */
2324 static int
2325func_remove(ufunc_T *fp)
2326{
2327 hashitem_T *hi;
2328
2329 // Return if it was already virtually deleted.
2330 if (fp->uf_flags & FC_DEAD)
2331 return FALSE;
2332
2333 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2334 if (!HASHITEM_EMPTY(hi))
2335 {
2336 // When there is a def-function index do not actually remove the
2337 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002338 // Do remove it when it's a copy.
2339 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002340 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002341 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002342 return FALSE;
2343 }
2344 hash_remove(&func_hashtab, hi);
2345 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002346 return TRUE;
2347 }
2348 return FALSE;
2349}
2350
2351 static void
2352func_clear_items(ufunc_T *fp)
2353{
2354 ga_clear_strings(&(fp->uf_args));
2355 ga_clear_strings(&(fp->uf_def_args));
2356 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002357 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002358 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002359 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002360 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002361
2362 // Increment the refcount of this function to avoid it being freed
2363 // recursively when the partial is freed.
2364 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002365 partial_unref(fp->uf_partial);
2366 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002367 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002368
2369#ifdef FEAT_LUA
2370 if (fp->uf_cb_free != NULL)
2371 {
2372 fp->uf_cb_free(fp->uf_cb_state);
2373 fp->uf_cb_free = NULL;
2374 }
2375
2376 fp->uf_cb_state = NULL;
2377 fp->uf_cb = NULL;
2378#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002379#ifdef FEAT_PROFILE
2380 VIM_CLEAR(fp->uf_tml_count);
2381 VIM_CLEAR(fp->uf_tml_total);
2382 VIM_CLEAR(fp->uf_tml_self);
2383#endif
2384}
2385
2386/*
2387 * Free all things that a function contains. Does not free the function
2388 * itself, use func_free() for that.
2389 * When "force" is TRUE we are exiting.
2390 */
2391 static void
2392func_clear(ufunc_T *fp, int force)
2393{
2394 if (fp->uf_cleared)
2395 return;
2396 fp->uf_cleared = TRUE;
2397
2398 // clear this function
2399 func_clear_items(fp);
2400 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002401 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002402}
2403
2404/*
2405 * Free a function and remove it from the list of functions. Does not free
2406 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002407 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002408 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002409 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002410 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002411func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002412{
2413 // Only remove it when not done already, otherwise we would remove a newer
2414 // version of the function with the same name.
2415 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2416 func_remove(fp);
2417
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002418 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002419 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002420 if (fp->uf_dfunc_idx > 0)
2421 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002422 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002423 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002424 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002425 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002426 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002427}
2428
2429/*
2430 * Free all things that a function contains and free the function itself.
2431 * When "force" is TRUE we are exiting.
2432 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002433 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002434func_clear_free(ufunc_T *fp, int force)
2435{
2436 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002437 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2438 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002439 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002440 else
2441 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002442}
2443
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002444/*
2445 * Copy already defined function "lambda" to a new function with name "global".
2446 * This is for when a compiled function defines a global function.
2447 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002448 int
2449copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002450{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002451 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002452 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002453
2454 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002455 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002456 semsg(_(e_lambda_function_not_found_str), lambda);
2457 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002458 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002459
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002460 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002461 if (fp != NULL)
2462 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002463 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002464 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002465 return FAIL;
2466 }
2467
2468 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2469 if (fp == NULL)
2470 return FAIL;
2471
2472 fp->uf_varargs = ufunc->uf_varargs;
2473 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2474 fp->uf_def_status = ufunc->uf_def_status;
2475 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2476 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2477 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2478 == FAIL
2479 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2480 goto failed;
2481
2482 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2483 : vim_strsave(ufunc->uf_name_exp);
2484 if (ufunc->uf_arg_types != NULL)
2485 {
2486 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2487 if (fp->uf_arg_types == NULL)
2488 goto failed;
2489 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2490 sizeof(type_T *) * fp->uf_args.ga_len);
2491 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002492 if (ufunc->uf_va_name != NULL)
2493 {
2494 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2495 if (fp->uf_va_name == NULL)
2496 goto failed;
2497 }
2498 fp->uf_ret_type = ufunc->uf_ret_type;
2499
2500 fp->uf_refcount = 1;
2501 STRCPY(fp->uf_name, global);
2502 hash_add(&func_hashtab, UF2HIKEY(fp));
2503
2504 // the referenced dfunc_T is now used one more time
2505 link_def_function(fp);
2506
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002507 // Create a partial to store the context of the function where it was
2508 // instantiated. Only needs to be done once. Do this on the original
2509 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002510 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2511 {
2512 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2513
2514 if (pt == NULL)
2515 goto failed;
2516 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002517 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002518 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002519 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002520 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002521 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002522 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002523 }
2524
2525 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002526
2527failed:
2528 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002529 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002530}
2531
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002532static int funcdepth = 0;
2533
2534/*
2535 * Increment the function call depth count.
2536 * Return FAIL when going over 'maxfuncdepth'.
2537 * Otherwise return OK, must call funcdepth_decrement() later!
2538 */
2539 int
2540funcdepth_increment(void)
2541{
2542 if (funcdepth >= p_mfd)
2543 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002544 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002545 return FAIL;
2546 }
2547 ++funcdepth;
2548 return OK;
2549}
2550
2551 void
2552funcdepth_decrement(void)
2553{
2554 --funcdepth;
2555}
2556
2557/*
2558 * Get the current function call depth.
2559 */
2560 int
2561funcdepth_get(void)
2562{
2563 return funcdepth;
2564}
2565
2566/*
2567 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002568 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002569 * times as funcdepth_increment().
2570 */
2571 void
2572funcdepth_restore(int depth)
2573{
2574 funcdepth = depth;
2575}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002576
2577/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002578 * Call a user function.
2579 */
2580 static void
2581call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002582 ufunc_T *fp, // pointer to function
2583 int argcount, // nr of args
2584 typval_T *argvars, // arguments
2585 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002586 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002587 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002588{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002589 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002590 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002591 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002592 funccall_T *fc;
2593 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002594 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002595 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002596 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002597 int i;
2598 int ai;
2599 int islambda = FALSE;
2600 char_u numbuf[NUMBUFLEN];
2601 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002602 typval_T *tv_to_free[MAX_FUNC_ARGS];
2603 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002604#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002605 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002606#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002607 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002608
Bram Moolenaarb2049902021-01-24 12:53:53 +01002609#ifdef FEAT_PROFILE
2610 CLEAR_FIELD(profile_info);
2611#endif
2612
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002613 // If depth of calling is getting too high, don't execute the function.
2614 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002615 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002616 rettv->v_type = VAR_NUMBER;
2617 rettv->vval.v_number = -1;
2618 return;
2619 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002620
Bram Moolenaare38eab22019-12-05 21:50:01 +01002621 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002623 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002624 if (fc == NULL)
2625 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626 fc->caller = current_funccal;
2627 current_funccal = fc;
2628 fc->func = fp;
2629 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002630 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002631 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2633 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002634 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002635 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002636 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002638 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002639 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002640#ifdef FEAT_PROFILE
2641 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2642#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002643 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002644#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002645 if (do_profiling == PROF_YES)
2646 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002647#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002648 sticky_cmdmod_flags = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002649 call_def_function(fp, argcount, argvars, funcexe->fe_partial, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002650 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002651#ifdef FEAT_PROFILE
2652 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002653 || (caller != NULL && caller->uf_profiling)))
2654 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002655#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002656 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002657 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002658 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002659 return;
2660 }
2661
Bram Moolenaar38453522021-11-28 22:00:12 +00002662 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663
2664 /*
2665 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2666 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2667 * each argument variable and saves a lot of time.
2668 */
2669 /*
2670 * Init l: variables.
2671 */
2672 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2673 if (selfdict != NULL)
2674 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002675 // Set l:self to "selfdict". Use "name" to avoid a warning from
2676 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677 v = &fc->fixvar[fixvar_idx++].var;
2678 name = v->di_key;
2679 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002680 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002681 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2682 v->di_tv.v_type = VAR_DICT;
2683 v->di_tv.v_lock = 0;
2684 v->di_tv.vval.v_dict = selfdict;
2685 ++selfdict->dv_refcount;
2686 }
2687
2688 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002689 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002690 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002691 * Set a:000 to a list with room for the "..." arguments.
2692 */
2693 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002694 if ((fp->uf_flags & FC_NOARGS) == 0)
2695 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002696 (varnumber_T)(argcount >= fp->uf_args.ga_len
2697 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002698 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002699 if ((fp->uf_flags & FC_NOARGS) == 0)
2700 {
2701 // Use "name" to avoid a warning from some compiler that checks the
2702 // destination size.
2703 v = &fc->fixvar[fixvar_idx++].var;
2704 name = v->di_key;
2705 STRCPY(name, "000");
2706 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2707 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2708 v->di_tv.v_type = VAR_LIST;
2709 v->di_tv.v_lock = VAR_FIXED;
2710 v->di_tv.vval.v_list = &fc->l_varlist;
2711 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002712 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002713 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2714 fc->l_varlist.lv_lock = VAR_FIXED;
2715
2716 /*
2717 * Set a:firstline to "firstline" and a:lastline to "lastline".
2718 * Set a:name to named arguments.
2719 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002720 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002722 if ((fp->uf_flags & FC_NOARGS) == 0)
2723 {
2724 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002725 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002726 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002727 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002728 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002729 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 {
2731 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002732 typval_T def_rettv;
2733 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002734
2735 ai = i - fp->uf_args.ga_len;
2736 if (ai < 0)
2737 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002738 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002739 name = FUNCARG(fp, i);
2740 if (islambda)
2741 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002742
2743 // evaluate named argument default expression
2744 isdefault = ai + fp->uf_def_args.ga_len >= 0
2745 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2746 && argvars[i].vval.v_number == VVAL_NONE));
2747 if (isdefault)
2748 {
2749 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002750
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002751 def_rettv.v_type = VAR_NUMBER;
2752 def_rettv.vval.v_number = -1;
2753
2754 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2755 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002756 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002757 {
2758 default_arg_err = 1;
2759 break;
2760 }
2761 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 }
2763 else
2764 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002765 if ((fp->uf_flags & FC_NOARGS) != 0)
2766 // Bail out if no a: arguments used (in lambda).
2767 break;
2768
Bram Moolenaare38eab22019-12-05 21:50:01 +01002769 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770 sprintf((char *)numbuf, "%d", ai + 1);
2771 name = numbuf;
2772 }
2773 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2774 {
2775 v = &fc->fixvar[fixvar_idx++].var;
2776 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002777 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 }
2779 else
2780 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002781 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002782 if (v == NULL)
2783 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002784 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002786
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002787 // Note: the values are copied directly to avoid alloc/free.
2788 // "argvars" must have VAR_FIXED for v_lock.
2789 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002790 v->di_tv.v_lock = VAR_FIXED;
2791
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002792 if (isdefault)
2793 // Need to free this later, no matter where it's stored.
2794 tv_to_free[tv_to_free_len++] = &v->di_tv;
2795
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002796 if (addlocal)
2797 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002798 // Named arguments should be accessed without the "a:" prefix in
2799 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002800 copy_tv(&v->di_tv, &v->di_tv);
2801 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002803 else
2804 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002805
2806 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2807 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002808 listitem_T *li = &fc->l_listitems[ai];
2809
2810 li->li_tv = argvars[i];
2811 li->li_tv.v_lock = VAR_FIXED;
2812 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002813 }
2814 }
2815
Bram Moolenaare38eab22019-12-05 21:50:01 +01002816 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002818
2819 if (fp->uf_flags & FC_SANDBOX)
2820 {
2821 using_sandbox = TRUE;
2822 ++sandbox;
2823 }
2824
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002825 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002826 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002827 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002828 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002829 ++no_wait_return;
2830 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002832 smsg(_("calling %s"), SOURCING_NAME);
2833 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002834 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002835 char_u buf[MSG_BUF_LEN];
2836 char_u numbuf2[NUMBUFLEN];
2837 char_u *tofree;
2838 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002839
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002840 msg_puts("(");
2841 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002843 if (i > 0)
2844 msg_puts(", ");
2845 if (argvars[i].v_type == VAR_NUMBER)
2846 msg_outnum((long)argvars[i].vval.v_number);
2847 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002848 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002849 // Do not want errors such as E724 here.
2850 ++emsg_off;
2851 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2852 --emsg_off;
2853 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002854 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002855 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002857 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2858 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002859 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002860 msg_puts((char *)s);
2861 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002862 }
2863 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002865 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002867 msg_puts("\n"); // don't overwrite this either
2868
2869 verbose_leave_scroll();
2870 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 }
2872#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002873 if (do_profiling == PROF_YES)
2874 profile_may_start_func(&profile_info, fp,
2875 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002876#endif
2877
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002878 // "legacy" does not apply to commands in the function
2879 sticky_cmdmod_flags = 0;
2880
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002881 save_current_sctx = current_sctx;
2882 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 save_did_emsg = did_emsg;
2884 did_emsg = FALSE;
2885
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002886 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2887 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002888 else if (islambda)
2889 {
2890 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2891
2892 // A Lambda always has the command "return {expr}". It is much faster
2893 // to evaluate {expr} directly.
2894 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002895 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002896 --ex_nesting_level;
2897 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002898 else
2899 // call do_cmdline() to execute the lines
2900 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2902
2903 --RedrawingDisabled;
2904
Bram Moolenaare38eab22019-12-05 21:50:01 +01002905 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2907 {
2908 clear_tv(rettv);
2909 rettv->v_type = VAR_NUMBER;
2910 rettv->vval.v_number = -1;
2911 }
2912
2913#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002914 if (do_profiling == PROF_YES)
2915 {
2916 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2917
2918 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2919 profile_may_end_func(&profile_info, fp, caller);
2920 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002921#endif
2922
Bram Moolenaare38eab22019-12-05 21:50:01 +01002923 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 if (p_verbose >= 12)
2925 {
2926 ++no_wait_return;
2927 verbose_enter_scroll();
2928
2929 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002930 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002931 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002932 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002933 (long)fc->rettv->vval.v_number);
2934 else
2935 {
2936 char_u buf[MSG_BUF_LEN];
2937 char_u numbuf2[NUMBUFLEN];
2938 char_u *tofree;
2939 char_u *s;
2940
Bram Moolenaare38eab22019-12-05 21:50:01 +01002941 // The value may be very long. Skip the middle part, so that we
2942 // have some idea how it starts and ends. smsg() would always
2943 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002944 ++emsg_off;
2945 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2946 --emsg_off;
2947 if (s != NULL)
2948 {
2949 if (vim_strsize(s) > MSG_BUF_CLEN)
2950 {
2951 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2952 s = buf;
2953 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002954 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955 vim_free(tofree);
2956 }
2957 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002958 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002959
2960 verbose_leave_scroll();
2961 --no_wait_return;
2962 }
2963
Bram Moolenaare31ee862020-01-07 20:59:34 +01002964 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002965 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002966 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002967#ifdef FEAT_PROFILE
2968 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002969 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002971 if (using_sandbox)
2972 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002973 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002974
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002975 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002976 {
2977 ++no_wait_return;
2978 verbose_enter_scroll();
2979
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002980 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002981 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002982
2983 verbose_leave_scroll();
2984 --no_wait_return;
2985 }
2986
2987 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002988 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002989 for (i = 0; i < tv_to_free_len; ++i)
2990 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002991 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992}
2993
2994/*
Bram Moolenaar50824712020-12-20 21:10:17 +01002995 * Check the argument count for user function "fp".
2996 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
2997 */
2998 int
2999check_user_func_argcount(ufunc_T *fp, int argcount)
3000{
3001 int regular_args = fp->uf_args.ga_len;
3002
3003 if (argcount < regular_args - fp->uf_def_args.ga_len)
3004 return FCERR_TOOFEW;
3005 else if (!has_varargs(fp) && argcount > regular_args)
3006 return FCERR_TOOMANY;
3007 return FCERR_UNKNOWN;
3008}
3009
3010/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003011 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003012 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003013 int
3014call_user_func_check(
3015 ufunc_T *fp,
3016 int argcount,
3017 typval_T *argvars,
3018 typval_T *rettv,
3019 funcexe_T *funcexe,
3020 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003021{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003022 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003023
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003024 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3025 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003026 error = check_user_func_argcount(fp, argcount);
3027 if (error != FCERR_UNKNOWN)
3028 return error;
3029 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003030 error = FCERR_DICT;
3031 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003032 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003033 int did_save_redo = FALSE;
3034 save_redo_T save_redo;
3035
3036 /*
3037 * Call the user function.
3038 * Save and restore search patterns, script variables and
3039 * redo buffer.
3040 */
3041 save_search_patterns();
3042 if (!ins_compl_active())
3043 {
3044 saveRedobuff(&save_redo);
3045 did_save_redo = TRUE;
3046 }
3047 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003048 call_user_func(fp, argcount, argvars, rettv, funcexe,
3049 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003050 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3051 // Function was unreferenced while being used, free it now.
3052 func_clear_free(fp, FALSE);
3053 if (did_save_redo)
3054 restoreRedobuff(&save_redo);
3055 restore_search_patterns();
3056 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003057 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003058 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003059}
3060
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003061static funccal_entry_T *funccal_stack = NULL;
3062
3063/*
3064 * Save the current function call pointer, and set it to NULL.
3065 * Used when executing autocommands and for ":source".
3066 */
3067 void
3068save_funccal(funccal_entry_T *entry)
3069{
3070 entry->top_funccal = current_funccal;
3071 entry->next = funccal_stack;
3072 funccal_stack = entry;
3073 current_funccal = NULL;
3074}
3075
3076 void
3077restore_funccal(void)
3078{
3079 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003080 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003081 else
3082 {
3083 current_funccal = funccal_stack->top_funccal;
3084 funccal_stack = funccal_stack->next;
3085 }
3086}
3087
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003088 funccall_T *
3089get_current_funccal(void)
3090{
3091 return current_funccal;
3092}
3093
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003094/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003095 * Return TRUE when currently at the script level:
3096 * - not in a function
3097 * - not executing an autocommand
3098 * Note that when an autocommand sources a script the result is FALSE;
3099 */
3100 int
3101at_script_level(void)
3102{
3103 return current_funccal == NULL && autocmd_match == NULL;
3104}
3105
3106/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003107 * Mark all functions of script "sid" as deleted.
3108 */
3109 void
3110delete_script_functions(int sid)
3111{
3112 hashitem_T *hi;
3113 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003114 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003115 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003116 size_t len;
3117
3118 buf[0] = K_SPECIAL;
3119 buf[1] = KS_EXTRA;
3120 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003121 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003122 len = STRLEN(buf);
3123
Bram Moolenaarce658352020-07-31 23:47:12 +02003124 while (todo > 0)
3125 {
3126 todo = func_hashtab.ht_used;
3127 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3128 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003129 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003130 fp = HI2UF(hi);
3131 if (STRNCMP(fp->uf_name, buf, len) == 0)
3132 {
3133 int changed = func_hashtab.ht_changed;
3134
3135 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003136
3137 if (fp->uf_calls > 0)
3138 {
3139 // Function is executing, don't free it but do remove
3140 // it from the hashtable.
3141 if (func_remove(fp))
3142 fp->uf_refcount--;
3143 }
3144 else
3145 {
3146 func_clear(fp, TRUE);
3147 // When clearing a function another function can be
3148 // cleared as a side effect. When that happens start
3149 // over.
3150 if (changed != func_hashtab.ht_changed)
3151 break;
3152 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003153 }
3154 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003155 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003156 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003157}
3158
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003159#if defined(EXITFREE) || defined(PROTO)
3160 void
3161free_all_functions(void)
3162{
3163 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003164 ufunc_T *fp;
3165 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003166 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003167 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003168
Bram Moolenaare38eab22019-12-05 21:50:01 +01003169 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003170 while (current_funccal != NULL)
3171 {
3172 clear_tv(current_funccal->rettv);
3173 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003174 if (current_funccal == NULL && funccal_stack != NULL)
3175 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003176 }
3177
Bram Moolenaare38eab22019-12-05 21:50:01 +01003178 // First clear what the functions contain. Since this may lower the
3179 // reference count of a function, it may also free a function and change
3180 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003181 while (todo > 0)
3182 {
3183 todo = func_hashtab.ht_used;
3184 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3185 if (!HASHITEM_EMPTY(hi))
3186 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003187 // clear the def function index now
3188 fp = HI2UF(hi);
3189 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003190 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003191
Bram Moolenaare38eab22019-12-05 21:50:01 +01003192 // Only free functions that are not refcounted, those are
3193 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003194 if (func_name_refcount(fp->uf_name))
3195 ++skipped;
3196 else
3197 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003198 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003199 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003200 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003201 {
3202 skipped = 0;
3203 break;
3204 }
3205 }
3206 --todo;
3207 }
3208 }
3209
Bram Moolenaare38eab22019-12-05 21:50:01 +01003210 // Now actually free the functions. Need to start all over every time,
3211 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003212 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003213 while (func_hashtab.ht_used > skipped)
3214 {
3215 todo = func_hashtab.ht_used;
3216 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217 if (!HASHITEM_EMPTY(hi))
3218 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003219 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003220 // Only free functions that are not refcounted, those are
3221 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003222 fp = HI2UF(hi);
3223 if (func_name_refcount(fp->uf_name))
3224 ++skipped;
3225 else
3226 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003227 if (func_free(fp, FALSE) == OK)
3228 {
3229 skipped = 0;
3230 break;
3231 }
3232 // did not actually free it
3233 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003234 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003235 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003236 }
3237 if (skipped == 0)
3238 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003239
3240 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003241}
3242#endif
3243
3244/*
3245 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003246 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3247 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003248 * "len" is the length of "name", or -1 for NUL terminated.
3249 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003250 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003251builtin_function(char_u *name, int len)
3252{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003253 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254
Bram Moolenaara26b9702020-04-18 19:53:28 +02003255 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003256 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003257 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3258 {
3259 if (name[i] == AUTOLOAD_CHAR)
3260 return FALSE;
3261 if (!eval_isnamec(name[i]))
3262 {
3263 // "name.something" is not a builtin function
3264 if (name[i] == '.')
3265 return FALSE;
3266 break;
3267 }
3268 }
3269 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270}
3271
3272 int
3273func_call(
3274 char_u *name,
3275 typval_T *args,
3276 partial_T *partial,
3277 dict_T *selfdict,
3278 typval_T *rettv)
3279{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003280 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003281 listitem_T *item;
3282 typval_T argv[MAX_FUNC_ARGS + 1];
3283 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003284 int r = 0;
3285
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003286 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003287 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003288 {
3289 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3290 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003291 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003292 break;
3293 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003294 // Make a copy of each argument. This is needed to be able to set
3295 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296 copy_tv(&item->li_tv, &argv[argc++]);
3297 }
3298
3299 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003300 {
3301 funcexe_T funcexe;
3302
Bram Moolenaara80faa82020-04-12 19:37:17 +02003303 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003304 funcexe.fe_firstline = curwin->w_cursor.lnum;
3305 funcexe.fe_lastline = curwin->w_cursor.lnum;
3306 funcexe.fe_evaluate = TRUE;
3307 funcexe.fe_partial = partial;
3308 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003309 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3310 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311
Bram Moolenaare38eab22019-12-05 21:50:01 +01003312 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313 while (argc > 0)
3314 clear_tv(&argv[--argc]);
3315
3316 return r;
3317}
3318
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003319static int callback_depth = 0;
3320
3321 int
3322get_callback_depth(void)
3323{
3324 return callback_depth;
3325}
3326
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003327/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003328 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003329 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003330 */
3331 int
3332call_callback(
3333 callback_T *callback,
3334 int len, // length of "name" or -1 to use strlen()
3335 typval_T *rettv, // return value goes here
3336 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003337 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003338 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003339{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003340 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003341 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003342
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003343 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3344 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003345 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003346 funcexe.fe_evaluate = TRUE;
3347 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003348 ++callback_depth;
3349 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3350 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003351
3352 // When a :def function was called that uses :try an error would be turned
3353 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003354 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003355 {
3356 need_rethrow = FALSE;
3357 handle_did_throw();
3358 }
3359
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003360 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003361}
3362
3363/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003364 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003365 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003366 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3367 */
3368 varnumber_T
3369call_callback_retnr(
3370 callback_T *callback,
3371 int argcount, // number of "argvars"
3372 typval_T *argvars) // vars for arguments, must have "argcount"
3373 // PLUS ONE elements!
3374{
3375 typval_T rettv;
3376 varnumber_T retval;
3377
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003378 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003379 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003380
3381 retval = tv_get_number_chk(&rettv, NULL);
3382 clear_tv(&rettv);
3383 return retval;
3384}
3385
3386/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003387 * Give an error message for the result of a function.
3388 * Nothing if "error" is FCERR_NONE.
3389 */
3390 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003391user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003392{
3393 switch (error)
3394 {
3395 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003396 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003397 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003398 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003399 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003400 break;
3401 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003402 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003403 break;
3404 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003405 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003406 break;
3407 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003408 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003409 break;
3410 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003411 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003412 break;
3413 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003414 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003415 break;
3416 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003417 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3418 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003419 break;
3420 }
3421}
3422
3423/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003424 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003425 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003426 * Return FAIL when the function can't be called, OK otherwise.
3427 * Also returns OK when an error was encountered while executing the function.
3428 */
3429 int
3430call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003431 char_u *funcname, // name of the function
3432 int len, // length of "name" or -1 to use strlen()
3433 typval_T *rettv, // return value goes here
3434 int argcount_in, // number of "argvars"
3435 typval_T *argvars_in, // vars for arguments, must have "argcount"
3436 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003437 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003438{
3439 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003440 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003441 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003442 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 char_u fname_buf[FLEN_FIXED + 1];
3444 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003445 char_u *fname = NULL;
3446 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003447 int argcount = argcount_in;
3448 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003449 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003450 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003451 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003452 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003453 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003454 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003455 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003456 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003458 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3459 // even when call_func() returns FAIL.
3460 rettv->v_type = VAR_UNKNOWN;
3461
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003462 if (partial != NULL)
3463 fp = partial->pt_func;
3464 if (fp == NULL)
3465 {
3466 // Make a copy of the name, if it comes from a funcref variable it
3467 // could be changed or deleted in the called function.
3468 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3469 if (name == NULL)
3470 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003472 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3473 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003474
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003475 if (funcexe->fe_doesrange != NULL)
3476 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003477
3478 if (partial != NULL)
3479 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003480 // When the function has a partial with a dict and there is a dict
3481 // argument, use the dict argument. That is backwards compatible.
3482 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003483 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003485 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 {
3487 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003488 {
3489 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3490 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003491 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003492 goto theend;
3493 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003494 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003495 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 for (i = 0; i < argcount_in; ++i)
3497 argv[i + argv_clear] = argvars_in[i];
3498 argvars = argv;
3499 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003500
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003501 if (funcexe->fe_check_type != NULL
3502 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003503 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003504 // Now funcexe->fe_check_type is missing the added arguments,
3505 // make a copy of the type with the correction.
3506 check_type = *funcexe->fe_check_type;
3507 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003508 check_type.tt_args = check_type_args;
3509 CLEAR_FIELD(check_type_args);
3510 for (i = 0; i < check_type.tt_argcount; ++i)
3511 check_type_args[i + partial->pt_argc] =
3512 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003513 check_type.tt_argcount += partial->pt_argc;
3514 check_type.tt_min_argcount += partial->pt_argc;
3515 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516 }
3517 }
3518
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003519 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3520 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003521 {
3522 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003523 if (check_argument_types(funcexe->fe_check_type,
3524 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003525 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003526 error = FCERR_OTHER;
3527 }
3528
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003529 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530 {
3531 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003532 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533
Bram Moolenaar333894b2020-08-01 18:53:07 +02003534 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003535 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003536 {
3537 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003538 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003539 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003540
Bram Moolenaare38eab22019-12-05 21:50:01 +01003541 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003543 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003545 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 {
3547 /*
3548 * User defined function.
3549 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003550 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003551 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003552 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003553 if (fp != NULL && !is_global && in_vim9script()
3554 && func_requires_g_prefix(fp))
3555 // In Vim9 script g: is required to find a global
3556 // non-autoload function.
3557 fp = NULL;
3558 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559
Bram Moolenaare38eab22019-12-05 21:50:01 +01003560 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 if (fp == NULL
3562 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003563 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003564 && !aborting())
3565 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003566 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003567 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003568 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003569 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003570 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3571 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003572 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003573 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003574 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003575 if (fp == NULL)
3576 {
3577 char_u *p = untrans_function_name(rfname);
3578
3579 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003580 // Don't do this if the name starts with "s:".
3581 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003582 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003583 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003584
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003585 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003586 error = FCERR_DELETED;
Bram Moolenaar801ab062020-06-25 19:27:56 +02003587#ifdef FEAT_LUA
3588 else if (fp != NULL && (fp->uf_flags & FC_CFUNC))
3589 {
3590 cfunc_T cb = fp->uf_cb;
3591
3592 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3593 }
3594#endif
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003595 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003597 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003598 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003599 argcount = funcexe->fe_argv_func(argcount, argvars,
3600 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003601
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003602 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003603 {
3604 // Method call: base->Method()
3605 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003606 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003607 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003608 argvars = argv;
3609 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003610 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003611
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003612 error = call_user_func_check(fp, argcount, argvars, rettv,
3613 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614 }
3615 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003616 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003617 {
3618 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003619 * expr->method(): Find the method name in the table, call its
3620 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003621 */
3622 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003623 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003624 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 else
3626 {
3627 /*
3628 * Find the function name in the table, call its implementation.
3629 */
3630 error = call_internal_func(fname, argcount, argvars, rettv);
3631 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003632
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 /*
3634 * The function call (or "FuncUndefined" autocommand sequence) might
3635 * have been aborted by an error, an interrupt, or an explicitly thrown
3636 * exception that has not been caught so far. This situation can be
3637 * tested for by calling aborting(). For an error in an internal
3638 * function or for the "E132" error in call_user_func(), however, the
3639 * throw point at which the "force_abort" flag (temporarily reset by
3640 * emsg()) is normally updated has not been reached yet. We need to
3641 * update that flag first to make aborting() reliable.
3642 */
3643 update_force_abort();
3644 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003645 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 ret = OK;
3647
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003648theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003649 /*
3650 * Report an error unless the argument evaluation or function call has been
3651 * cancelled due to an aborting error, an interrupt, or an exception.
3652 */
3653 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003654 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003655
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003656 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003658 clear_tv(&argv[--argv_clear + argv_base]);
3659
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003660 vim_free(tofree);
3661 vim_free(name);
3662
3663 return ret;
3664}
3665
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003666 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003667printable_func_name(ufunc_T *fp)
3668{
3669 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3670}
3671
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003673 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003674 */
3675 static void
3676list_func_head(ufunc_T *fp, int indent)
3677{
3678 int j;
3679
3680 msg_start();
3681 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003682 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003683 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003684 msg_puts("def ");
3685 else
3686 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003687 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003688 msg_putchar('(');
3689 for (j = 0; j < fp->uf_args.ga_len; ++j)
3690 {
3691 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003692 msg_puts(", ");
3693 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003694 if (fp->uf_arg_types != NULL)
3695 {
3696 char *tofree;
3697
3698 msg_puts(": ");
3699 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3700 vim_free(tofree);
3701 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003702 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3703 {
3704 msg_puts(" = ");
3705 msg_puts(((char **)(fp->uf_def_args.ga_data))
3706 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003708 }
3709 if (fp->uf_varargs)
3710 {
3711 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003712 msg_puts(", ");
3713 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003714 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003715 if (fp->uf_va_name != NULL)
3716 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003717 if (!fp->uf_varargs)
3718 {
3719 if (j)
3720 msg_puts(", ");
3721 msg_puts("...");
3722 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003723 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003724 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003725 {
3726 char *tofree;
3727
3728 msg_puts(": ");
3729 msg_puts(type_name(fp->uf_va_type, &tofree));
3730 vim_free(tofree);
3731 }
3732 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003733 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003734
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003735 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003736 {
3737 if (fp->uf_ret_type != &t_void)
3738 {
3739 char *tofree;
3740
3741 msg_puts(": ");
3742 msg_puts(type_name(fp->uf_ret_type, &tofree));
3743 vim_free(tofree);
3744 }
3745 }
3746 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003747 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003748 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003749 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003750 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003751 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003752 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003753 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003754 msg_clr_eos();
3755 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003756 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003757}
3758
3759/*
3760 * Get a function name, translating "<SID>" and "<SNR>".
3761 * Also handles a Funcref in a List or Dictionary.
3762 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003763 * Set "*is_global" to TRUE when the function must be global, unless
3764 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 * flags:
3766 * TFN_INT: internal function name OK
3767 * TFN_QUIET: be quiet
3768 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003769 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003770 * Advances "pp" to just after the function name (if no error).
3771 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003772 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003773trans_function_name(
3774 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003775 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003776 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003777 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003778 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003779 partial_T **partial, // return: partial of a FuncRef
3780 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781{
3782 char_u *name = NULL;
3783 char_u *start;
3784 char_u *end;
3785 int lead;
3786 char_u sid_buf[20];
3787 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003788 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003789 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003790 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003791 int vim9script = in_vim9script();
3792 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003793
3794 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003795 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003796 start = *pp;
3797
Bram Moolenaare38eab22019-12-05 21:50:01 +01003798 // Check for hard coded <SNR>: already translated function ID (from a user
3799 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3801 && (*pp)[2] == (int)KE_SNR)
3802 {
3803 *pp += 3;
3804 len = get_id_len(pp) + 3;
3805 return vim_strnsave(start, len);
3806 }
3807
Bram Moolenaare38eab22019-12-05 21:50:01 +01003808 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3809 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003810 lead = eval_fname_script(start);
3811 if (lead > 2)
3812 start += lead;
3813
Bram Moolenaare38eab22019-12-05 21:50:01 +01003814 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003815 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003816 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003817 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003818 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003819 {
3820 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003821 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 goto theend;
3823 }
3824 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3825 {
3826 /*
3827 * Report an invalid expression in braces, unless the expression
3828 * evaluation has been cancelled due to an aborting error, an
3829 * interrupt, or an exception.
3830 */
3831 if (!aborting())
3832 {
3833 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003834 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003835 }
3836 else
3837 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3838 goto theend;
3839 }
3840
3841 if (lv.ll_tv != NULL)
3842 {
3843 if (fdp != NULL)
3844 {
3845 fdp->fd_dict = lv.ll_dict;
3846 fdp->fd_newkey = lv.ll_newkey;
3847 lv.ll_newkey = NULL;
3848 fdp->fd_di = lv.ll_di;
3849 }
3850 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3851 {
3852 name = vim_strsave(lv.ll_tv->vval.v_string);
3853 *pp = end;
3854 }
3855 else if (lv.ll_tv->v_type == VAR_PARTIAL
3856 && lv.ll_tv->vval.v_partial != NULL)
3857 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003858 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003859 *pp = end;
3860 if (partial != NULL)
3861 *partial = lv.ll_tv->vval.v_partial;
3862 }
3863 else
3864 {
3865 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3866 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003867 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 else
3869 *pp = end;
3870 name = NULL;
3871 }
3872 goto theend;
3873 }
3874
3875 if (lv.ll_name == NULL)
3876 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003877 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003878 *pp = end;
3879 goto theend;
3880 }
3881
Bram Moolenaare38eab22019-12-05 21:50:01 +01003882 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003883 if (lv.ll_exp_name != NULL)
3884 {
3885 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003886 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003887 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003888 if (name == lv.ll_exp_name)
3889 name = NULL;
3890 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003891 else if (lv.ll_sid > 0)
3892 {
3893 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3894 int cc = *lv.ll_name_end;
3895
3896 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3897 *lv.ll_name_end = NUL;
3898 if (si->sn_autoload_prefix != NULL)
3899 {
3900 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3901 }
3902 else
3903 {
3904 sid_buf[0] = K_SPECIAL;
3905 sid_buf[1] = KS_EXTRA;
3906 sid_buf[2] = (int)KE_SNR;
3907 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003908 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003909 name = concat_str(sid_buf, lv.ll_name);
3910 }
3911 *lv.ll_name_end = cc;
3912 *pp = end;
3913 goto theend;
3914 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003915 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916 {
3917 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003918 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003919 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 if (name == *pp)
3921 name = NULL;
3922 }
3923 if (name != NULL)
3924 {
3925 name = vim_strsave(name);
3926 *pp = end;
3927 if (STRNCMP(name, "<SNR>", 5) == 0)
3928 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003929 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 name[0] = K_SPECIAL;
3931 name[1] = KS_EXTRA;
3932 name[2] = (int)KE_SNR;
3933 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3934 }
3935 goto theend;
3936 }
3937
3938 if (lv.ll_exp_name != NULL)
3939 {
3940 len = (int)STRLEN(lv.ll_exp_name);
3941 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3942 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3943 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003944 // When there was "s:" already or the name expanded to get a
3945 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 lv.ll_name += 2;
3947 len -= 2;
3948 lead = 2;
3949 }
3950 }
3951 else
3952 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003953 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003954 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003955 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003956 if (lv.ll_name[0] == 'g')
3957 {
3958 if (is_global != NULL)
3959 {
3960 *is_global = TRUE;
3961 }
3962 else
3963 {
3964 // dropping "g:" without setting "is_global" won't work in
3965 // Vim9script, put it back later
3966 prefix_g = TRUE;
3967 extra = 2;
3968 }
3969 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003971 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003972 len = (int)(end - lv.ll_name);
3973 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003974 if (len <= 0)
3975 {
3976 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003977 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003978 goto theend;
3979 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003981 // In Vim9 script a user function is script-local by default, unless it
3982 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003983 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003984
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003985 /*
3986 * Copy the function name to allocated memory.
3987 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3988 * Accept <SNR>123_name() outside a script.
3989 */
3990 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01003991 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00003992 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003994 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00003995 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003996 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name))
Bram Moolenaar3787f262022-02-07 21:54:01 +00003997 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00003998 semsg(_(vim9script
Bram Moolenaar3787f262022-02-07 21:54:01 +00003999 ? e_function_name_must_start_with_capital_str
4000 : e_function_name_must_start_with_capital_or_s_str),
4001 start);
4002 goto theend;
4003 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004004 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004005 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004006 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004007 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004008 || eval_fname_sid(*pp))
4009 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004010 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004011 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004012 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004013 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 goto theend;
4015 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004016 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004017 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004018 extra = 3 + (int)STRLEN(sid_buf);
4019 else
4020 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 }
4022 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004023 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004024 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004025 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004026 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004027 : e_function_name_must_start_with_capital_or_s_str),
4028 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 goto theend;
4030 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004031 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 {
4033 char_u *cp = vim_strchr(lv.ll_name, ':');
4034
4035 if (cp != NULL && cp < end)
4036 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004037 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 goto theend;
4039 }
4040 }
4041
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004042 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 if (name != NULL)
4044 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004045 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004046 {
4047 name[0] = K_SPECIAL;
4048 name[1] = KS_EXTRA;
4049 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004050 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004051 STRCPY(name + 3, sid_buf);
4052 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004053 else if (prefix_g)
4054 {
4055 name[0] = 'g';
4056 name[1] = ':';
4057 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004058 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4059 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 }
4061 *pp = end;
4062
4063theend:
4064 clear_lval(&lv);
4065 return name;
4066}
4067
4068/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004069 * Assuming "name" is the result of trans_function_name() and it was prefixed
4070 * to use the script-local name, return the unmodified name (points into
4071 * "name"). Otherwise return NULL.
4072 * This can be used to first search for a script-local function and fall back
4073 * to the global function if not found.
4074 */
4075 char_u *
4076untrans_function_name(char_u *name)
4077{
4078 char_u *p;
4079
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004080 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004081 {
4082 p = vim_strchr(name, '_');
4083 if (p != NULL)
4084 return p + 1;
4085 }
4086 return NULL;
4087}
4088
4089/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004090 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4091 * current script ID and returns the expanded function name. The caller should
4092 * free the returned name. If not called from a script context or the function
4093 * name doesn't start with these prefixes, then returns NULL.
4094 * This doesn't check whether the script-local function exists or not.
4095 */
4096 char_u *
4097get_scriptlocal_funcname(char_u *funcname)
4098{
4099 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004100 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004101 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004102 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004103
4104 if (funcname == NULL)
4105 return NULL;
4106
4107 if (STRNCMP(funcname, "s:", 2) != 0
4108 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004109 {
4110 ufunc_T *ufunc;
4111
4112 // The function name does not have a script-local prefix. Try finding
4113 // it when in a Vim9 script and there is no "g:" prefix.
4114 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4115 return NULL;
4116 ufunc = find_func(funcname, FALSE);
4117 if (ufunc == NULL || func_is_global(ufunc)
4118 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4119 return NULL;
4120 ++p;
4121 off = 0;
4122 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004123 else
4124 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004125
4126 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4127 {
4128 emsg(_(e_using_sid_not_in_script_context));
4129 return NULL;
4130 }
4131 // Expand s: prefix into <SNR>nr_<name>
4132 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4133 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004134 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004135 if (newname == NULL)
4136 return NULL;
4137 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004138 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004139
4140 return newname;
4141}
4142
4143/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004144 * Return script-local "fname" with the 3-byte sequence replaced by
4145 * printable <SNR> in allocated memory.
4146 */
4147 char_u *
4148alloc_printable_func_name(char_u *fname)
4149{
4150 char_u *n = alloc(STRLEN(fname + 3) + 6);
4151
4152 if (n != NULL)
4153 {
4154 STRCPY(n, "<SNR>");
4155 STRCPY(n + 5, fname + 3);
4156 }
4157 return n;
4158}
4159
4160/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004161 * Call trans_function_name(), except that a lambda is returned as-is.
4162 * Returns the name in allocated memory.
4163 */
4164 char_u *
4165save_function_name(
4166 char_u **name,
4167 int *is_global,
4168 int skip,
4169 int flags,
4170 funcdict_T *fudi)
4171{
4172 char_u *p = *name;
4173 char_u *saved;
4174
4175 if (STRNCMP(p, "<lambda>", 8) == 0)
4176 {
4177 p += 8;
4178 (void)getdigits(&p);
4179 saved = vim_strnsave(*name, p - *name);
4180 if (fudi != NULL)
4181 CLEAR_POINTER(fudi);
4182 }
4183 else
4184 saved = trans_function_name(&p, is_global, skip,
4185 flags, fudi, NULL, NULL);
4186 *name = p;
4187 return saved;
4188}
4189
4190/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004191 * List functions. When "regmatch" is NULL all of then.
4192 * Otherwise functions matching "regmatch".
4193 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004194 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004195list_functions(regmatch_T *regmatch)
4196{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004197 int changed = func_hashtab.ht_changed;
4198 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004199 hashitem_T *hi;
4200
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004201 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004202 {
4203 if (!HASHITEM_EMPTY(hi))
4204 {
4205 ufunc_T *fp = HI2UF(hi);
4206
4207 --todo;
4208 if ((fp->uf_flags & FC_DEAD) == 0
4209 && (regmatch == NULL
4210 ? !message_filtered(fp->uf_name)
4211 && !func_name_refcount(fp->uf_name)
4212 : !isdigit(*fp->uf_name)
4213 && vim_regexec(regmatch, fp->uf_name, 0)))
4214 {
4215 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004216 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004217 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004218 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004219 return;
4220 }
4221 }
4222 }
4223 }
4224}
4225
4226/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004227 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004228 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4229 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004230 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004231 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004232 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004233 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004234define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004235{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004236 int j;
4237 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004238 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004239 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004240 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 char_u *p;
4242 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004243 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004244 char_u *line_arg = NULL;
4245 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004246 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004247 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004248 garray_T newlines;
4249 int varargs = FALSE;
4250 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004251 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004252 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004253 int fp_allocated = FALSE;
4254 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004255 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004256 dictitem_T *v;
4257 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004258 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004259 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004260 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004261 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004262 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004263 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004264
4265 /*
4266 * ":function" without argument: list functions.
4267 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004268 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004269 {
4270 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004271 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004272 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004273 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004274 }
4275
4276 /*
4277 * ":function /pat": list functions matching pattern.
4278 */
4279 if (*eap->arg == '/')
4280 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004281 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 if (!eap->skip)
4283 {
4284 regmatch_T regmatch;
4285
4286 c = *p;
4287 *p = NUL;
4288 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4289 *p = c;
4290 if (regmatch.regprog != NULL)
4291 {
4292 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004293 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294 vim_regfree(regmatch.regprog);
4295 }
4296 }
4297 if (*p == '/')
4298 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004299 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004300 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 }
4302
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004303 ga_init(&newargs);
4304 ga_init(&argtypes);
4305 ga_init(&default_args);
4306
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307 /*
4308 * Get the function name. There are these situations:
4309 * func normal function name
4310 * "name" == func, "fudi.fd_dict" == NULL
4311 * dict.func new dictionary entry
4312 * "name" == NULL, "fudi.fd_dict" set,
4313 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4314 * dict.func existing dict entry with a Funcref
4315 * "name" == func, "fudi.fd_dict" set,
4316 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4317 * dict.func existing dict entry that's not a Funcref
4318 * "name" == NULL, "fudi.fd_dict" set,
4319 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4320 * s:func script-local function name
4321 * g:func global function name, same as "func"
4322 */
4323 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004324 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004325 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004326 // nested function, argument is (args).
4327 paren = TRUE;
4328 CLEAR_FIELD(fudi);
4329 }
4330 else
4331 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004332 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004333 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004334 if (p[0] == 's' && p[1] == ':')
4335 {
4336 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4337 return NULL;
4338 }
4339 p = to_name_end(p, TRUE);
4340 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4341 {
4342 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4343 eap->arg);
4344 return NULL;
4345 }
4346 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004347 }
4348
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004349 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004350 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004351 paren = (vim_strchr(p, '(') != NULL);
4352 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004353 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004354 /*
4355 * Return on an invalid expression in braces, unless the expression
4356 * evaluation has been cancelled due to an aborting error, an
4357 * interrupt, or an exception.
4358 */
4359 if (!aborting())
4360 {
4361 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004362 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004363 vim_free(fudi.fd_newkey);
4364 return NULL;
4365 }
4366 else
4367 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004368 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004369
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004370 // For "export def FuncName()" in an autoload script the function name
4371 // is stored with the legacy autoload name "dir#script#FuncName" so
4372 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004373 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004374 {
4375 char_u *prefixed = may_prefix_autoload(name);
4376
4377 if (prefixed != NULL && prefixed != name)
4378 {
4379 vim_free(name);
4380 name = prefixed;
4381 }
4382 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004383 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004384 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004385 {
4386 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4387 goto ret_free;
4388 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004389 }
4390
Bram Moolenaare38eab22019-12-05 21:50:01 +01004391 // An error in a function call during evaluation of an expression in magic
4392 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004393 saved_did_emsg = did_emsg;
4394 did_emsg = FALSE;
4395
4396 /*
4397 * ":function func" with only function name: list function.
4398 */
4399 if (!paren)
4400 {
4401 if (!ends_excmd(*skipwhite(p)))
4402 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004403 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004404 goto ret_free;
4405 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004406 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004407 if (eap->nextcmd != NULL)
4408 *p = NUL;
4409 if (!eap->skip && !got_int)
4410 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004411 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004412 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4413 {
4414 char_u *up = untrans_function_name(name);
4415
4416 // With Vim9 script the name was made script-local, if not
4417 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004418 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004419 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004420 }
4421
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004422 if (fp != NULL)
4423 {
4424 list_func_head(fp, TRUE);
4425 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4426 {
4427 if (FUNCLINE(fp, j) == NULL)
4428 continue;
4429 msg_putchar('\n');
4430 msg_outnum((long)(j + 1));
4431 if (j < 9)
4432 msg_putchar(' ');
4433 if (j < 99)
4434 msg_putchar(' ');
4435 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004436 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 ui_breakcheck();
4438 }
4439 if (!got_int)
4440 {
4441 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004442 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004443 msg_puts(" enddef");
4444 else
4445 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 }
4447 }
4448 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004449 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004450 }
4451 goto ret_free;
4452 }
4453
4454 /*
4455 * ":function name(arg1, arg2)" Define function.
4456 */
4457 p = skipwhite(p);
4458 if (*p != '(')
4459 {
4460 if (!eap->skip)
4461 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004462 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004463 goto ret_free;
4464 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004465 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004466 if (vim_strchr(p, '(') != NULL)
4467 p = vim_strchr(p, '(');
4468 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004469
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004470 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4471 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004472 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004473 goto ret_free;
4474 }
4475
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004476 // In Vim9 script only global functions can be redefined.
4477 if (vim9script && eap->forceit && !is_global)
4478 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004479 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004480 goto ret_free;
4481 }
4482
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004483 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004484
Bram Moolenaar04b12692020-05-04 23:24:44 +02004485 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004486 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004487 // Check the name of the function. Unless it's a dictionary function
4488 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004489 if (name != NULL)
4490 arg = name;
4491 else
4492 arg = fudi.fd_newkey;
4493 if (arg != NULL && (fudi.fd_di == NULL
4494 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4495 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4496 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004497 char_u *name_base = arg;
4498 int i;
4499
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004501 {
4502 name_base = vim_strchr(arg, '_');
4503 if (name_base == NULL)
4504 name_base = arg + 3;
4505 else
4506 ++name_base;
4507 }
4508 for (i = 0; name_base[i] != NUL && (i == 0
4509 ? eval_isnamec1(name_base[i])
4510 : eval_isnamec(name_base[i])); ++i)
4511 ;
4512 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004513 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004514
4515 // In Vim9 script a function cannot have the same name as a
4516 // variable.
4517 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004518 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4519 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004520 + EVAL_VAR_NO_FUNC) == OK)
4521 {
4522 semsg(_(e_redefining_script_item_str), name_base);
4523 goto ret_free;
4524 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004525 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004526 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004527 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004528 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004529 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004530 goto ret_free;
4531 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532 }
4533
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004534 // This may get more lines and make the pointers into the first line
4535 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004536 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004537 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004538 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004539 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004540 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004542 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004543
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004544 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004546 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004547 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004549 if (*p != ':')
4550 {
4551 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4552 p = skipwhite(p);
4553 }
4554 else if (!IS_WHITE_OR_NUL(p[1]))
4555 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004556 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004557 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004558 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004559 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004560 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004561 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004562 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004563 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004564 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004565 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004566 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004567 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004568 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004569 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004570 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004572 else
4573 // find extra arguments "range", "dict", "abort" and "closure"
4574 for (;;)
4575 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004576 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004577 p = skipwhite(p);
4578 if (STRNCMP(p, "range", 5) == 0)
4579 {
4580 flags |= FC_RANGE;
4581 p += 5;
4582 }
4583 else if (STRNCMP(p, "dict", 4) == 0)
4584 {
4585 flags |= FC_DICT;
4586 p += 4;
4587 }
4588 else if (STRNCMP(p, "abort", 5) == 0)
4589 {
4590 flags |= FC_ABORT;
4591 p += 5;
4592 }
4593 else if (STRNCMP(p, "closure", 7) == 0)
4594 {
4595 flags |= FC_CLOSURE;
4596 p += 7;
4597 if (current_funccal == NULL)
4598 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004599 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004600 name == NULL ? (char_u *)"" : name);
4601 goto erret;
4602 }
4603 }
4604 else
4605 break;
4606 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004607
Bram Moolenaare38eab22019-12-05 21:50:01 +01004608 // When there is a line break use what follows for the function body.
4609 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004610 if (*p == '\n')
4611 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004612 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004613 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4614 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004615 && !(VIM_ISWHITE(*whitep) && *p == '#'
4616 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004617 && !eap->skip
4618 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004619 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004620
4621 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004622 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4623 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004624 */
4625 if (KeyTyped)
4626 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004627 // Check if the function already exists, don't let the user type the
4628 // whole function before telling him it doesn't work! For a script we
4629 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004630 if (!eap->skip && !eap->forceit)
4631 {
4632 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004633 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004634 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004635 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004636 }
4637
4638 if (!eap->skip && did_emsg)
4639 goto erret;
4640
Bram Moolenaare38eab22019-12-05 21:50:01 +01004641 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 cmdline_row = msg_row;
4643 }
4644
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004645 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004646 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004647
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004648 // Do not define the function when getting the body fails and when
4649 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004650 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004651 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004652 goto erret;
4653
4654 /*
4655 * If there are no errors, add the function
4656 */
4657 if (fudi.fd_dict == NULL)
4658 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004659 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004660 char_u *find_name = name;
4661 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004662 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004663
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004664 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004665 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004666 var_conflict = TRUE;
4667
4668 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4669 {
4670 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4671
4672 if (si->sn_autoload_prefix != NULL)
4673 {
4674 if (is_export)
4675 {
4676 find_name = name + STRLEN(si->sn_autoload_prefix);
4677 v = find_var(find_name, &ht, TRUE);
4678 if (v != NULL)
4679 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004680 // Only check if the function already exists in the script,
4681 // global functions can be shadowed.
4682 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004683 }
4684 else
4685 {
4686 char_u *prefixed = may_prefix_autoload(name);
4687
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004688 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004689 {
4690 v = find_var(prefixed, &ht, TRUE);
4691 if (v != NULL)
4692 var_conflict = TRUE;
4693 vim_free(prefixed);
4694 }
4695 }
4696 }
4697 }
4698 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004699 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004700 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004701 goto erret;
4702 }
4703
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004704 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004705 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004706 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004707 char_u *uname = untrans_function_name(name);
4708
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004709 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004710 }
4711
4712 if (fp != NULL || import != NULL)
4713 {
4714 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004715
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004716 // Function can be replaced with "function!" and when sourcing the
4717 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004718 // A name that is used by an import can not be overruled.
4719 if (import != NULL
4720 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004721 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004722 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004723 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004724 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004725 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004726 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004727 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004728 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004729 goto erret;
4730 }
4731 if (fp->uf_calls > 0)
4732 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004733 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004734 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004735 goto erret;
4736 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004737 if (fp->uf_refcount > 1)
4738 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004739 // This function is referenced somewhere, don't redefine it but
4740 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004741 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004742 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004743 fp = NULL;
4744 overwrite = TRUE;
4745 }
4746 else
4747 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004748 char_u *exp_name = fp->uf_name_exp;
4749
4750 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004751 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004752 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004753 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004754 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004755 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004756#ifdef FEAT_PROFILE
4757 fp->uf_profiling = FALSE;
4758 fp->uf_prof_initialized = FALSE;
4759#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004760 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004761 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004762 }
4763 }
4764 else
4765 {
4766 char numbuf[20];
4767
4768 fp = NULL;
4769 if (fudi.fd_newkey == NULL && !eap->forceit)
4770 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004771 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004772 goto erret;
4773 }
4774 if (fudi.fd_di == NULL)
4775 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004776 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004777 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004778 goto erret;
4779 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004780 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004781 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004782 goto erret;
4783
Bram Moolenaare38eab22019-12-05 21:50:01 +01004784 // Give the function a sequential number. Can only be used with a
4785 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004786 vim_free(name);
4787 sprintf(numbuf, "%d", ++func_nr);
4788 name = vim_strsave((char_u *)numbuf);
4789 if (name == NULL)
4790 goto erret;
4791 }
4792
4793 if (fp == NULL)
4794 {
4795 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4796 {
4797 int slen, plen;
4798 char_u *scriptname;
4799
Bram Moolenaare38eab22019-12-05 21:50:01 +01004800 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004801 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004802 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004803 {
4804 scriptname = autoload_name(name);
4805 if (scriptname != NULL)
4806 {
4807 p = vim_strchr(scriptname, '/');
4808 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004809 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004811 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 j = OK;
4813 vim_free(scriptname);
4814 }
4815 }
4816 if (j == FAIL)
4817 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004818 linenr_T save_lnum = SOURCING_LNUM;
4819
4820 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004821 semsg(_(e_function_name_does_not_match_script_file_name_str),
4822 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004823 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004824 goto erret;
4825 }
4826 }
4827
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004828 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004829 if (fp == NULL)
4830 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004831 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004832
4833 if (fudi.fd_dict != NULL)
4834 {
4835 if (fudi.fd_di == NULL)
4836 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004837 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4839 if (fudi.fd_di == NULL)
4840 {
4841 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004842 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004843 goto erret;
4844 }
4845 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4846 {
4847 vim_free(fudi.fd_di);
4848 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004849 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004850 goto erret;
4851 }
4852 }
4853 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004854 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855 clear_tv(&fudi.fd_di->di_tv);
4856 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004858
Bram Moolenaare38eab22019-12-05 21:50:01 +01004859 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 flags |= FC_DICT;
4861 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004862 }
4863 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004864 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004865 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004866 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004867
4868 if (eap->cmdidx == CMD_def)
4869 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004870 int lnum_save = SOURCING_LNUM;
4871 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004872
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004873 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004874
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004875 // error messages are for the first function line
4876 SOURCING_LNUM = sourcing_lnum_top;
4877
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004878 // The function may use script variables from the context.
4879 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004880
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004881 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004882 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004883 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004884 free_fp = fp_allocated;
4885 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004886 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004887 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004888
4889 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004890 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004891 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004892 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004893 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004894 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004895 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004896 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004897 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004898 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004899 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004900
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004901 if (fp_allocated)
4902 {
4903 // insert the new function in the function list
4904 set_ufunc_name(fp, name);
4905 if (overwrite)
4906 {
4907 hi = hash_find(&func_hashtab, name);
4908 hi->hi_key = UF2HIKEY(fp);
4909 }
4910 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4911 {
4912 free_fp = TRUE;
4913 goto erret;
4914 }
4915 fp->uf_refcount = 1;
4916 }
4917
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004918 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004919 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004920 if ((flags & FC_CLOSURE) != 0)
4921 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004922 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004923 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004924 }
4925 else
4926 fp->uf_scoped = NULL;
4927
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004928#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004929 if (prof_def_func())
4930 func_do_profile(fp);
4931#endif
4932 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004933 if (sandbox)
4934 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004935 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004936 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937 fp->uf_flags = flags;
4938 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004939 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004940 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004941 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004942 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004943 if (is_export)
4944 {
4945 fp->uf_flags |= FC_EXPORT;
4946 // let ex_export() know the export worked.
4947 is_export = FALSE;
4948 }
4949
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004950 if (eap->cmdidx == CMD_def)
4951 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004952 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4953 // :func does not use Vim9 script syntax, even in a Vim9 script file
4954 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004955
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956 goto ret_free;
4957
4958erret:
4959 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004960 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004961 if (fp != NULL)
4962 {
4963 ga_init(&fp->uf_args);
4964 ga_init(&fp->uf_def_args);
4965 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966errret_2:
4967 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004968 if (fp != NULL)
4969 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004970 if (free_fp)
4971 {
4972 vim_free(fp);
4973 fp = NULL;
4974 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004975ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004976 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004977 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004978 if (name != name_arg)
4979 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004980 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004981 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004982
4983 return fp;
4984}
4985
4986/*
4987 * ":function"
4988 */
4989 void
4990ex_function(exarg_T *eap)
4991{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004992 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00004993
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004994 ga_init2(&lines_to_free, sizeof(char_u *), 50);
4995 (void)define_function(eap, NULL, &lines_to_free);
4996 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02004997}
4998
4999/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005000 * Find a function by name, including "<lambda>123".
5001 * Check for "profile" and "debug" arguments and set"compile_type".
5002 * Return NULL if not found.
5003 */
5004 ufunc_T *
5005find_func_by_name(char_u *name, compiletype_T *compile_type)
5006{
5007 char_u *arg = name;
5008 char_u *fname;
5009 ufunc_T *ufunc;
5010 int is_global = FALSE;
5011
5012 *compile_type = CT_NONE;
5013 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5014 {
5015 *compile_type = CT_PROFILE;
5016 arg = skipwhite(arg + 7);
5017 }
5018 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5019 {
5020 *compile_type = CT_DEBUG;
5021 arg = skipwhite(arg + 5);
5022 }
5023
5024 if (STRNCMP(arg, "<lambda>", 8) == 0)
5025 {
5026 arg += 8;
5027 (void)getdigits(&arg);
5028 fname = vim_strnsave(name, arg - name);
5029 }
5030 else
5031 fname = trans_function_name(&arg, &is_global, FALSE,
5032 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5033 if (fname == NULL)
5034 {
5035 semsg(_(e_invalid_argument_str), name);
5036 return NULL;
5037 }
5038 if (!ends_excmd2(name, arg))
5039 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005040 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005041 emsg(ex_errmsg(e_trailing_characters_str, arg));
5042 return NULL;
5043 }
5044
5045 ufunc = find_func(fname, is_global);
5046 if (ufunc == NULL)
5047 {
5048 char_u *p = untrans_function_name(fname);
5049
5050 if (p != NULL)
5051 // Try again without making it script-local.
5052 ufunc = find_func(p, FALSE);
5053 }
5054 vim_free(fname);
5055 if (ufunc == NULL)
5056 semsg(_(e_cannot_find_function_str), name);
5057 return ufunc;
5058}
5059
5060/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005061 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005062 * be compiled or the one specified by the argument.
5063 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005064 */
5065 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005066ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005067{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005068 ufunc_T *ufunc;
5069
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005070 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005071 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005072 compiletype_T compile_type;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005073
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005074 ufunc = find_func_by_name(eap->arg, &compile_type);
5075 if (ufunc != NULL)
5076 {
5077 if (func_needs_compiling(ufunc, compile_type))
5078 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5079 else
5080 smsg(_("Function %s does not need compiling"), eap->arg);
5081 }
5082 }
5083 else
5084 {
5085 long todo = (long)func_hashtab.ht_used;
5086 int changed = func_hashtab.ht_changed;
5087 hashitem_T *hi;
5088
5089 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5090 {
5091 if (!HASHITEM_EMPTY(hi))
5092 {
5093 --todo;
5094 ufunc = HI2UF(hi);
5095 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5096 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5097 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005098 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005099 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5100
5101 if (func_hashtab.ht_changed != changed)
5102 {
5103 // a function has been added or removed, need to start
5104 // over
5105 todo = (long)func_hashtab.ht_used;
5106 changed = func_hashtab.ht_changed;
5107 hi = func_hashtab.ht_array;
5108 --hi;
5109 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005110 }
5111 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005112 }
5113 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005114}
5115
5116/*
5117 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5118 * Return 2 if "p" starts with "s:".
5119 * Return 0 otherwise.
5120 */
5121 int
5122eval_fname_script(char_u *p)
5123{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005124 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5125 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005126 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5127 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5128 return 5;
5129 if (p[0] == 's' && p[1] == ':')
5130 return 2;
5131 return 0;
5132}
5133
5134 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005135translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005136{
5137 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005138 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005139 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005140}
5141
5142/*
5143 * Return TRUE when "ufunc" has old-style "..." varargs
5144 * or named varargs "...name: type".
5145 */
5146 int
5147has_varargs(ufunc_T *ufunc)
5148{
5149 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005150}
5151
5152/*
5153 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005154 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005155 */
5156 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005157function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005158{
5159 char_u *nm = name;
5160 char_u *p;
5161 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005162 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005163 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005164
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005165 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5166 if (no_deref)
5167 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005168 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005169 nm = skipwhite(nm);
5170
Bram Moolenaare38eab22019-12-05 21:50:01 +01005171 // Only accept "funcname", "funcname ", "funcname (..." and
5172 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005173 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005174 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005175 vim_free(p);
5176 return n;
5177}
5178
Bram Moolenaar113e1072019-01-20 15:30:40 +01005179#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005180 char_u *
5181get_expanded_name(char_u *name, int check)
5182{
5183 char_u *nm = name;
5184 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005185 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005186
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005187 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005188 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005189
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005190 if (p != NULL && *nm == NUL
5191 && (!check || translated_function_exists(p, is_global)))
5192 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005193
5194 vim_free(p);
5195 return NULL;
5196}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005197#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005198
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005199/*
5200 * Function given to ExpandGeneric() to obtain the list of user defined
5201 * function names.
5202 */
5203 char_u *
5204get_user_func_name(expand_T *xp, int idx)
5205{
5206 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005207 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208 static hashitem_T *hi;
5209 ufunc_T *fp;
5210
5211 if (idx == 0)
5212 {
5213 done = 0;
5214 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005215 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005216 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005217 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218 {
5219 if (done++ > 0)
5220 ++hi;
5221 while (HASHITEM_EMPTY(hi))
5222 ++hi;
5223 fp = HI2UF(hi);
5224
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005225 // don't show dead, dict and lambda functions
5226 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005227 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005228 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005229
5230 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005231 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005232
5233 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005234 if (xp->xp_context != EXPAND_USER_FUNC
5235 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236 {
5237 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005238 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005239 STRCAT(IObuff, ")");
5240 }
5241 return IObuff;
5242 }
5243 return NULL;
5244}
5245
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005246/*
5247 * ":delfunction {name}"
5248 */
5249 void
5250ex_delfunction(exarg_T *eap)
5251{
5252 ufunc_T *fp = NULL;
5253 char_u *p;
5254 char_u *name;
5255 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005256 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005257
5258 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005259 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5260 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005261 vim_free(fudi.fd_newkey);
5262 if (name == NULL)
5263 {
5264 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005265 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005266 return;
5267 }
5268 if (!ends_excmd(*skipwhite(p)))
5269 {
5270 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005271 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005272 return;
5273 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005274 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005275 if (eap->nextcmd != NULL)
5276 *p = NUL;
5277
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005278 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005279 {
5280 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005281 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005282 vim_free(name);
5283 return;
5284 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005285 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005286 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005287 vim_free(name);
5288
5289 if (!eap->skip)
5290 {
5291 if (fp == NULL)
5292 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005293 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005294 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005295 return;
5296 }
5297 if (fp->uf_calls > 0)
5298 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005299 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005300 return;
5301 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005302 if (fp->uf_flags & FC_VIM9)
5303 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005304 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005305 return;
5306 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005307
5308 if (fudi.fd_dict != NULL)
5309 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005310 // Delete the dict item that refers to the function, it will
5311 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005312 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5313 }
5314 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005315 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005316 // A normal function (not a numbered function or lambda) has a
5317 // refcount of 1 for the entry in the hashtable. When deleting
5318 // it and the refcount is more than one, it should be kept.
5319 // A numbered function and lambda should be kept if the refcount is
5320 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005321 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005322 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005323 // Function is still referenced somewhere. Don't free it but
5324 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005325 if (func_remove(fp))
5326 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005327 }
5328 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005329 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005330 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005331 }
5332}
5333
5334/*
5335 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005336 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337 */
5338 void
5339func_unref(char_u *name)
5340{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005341 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005343 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005344 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005345 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005346 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005347 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005349 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005350#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005351 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005352 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005353 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005354}
5355
5356/*
5357 * Unreference a Function: decrement the reference count and free it when it
5358 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005359 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005360 */
5361 void
5362func_ptr_unref(ufunc_T *fp)
5363{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005364 if (fp != NULL && (--fp->uf_refcount <= 0
5365 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5366 && fp->uf_partial->pt_refcount <= 1
5367 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005368 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005369 // Only delete it when it's not being used. Otherwise it's done
5370 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005371 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005372 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005373 }
5374}
5375
5376/*
5377 * Count a reference to a Function.
5378 */
5379 void
5380func_ref(char_u *name)
5381{
5382 ufunc_T *fp;
5383
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005384 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005386 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005387 if (fp != NULL)
5388 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005389 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005390 // Only give an error for a numbered function.
5391 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005392 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005393}
5394
5395/*
5396 * Count a reference to a Function.
5397 */
5398 void
5399func_ptr_ref(ufunc_T *fp)
5400{
5401 if (fp != NULL)
5402 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005403}
5404
5405/*
5406 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5407 * referenced from anywhere that is in use.
5408 */
5409 static int
5410can_free_funccal(funccall_T *fc, int copyID)
5411{
5412 return (fc->l_varlist.lv_copyID != copyID
5413 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005414 && fc->l_avars.dv_copyID != copyID
5415 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005416}
5417
5418/*
5419 * ":return [expr]"
5420 */
5421 void
5422ex_return(exarg_T *eap)
5423{
5424 char_u *arg = eap->arg;
5425 typval_T rettv;
5426 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005427 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005428
5429 if (current_funccal == NULL)
5430 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005431 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005432 return;
5433 }
5434
Bram Moolenaar844fb642021-10-23 13:32:30 +01005435 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005436 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5437
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005438 if (eap->skip)
5439 ++emsg_skip;
5440
5441 eap->nextcmd = NULL;
5442 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005443 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005444 {
5445 if (!eap->skip)
5446 returning = do_return(eap, FALSE, TRUE, &rettv);
5447 else
5448 clear_tv(&rettv);
5449 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005450 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005451 else if (!eap->skip)
5452 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005453 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005454 update_force_abort();
5455
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005456 /*
5457 * Return unless the expression evaluation has been cancelled due to an
5458 * aborting error, an interrupt, or an exception.
5459 */
5460 if (!aborting())
5461 returning = do_return(eap, FALSE, TRUE, NULL);
5462 }
5463
Bram Moolenaare38eab22019-12-05 21:50:01 +01005464 // When skipping or the return gets pending, advance to the next command
5465 // in this line (!returning). Otherwise, ignore the rest of the line.
5466 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005467 if (returning)
5468 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005469 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005470 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005471
5472 if (eap->skip)
5473 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005474 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005475}
5476
5477/*
5478 * ":1,25call func(arg1, arg2)" function call.
5479 */
5480 void
5481ex_call(exarg_T *eap)
5482{
5483 char_u *arg = eap->arg;
5484 char_u *startarg;
5485 char_u *name;
5486 char_u *tofree;
5487 int len;
5488 typval_T rettv;
5489 linenr_T lnum;
5490 int doesrange;
5491 int failed = FALSE;
5492 funcdict_T fudi;
5493 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005494 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005495 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005496 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005497 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005498
Bram Moolenaare6b53242020-07-01 17:28:33 +02005499 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005500 if (eap->skip)
5501 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005502 // trans_function_name() doesn't work well when skipping, use eval0()
5503 // instead to skip to any following command, e.g. for:
5504 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005505 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005506 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005507 clear_tv(&rettv);
5508 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005509 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005510 return;
5511 }
5512
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005513 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005514 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515 if (fudi.fd_newkey != NULL)
5516 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005517 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005518 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519 vim_free(fudi.fd_newkey);
5520 }
5521 if (tofree == NULL)
5522 return;
5523
Bram Moolenaare38eab22019-12-05 21:50:01 +01005524 // Increase refcount on dictionary, it could get deleted when evaluating
5525 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005526 if (fudi.fd_dict != NULL)
5527 ++fudi.fd_dict->dv_refcount;
5528
Bram Moolenaare38eab22019-12-05 21:50:01 +01005529 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5530 // contents. For VAR_PARTIAL get its partial, unless we already have one
5531 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005532 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005533 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005534 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005535 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005536
Bram Moolenaare38eab22019-12-05 21:50:01 +01005537 // Skip white space to allow ":call func ()". Not good, but required for
5538 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005539 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005540 if (*startarg != '(')
5541 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005542 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005543 goto end;
5544 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005545 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005546 {
5547 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5548 goto end;
5549 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005550
5551 /*
5552 * When skipping, evaluate the function once, to find the end of the
5553 * arguments.
5554 * When the function takes a range, this is discovered after the first
5555 * call, and the loop is broken.
5556 */
5557 if (eap->skip)
5558 {
5559 ++emsg_skip;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005560 lnum = eap->line2; // do it once, also with an invalid range
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005561 }
5562 else
5563 lnum = eap->line1;
5564 for ( ; lnum <= eap->line2; ++lnum)
5565 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005566 funcexe_T funcexe;
5567
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005568 if (!eap->skip && eap->addr_count > 0)
5569 {
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005570 if (lnum > curbuf->b_ml.ml_line_count)
5571 {
5572 // If the function deleted lines or switched to another buffer
5573 // the line number may become invalid.
Bram Moolenaar108010a2021-06-27 22:03:33 +02005574 emsg(_(e_invalid_range));
Bram Moolenaar9e353b52018-11-04 23:39:38 +01005575 break;
5576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005577 curwin->w_cursor.lnum = lnum;
5578 curwin->w_cursor.col = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005579 curwin->w_cursor.coladd = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005580 }
5581 arg = startarg;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005582
Bram Moolenaara80faa82020-04-12 19:37:17 +02005583 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005584 funcexe.fe_firstline = eap->line1;
5585 funcexe.fe_lastline = eap->line2;
5586 funcexe.fe_doesrange = &doesrange;
5587 funcexe.fe_evaluate = !eap->skip;
5588 funcexe.fe_partial = partial;
5589 funcexe.fe_selfdict = fudi.fd_dict;
5590 funcexe.fe_check_type = type;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005591 funcexe.fe_found_var = found_var;
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005592 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
Bram Moolenaare6b53242020-07-01 17:28:33 +02005593 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005594 {
5595 failed = TRUE;
5596 break;
5597 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01005598 if (has_watchexpr())
5599 dbg_check_breakpoint(eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005600
Bram Moolenaar9cfe8f62019-08-17 21:04:16 +02005601 // Handle a function returning a Funcref, Dictionary or List.
Bram Moolenaar32884ad2022-01-07 12:45:29 +00005602 if (handle_subscript(&arg, NULL, &rettv,
Bram Moolenaare40fbc22020-06-27 18:06:45 +02005603 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005604 {
5605 failed = TRUE;
5606 break;
5607 }
5608
5609 clear_tv(&rettv);
5610 if (doesrange || eap->skip)
5611 break;
5612
Bram Moolenaare38eab22019-12-05 21:50:01 +01005613 // Stop when immediately aborting on error, or when an interrupt
5614 // occurred or an exception was thrown but not caught.
5615 // get_func_tv() returned OK, so that the check for trailing
5616 // characters below is executed.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005617 if (aborting())
5618 break;
5619 }
5620 if (eap->skip)
5621 --emsg_skip;
5622
Bram Moolenaar1d341892021-09-18 15:25:52 +02005623 // When inside :try we need to check for following "| catch" or "| endtry".
5624 // Not when there was an error, but do check if an exception was thrown.
5625 if ((!aborting() || did_throw)
5626 && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005627 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005628 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005629 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005630 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005631 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005632 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005633 {
5634 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005635 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005636 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005637 }
5638 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005639 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005640 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005641 // Must be after using "arg", it may point into memory cleared here.
5642 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005643
5644end:
5645 dict_unref(fudi.fd_dict);
5646 vim_free(tofree);
5647}
5648
5649/*
5650 * Return from a function. Possibly makes the return pending. Also called
5651 * for a pending return at the ":endtry" or after returning from an extra
5652 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5653 * when called due to a ":return" command. "rettv" may point to a typval_T
5654 * with the return rettv. Returns TRUE when the return can be carried out,
5655 * FALSE when the return gets pending.
5656 */
5657 int
5658do_return(
5659 exarg_T *eap,
5660 int reanimate,
5661 int is_cmd,
5662 void *rettv)
5663{
5664 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005665 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005666
5667 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005668 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005669 current_funccal->returned = FALSE;
5670
5671 /*
5672 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5673 * not in its finally clause (which then is to be executed next) is found.
5674 * In this case, make the ":return" pending for execution at the ":endtry".
5675 * Otherwise, return normally.
5676 */
5677 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5678 if (idx >= 0)
5679 {
5680 cstack->cs_pending[idx] = CSTP_RETURN;
5681
5682 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005683 // A pending return again gets pending. "rettv" points to an
5684 // allocated variable with the rettv of the original ":return"'s
5685 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005686 cstack->cs_rettv[idx] = rettv;
5687 else
5688 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005689 // When undoing a return in order to make it pending, get the stored
5690 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005691 if (reanimate)
5692 rettv = current_funccal->rettv;
5693
5694 if (rettv != NULL)
5695 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005696 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005697 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5698 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5699 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005700 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005701 }
5702 else
5703 cstack->cs_rettv[idx] = NULL;
5704
5705 if (reanimate)
5706 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005707 // The pending return value could be overwritten by a ":return"
5708 // without argument in a finally clause; reset the default
5709 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005710 current_funccal->rettv->v_type = VAR_NUMBER;
5711 current_funccal->rettv->vval.v_number = 0;
5712 }
5713 }
5714 report_make_pending(CSTP_RETURN, rettv);
5715 }
5716 else
5717 {
5718 current_funccal->returned = TRUE;
5719
Bram Moolenaare38eab22019-12-05 21:50:01 +01005720 // If the return is carried out now, store the return value. For
5721 // a return immediately after reanimation, the value is already
5722 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005723 if (!reanimate && rettv != NULL)
5724 {
5725 clear_tv(current_funccal->rettv);
5726 *current_funccal->rettv = *(typval_T *)rettv;
5727 if (!is_cmd)
5728 vim_free(rettv);
5729 }
5730 }
5731
5732 return idx < 0;
5733}
5734
5735/*
5736 * Free the variable with a pending return value.
5737 */
5738 void
5739discard_pending_return(void *rettv)
5740{
5741 free_tv((typval_T *)rettv);
5742}
5743
5744/*
5745 * Generate a return command for producing the value of "rettv". The result
5746 * is an allocated string. Used by report_pending() for verbose messages.
5747 */
5748 char_u *
5749get_return_cmd(void *rettv)
5750{
5751 char_u *s = NULL;
5752 char_u *tofree = NULL;
5753 char_u numbuf[NUMBUFLEN];
5754
5755 if (rettv != NULL)
5756 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5757 if (s == NULL)
5758 s = (char_u *)"";
5759
5760 STRCPY(IObuff, ":return ");
5761 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5762 if (STRLEN(s) + 8 >= IOSIZE)
5763 STRCPY(IObuff + IOSIZE - 4, "...");
5764 vim_free(tofree);
5765 return vim_strsave(IObuff);
5766}
5767
5768/*
5769 * Get next function line.
5770 * Called by do_cmdline() to get the next line.
5771 * Returns allocated string, or NULL for end of function.
5772 */
5773 char_u *
5774get_func_line(
5775 int c UNUSED,
5776 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005777 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005778 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005779{
5780 funccall_T *fcp = (funccall_T *)cookie;
5781 ufunc_T *fp = fcp->func;
5782 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005783 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005784
Bram Moolenaare38eab22019-12-05 21:50:01 +01005785 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005786 if (fcp->dbg_tick != debug_tick)
5787 {
5788 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005789 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005790 fcp->dbg_tick = debug_tick;
5791 }
5792#ifdef FEAT_PROFILE
5793 if (do_profiling == PROF_YES)
5794 func_line_end(cookie);
5795#endif
5796
5797 gap = &fp->uf_lines;
5798 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5799 || fcp->returned)
5800 retval = NULL;
5801 else
5802 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005803 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005804 while (fcp->linenr < gap->ga_len
5805 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5806 ++fcp->linenr;
5807 if (fcp->linenr >= gap->ga_len)
5808 retval = NULL;
5809 else
5810 {
5811 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005812 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005813#ifdef FEAT_PROFILE
5814 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005815 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005816#endif
5817 }
5818 }
5819
Bram Moolenaare38eab22019-12-05 21:50:01 +01005820 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005821 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005822 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005823 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01005824 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005825 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005826 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005827 fcp->dbg_tick = debug_tick;
5828 }
5829
5830 return retval;
5831}
5832
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005833/*
5834 * Return TRUE if the currently active function should be ended, because a
5835 * return was encountered or an error occurred. Used inside a ":while".
5836 */
5837 int
5838func_has_ended(void *cookie)
5839{
5840 funccall_T *fcp = (funccall_T *)cookie;
5841
Bram Moolenaare38eab22019-12-05 21:50:01 +01005842 // Ignore the "abort" flag if the abortion behavior has been changed due to
5843 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005844 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5845 || fcp->returned);
5846}
5847
5848/*
5849 * return TRUE if cookie indicates a function which "abort"s on errors.
5850 */
5851 int
5852func_has_abort(
5853 void *cookie)
5854{
5855 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
5856}
5857
5858
5859/*
5860 * Turn "dict.Func" into a partial for "Func" bound to "dict".
5861 * Don't do this when "Func" is already a partial that was bound
5862 * explicitly (pt_auto is FALSE).
5863 * Changes "rettv" in-place.
5864 * Returns the updated "selfdict_in".
5865 */
5866 dict_T *
5867make_partial(dict_T *selfdict_in, typval_T *rettv)
5868{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005869 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005870 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005871 char_u fname_buf[FLEN_FIXED + 1];
5872 int error;
5873 dict_T *selfdict = selfdict_in;
5874
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005875 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
5876 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005877 fp = rettv->vval.v_partial->pt_func;
5878 else
5879 {
5880 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005881 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005882 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005883 if (fname == NULL)
5884 {
5885 // There is no point binding a dict to a NULL function, just create
5886 // a function reference.
5887 rettv->v_type = VAR_FUNC;
5888 rettv->vval.v_string = NULL;
5889 }
5890 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00005891 {
5892 char_u *tofree = NULL;
5893
5894 // Translate "s:func" to the stored function name.
5895 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
5896 fp = find_func(fname, FALSE);
5897 vim_free(tofree);
5898 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005899 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005900
Bram Moolenaared0c62e2022-03-08 19:43:55 +00005901 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005902 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005903 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005904
5905 if (pt != NULL)
5906 {
5907 pt->pt_refcount = 1;
5908 pt->pt_dict = selfdict;
5909 pt->pt_auto = TRUE;
5910 selfdict = NULL;
5911 if (rettv->v_type == VAR_FUNC)
5912 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005913 // Just a function: Take over the function name and use
5914 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005915 pt->pt_name = rettv->vval.v_string;
5916 }
5917 else
5918 {
5919 partial_T *ret_pt = rettv->vval.v_partial;
5920 int i;
5921
Bram Moolenaare38eab22019-12-05 21:50:01 +01005922 // Partial: copy the function name, use selfdict and copy
5923 // args. Can't take over name or args, the partial might
5924 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005925 if (ret_pt->pt_name != NULL)
5926 {
5927 pt->pt_name = vim_strsave(ret_pt->pt_name);
5928 func_ref(pt->pt_name);
5929 }
5930 else
5931 {
5932 pt->pt_func = ret_pt->pt_func;
5933 func_ptr_ref(pt->pt_func);
5934 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005935 if (ret_pt->pt_argc > 0)
5936 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02005937 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005938 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005939 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005940 pt->pt_argc = 0;
5941 else
5942 {
5943 pt->pt_argc = ret_pt->pt_argc;
5944 for (i = 0; i < pt->pt_argc; i++)
5945 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
5946 }
5947 }
5948 partial_unref(ret_pt);
5949 }
5950 rettv->v_type = VAR_PARTIAL;
5951 rettv->vval.v_partial = pt;
5952 }
5953 }
5954 return selfdict;
5955}
5956
5957/*
5958 * Return the name of the executed function.
5959 */
5960 char_u *
5961func_name(void *cookie)
5962{
5963 return ((funccall_T *)cookie)->func->uf_name;
5964}
5965
5966/*
5967 * Return the address holding the next breakpoint line for a funccall cookie.
5968 */
5969 linenr_T *
5970func_breakpoint(void *cookie)
5971{
5972 return &((funccall_T *)cookie)->breakpoint;
5973}
5974
5975/*
5976 * Return the address holding the debug tick for a funccall cookie.
5977 */
5978 int *
5979func_dbg_tick(void *cookie)
5980{
5981 return &((funccall_T *)cookie)->dbg_tick;
5982}
5983
5984/*
5985 * Return the nesting level for a funccall cookie.
5986 */
5987 int
5988func_level(void *cookie)
5989{
5990 return ((funccall_T *)cookie)->level;
5991}
5992
5993/*
5994 * Return TRUE when a function was ended by a ":return" command.
5995 */
5996 int
5997current_func_returned(void)
5998{
5999 return current_funccal->returned;
6000}
6001
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006002 int
6003free_unref_funccal(int copyID, int testing)
6004{
6005 int did_free = FALSE;
6006 int did_free_funccal = FALSE;
6007 funccall_T *fc, **pfc;
6008
6009 for (pfc = &previous_funccal; *pfc != NULL; )
6010 {
6011 if (can_free_funccal(*pfc, copyID))
6012 {
6013 fc = *pfc;
6014 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006015 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006016 did_free = TRUE;
6017 did_free_funccal = TRUE;
6018 }
6019 else
6020 pfc = &(*pfc)->caller;
6021 }
6022 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006023 // When a funccal was freed some more items might be garbage
6024 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006025 (void)garbage_collect(testing);
6026
6027 return did_free;
6028}
6029
6030/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006031 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006032 */
6033 static funccall_T *
6034get_funccal(void)
6035{
6036 int i;
6037 funccall_T *funccal;
6038 funccall_T *temp_funccal;
6039
6040 funccal = current_funccal;
6041 if (debug_backtrace_level > 0)
6042 {
6043 for (i = 0; i < debug_backtrace_level; i++)
6044 {
6045 temp_funccal = funccal->caller;
6046 if (temp_funccal)
6047 funccal = temp_funccal;
6048 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006049 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006050 debug_backtrace_level = i;
6051 }
6052 }
6053 return funccal;
6054}
6055
6056/*
6057 * Return the hashtable used for local variables in the current funccal.
6058 * Return NULL if there is no current funccal.
6059 */
6060 hashtab_T *
6061get_funccal_local_ht()
6062{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006063 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006064 return NULL;
6065 return &get_funccal()->l_vars.dv_hashtab;
6066}
6067
6068/*
6069 * Return the l: scope variable.
6070 * Return NULL if there is no current funccal.
6071 */
6072 dictitem_T *
6073get_funccal_local_var()
6074{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006075 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006076 return NULL;
6077 return &get_funccal()->l_vars_var;
6078}
6079
6080/*
6081 * Return the hashtable used for argument in the current funccal.
6082 * Return NULL if there is no current funccal.
6083 */
6084 hashtab_T *
6085get_funccal_args_ht()
6086{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006087 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006088 return NULL;
6089 return &get_funccal()->l_avars.dv_hashtab;
6090}
6091
6092/*
6093 * Return the a: scope variable.
6094 * Return NULL if there is no current funccal.
6095 */
6096 dictitem_T *
6097get_funccal_args_var()
6098{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006099 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006100 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01006101 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006102}
6103
6104/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006105 * List function variables, if there is a function.
6106 */
6107 void
6108list_func_vars(int *first)
6109{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006110 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006111 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006112 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006113}
6114
6115/*
6116 * If "ht" is the hashtable for local variables in the current funccal, return
6117 * the dict that contains it.
6118 * Otherwise return NULL.
6119 */
6120 dict_T *
6121get_current_funccal_dict(hashtab_T *ht)
6122{
6123 if (current_funccal != NULL
6124 && ht == &current_funccal->l_vars.dv_hashtab)
6125 return &current_funccal->l_vars;
6126 return NULL;
6127}
6128
6129/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006130 * Search hashitem in parent scope.
6131 */
6132 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006133find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006134{
6135 funccall_T *old_current_funccal = current_funccal;
6136 hashtab_T *ht;
6137 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006138 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006139
6140 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6141 return NULL;
6142
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006143 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006144 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006145 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006146 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006147 ht = find_var_ht(name, &varname);
6148 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006149 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006150 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006151 if (!HASHITEM_EMPTY(hi))
6152 {
6153 *pht = ht;
6154 break;
6155 }
6156 }
6157 if (current_funccal == current_funccal->func->uf_scoped)
6158 break;
6159 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006160 }
6161 current_funccal = old_current_funccal;
6162
6163 return hi;
6164}
6165
6166/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006167 * Search variable in parent scope.
6168 */
6169 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006170find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006171{
6172 dictitem_T *v = NULL;
6173 funccall_T *old_current_funccal = current_funccal;
6174 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006175 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006176
6177 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6178 return NULL;
6179
Bram Moolenaare38eab22019-12-05 21:50:01 +01006180 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006181 current_funccal = current_funccal->func->uf_scoped;
6182 while (current_funccal)
6183 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006184 ht = find_var_ht(name, &varname);
6185 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006186 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006187 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006188 if (v != NULL)
6189 break;
6190 }
6191 if (current_funccal == current_funccal->func->uf_scoped)
6192 break;
6193 current_funccal = current_funccal->func->uf_scoped;
6194 }
6195 current_funccal = old_current_funccal;
6196
6197 return v;
6198}
6199
6200/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006201 * Set "copyID + 1" in previous_funccal and callers.
6202 */
6203 int
6204set_ref_in_previous_funccal(int copyID)
6205{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006206 funccall_T *fc;
6207
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006208 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006209 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006210 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006211 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6212 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6213 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6214 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006215 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006216 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006217}
6218
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006219 static int
6220set_ref_in_funccal(funccall_T *fc, int copyID)
6221{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006222 if (fc->fc_copyID != copyID)
6223 {
6224 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006225 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6226 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6227 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6228 || set_ref_in_func(NULL, fc->func, copyID))
6229 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006230 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006231 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006232}
6233
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006234/*
6235 * Set "copyID" in all local vars and arguments in the call stack.
6236 */
6237 int
6238set_ref_in_call_stack(int copyID)
6239{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006240 funccall_T *fc;
6241 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006242
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006243 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6244 if (set_ref_in_funccal(fc, copyID))
6245 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006246
6247 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006248 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6249 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6250 if (set_ref_in_funccal(fc, copyID))
6251 return TRUE;
6252 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006253}
6254
6255/*
6256 * Set "copyID" in all functions available by name.
6257 */
6258 int
6259set_ref_in_functions(int copyID)
6260{
6261 int todo;
6262 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006263 ufunc_T *fp;
6264
6265 todo = (int)func_hashtab.ht_used;
6266 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006267 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006268 if (!HASHITEM_EMPTY(hi))
6269 {
6270 --todo;
6271 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006272 if (!func_name_refcount(fp->uf_name)
6273 && set_ref_in_func(NULL, fp, copyID))
6274 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006275 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006276 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006277 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006278}
6279
6280/*
6281 * Set "copyID" in all function arguments.
6282 */
6283 int
6284set_ref_in_func_args(int copyID)
6285{
6286 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006287
6288 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006289 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6290 copyID, NULL, NULL))
6291 return TRUE;
6292 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006293}
6294
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006295/*
6296 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006297 * Returns TRUE if setting references failed somehow.
6298 */
6299 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006300set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006301{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006302 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006303 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006304 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006305 char_u fname_buf[FLEN_FIXED + 1];
6306 char_u *tofree = NULL;
6307 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006308 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006309
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006310 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006311 return FALSE;
6312
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006313 if (fp_in == NULL)
6314 {
6315 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006316 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006317 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006318 if (fp != NULL)
6319 {
6320 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006321 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006322 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006323
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006324 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006325 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006326}
6327
Bram Moolenaare38eab22019-12-05 21:50:01 +01006328#endif // FEAT_EVAL