blob: 8956b8244325cf1b8da4df103c105ecf9080438c [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);
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +010035static char_u *untrans_function_name(char_u *name);
Bram Moolenaar58779852022-09-06 18:31:14 +010036static void handle_defer_one(funccall_T *funccal);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020037
38 void
39func_init()
40{
41 hash_init(&func_hashtab);
42}
43
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020044/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020045 * Return the function hash table
46 */
47 hashtab_T *
48func_tbl_get(void)
49{
50 return &func_hashtab;
51}
52
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;
Bram Moolenaareb5adf12022-09-04 13:41:37 +0100315 p = skipwhite(np + 1);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200316 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200317 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200318 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200319 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200320 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200321 if (ga_grow(default_args, 1) == FAIL)
322 goto err_ret;
323
324 // trim trailing whitespace
325 while (p > expr && VIM_ISWHITE(p[-1]))
326 p--;
327 c = *p;
328 *p = NUL;
329 expr = vim_strsave(expr);
330 if (expr == NULL)
331 {
332 *p = c;
333 goto err_ret;
334 }
335 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200336 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200337 default_args->ga_len++;
338 *p = c;
339 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200340 }
341 else
342 mustend = TRUE;
343 }
344 else if (any_default)
345 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000346 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200347 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200348 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200349
350 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
351 {
352 // Be tolerant when skipping
353 if (!skip)
354 {
355 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
356 goto err_ret;
357 }
358 p = skipwhite(p);
359 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200360 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200361 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200363 // Don't give this error when skipping, it makes the "->" not
364 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100365 // Allow missing space after comma in legacy functions.
366 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200367 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
368 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100369 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200370 goto err_ret;
371 }
372 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200373 else
374 mustend = TRUE;
375 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200376 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200378 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200379
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200380 if (*p != endchar)
381 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100382 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200383
384 *argp = p;
385 return OK;
386
387err_ret:
388 if (newargs != NULL)
389 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200390 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200391 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200392 return FAIL;
393}
394
395/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100396 * Parse the argument types, filling "fp->uf_arg_types".
397 * Return OK or FAIL.
398 */
399 static int
400parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
401{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200402 int len = 0;
403
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100404 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
405 if (argtypes->ga_len > 0)
406 {
407 // When "varargs" is set the last name/type goes into uf_va_name
408 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200409 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100410
411 if (len > 0)
412 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
413 if (fp->uf_arg_types != NULL)
414 {
415 int i;
416 type_T *type;
417
418 for (i = 0; i < len; ++ i)
419 {
420 char_u *p = ((char_u **)argtypes->ga_data)[i];
421
422 if (p == NULL)
423 // will get the type from the default value
424 type = &t_unknown;
425 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100426 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100427 if (type == NULL)
428 return FAIL;
429 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000430 if (i < fp->uf_args.ga_len
431 && (type->tt_type == VAR_FUNC
432 || type->tt_type == VAR_PARTIAL)
433 && var_wrong_func_name(
434 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
435 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100436 }
437 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100438 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200439
440 if (varargs)
441 {
442 char_u *p;
443
444 // Move the last argument "...name: type" to uf_va_name and
445 // uf_va_type.
446 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
447 [fp->uf_args.ga_len - 1];
448 --fp->uf_args.ga_len;
449 p = ((char_u **)argtypes->ga_data)[len];
450 if (p == NULL)
451 // TODO: get type from default value
452 fp->uf_va_type = &t_list_any;
453 else
454 {
455 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
456 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
457 {
458 semsg(_(e_variable_arguments_type_must_be_list_str),
459 ((char_u **)argtypes->ga_data)[len]);
460 return FAIL;
461 }
462 }
463 if (fp->uf_va_type == NULL)
464 return FAIL;
465 }
466
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100467 return OK;
468}
469
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100470 static int
471parse_return_type(ufunc_T *fp, char_u *ret_type)
472{
473 if (ret_type == NULL)
474 fp->uf_ret_type = &t_void;
475 else
476 {
477 char_u *p = ret_type;
478
479 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
480 if (fp->uf_ret_type == NULL)
481 {
482 fp->uf_ret_type = &t_void;
483 return FAIL;
484 }
485 }
486 return OK;
487}
488
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100489/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200490 * Register function "fp" as using "current_funccal" as its scope.
491 */
492 static int
493register_closure(ufunc_T *fp)
494{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200495 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100496 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200498 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200499 fp->uf_scoped = current_funccal;
500 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200501
Bram Moolenaar58016442016-07-31 18:30:22 +0200502 if (ga_grow(&current_funccal->fc_funcs, 1) == FAIL)
503 return FAIL;
504 ((ufunc_T **)current_funccal->fc_funcs.ga_data)
505 [current_funccal->fc_funcs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200506 return OK;
507}
508
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100509 static void
510set_ufunc_name(ufunc_T *fp, char_u *name)
511{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100512 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
513 // actually extends beyond the struct.
514 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100515
516 if (name[0] == K_SPECIAL)
517 {
518 fp->uf_name_exp = alloc(STRLEN(name) + 3);
519 if (fp->uf_name_exp != NULL)
520 {
521 STRCPY(fp->uf_name_exp, "<SNR>");
522 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
523 }
524 }
525}
526
Bram Moolenaar58016442016-07-31 18:30:22 +0200527/*
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100528 * If "name" starts with K_SPECIAL and "buf[bufsize]" is big enough
529 * return "buf" filled with a readable function name.
530 * Otherwise just return "name", thus the return value can always be used.
531 * "name" and "buf" may be equal.
532 */
533 char_u *
534make_ufunc_name_readable(char_u *name, char_u *buf, size_t bufsize)
535{
536 size_t len;
537
538 if (name[0] != K_SPECIAL)
539 return name;
540 len = STRLEN(name);
541 if (len + 3 > bufsize)
542 return name;
543
Bram Moolenaar96e08e02022-03-31 21:40:33 +0100544 mch_memmove(buf + 5, name + 3, len - 2); // Include trailing NUL
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100545 mch_memmove(buf, "<SNR>", 5);
546 return buf;
547}
548
549/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200550 * Get a name for a lambda. Returned in static memory.
551 */
552 char_u *
553get_lambda_name(void)
554{
555 static char_u name[30];
556 static int lambda_no = 0;
557
558 sprintf((char*)name, "<lambda>%d", ++lambda_no);
559 return name;
560}
561
Bram Moolenaar801ab062020-06-25 19:27:56 +0200562#if defined(FEAT_LUA) || defined(PROTO)
563/*
564 * Registers a native C callback which can be called from Vim script.
565 * Returns the name of the Vim script function.
566 */
567 char_u *
568register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
569{
570 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200571 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200572
573 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
574 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200575 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200576
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200577 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200578 fp->uf_refcount = 1;
579 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000580 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200581 fp->uf_calls = 0;
582 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200583 fp->uf_cb = cb;
584 fp->uf_cb_free = cb_free;
585 fp->uf_cb_state = state;
586
587 set_ufunc_name(fp, name);
588 hash_add(&func_hashtab, UF2HIKEY(fp));
589
590 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200591}
592#endif
593
Bram Moolenaar04b12692020-05-04 23:24:44 +0200594/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100595 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100596 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100597 * If "white_error" is not NULL check for correct use of white space and set
598 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100599 * Return NULL if no valid arrow found.
600 */
601 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100602skip_arrow(
603 char_u *start,
604 int equal_arrow,
605 char_u **ret_type,
606 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100607{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100608 char_u *s = start;
609 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100610
611 if (equal_arrow)
612 {
613 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100614 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100615 if (white_error != NULL && !VIM_ISWHITE(s[1]))
616 {
617 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100618 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100619 return NULL;
620 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100621 s = skipwhite(s + 1);
622 *ret_type = s;
623 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100624 if (s == *ret_type)
625 {
626 emsg(_(e_missing_return_type));
627 return NULL;
628 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100629 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100630 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100631 s = skipwhite(s);
632 if (*s != '=')
633 return NULL;
634 ++s;
635 }
636 if (*s != '>')
637 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100638 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
639 || !IS_WHITE_OR_NUL(s[1])))
640 {
641 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100642 semsg(_(e_white_space_required_before_and_after_str_at_str),
643 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100644 return NULL;
645 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100646 return skipwhite(s + 1);
647}
648
649/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100650 * Check if "*cmd" points to a function command and if so advance "*cmd" and
651 * return TRUE.
652 * Otherwise return FALSE;
653 * Do not consider "function(" to be a command.
654 */
655 static int
656is_function_cmd(char_u **cmd)
657{
658 char_u *p = *cmd;
659
660 if (checkforcmd(&p, "function", 2))
661 {
662 if (*p == '(')
663 return FALSE;
664 *cmd = p;
665 return TRUE;
666 }
667 return FALSE;
668}
669
670/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200671 * Called when defining a function: The context may be needed for script
672 * variables declared in a block that is visible now but not when the function
673 * is compiled or called later.
674 */
675 static void
676function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
677{
678 if (cstack != NULL && cstack->cs_idx >= 0)
679 {
680 int count = cstack->cs_idx + 1;
681 int i;
682
683 fp->uf_block_ids = ALLOC_MULT(int, count);
684 if (fp->uf_block_ids != NULL)
685 {
686 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
687 sizeof(int) * count);
688 fp->uf_block_depth = count;
689 }
690
691 // Set flag in each block to indicate a function was defined. This
692 // is used to keep the variable when leaving the block, see
693 // hide_script_var().
694 for (i = 0; i <= cstack->cs_idx; ++i)
695 cstack->cs_flags[i] |= CSF_FUNC_DEF;
696 }
697}
698
699/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100700 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200701 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100702 * "newlines" must already have been initialized.
703 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
704 */
705 static int
706get_function_body(
707 exarg_T *eap,
708 garray_T *newlines,
709 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000710 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100711{
712 linenr_T sourcing_lnum_top = SOURCING_LNUM;
713 linenr_T sourcing_lnum_off;
714 int saved_wait_return = need_wait_return;
715 char_u *line_arg = line_arg_in;
716 int vim9_function = eap->cmdidx == CMD_def
717 || eap->cmdidx == CMD_block;
718#define MAX_FUNC_NESTING 50
719 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200720 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100721 int nesting = 0;
722 getline_opt_T getline_options;
723 int indent = 2;
724 char_u *skip_until = NULL;
725 int ret = FAIL;
726 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200727 int heredoc_concat_len = 0;
728 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100729 char_u *heredoc_trimmed = NULL;
730
Bram Moolenaar20677332021-06-06 17:02:53 +0200731 ga_init2(&heredoc_ga, 1, 500);
732
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100733 // Detect having skipped over comment lines to find the return
734 // type. Add NULL lines to keep the line count correct.
735 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
736 if (SOURCING_LNUM < sourcing_lnum_off)
737 {
738 sourcing_lnum_off -= SOURCING_LNUM;
739 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
740 goto theend;
741 while (sourcing_lnum_off-- > 0)
742 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
743 }
744
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200745 nesting_def[0] = vim9_function;
746 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100747 getline_options = vim9_function
748 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
749 for (;;)
750 {
751 char_u *theline;
752 char_u *p;
753 char_u *arg;
754
755 if (KeyTyped)
756 {
757 msg_scroll = TRUE;
758 saved_wait_return = FALSE;
759 }
760 need_wait_return = FALSE;
761
762 if (line_arg != NULL)
763 {
764 // Use eap->arg, split up in parts by line breaks.
765 theline = line_arg;
766 p = vim_strchr(theline, '\n');
767 if (p == NULL)
768 line_arg += STRLEN(line_arg);
769 else
770 {
771 *p = NUL;
772 line_arg = p + 1;
773 }
774 }
775 else
776 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000777 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100778 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100779 }
780 if (KeyTyped)
781 lines_left = Rows - 1;
782 if (theline == NULL)
783 {
784 // Use the start of the function for the line number.
785 SOURCING_LNUM = sourcing_lnum_top;
786 if (skip_until != NULL)
787 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200788 else if (nesting_inline[nesting])
789 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100790 else if (eap->cmdidx == CMD_def)
791 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100792 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000793 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 goto theend;
795 }
796
797 // Detect line continuation: SOURCING_LNUM increased more than one.
798 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
799 if (SOURCING_LNUM < sourcing_lnum_off)
800 sourcing_lnum_off -= SOURCING_LNUM;
801 else
802 sourcing_lnum_off = 0;
803
804 if (skip_until != NULL)
805 {
806 // Don't check for ":endfunc"/":enddef" between
807 // * ":append" and "."
808 // * ":python <<EOF" and "EOF"
809 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
810 if (heredoc_trimmed == NULL
811 || (is_heredoc && skipwhite(theline) == theline)
812 || STRNCMP(theline, heredoc_trimmed,
813 STRLEN(heredoc_trimmed)) == 0)
814 {
815 if (heredoc_trimmed == NULL)
816 p = theline;
817 else if (is_heredoc)
818 p = skipwhite(theline) == theline
819 ? theline : theline + STRLEN(heredoc_trimmed);
820 else
821 p = theline + STRLEN(heredoc_trimmed);
822 if (STRCMP(p, skip_until) == 0)
823 {
824 VIM_CLEAR(skip_until);
825 VIM_CLEAR(heredoc_trimmed);
826 getline_options = vim9_function
827 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
828 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200829
830 if (heredoc_concat_len > 0)
831 {
832 // Replace the starting line with all the concatenated
833 // lines.
834 ga_concat(&heredoc_ga, theline);
835 vim_free(((char_u **)(newlines->ga_data))[
836 heredoc_concat_len - 1]);
837 ((char_u **)(newlines->ga_data))[
838 heredoc_concat_len - 1] = heredoc_ga.ga_data;
839 ga_init(&heredoc_ga);
840 heredoc_concat_len = 0;
841 theline += STRLEN(theline); // skip the "EOF"
842 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100843 }
844 }
845 }
846 else
847 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200848 int c;
849 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000850 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100851
852 // skip ':' and blanks
853 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
854 ;
855
856 // Check for "endfunction", "enddef" or "}".
857 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000858 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200859 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100860 ? *p == '}'
861 : (checkforcmd(&p, nesting_def[nesting]
862 ? "enddef" : "endfunction", 4)
863 && *p != ':'))
864 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000865 if (!nesting_inline[nesting] && nesting_def[nesting]
866 && p < cmd + 6)
867 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 if (nesting-- == 0)
869 {
870 char_u *nextcmd = NULL;
871
872 if (*p == '|' || *p == '}')
873 nextcmd = p + 1;
874 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
875 nextcmd = line_arg;
876 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100877 && (vim9_function || p_verbose > 0))
878 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200879 SOURCING_LNUM = sourcing_lnum_top
880 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100881 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000882 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100883 else
884 give_warning2((char_u *)
885 _("W22: Text found after :endfunction: %s"),
886 p, TRUE);
887 }
888 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100889 {
890 // Another command follows. If the line came from "eap"
891 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000892 // change "eap->cmdlinep" to point to the last fetched
893 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100894 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000895 if (lines_to_free->ga_len > 0
896 && *eap->cmdlinep !=
897 ((char_u **)lines_to_free->ga_data)
898 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100899 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000900 // *cmdlinep will be freed later, thus remove the
901 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100902 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000903 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
904 [lines_to_free->ga_len - 1];
905 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100906 }
907 }
908 break;
909 }
910 }
911
912 // Check for mismatched "endfunc" or "enddef".
913 // We don't check for "def" inside "func" thus we also can't check
914 // for "enddef".
915 // We continue to find the end of the function, although we might
916 // not find it.
917 else if (nesting_def[nesting])
918 {
919 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
920 emsg(_(e_mismatched_endfunction));
921 }
922 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
923 emsg(_(e_mismatched_enddef));
924
925 // Increase indent inside "if", "while", "for" and "try", decrease
926 // at "end".
927 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
928 indent -= 2;
929 else if (STRNCMP(p, "if", 2) == 0
930 || STRNCMP(p, "wh", 2) == 0
931 || STRNCMP(p, "for", 3) == 0
932 || STRNCMP(p, "try", 3) == 0)
933 indent += 2;
934
935 // Check for defining a function inside this function.
936 // Only recognize "def" inside "def", not inside "function",
937 // For backwards compatibility, see Test_function_python().
938 c = *p;
939 if (is_function_cmd(&p)
940 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
941 {
942 if (*p == '!')
943 p = skipwhite(p + 1);
944 p += eval_fname_script(p);
945 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
946 NULL, NULL));
947 if (*skipwhite(p) == '(')
948 {
949 if (nesting == MAX_FUNC_NESTING - 1)
950 emsg(_(e_function_nesting_too_deep));
951 else
952 {
953 ++nesting;
954 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200955 nesting_inline[nesting] = FALSE;
956 indent += 2;
957 }
958 }
959 }
960
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200961 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200962 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200963 // Not a comment line: check for nested inline function.
964 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200965 while (end > p && VIM_ISWHITE(*end))
966 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200967 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200968 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200969 int is_block;
970
971 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200972 --end;
973 while (end > p && VIM_ISWHITE(*end))
974 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200975 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
976 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200977 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200978 char_u *s = p;
979
980 // check for line starting with "au" for :autocmd or
981 // "com" for :command, these can use a {} block
982 is_block = checkforcmd_noparen(&s, "autocmd", 2)
983 || checkforcmd_noparen(&s, "command", 3);
984 }
985
986 if (is_block)
987 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200988 if (nesting == MAX_FUNC_NESTING - 1)
989 emsg(_(e_function_nesting_too_deep));
990 else
991 {
992 ++nesting;
993 nesting_def[nesting] = TRUE;
994 nesting_inline[nesting] = TRUE;
995 indent += 2;
996 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 }
998 }
999 }
1000
1001 // Check for ":append", ":change", ":insert". Not for :def.
1002 p = skip_range(p, FALSE, NULL);
1003 if (!vim9_function
1004 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1005 || (p[0] == 'c'
1006 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1007 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1008 && (STRNCMP(&p[3], "nge", 3) != 0
1009 || !ASCII_ISALPHA(p[6])))))))
1010 || (p[0] == 'i'
1011 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1012 && (!ASCII_ISALPHA(p[2])
1013 || (p[2] == 's'
1014 && (!ASCII_ISALPHA(p[3])
1015 || p[3] == 'e'))))))))
1016 skip_until = vim_strsave((char_u *)".");
1017
1018 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1019 arg = skipwhite(skiptowhite(p));
1020 if (arg[0] == '<' && arg[1] =='<'
1021 && ((p[0] == 'p' && p[1] == 'y'
1022 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1023 || ((p[2] == '3' || p[2] == 'x')
1024 && !ASCII_ISALPHA(p[3]))))
1025 || (p[0] == 'p' && p[1] == 'e'
1026 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1027 || (p[0] == 't' && p[1] == 'c'
1028 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1029 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1030 && !ASCII_ISALPHA(p[3]))
1031 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1032 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1033 || (p[0] == 'm' && p[1] == 'z'
1034 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1035 ))
1036 {
1037 // ":python <<" continues until a dot, like ":append"
1038 p = skipwhite(arg + 2);
1039 if (STRNCMP(p, "trim", 4) == 0)
1040 {
1041 // Ignore leading white space.
1042 p = skipwhite(p + 4);
1043 heredoc_trimmed = vim_strnsave(theline,
1044 skipwhite(theline) - theline);
1045 }
1046 if (*p == NUL)
1047 skip_until = vim_strsave((char_u *)".");
1048 else
1049 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1050 getline_options = GETLINE_NONE;
1051 is_heredoc = TRUE;
Bram Moolenaard881d152022-05-13 13:50:36 +01001052 if (eap->cmdidx == CMD_def && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001053 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001054 }
1055
Bram Moolenaard881d152022-05-13 13:50:36 +01001056 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001057 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001058 // Check for ":cmd v =<< [trim] EOF"
1059 // and ":cmd [a, b] =<< [trim] EOF"
1060 // and "lines =<< [trim] EOF" for Vim9
1061 // Where "cmd" can be "let", "var", "final" or "const".
1062 arg = skipwhite(skiptowhite(p));
1063 if (*arg == '[')
1064 arg = vim_strchr(arg, ']');
1065 if (arg != NULL)
1066 {
1067 int found = (eap->cmdidx == CMD_def && arg[0] == '='
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001068 && arg[1] == '<' && arg[2] =='<');
1069
Bram Moolenaard881d152022-05-13 13:50:36 +01001070 if (!found)
1071 // skip over the argument after "cmd"
1072 arg = skipwhite(skiptowhite(arg));
1073 if (found || (arg[0] == '=' && arg[1] == '<'
1074 && arg[2] =='<'
1075 && (checkforcmd(&p, "let", 2)
1076 || checkforcmd(&p, "var", 3)
1077 || checkforcmd(&p, "final", 5)
1078 || checkforcmd(&p, "const", 5))))
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001079 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001080 p = skipwhite(arg + 3);
1081 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001082 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001083 if (STRNCMP(p, "trim", 4) == 0)
1084 {
1085 // Ignore leading white space.
1086 p = skipwhite(p + 4);
1087 heredoc_trimmed = vim_strnsave(theline,
1088 skipwhite(theline) - theline);
1089 continue;
1090 }
1091 if (STRNCMP(p, "eval", 4) == 0)
1092 {
1093 // Ignore leading white space.
1094 p = skipwhite(p + 4);
1095 continue;
1096 }
1097 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001098 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001099 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1100 getline_options = GETLINE_NONE;
1101 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001102 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001103 }
1104 }
1105 }
1106
1107 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001108 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001109 goto theend;
1110
Bram Moolenaar20677332021-06-06 17:02:53 +02001111 if (heredoc_concat_len > 0)
1112 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001113 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001114 // to be used for the instruction later.
1115 ga_concat(&heredoc_ga, theline);
1116 ga_concat(&heredoc_ga, (char_u *)"\n");
1117 p = vim_strsave((char_u *)"");
1118 }
1119 else
1120 {
1121 // Copy the line to newly allocated memory. get_one_sourceline()
1122 // allocates 250 bytes per line, this saves 80% on average. The
1123 // cost is an extra alloc/free.
1124 p = vim_strsave(theline);
1125 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001126 if (p == NULL)
1127 goto theend;
1128 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1129
1130 // Add NULL lines for continuation lines, so that the line count is
1131 // equal to the index in the growarray.
1132 while (sourcing_lnum_off-- > 0)
1133 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1134
1135 // Check for end of eap->arg.
1136 if (line_arg != NULL && *line_arg == NUL)
1137 line_arg = NULL;
1138 }
1139
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001140 // Return OK when no error was detected.
1141 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 ret = OK;
1143
1144theend:
1145 vim_free(skip_until);
1146 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001147 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001148 need_wait_return |= saved_wait_return;
1149 return ret;
1150}
1151
1152/*
1153 * Handle the body of a lambda. *arg points to the "{", process statements
1154 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001155 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001156 * When successful "rettv" is set to a funcref.
1157 */
1158 static int
1159lambda_function_body(
1160 char_u **arg,
1161 typval_T *rettv,
1162 evalarg_T *evalarg,
1163 garray_T *newargs,
1164 garray_T *argtypes,
1165 int varargs,
1166 garray_T *default_args,
1167 char_u *ret_type)
1168{
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001169 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001170 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001171 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001172 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001173 exarg_T eap;
1174 garray_T newlines;
1175 char_u *cmdline = NULL;
1176 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001177 partial_T *pt;
1178 char_u *name;
1179 int lnum_save = -1;
1180 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1181
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001182 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1183 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001184 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001185 return FAIL;
1186 }
1187
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001188 CLEAR_FIELD(eap);
1189 eap.cmdidx = CMD_block;
1190 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001191 eap.cmdlinep = &cmdline;
1192 eap.skip = !evaluate;
1193 if (evalarg->eval_cctx != NULL)
1194 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1195 else
1196 {
1197 eap.getline = evalarg->eval_getline;
1198 eap.cookie = evalarg->eval_cookie;
1199 }
1200
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001201 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001202 if (get_function_body(&eap, &newlines, NULL,
1203 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001204 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001205
1206 // When inside a lambda must add the function lines to evalarg.eval_ga.
1207 evalarg->eval_break_count += newlines.ga_len;
1208 if (gap->ga_itemsize > 0)
1209 {
1210 int idx;
1211 char_u *last;
1212 size_t plen;
1213 char_u *pnl;
1214
1215 for (idx = 0; idx < newlines.ga_len; ++idx)
1216 {
1217 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1218
Bram Moolenaarecb66452021-05-18 15:09:18 +02001219 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001220 goto erret;
1221
1222 // Going to concatenate the lines after parsing. For an empty or
1223 // comment line use an empty string.
1224 // Insert NL characters at the start of each line, the string will
1225 // be split again later in .get_lambda_tv().
1226 if (*p == NUL || vim9_comment_start(p))
1227 p = (char_u *)"";
1228 plen = STRLEN(p);
1229 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1230 if (pnl != NULL)
1231 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001232 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1233 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001234 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001235 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001237 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001238 // more is following after the "}", which was skipped
1239 last = cmdline;
1240 else
1241 // nothing is following the "}"
1242 last = (char_u *)"}";
1243 plen = STRLEN(last);
1244 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1245 if (pnl != NULL)
1246 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001247 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1248 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001249 }
1250
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001251 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001252 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001253 garray_T *tfgap = &evalarg->eval_tofree_ga;
1254
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001255 // Something comes after the "}".
1256 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001257
1258 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001259 if (ga_grow(tfgap, 1) == OK)
1260 {
1261 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1262 evalarg->eval_using_cmdline = TRUE;
1263 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001264 }
1265 else
1266 *arg = (char_u *)"";
1267
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001268 if (!evaluate)
1269 {
1270 ret = OK;
1271 goto erret;
1272 }
1273
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001274 name = get_lambda_name();
1275 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1276 if (ufunc == NULL)
1277 goto erret;
1278 set_ufunc_name(ufunc, name);
1279 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001280 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001281 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 ufunc->uf_refcount = 1;
1283 ufunc->uf_args = *newargs;
1284 newargs->ga_data = NULL;
1285 ufunc->uf_def_args = *default_args;
1286 default_args->ga_data = NULL;
1287 ufunc->uf_func_type = &t_func_any;
1288
1289 // error messages are for the first function line
1290 lnum_save = SOURCING_LNUM;
1291 SOURCING_LNUM = sourcing_lnum_top;
1292
1293 // parse argument types
1294 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1295 {
1296 SOURCING_LNUM = lnum_save;
1297 goto erret;
1298 }
1299
1300 // parse the return type, if any
1301 if (parse_return_type(ufunc, ret_type) == FAIL)
1302 goto erret;
1303
1304 pt = ALLOC_CLEAR_ONE(partial_T);
1305 if (pt == NULL)
1306 goto erret;
1307 pt->pt_func = ufunc;
1308 pt->pt_refcount = 1;
1309
1310 ufunc->uf_lines = newlines;
1311 newlines.ga_data = NULL;
1312 if (sandbox)
1313 ufunc->uf_flags |= FC_SANDBOX;
1314 if (!ASCII_ISUPPER(*ufunc->uf_name))
1315 ufunc->uf_flags |= FC_VIM9;
1316 ufunc->uf_script_ctx = current_sctx;
1317 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1318 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1319 set_function_type(ufunc);
1320
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001321 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1322
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001323 rettv->vval.v_partial = pt;
1324 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001325 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001326 ret = OK;
1327
1328erret:
1329 if (lnum_save >= 0)
1330 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001331 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001332 if (newargs != NULL)
1333 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001334 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001335 if (ufunc != NULL)
1336 {
1337 func_clear(ufunc, TRUE);
1338 func_free(ufunc, TRUE);
1339 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001340 return ret;
1341}
1342
1343/*
1344 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001345 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001346 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1348 */
1349 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001350get_lambda_tv(
1351 char_u **arg,
1352 typval_T *rettv,
1353 int types_optional,
1354 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001355{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001356 int evaluate = evalarg != NULL
1357 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001358 garray_T newargs;
1359 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001360 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001361 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001362 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001364 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001366 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001368 char_u *s;
1369 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001370 int *old_eval_lavars = eval_lavars_used;
1371 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001372 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001373 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001374 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001375 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001376 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001377 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001378
Bram Moolenaar4525a572022-02-13 11:57:33 +00001379 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001381
1382 ga_init(&newargs);
1383 ga_init(&newlines);
1384
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001385 // First, check if this is really a lambda expression. "->" or "=>" must
1386 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001387 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001388 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001389 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001390 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001391 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001392 {
1393 if (types_optional)
1394 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001395 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001396 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001397
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001398 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001399 if (evaluate)
1400 pnewargs = &newargs;
1401 else
1402 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001403 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001404 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001405 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001406 &varargs, &default_args,
1407 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001408 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001409 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001410 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001411 {
1412 if (types_optional)
1413 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001414 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001415 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001416 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001417 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001419 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1420 if (ret_type != NULL)
1421 {
1422 ret_type = vim_strsave(ret_type);
1423 tofree2 = ret_type;
1424 }
1425
Bram Moolenaare38eab22019-12-05 21:50:01 +01001426 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001427 if (evaluate)
1428 eval_lavars_used = &eval_lavars;
1429
Bram Moolenaar65c44152020-12-24 15:14:01 +01001430 *arg = skipwhite_and_linebreak(*arg, evalarg);
1431
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001432 // Recognize "{" as the start of a function body.
1433 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001434 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001435 if (evalarg == NULL)
1436 // cannot happen?
1437 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001438 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001439 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1440 types_optional ? &argtypes : NULL, varargs,
1441 &default_args, ret_type) == FAIL)
1442 goto errret;
1443 goto theend;
1444 }
1445 if (default_args.ga_len > 0)
1446 {
1447 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001448 goto errret;
1449 }
1450
Bram Moolenaare38eab22019-12-05 21:50:01 +01001451 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001452 start = *arg;
1453 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454 if (ret == FAIL)
1455 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001456
Bram Moolenaar65c44152020-12-24 15:14:01 +01001457 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001458 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001459 *arg = skipwhite_and_linebreak(*arg, evalarg);
1460 if (**arg != '}')
1461 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001462 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001463 goto errret;
1464 }
1465 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001467
1468 if (evaluate)
1469 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001470 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001471 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001472 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001473 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001474 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001475
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001476 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477 if (fp == NULL)
1478 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001479 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001480 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001481 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001482 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001484 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485 if (ga_grow(&newlines, 1) == FAIL)
1486 goto errret;
1487
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001488 // If there are line breaks, we need to split up the string.
1489 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001490 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001491 line_end = end;
1492
1493 // Add "return " before the expression (or the first line).
1494 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001495 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496 if (p == NULL)
1497 goto errret;
1498 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1499 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001500 vim_strncpy(p + 7, start, line_end - start);
1501
1502 if (line_end != end)
1503 {
1504 // Add more lines, split by line breaks. Thus is used when a
1505 // lambda with { cmds } is encountered.
1506 while (*line_end == '\n')
1507 {
1508 if (ga_grow(&newlines, 1) == FAIL)
1509 goto errret;
1510 start = line_end + 1;
1511 line_end = vim_strchr(start, '\n');
1512 if (line_end == NULL)
1513 line_end = end;
1514 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1515 vim_strnsave(start, line_end - start);
1516 }
1517 }
1518
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001519 if (strstr((char *)p + 7, "a:") == NULL)
1520 // No a: variables are used for sure.
1521 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522
1523 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001524 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001526 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001527 if (types_optional)
1528 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001529 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001530 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001531 goto errret;
1532 if (ret_type != NULL)
1533 {
1534 fp->uf_ret_type = parse_type(&ret_type,
1535 &fp->uf_type_list, TRUE);
1536 if (fp->uf_ret_type == NULL)
1537 goto errret;
1538 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001539 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001540 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001541 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001542
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001544 if (current_funccal != NULL && eval_lavars)
1545 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001546 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001547 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001548 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001549 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001550
1551#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 if (prof_def_func())
1553 func_do_profile(fp);
1554#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001555 if (sandbox)
1556 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001557 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001558 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001559 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001560 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001562 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001563 // Use the line number of the arguments.
1564 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001566 function_using_block_scopes(fp, evalarg->eval_cstack);
1567
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001568 pt->pt_func = fp;
1569 pt->pt_refcount = 1;
1570 rettv->vval.v_partial = pt;
1571 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001572
1573 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001576theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001577 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001578 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001579 if (types_optional)
1580 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 return OK;
1583
1584errret:
1585 ga_clear_strings(&newargs);
1586 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001587 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001588 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001589 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001590 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001591 if (fp != NULL)
1592 vim_free(fp->uf_arg_types);
1593 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001595 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001596 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001597 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 return FAIL;
1599}
1600
1601/*
1602 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1603 * name it contains, otherwise return "name".
1604 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1605 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001606 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1607 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001608 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001609 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610 */
1611 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001612deref_func_name(
1613 char_u *name,
1614 int *lenp,
1615 partial_T **partialp,
1616 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001617 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001618 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001619 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620{
1621 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001622 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001624 char_u *s = NULL;
1625 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001626 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627
1628 if (partialp != NULL)
1629 *partialp = NULL;
1630
1631 cc = name[*lenp];
1632 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001633
Bram Moolenaar71f21932022-01-07 18:20:55 +00001634 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001638 tv = &v->di_tv;
1639 }
1640 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1641 {
1642 imported_T *import;
1643 char_u *p = name;
1644 int len = *lenp;
1645
1646 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001648 p = name + 2;
1649 len -= 2;
1650 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001651 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001652
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001653 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001654 if (import != NULL)
1655 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001656 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001657 if (new_function)
1658 semsg(_(e_redefining_imported_item_str), name);
1659 else
1660 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001661 name[len] = cc;
1662 *lenp = 0;
1663 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001664 }
1665 }
1666
1667 if (tv != NULL)
1668 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001669 if (found_var != NULL)
1670 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001671 if (tv->v_type == VAR_FUNC)
1672 {
1673 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001674 {
1675 *lenp = 0;
1676 return (char_u *)""; // just in case
1677 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001678 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001679 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001682 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001684 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001685
1686 if (pt == NULL)
1687 {
1688 *lenp = 0;
1689 return (char_u *)""; // just in case
1690 }
1691 if (partialp != NULL)
1692 *partialp = pt;
1693 s = partial_name(pt);
1694 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001695 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001696
1697 if (s != NULL)
1698 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001699 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001700 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001701 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001702
1703 if (sv != NULL)
1704 *type = sv->sv_type;
1705 }
1706 return s;
1707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 }
1709
1710 return name;
1711}
1712
1713/*
1714 * Give an error message with a function name. Handle <SNR> things.
1715 * "ermsg" is to be passed without translation, use N_() instead of _().
1716 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001717 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718emsg_funcname(char *ermsg, char_u *name)
1719{
Bram Moolenaar54598062022-01-13 12:05:09 +00001720 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721
Bram Moolenaar54598062022-01-13 12:05:09 +00001722 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001724 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 if (p != name)
1726 vim_free(p);
1727}
1728
1729/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001730 * Get function arguments at "*arg" and advance it.
1731 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001732 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 */
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001734 static int
1735get_func_arguments(
1736 char_u **arg,
1737 evalarg_T *evalarg,
1738 int partial_argc,
1739 typval_T *argvars,
1740 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001742 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001744 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001745 int evaluate = evalarg == NULL
1746 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001747
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001748 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001750 // skip the '(' or ',' and possibly line breaks
1751 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1752
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753 if (*argp == ')' || *argp == ',' || *argp == NUL)
1754 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001755 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001756 {
1757 ret = FAIL;
1758 break;
1759 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001760 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001761 // The comma should come right after the argument, but this wasn't
1762 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001763 if (vim9script)
1764 {
1765 if (*argp != ',' && *skipwhite(argp) == ',')
1766 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001767 if (evaluate)
1768 semsg(_(e_no_white_space_allowed_before_str_str),
1769 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001770 ret = FAIL;
1771 break;
1772 }
1773 }
1774 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001775 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 if (*argp != ',')
1777 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001778 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1779 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001780 if (evaluate)
1781 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001782 ret = FAIL;
1783 break;
1784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001786
Bram Moolenaare6b53242020-07-01 17:28:33 +02001787 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 if (*argp == ')')
1789 ++argp;
1790 else
1791 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001792 *arg = argp;
1793 return ret;
1794}
1795
1796/*
1797 * Call a function and put the result in "rettv".
1798 * Return OK or FAIL.
1799 */
1800 int
1801get_func_tv(
1802 char_u *name, // name of the function
1803 int len, // length of "name" or -1 to use strlen()
1804 typval_T *rettv,
1805 char_u **arg, // argument, pointing to the '('
1806 evalarg_T *evalarg, // for line continuation
1807 funcexe_T *funcexe) // various values
1808{
1809 char_u *argp;
1810 int ret = OK;
1811 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1812 int argcount = 0; // number of arguments found
1813 int vim9script = in_vim9script();
1814 int evaluate = evalarg == NULL
1815 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1816
1817 argp = *arg;
1818 ret = get_func_arguments(&argp, evalarg,
1819 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1820 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821
1822 if (ret == OK)
1823 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001824 int i = 0;
1825 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826
1827 if (get_vim_var_nr(VV_TESTING))
1828 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001829 // Prepare for calling test_garbagecollect_now(), need to know
1830 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001832 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 for (i = 0; i < argcount; ++i)
1834 if (ga_grow(&funcargs, 1) == OK)
1835 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1836 &argvars[i];
1837 }
1838
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001839 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001840 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001841 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001842 // An error in a builtin function does not return FAIL, but we do
1843 // want to abort further processing if an error was given.
1844 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001845 clear_tv(rettv);
1846 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001847
1848 funcargs.ga_len -= i;
1849 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001850 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 {
1852 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001853 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001855 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 }
1857
1858 while (--argcount >= 0)
1859 clear_tv(&argvars[argcount]);
1860
Bram Moolenaar4525a572022-02-13 11:57:33 +00001861 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001862 *arg = argp;
1863 else
1864 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001865 return ret;
1866}
1867
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868/*
1869 * Return TRUE if "p" starts with "<SID>" or "s:".
1870 * Only works if eval_fname_script() returned non-zero for "p"!
1871 */
1872 static int
1873eval_fname_sid(char_u *p)
1874{
1875 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1876}
1877
1878/*
1879 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1880 * Change <SNR>123_name() to K_SNR 123_name().
1881 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1882 * (slow).
1883 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001884 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1886{
1887 int llen;
1888 char_u *fname;
1889 int i;
1890
1891 llen = eval_fname_script(name);
1892 if (llen > 0)
1893 {
1894 fname_buf[0] = K_SPECIAL;
1895 fname_buf[1] = KS_EXTRA;
1896 fname_buf[2] = (int)KE_SNR;
1897 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001898 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001899 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001900 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001901 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902 else
1903 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001904 sprintf((char *)fname_buf + 3, "%ld_",
1905 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906 i = (int)STRLEN(fname_buf);
1907 }
1908 }
1909 if (i + STRLEN(name + llen) < FLEN_FIXED)
1910 {
1911 STRCPY(fname_buf + i, name + llen);
1912 fname = fname_buf;
1913 }
1914 else
1915 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001916 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001918 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 else
1920 {
1921 *tofree = fname;
1922 mch_memmove(fname, fname_buf, (size_t)i);
1923 STRCPY(fname + i, name + llen);
1924 }
1925 }
1926 }
1927 else
1928 fname = name;
1929 return fname;
1930}
1931
1932/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001933 * Concatenate the script ID and function name into "<SNR>99_name".
1934 * "buffer" must have size MAX_FUNC_NAME_LEN.
1935 */
1936 void
1937func_name_with_sid(char_u *name, int sid, char_u *buffer)
1938{
1939 // A script-local function is stored as "<SNR>99_name".
1940 buffer[0] = K_SPECIAL;
1941 buffer[1] = KS_EXTRA;
1942 buffer[2] = (int)KE_SNR;
1943 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1944 (long)sid, name);
1945}
1946
1947/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948 * Find a function "name" in script "sid".
1949 */
1950 static ufunc_T *
1951find_func_with_sid(char_u *name, int sid)
1952{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001953 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001954 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955
Bram Moolenaarb8822442022-01-11 15:24:05 +00001956 if (!SCRIPT_ID_VALID(sid))
1957 return NULL; // not in a script
1958
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001959 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 hi = hash_find(&func_hashtab, buffer);
1961 if (!HASHITEM_EMPTY(hi))
1962 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001963 return NULL;
1964}
1965
1966/*
1967 * Find a function "name" in script "sid" prefixing the autoload prefix.
1968 */
1969 static ufunc_T *
1970find_func_with_prefix(char_u *name, int sid)
1971{
1972 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001973 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001974 scriptitem_T *si;
1975
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001976 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001977 return NULL; // already has the prefix
1978 if (!SCRIPT_ID_VALID(sid))
1979 return NULL; // not in a script
1980 si = SCRIPT_ITEM(sid);
1981 if (si->sn_autoload_prefix != NULL)
1982 {
1983 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1984 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001985 char_u *namep;
1986
1987 // skip a "<SNR>99_" prefix
1988 namep = untrans_function_name(name);
1989 if (namep == NULL)
1990 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001991
1992 // An exported function in an autoload script is stored as
1993 // "dir#path#name".
1994 if (len < sizeof(buffer))
1995 auto_name = buffer;
1996 else
1997 auto_name = alloc(len);
1998 if (auto_name != NULL)
1999 {
2000 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002001 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002002 hi = hash_find(&func_hashtab, auto_name);
2003 if (auto_name != buffer)
2004 vim_free(auto_name);
2005 if (!HASHITEM_EMPTY(hi))
2006 return HI2UF(hi);
2007 }
2008 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009
2010 return NULL;
2011}
2012
2013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002015 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2016 * functions.
2017 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002018 * Return NULL for unknown function.
2019 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002020 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002021find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002022{
2023 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002025
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002026 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002028 // Find script-local function before global one.
2029 if (in_vim9script() && eval_isnamec1(*name)
2030 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002032 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2033 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002034 if (func != NULL)
2035 return func;
2036 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002037 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2038 {
2039 char_u *p = name + 5;
2040 long sid;
2041
2042 // printable "<SNR>123_Name" form
2043 sid = getdigits(&p);
2044 if (*p == '_')
2045 {
2046 func = find_func_with_sid(p + 1, (int)sid);
2047 if (func != NULL)
2048 return func;
2049 }
2050 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002052
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002053 if ((flags & FFED_NO_GLOBAL) == 0)
2054 {
2055 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002056 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002057 if (!HASHITEM_EMPTY(hi))
2058 return HI2UF(hi);
2059 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002060
Bram Moolenaarb8822442022-01-11 15:24:05 +00002061 // Find autoload function if this is an autoload script.
2062 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2063 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002064}
2065
2066/*
2067 * Find a function by name, return pointer to it in ufuncs.
2068 * "cctx" is passed in a :def function to find imported functions.
2069 * Return NULL for unknown or dead function.
2070 */
2071 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002072find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002073{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002074 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002075
2076 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2077 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 return NULL;
2079}
2080
2081/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002082 * Return TRUE if "ufunc" is a global function.
2083 */
2084 int
2085func_is_global(ufunc_T *ufunc)
2086{
2087 return ufunc->uf_name[0] != K_SPECIAL;
2088}
2089
2090/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002091 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2092 */
2093 int
2094func_requires_g_prefix(ufunc_T *ufunc)
2095{
2096 return ufunc->uf_name[0] != K_SPECIAL
2097 && (ufunc->uf_flags & FC_LAMBDA) == 0
2098 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2099}
2100
2101/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102 * Copy the function name of "fp" to buffer "buf".
2103 * "buf" must be able to hold the function name plus three bytes.
2104 * Takes care of script-local function names.
2105 */
2106 static void
2107cat_func_name(char_u *buf, ufunc_T *fp)
2108{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002109 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 {
2111 STRCPY(buf, "<SNR>");
2112 STRCAT(buf, fp->uf_name + 3);
2113 }
2114 else
2115 STRCPY(buf, fp->uf_name);
2116}
2117
2118/*
2119 * Add a number variable "name" to dict "dp" with value "nr".
2120 */
2121 static void
2122add_nr_var(
2123 dict_T *dp,
2124 dictitem_T *v,
2125 char *name,
2126 varnumber_T nr)
2127{
2128 STRCPY(v->di_key, name);
2129 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2130 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2131 v->di_tv.v_type = VAR_NUMBER;
2132 v->di_tv.v_lock = VAR_FIXED;
2133 v->di_tv.vval.v_number = nr;
2134}
2135
2136/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002137 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002138 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002139 static void
2140free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002143
2144 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2145 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002146 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002147
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002148 // When garbage collecting a funccall_T may be freed before the
2149 // function that references it, clear its uf_scoped field.
2150 // The function may have been redefined and point to another
2151 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002152 if (fp != NULL && fp->uf_scoped == fc)
2153 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002154 }
Bram Moolenaar58016442016-07-31 18:30:22 +02002155 ga_clear(&fc->fc_funcs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002157 func_ptr_unref(fc->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002158 vim_free(fc);
2159}
2160
2161/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002162 * Free "fc" and what it contains.
2163 * Can be called only when "fc" is kept beyond the period of it called,
2164 * i.e. after cleanup_function_call(fc).
2165 */
2166 static void
2167free_funccal_contents(funccall_T *fc)
2168{
2169 listitem_T *li;
2170
2171 // Free all l: variables.
2172 vars_clear(&fc->l_vars.dv_hashtab);
2173
2174 // Free all a: variables.
2175 vars_clear(&fc->l_avars.dv_hashtab);
2176
2177 // Free the a:000 variables.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002178 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002179 clear_tv(&li->li_tv);
2180
2181 free_funccal(fc);
2182}
2183
2184/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002185 * Handle the last part of returning from a function: free the local hashtable.
2186 * Unless it is still in use by a closure.
2187 */
2188 static void
2189cleanup_function_call(funccall_T *fc)
2190{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002191 int may_free_fc = fc->fc_refcount <= 0;
2192 int free_fc = TRUE;
2193
Bram Moolenaar6914c642017-04-01 21:21:30 +02002194 current_funccal = fc->caller;
2195
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002196 // Free all l: variables if not referred.
2197 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT)
2198 vars_clear(&fc->l_vars.dv_hashtab);
2199 else
2200 free_fc = FALSE;
2201
2202 // If the a:000 list and the l: and a: dicts are not referenced and
2203 // there is no closure using it, we can free the funccall_T and what's
2204 // in it.
2205 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)
2206 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002207 else
2208 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002209 int todo;
2210 hashitem_T *hi;
2211 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002212
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002213 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002214
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002215 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaar6914c642017-04-01 21:21:30 +02002216 todo = (int)fc->l_avars.dv_hashtab.ht_used;
2217 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
2218 {
2219 if (!HASHITEM_EMPTY(hi))
2220 {
2221 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002222 di = HI2DI(hi);
2223 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002224 }
2225 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002226 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002227
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002228 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2229 fc->l_varlist.lv_first = NULL;
2230 else
2231 {
2232 listitem_T *li;
2233
2234 free_fc = FALSE;
2235
2236 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002237 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002238 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002239 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002240
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002241 if (free_fc)
2242 free_funccal(fc);
2243 else
2244 {
2245 static int made_copy = 0;
2246
2247 // "fc" is still in use. This can happen when returning "a:000",
2248 // assigning "l:" to a global variable or defining a closure.
2249 // Link "fc" in the list for garbage collection later.
2250 fc->caller = previous_funccal;
2251 previous_funccal = fc;
2252
2253 if (want_garbage_collect)
2254 // If garbage collector is ready, clear count.
2255 made_copy = 0;
2256 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002257 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002258 // We have made a lot of copies, worth 4 Mbyte. This can happen
2259 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002260 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002261 // too much memory.
2262 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002263 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002264 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002265 }
2266}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002267
2268/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002269 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2270 */
2271 static int
2272numbered_function(char_u *name)
2273{
2274 return isdigit(*name)
2275 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2276}
2277
2278/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002279 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002280 * 1. ordinary names, function defined with :function or :def;
2281 * can start with "<SNR>123_" literally or with K_SPECIAL.
2282 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002283 * For the first we only count the name stored in func_hashtab as a reference,
2284 * using function() does not count as a reference, because the function is
2285 * looked up by name.
2286 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002287 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002288func_name_refcount(char_u *name)
2289{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002290 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002291}
2292
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293/*
2294 * Unreference "fc": decrement the reference count and free it when it
2295 * becomes zero. "fp" is detached from "fc".
2296 * When "force" is TRUE we are exiting.
2297 */
2298 static void
2299funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2300{
2301 funccall_T **pfc;
2302 int i;
2303
2304 if (fc == NULL)
2305 return;
2306
2307 if (--fc->fc_refcount <= 0 && (force || (
2308 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT
2309 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT
2310 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2311 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller)
2312 {
2313 if (fc == *pfc)
2314 {
2315 *pfc = fc->caller;
2316 free_funccal_contents(fc);
2317 return;
2318 }
2319 }
2320 for (i = 0; i < fc->fc_funcs.ga_len; ++i)
2321 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp)
2322 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL;
2323}
2324
2325/*
2326 * Remove the function from the function hashtable. If the function was
2327 * deleted while it still has references this was already done.
2328 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2329 */
2330 static int
2331func_remove(ufunc_T *fp)
2332{
2333 hashitem_T *hi;
2334
2335 // Return if it was already virtually deleted.
2336 if (fp->uf_flags & FC_DEAD)
2337 return FALSE;
2338
2339 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2340 if (!HASHITEM_EMPTY(hi))
2341 {
2342 // When there is a def-function index do not actually remove the
2343 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002344 // Do remove it when it's a copy.
2345 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002346 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002347 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002348 return FALSE;
2349 }
2350 hash_remove(&func_hashtab, hi);
2351 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002352 return TRUE;
2353 }
2354 return FALSE;
2355}
2356
2357 static void
2358func_clear_items(ufunc_T *fp)
2359{
2360 ga_clear_strings(&(fp->uf_args));
2361 ga_clear_strings(&(fp->uf_def_args));
2362 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002363 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002364 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002365 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002366 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002367
2368 // Increment the refcount of this function to avoid it being freed
2369 // recursively when the partial is freed.
2370 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002371 partial_unref(fp->uf_partial);
2372 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002373 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002374
2375#ifdef FEAT_LUA
2376 if (fp->uf_cb_free != NULL)
2377 {
2378 fp->uf_cb_free(fp->uf_cb_state);
2379 fp->uf_cb_free = NULL;
2380 }
2381
2382 fp->uf_cb_state = NULL;
2383 fp->uf_cb = NULL;
2384#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002385#ifdef FEAT_PROFILE
2386 VIM_CLEAR(fp->uf_tml_count);
2387 VIM_CLEAR(fp->uf_tml_total);
2388 VIM_CLEAR(fp->uf_tml_self);
2389#endif
2390}
2391
2392/*
2393 * Free all things that a function contains. Does not free the function
2394 * itself, use func_free() for that.
2395 * When "force" is TRUE we are exiting.
2396 */
2397 static void
2398func_clear(ufunc_T *fp, int force)
2399{
2400 if (fp->uf_cleared)
2401 return;
2402 fp->uf_cleared = TRUE;
2403
2404 // clear this function
2405 func_clear_items(fp);
2406 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002407 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002408}
2409
2410/*
2411 * Free a function and remove it from the list of functions. Does not free
2412 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002413 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002414 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002415 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002416 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002417func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002418{
2419 // Only remove it when not done already, otherwise we would remove a newer
2420 // version of the function with the same name.
2421 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2422 func_remove(fp);
2423
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002424 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002425 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002426 if (fp->uf_dfunc_idx > 0)
2427 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002428 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002429 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002430 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002431 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002432 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002433}
2434
2435/*
2436 * Free all things that a function contains and free the function itself.
2437 * When "force" is TRUE we are exiting.
2438 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002439 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002440func_clear_free(ufunc_T *fp, int force)
2441{
2442 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002443 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2444 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002445 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002446 else
2447 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002448}
2449
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002450/*
2451 * Copy already defined function "lambda" to a new function with name "global".
2452 * This is for when a compiled function defines a global function.
2453 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002454 int
2455copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002456{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002457 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002458 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002459
2460 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002461 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002462 semsg(_(e_lambda_function_not_found_str), lambda);
2463 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002464 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002465
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002466 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002467 if (fp != NULL)
2468 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002469 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002470 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002471 return FAIL;
2472 }
2473
2474 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2475 if (fp == NULL)
2476 return FAIL;
2477
2478 fp->uf_varargs = ufunc->uf_varargs;
2479 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2480 fp->uf_def_status = ufunc->uf_def_status;
2481 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2482 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2483 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2484 == FAIL
2485 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2486 goto failed;
2487
2488 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2489 : vim_strsave(ufunc->uf_name_exp);
2490 if (ufunc->uf_arg_types != NULL)
2491 {
2492 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2493 if (fp->uf_arg_types == NULL)
2494 goto failed;
2495 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2496 sizeof(type_T *) * fp->uf_args.ga_len);
2497 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002498 if (ufunc->uf_va_name != NULL)
2499 {
2500 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2501 if (fp->uf_va_name == NULL)
2502 goto failed;
2503 }
2504 fp->uf_ret_type = ufunc->uf_ret_type;
2505
2506 fp->uf_refcount = 1;
2507 STRCPY(fp->uf_name, global);
2508 hash_add(&func_hashtab, UF2HIKEY(fp));
2509
2510 // the referenced dfunc_T is now used one more time
2511 link_def_function(fp);
2512
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002513 // Create a partial to store the context of the function where it was
2514 // instantiated. Only needs to be done once. Do this on the original
2515 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002516 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2517 {
2518 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2519
2520 if (pt == NULL)
2521 goto failed;
2522 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002523 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002524 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002525 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002526 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002527 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002528 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002529 }
2530
2531 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002532
2533failed:
2534 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002535 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002536}
2537
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002538static int funcdepth = 0;
2539
2540/*
2541 * Increment the function call depth count.
2542 * Return FAIL when going over 'maxfuncdepth'.
2543 * Otherwise return OK, must call funcdepth_decrement() later!
2544 */
2545 int
2546funcdepth_increment(void)
2547{
2548 if (funcdepth >= p_mfd)
2549 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002550 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002551 return FAIL;
2552 }
2553 ++funcdepth;
2554 return OK;
2555}
2556
2557 void
2558funcdepth_decrement(void)
2559{
2560 --funcdepth;
2561}
2562
2563/*
2564 * Get the current function call depth.
2565 */
2566 int
2567funcdepth_get(void)
2568{
2569 return funcdepth;
2570}
2571
2572/*
2573 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002574 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002575 * times as funcdepth_increment().
2576 */
2577 void
2578funcdepth_restore(int depth)
2579{
2580 funcdepth = depth;
2581}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002582
2583/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002584 * Call a user function.
2585 */
2586 static void
2587call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002588 ufunc_T *fp, // pointer to function
2589 int argcount, // nr of args
2590 typval_T *argvars, // arguments
2591 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002592 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002593 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002594{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002595 sctx_T save_current_sctx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002596 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002597 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002598 funccall_T *fc;
2599 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002600 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002601 dictitem_T *v;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002602 int fixvar_idx = 0; // index in fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002603 int i;
2604 int ai;
2605 int islambda = FALSE;
2606 char_u numbuf[NUMBUFLEN];
2607 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002608 typval_T *tv_to_free[MAX_FUNC_ARGS];
2609 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002610#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002611 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002612#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002613 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002614
Bram Moolenaarb2049902021-01-24 12:53:53 +01002615#ifdef FEAT_PROFILE
2616 CLEAR_FIELD(profile_info);
2617#endif
2618
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002619 // If depth of calling is getting too high, don't execute the function.
2620 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 rettv->v_type = VAR_NUMBER;
2623 rettv->vval.v_number = -1;
2624 return;
2625 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002626
Bram Moolenaare38eab22019-12-05 21:50:01 +01002627 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002629 fc = ALLOC_CLEAR_ONE(funccall_T);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002630 if (fc == NULL)
2631 return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632 fc->caller = current_funccal;
2633 current_funccal = fc;
2634 fc->func = fp;
2635 fc->rettv = rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 fc->level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002637 // Check if this function has a breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2639 fc->dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002640 // Set up fields for closure.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002641 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02002642 func_ptr_ref(fp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002644 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002645 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002646#ifdef FEAT_PROFILE
2647 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2648#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002649 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002650#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002651 if (do_profiling == PROF_YES)
2652 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002653#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002654 sticky_cmdmod_flags = 0;
Bram Moolenaar58779852022-09-06 18:31:14 +01002655 call_def_function(fp, argcount, argvars, funcexe->fe_partial,
2656 fc, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002657 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002658#ifdef FEAT_PROFILE
2659 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002660 || (caller != NULL && caller->uf_profiling)))
2661 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002662#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002663 current_funccal = fc->caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002664 free_funccal(fc);
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002665 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002666 return;
2667 }
2668
Bram Moolenaar38453522021-11-28 22:00:12 +00002669 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002670
2671 /*
2672 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables
2673 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free
2674 * each argument variable and saves a lot of time.
2675 */
2676 /*
2677 * Init l: variables.
2678 */
2679 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE);
2680 if (selfdict != NULL)
2681 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002682 // Set l:self to "selfdict". Use "name" to avoid a warning from
2683 // some compiler that checks the destination size.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002684 v = &fc->fixvar[fixvar_idx++].var;
2685 name = v->di_key;
2686 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002687 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002688 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
2689 v->di_tv.v_type = VAR_DICT;
2690 v->di_tv.v_lock = 0;
2691 v->di_tv.vval.v_dict = selfdict;
2692 ++selfdict->dv_refcount;
2693 }
2694
2695 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002696 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002697 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002698 * Set a:000 to a list with room for the "..." arguments.
2699 */
2700 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002701 if ((fp->uf_flags & FC_NOARGS) == 0)
2702 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002703 (varnumber_T)(argcount >= fp->uf_args.ga_len
2704 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaar31b81602019-02-10 22:14:27 +01002705 fc->l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002706 if ((fp->uf_flags & FC_NOARGS) == 0)
2707 {
2708 // Use "name" to avoid a warning from some compiler that checks the
2709 // destination size.
2710 v = &fc->fixvar[fixvar_idx++].var;
2711 name = v->di_key;
2712 STRCPY(name, "000");
2713 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2714 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
2715 v->di_tv.v_type = VAR_LIST;
2716 v->di_tv.v_lock = VAR_FIXED;
2717 v->di_tv.vval.v_list = &fc->l_varlist;
2718 }
Bram Moolenaara80faa82020-04-12 19:37:17 +02002719 CLEAR_FIELD(fc->l_varlist);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002720 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2721 fc->l_varlist.lv_lock = VAR_FIXED;
2722
2723 /*
2724 * Set a:firstline to "firstline" and a:lastline to "lastline".
2725 * Set a:name to named arguments.
2726 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002727 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002728 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002729 if ((fp->uf_flags & FC_NOARGS) == 0)
2730 {
2731 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002732 (varnumber_T)funcexe->fe_firstline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002733 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline",
Bram Moolenaar851f86b2021-12-13 14:26:44 +00002734 (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002735 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002736 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002737 {
2738 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002739 typval_T def_rettv;
2740 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002741
2742 ai = i - fp->uf_args.ga_len;
2743 if (ai < 0)
2744 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002745 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002746 name = FUNCARG(fp, i);
2747 if (islambda)
2748 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002749
2750 // evaluate named argument default expression
2751 isdefault = ai + fp->uf_def_args.ga_len >= 0
2752 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2753 && argvars[i].vval.v_number == VVAL_NONE));
2754 if (isdefault)
2755 {
2756 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002757
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002758 def_rettv.v_type = VAR_NUMBER;
2759 def_rettv.vval.v_number = -1;
2760
2761 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2762 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002763 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002764 {
2765 default_arg_err = 1;
2766 break;
2767 }
2768 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 }
2770 else
2771 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002772 if ((fp->uf_flags & FC_NOARGS) != 0)
2773 // Bail out if no a: arguments used (in lambda).
2774 break;
2775
Bram Moolenaare38eab22019-12-05 21:50:01 +01002776 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002777 sprintf((char *)numbuf, "%d", ai + 1);
2778 name = numbuf;
2779 }
2780 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2781 {
2782 v = &fc->fixvar[fixvar_idx++].var;
2783 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002784 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002785 }
2786 else
2787 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002788 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002789 if (v == NULL)
2790 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002791 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002792 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002793
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002794 // Note: the values are copied directly to avoid alloc/free.
2795 // "argvars" must have VAR_FIXED for v_lock.
2796 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002797 v->di_tv.v_lock = VAR_FIXED;
2798
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002799 if (isdefault)
2800 // Need to free this later, no matter where it's stored.
2801 tv_to_free[tv_to_free_len++] = &v->di_tv;
2802
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002803 if (addlocal)
2804 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002805 // Named arguments should be accessed without the "a:" prefix in
2806 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002807 copy_tv(&v->di_tv, &v->di_tv);
2808 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002810 else
2811 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812
2813 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2814 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002815 listitem_T *li = &fc->l_listitems[ai];
2816
2817 li->li_tv = argvars[i];
2818 li->li_tv.v_lock = VAR_FIXED;
2819 list_append(&fc->l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002820 }
2821 }
2822
Bram Moolenaare38eab22019-12-05 21:50:01 +01002823 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002825
2826 if (fp->uf_flags & FC_SANDBOX)
2827 {
2828 using_sandbox = TRUE;
2829 ++sandbox;
2830 }
2831
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002832 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002833 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002834 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002836 ++no_wait_return;
2837 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002839 smsg(_("calling %s"), SOURCING_NAME);
2840 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002842 char_u buf[MSG_BUF_LEN];
2843 char_u numbuf2[NUMBUFLEN];
2844 char_u *tofree;
2845 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002846
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002847 msg_puts("(");
2848 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002850 if (i > 0)
2851 msg_puts(", ");
2852 if (argvars[i].v_type == VAR_NUMBER)
2853 msg_outnum((long)argvars[i].vval.v_number);
2854 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002855 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002856 // Do not want errors such as E724 here.
2857 ++emsg_off;
2858 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2859 --emsg_off;
2860 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002861 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002862 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002863 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002864 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2865 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002866 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002867 msg_puts((char *)s);
2868 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 }
2870 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002872 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002874 msg_puts("\n"); // don't overwrite this either
2875
2876 verbose_leave_scroll();
2877 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878 }
2879#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002880 if (do_profiling == PROF_YES)
2881 profile_may_start_func(&profile_info, fp,
2882 fc->caller == NULL ? NULL : fc->caller->func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883#endif
2884
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002885 // "legacy" does not apply to commands in the function
2886 sticky_cmdmod_flags = 0;
2887
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002888 save_current_sctx = current_sctx;
2889 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 save_did_emsg = did_emsg;
2891 did_emsg = FALSE;
2892
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002893 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2894 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002895 else if (islambda)
2896 {
2897 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2898
2899 // A Lambda always has the command "return {expr}". It is much faster
2900 // to evaluate {expr} directly.
2901 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002902 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002903 --ex_nesting_level;
2904 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002905 else
2906 // call do_cmdline() to execute the lines
2907 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002908 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2909
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002910 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01002911 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002912
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002913 --RedrawingDisabled;
2914
Bram Moolenaare38eab22019-12-05 21:50:01 +01002915 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002916 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2917 {
2918 clear_tv(rettv);
2919 rettv->v_type = VAR_NUMBER;
2920 rettv->vval.v_number = -1;
2921 }
2922
2923#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002924 if (do_profiling == PROF_YES)
2925 {
2926 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func;
2927
2928 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2929 profile_may_end_func(&profile_info, fp, caller);
2930 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002931#endif
2932
Bram Moolenaare38eab22019-12-05 21:50:01 +01002933 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002934 if (p_verbose >= 12)
2935 {
2936 ++no_wait_return;
2937 verbose_enter_scroll();
2938
2939 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002940 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002941 else if (fc->rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002942 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002943 (long)fc->rettv->vval.v_number);
2944 else
2945 {
2946 char_u buf[MSG_BUF_LEN];
2947 char_u numbuf2[NUMBUFLEN];
2948 char_u *tofree;
2949 char_u *s;
2950
Bram Moolenaare38eab22019-12-05 21:50:01 +01002951 // The value may be very long. Skip the middle part, so that we
2952 // have some idea how it starts and ends. smsg() would always
2953 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954 ++emsg_off;
2955 s = tv2string(fc->rettv, &tofree, numbuf2, 0);
2956 --emsg_off;
2957 if (s != NULL)
2958 {
2959 if (vim_strsize(s) > MSG_BUF_CLEN)
2960 {
2961 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2962 s = buf;
2963 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002964 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965 vim_free(tofree);
2966 }
2967 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01002968 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969
2970 verbose_leave_scroll();
2971 --no_wait_return;
2972 }
2973
Bram Moolenaare31ee862020-01-07 20:59:34 +01002974 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002975 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002976 current_sctx = save_current_sctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002977#ifdef FEAT_PROFILE
2978 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01002979 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002980#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02002981 if (using_sandbox)
2982 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002983 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002984
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002985 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002986 {
2987 ++no_wait_return;
2988 verbose_enter_scroll();
2989
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002990 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01002991 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992
2993 verbose_leave_scroll();
2994 --no_wait_return;
2995 }
2996
2997 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002998 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002999 for (i = 0; i < tv_to_free_len; ++i)
3000 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003001 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002}
3003
3004/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003005 * Check the argument count for user function "fp".
3006 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3007 */
3008 int
3009check_user_func_argcount(ufunc_T *fp, int argcount)
3010{
3011 int regular_args = fp->uf_args.ga_len;
3012
3013 if (argcount < regular_args - fp->uf_def_args.ga_len)
3014 return FCERR_TOOFEW;
3015 else if (!has_varargs(fp) && argcount > regular_args)
3016 return FCERR_TOOMANY;
3017 return FCERR_UNKNOWN;
3018}
3019
3020/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003021 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003022 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003023 int
3024call_user_func_check(
3025 ufunc_T *fp,
3026 int argcount,
3027 typval_T *argvars,
3028 typval_T *rettv,
3029 funcexe_T *funcexe,
3030 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003031{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003032 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003033
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003034#ifdef FEAT_LUA
3035 if (fp->uf_flags & FC_CFUNC)
3036 {
3037 cfunc_T cb = fp->uf_cb;
3038
3039 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3040 }
3041#endif
3042
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003043 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3044 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003045 error = check_user_func_argcount(fp, argcount);
3046 if (error != FCERR_UNKNOWN)
3047 return error;
3048 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003049 error = FCERR_DICT;
3050 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003051 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003052 int did_save_redo = FALSE;
3053 save_redo_T save_redo;
3054
3055 /*
3056 * Call the user function.
3057 * Save and restore search patterns, script variables and
3058 * redo buffer.
3059 */
3060 save_search_patterns();
3061 if (!ins_compl_active())
3062 {
3063 saveRedobuff(&save_redo);
3064 did_save_redo = TRUE;
3065 }
3066 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003067 call_user_func(fp, argcount, argvars, rettv, funcexe,
3068 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003069 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3070 // Function was unreferenced while being used, free it now.
3071 func_clear_free(fp, FALSE);
3072 if (did_save_redo)
3073 restoreRedobuff(&save_redo);
3074 restore_search_patterns();
3075 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003076 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003077 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003078}
3079
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003080static funccal_entry_T *funccal_stack = NULL;
3081
3082/*
3083 * Save the current function call pointer, and set it to NULL.
3084 * Used when executing autocommands and for ":source".
3085 */
3086 void
3087save_funccal(funccal_entry_T *entry)
3088{
3089 entry->top_funccal = current_funccal;
3090 entry->next = funccal_stack;
3091 funccal_stack = entry;
3092 current_funccal = NULL;
3093}
3094
3095 void
3096restore_funccal(void)
3097{
3098 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003099 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003100 else
3101 {
3102 current_funccal = funccal_stack->top_funccal;
3103 funccal_stack = funccal_stack->next;
3104 }
3105}
3106
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003107 funccall_T *
3108get_current_funccal(void)
3109{
3110 return current_funccal;
3111}
3112
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003113/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003114 * Return TRUE when currently at the script level:
3115 * - not in a function
3116 * - not executing an autocommand
3117 * Note that when an autocommand sources a script the result is FALSE;
3118 */
3119 int
3120at_script_level(void)
3121{
3122 return current_funccal == NULL && autocmd_match == NULL;
3123}
3124
3125/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003126 * Mark all functions of script "sid" as deleted.
3127 */
3128 void
3129delete_script_functions(int sid)
3130{
3131 hashitem_T *hi;
3132 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003133 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003134 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003135 size_t len;
3136
3137 buf[0] = K_SPECIAL;
3138 buf[1] = KS_EXTRA;
3139 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003140 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003141 len = STRLEN(buf);
3142
Bram Moolenaarce658352020-07-31 23:47:12 +02003143 while (todo > 0)
3144 {
3145 todo = func_hashtab.ht_used;
3146 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3147 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003148 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003149 fp = HI2UF(hi);
3150 if (STRNCMP(fp->uf_name, buf, len) == 0)
3151 {
3152 int changed = func_hashtab.ht_changed;
3153
3154 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003155
3156 if (fp->uf_calls > 0)
3157 {
3158 // Function is executing, don't free it but do remove
3159 // it from the hashtable.
3160 if (func_remove(fp))
3161 fp->uf_refcount--;
3162 }
3163 else
3164 {
3165 func_clear(fp, TRUE);
3166 // When clearing a function another function can be
3167 // cleared as a side effect. When that happens start
3168 // over.
3169 if (changed != func_hashtab.ht_changed)
3170 break;
3171 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003172 }
3173 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003174 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003175 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003176}
3177
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003178#if defined(EXITFREE) || defined(PROTO)
3179 void
3180free_all_functions(void)
3181{
3182 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003183 ufunc_T *fp;
3184 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003185 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003186 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003187
Bram Moolenaare38eab22019-12-05 21:50:01 +01003188 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003189 while (current_funccal != NULL)
3190 {
3191 clear_tv(current_funccal->rettv);
3192 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003193 if (current_funccal == NULL && funccal_stack != NULL)
3194 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003195 }
3196
Bram Moolenaare38eab22019-12-05 21:50:01 +01003197 // First clear what the functions contain. Since this may lower the
3198 // reference count of a function, it may also free a function and change
3199 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003200 while (todo > 0)
3201 {
3202 todo = func_hashtab.ht_used;
3203 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3204 if (!HASHITEM_EMPTY(hi))
3205 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003206 // clear the def function index now
3207 fp = HI2UF(hi);
3208 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003209 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003210
Bram Moolenaare38eab22019-12-05 21:50:01 +01003211 // Only free functions that are not refcounted, those are
3212 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003213 if (func_name_refcount(fp->uf_name))
3214 ++skipped;
3215 else
3216 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003217 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003218 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003219 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003220 {
3221 skipped = 0;
3222 break;
3223 }
3224 }
3225 --todo;
3226 }
3227 }
3228
Bram Moolenaare38eab22019-12-05 21:50:01 +01003229 // Now actually free the functions. Need to start all over every time,
3230 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003231 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003232 while (func_hashtab.ht_used > skipped)
3233 {
3234 todo = func_hashtab.ht_used;
3235 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003236 if (!HASHITEM_EMPTY(hi))
3237 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003238 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003239 // Only free functions that are not refcounted, those are
3240 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003241 fp = HI2UF(hi);
3242 if (func_name_refcount(fp->uf_name))
3243 ++skipped;
3244 else
3245 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003246 if (func_free(fp, FALSE) == OK)
3247 {
3248 skipped = 0;
3249 break;
3250 }
3251 // did not actually free it
3252 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003253 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003254 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003255 }
3256 if (skipped == 0)
3257 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003258
3259 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003260}
3261#endif
3262
3263/*
3264 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003265 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3266 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003267 * "len" is the length of "name", or -1 for NUL terminated.
3268 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003269 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003270builtin_function(char_u *name, int len)
3271{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003272 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003273
Bram Moolenaara26b9702020-04-18 19:53:28 +02003274 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003276 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3277 {
3278 if (name[i] == AUTOLOAD_CHAR)
3279 return FALSE;
3280 if (!eval_isnamec(name[i]))
3281 {
3282 // "name.something" is not a builtin function
3283 if (name[i] == '.')
3284 return FALSE;
3285 break;
3286 }
3287 }
3288 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003289}
3290
3291 int
3292func_call(
3293 char_u *name,
3294 typval_T *args,
3295 partial_T *partial,
3296 dict_T *selfdict,
3297 typval_T *rettv)
3298{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003299 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003300 listitem_T *item;
3301 typval_T argv[MAX_FUNC_ARGS + 1];
3302 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 int r = 0;
3304
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003305 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003306 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307 {
3308 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3309 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003310 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 break;
3312 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003313 // Make a copy of each argument. This is needed to be able to set
3314 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315 copy_tv(&item->li_tv, &argv[argc++]);
3316 }
3317
3318 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003319 {
3320 funcexe_T funcexe;
3321
Bram Moolenaara80faa82020-04-12 19:37:17 +02003322 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003323 funcexe.fe_firstline = curwin->w_cursor.lnum;
3324 funcexe.fe_lastline = curwin->w_cursor.lnum;
3325 funcexe.fe_evaluate = TRUE;
3326 funcexe.fe_partial = partial;
3327 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003328 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3329 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330
Bram Moolenaare38eab22019-12-05 21:50:01 +01003331 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003332 while (argc > 0)
3333 clear_tv(&argv[--argc]);
3334
3335 return r;
3336}
3337
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003338static int callback_depth = 0;
3339
3340 int
3341get_callback_depth(void)
3342{
3343 return callback_depth;
3344}
3345
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003347 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003348 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003349 */
3350 int
3351call_callback(
3352 callback_T *callback,
3353 int len, // length of "name" or -1 to use strlen()
3354 typval_T *rettv, // return value goes here
3355 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003356 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003357 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003358{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003359 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003360 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003361
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003362 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3363 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003364 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003365 funcexe.fe_evaluate = TRUE;
3366 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003367 ++callback_depth;
3368 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3369 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003370
3371 // When a :def function was called that uses :try an error would be turned
3372 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003373 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003374 {
3375 need_rethrow = FALSE;
3376 handle_did_throw();
3377 }
3378
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003379 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003380}
3381
3382/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003383 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003384 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003385 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3386 */
3387 varnumber_T
3388call_callback_retnr(
3389 callback_T *callback,
3390 int argcount, // number of "argvars"
3391 typval_T *argvars) // vars for arguments, must have "argcount"
3392 // PLUS ONE elements!
3393{
3394 typval_T rettv;
3395 varnumber_T retval;
3396
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003397 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003398 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003399
3400 retval = tv_get_number_chk(&rettv, NULL);
3401 clear_tv(&rettv);
3402 return retval;
3403}
3404
3405/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003406 * Give an error message for the result of a function.
3407 * Nothing if "error" is FCERR_NONE.
3408 */
3409 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003410user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003411{
3412 switch (error)
3413 {
3414 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003415 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003416 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003417 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003418 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003419 break;
3420 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003421 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003422 break;
3423 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003424 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003425 break;
3426 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003427 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003428 break;
3429 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003430 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003431 break;
3432 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003433 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003434 break;
3435 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003436 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3437 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003438 break;
3439 }
3440}
3441
3442/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003443 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003444 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003445 * Return FAIL when the function can't be called, OK otherwise.
3446 * Also returns OK when an error was encountered while executing the function.
3447 */
3448 int
3449call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003450 char_u *funcname, // name of the function
3451 int len, // length of "name" or -1 to use strlen()
3452 typval_T *rettv, // return value goes here
3453 int argcount_in, // number of "argvars"
3454 typval_T *argvars_in, // vars for arguments, must have "argcount"
3455 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003456 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003457{
3458 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003459 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003460 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003461 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003462 char_u fname_buf[FLEN_FIXED + 1];
3463 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003464 char_u *fname = NULL;
3465 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003466 int argcount = argcount_in;
3467 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003468 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003469 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003470 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003471 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003472 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003473 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003474 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003475 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003476
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003477 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3478 // even when call_func() returns FAIL.
3479 rettv->v_type = VAR_UNKNOWN;
3480
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003481 if (partial != NULL)
3482 fp = partial->pt_func;
3483 if (fp == NULL)
3484 {
3485 // Make a copy of the name, if it comes from a funcref variable it
3486 // could be changed or deleted in the called function.
3487 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3488 if (name == NULL)
3489 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003490
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003491 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3492 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003494 if (funcexe->fe_doesrange != NULL)
3495 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496
3497 if (partial != NULL)
3498 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003499 // When the function has a partial with a dict and there is a dict
3500 // argument, use the dict argument. That is backwards compatible.
3501 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003502 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003503 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003504 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505 {
3506 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003507 {
3508 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3509 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003510 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003511 goto theend;
3512 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003513 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003514 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515 for (i = 0; i < argcount_in; ++i)
3516 argv[i + argv_clear] = argvars_in[i];
3517 argvars = argv;
3518 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003519
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003520 if (funcexe->fe_check_type != NULL
3521 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003522 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003523 // Now funcexe->fe_check_type is missing the added arguments,
3524 // make a copy of the type with the correction.
3525 check_type = *funcexe->fe_check_type;
3526 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003527 check_type.tt_args = check_type_args;
3528 CLEAR_FIELD(check_type_args);
3529 for (i = 0; i < check_type.tt_argcount; ++i)
3530 check_type_args[i + partial->pt_argc] =
3531 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003532 check_type.tt_argcount += partial->pt_argc;
3533 check_type.tt_min_argcount += partial->pt_argc;
3534 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535 }
3536 }
3537
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003538 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3539 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003540 {
3541 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003542 if (check_argument_types(funcexe->fe_check_type,
3543 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003544 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003545 error = FCERR_OTHER;
3546 }
3547
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003548 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 {
3550 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003551 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552
Bram Moolenaar333894b2020-08-01 18:53:07 +02003553 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003554 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003555 {
3556 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003557 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003558 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003559
Bram Moolenaare38eab22019-12-05 21:50:01 +01003560 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003561 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003562 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003563
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003564 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003565 {
3566 /*
3567 * User defined function.
3568 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003569 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003570 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003571 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003572 if (fp != NULL && !is_global && in_vim9script()
3573 && func_requires_g_prefix(fp))
3574 // In Vim9 script g: is required to find a global
3575 // non-autoload function.
3576 fp = NULL;
3577 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003578
Bram Moolenaare38eab22019-12-05 21:50:01 +01003579 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003580 if (fp == NULL
3581 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003582 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003583 && !aborting())
3584 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003585 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003586 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003587 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003588 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3590 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003591 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003592 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003593 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003594 if (fp == NULL)
3595 {
3596 char_u *p = untrans_function_name(rfname);
3597
3598 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003599 // Don't do this if the name starts with "s:".
3600 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003601 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003602 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003604 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003605 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003606 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003607 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003608 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003609 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003610 argcount = funcexe->fe_argv_func(argcount, argvars,
3611 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003612
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003613 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003614 {
3615 // Method call: base->Method()
3616 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003617 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003618 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003619 argvars = argv;
3620 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003621 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003622
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003623 error = call_user_func_check(fp, argcount, argvars, rettv,
3624 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 }
3626 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003627 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003628 {
3629 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003630 * expr->method(): Find the method name in the table, call its
3631 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003632 */
3633 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003634 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003635 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003636 else
3637 {
3638 /*
3639 * Find the function name in the table, call its implementation.
3640 */
3641 error = call_internal_func(fname, argcount, argvars, rettv);
3642 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003643
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644 /*
3645 * The function call (or "FuncUndefined" autocommand sequence) might
3646 * have been aborted by an error, an interrupt, or an explicitly thrown
3647 * exception that has not been caught so far. This situation can be
3648 * tested for by calling aborting(). For an error in an internal
3649 * function or for the "E132" error in call_user_func(), however, the
3650 * throw point at which the "force_abort" flag (temporarily reset by
3651 * emsg()) is normally updated has not been reached yet. We need to
3652 * update that flag first to make aborting() reliable.
3653 */
3654 update_force_abort();
3655 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003656 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003657 ret = OK;
3658
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003659theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003660 /*
3661 * Report an error unless the argument evaluation or function call has been
3662 * cancelled due to an aborting error, an interrupt, or an exception.
3663 */
3664 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003665 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003666
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003667 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003668 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003669 clear_tv(&argv[--argv_clear + argv_base]);
3670
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003671 vim_free(tofree);
3672 vim_free(name);
3673
3674 return ret;
3675}
3676
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003677 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003678printable_func_name(ufunc_T *fp)
3679{
3680 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3681}
3682
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003684 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 */
3686 static void
3687list_func_head(ufunc_T *fp, int indent)
3688{
3689 int j;
3690
3691 msg_start();
3692 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003693 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003694 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003695 msg_puts("def ");
3696 else
3697 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003698 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 msg_putchar('(');
3700 for (j = 0; j < fp->uf_args.ga_len; ++j)
3701 {
3702 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003703 msg_puts(", ");
3704 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003705 if (fp->uf_arg_types != NULL)
3706 {
3707 char *tofree;
3708
3709 msg_puts(": ");
3710 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3711 vim_free(tofree);
3712 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003713 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3714 {
3715 msg_puts(" = ");
3716 msg_puts(((char **)(fp->uf_def_args.ga_data))
3717 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3718 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719 }
3720 if (fp->uf_varargs)
3721 {
3722 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003723 msg_puts(", ");
3724 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003725 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003726 if (fp->uf_va_name != NULL)
3727 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003728 if (!fp->uf_varargs)
3729 {
3730 if (j)
3731 msg_puts(", ");
3732 msg_puts("...");
3733 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003734 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003735 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003736 {
3737 char *tofree;
3738
3739 msg_puts(": ");
3740 msg_puts(type_name(fp->uf_va_type, &tofree));
3741 vim_free(tofree);
3742 }
3743 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003744 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003745
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003746 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003747 {
3748 if (fp->uf_ret_type != &t_void)
3749 {
3750 char *tofree;
3751
3752 msg_puts(": ");
3753 msg_puts(type_name(fp->uf_ret_type, &tofree));
3754 vim_free(tofree);
3755 }
3756 }
3757 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003758 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003759 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003760 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003762 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003763 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003764 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003765 msg_clr_eos();
3766 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003767 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003768}
3769
3770/*
3771 * Get a function name, translating "<SID>" and "<SNR>".
3772 * Also handles a Funcref in a List or Dictionary.
3773 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003774 * Set "*is_global" to TRUE when the function must be global, unless
3775 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003776 * flags:
3777 * TFN_INT: internal function name OK
3778 * TFN_QUIET: be quiet
3779 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003780 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003781 * Advances "pp" to just after the function name (if no error).
3782 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003783 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003784trans_function_name(
3785 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003786 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003787 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003788 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003789 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003790 partial_T **partial, // return: partial of a FuncRef
3791 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003792{
3793 char_u *name = NULL;
3794 char_u *start;
3795 char_u *end;
3796 int lead;
3797 char_u sid_buf[20];
3798 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003799 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003800 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003802 int vim9script = in_vim9script();
3803 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804
3805 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003806 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807 start = *pp;
3808
Bram Moolenaare38eab22019-12-05 21:50:01 +01003809 // Check for hard coded <SNR>: already translated function ID (from a user
3810 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003811 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3812 && (*pp)[2] == (int)KE_SNR)
3813 {
3814 *pp += 3;
3815 len = get_id_len(pp) + 3;
3816 return vim_strnsave(start, len);
3817 }
3818
Bram Moolenaare38eab22019-12-05 21:50:01 +01003819 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3820 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003821 lead = eval_fname_script(start);
3822 if (lead > 2)
3823 start += lead;
3824
Bram Moolenaare38eab22019-12-05 21:50:01 +01003825 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003826 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003828 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003829 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003830 {
3831 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003832 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833 goto theend;
3834 }
3835 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3836 {
3837 /*
3838 * Report an invalid expression in braces, unless the expression
3839 * evaluation has been cancelled due to an aborting error, an
3840 * interrupt, or an exception.
3841 */
3842 if (!aborting())
3843 {
3844 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003845 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 }
3847 else
3848 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3849 goto theend;
3850 }
3851
3852 if (lv.ll_tv != NULL)
3853 {
3854 if (fdp != NULL)
3855 {
3856 fdp->fd_dict = lv.ll_dict;
3857 fdp->fd_newkey = lv.ll_newkey;
3858 lv.ll_newkey = NULL;
3859 fdp->fd_di = lv.ll_di;
3860 }
3861 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3862 {
3863 name = vim_strsave(lv.ll_tv->vval.v_string);
3864 *pp = end;
3865 }
3866 else if (lv.ll_tv->v_type == VAR_PARTIAL
3867 && lv.ll_tv->vval.v_partial != NULL)
3868 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003869 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003870 *pp = end;
3871 if (partial != NULL)
3872 *partial = lv.ll_tv->vval.v_partial;
3873 }
3874 else
3875 {
3876 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3877 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003878 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003879 else
3880 *pp = end;
3881 name = NULL;
3882 }
3883 goto theend;
3884 }
3885
3886 if (lv.ll_name == NULL)
3887 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003888 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003889 *pp = end;
3890 goto theend;
3891 }
3892
Bram Moolenaare38eab22019-12-05 21:50:01 +01003893 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 if (lv.ll_exp_name != NULL)
3895 {
3896 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003897 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003898 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003899 if (name == lv.ll_exp_name)
3900 name = NULL;
3901 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003902 else if (lv.ll_sid > 0)
3903 {
3904 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3905 int cc = *lv.ll_name_end;
3906
3907 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3908 *lv.ll_name_end = NUL;
3909 if (si->sn_autoload_prefix != NULL)
3910 {
3911 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3912 }
3913 else
3914 {
3915 sid_buf[0] = K_SPECIAL;
3916 sid_buf[1] = KS_EXTRA;
3917 sid_buf[2] = (int)KE_SNR;
3918 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003919 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003920 name = concat_str(sid_buf, lv.ll_name);
3921 }
3922 *lv.ll_name_end = cc;
3923 *pp = end;
3924 goto theend;
3925 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003926 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927 {
3928 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003929 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003930 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003931 if (name == *pp)
3932 name = NULL;
3933 }
3934 if (name != NULL)
3935 {
3936 name = vim_strsave(name);
3937 *pp = end;
3938 if (STRNCMP(name, "<SNR>", 5) == 0)
3939 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003940 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003941 name[0] = K_SPECIAL;
3942 name[1] = KS_EXTRA;
3943 name[2] = (int)KE_SNR;
3944 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3945 }
3946 goto theend;
3947 }
3948
3949 if (lv.ll_exp_name != NULL)
3950 {
3951 len = (int)STRLEN(lv.ll_exp_name);
3952 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3953 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3954 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003955 // When there was "s:" already or the name expanded to get a
3956 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003957 lv.ll_name += 2;
3958 len -= 2;
3959 lead = 2;
3960 }
3961 }
3962 else
3963 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003964 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003966 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003967 if (lv.ll_name[0] == 'g')
3968 {
3969 if (is_global != NULL)
3970 {
3971 *is_global = TRUE;
3972 }
3973 else
3974 {
3975 // dropping "g:" without setting "is_global" won't work in
3976 // Vim9script, put it back later
3977 prefix_g = TRUE;
3978 extra = 2;
3979 }
3980 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003982 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003983 len = (int)(end - lv.ll_name);
3984 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003985 if (len <= 0)
3986 {
3987 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003988 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02003989 goto theend;
3990 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003991
Bram Moolenaar17f700a2020-12-19 21:23:42 +01003992 // In Vim9 script a user function is script-local by default, unless it
3993 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00003994 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003995
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996 /*
3997 * Copy the function name to allocated memory.
3998 * Accept <SID>name() inside a script, translate into <SNR>123_name().
3999 * Accept <SNR>123_name() outside a script.
4000 */
4001 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004002 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004003 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004005 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004006 {
Kota Kato948a3892022-08-16 16:09:59 +01004007 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4008 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004009 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004010 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004011 goto theend;
4012 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004013 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004014 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004015 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004016 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 || eval_fname_sid(*pp))
4018 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004019 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004020 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004021 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004022 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004023 goto theend;
4024 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004025 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004026 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004027 extra = 3 + (int)STRLEN(sid_buf);
4028 else
4029 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030 }
4031 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004032 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004033 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004035 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004036 : e_function_name_must_start_with_capital_or_s_str),
4037 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004038 goto theend;
4039 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004040 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004041 {
4042 char_u *cp = vim_strchr(lv.ll_name, ':');
4043
4044 if (cp != NULL && cp < end)
4045 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004046 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004047 goto theend;
4048 }
4049 }
4050
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004051 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004052 if (name != NULL)
4053 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004054 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004055 {
4056 name[0] = K_SPECIAL;
4057 name[1] = KS_EXTRA;
4058 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004059 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 STRCPY(name + 3, sid_buf);
4061 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004062 else if (prefix_g)
4063 {
4064 name[0] = 'g';
4065 name[1] = ':';
4066 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004067 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4068 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 }
4070 *pp = end;
4071
4072theend:
4073 clear_lval(&lv);
4074 return name;
4075}
4076
4077/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004078 * Assuming "name" is the result of trans_function_name() and it was prefixed
4079 * to use the script-local name, return the unmodified name (points into
4080 * "name"). Otherwise return NULL.
4081 * This can be used to first search for a script-local function and fall back
4082 * to the global function if not found.
4083 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004084 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004085untrans_function_name(char_u *name)
4086{
4087 char_u *p;
4088
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004089 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004090 {
4091 p = vim_strchr(name, '_');
4092 if (p != NULL)
4093 return p + 1;
4094 }
4095 return NULL;
4096}
4097
4098/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004099 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4100 * current script ID and returns the expanded function name. The caller should
4101 * free the returned name. If not called from a script context or the function
4102 * name doesn't start with these prefixes, then returns NULL.
4103 * This doesn't check whether the script-local function exists or not.
4104 */
4105 char_u *
4106get_scriptlocal_funcname(char_u *funcname)
4107{
4108 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004109 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004110 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004111 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004112
4113 if (funcname == NULL)
4114 return NULL;
4115
4116 if (STRNCMP(funcname, "s:", 2) != 0
4117 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004118 {
4119 ufunc_T *ufunc;
4120
4121 // The function name does not have a script-local prefix. Try finding
4122 // it when in a Vim9 script and there is no "g:" prefix.
4123 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4124 return NULL;
4125 ufunc = find_func(funcname, FALSE);
4126 if (ufunc == NULL || func_is_global(ufunc)
4127 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4128 return NULL;
4129 ++p;
4130 off = 0;
4131 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004132 else
4133 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004134
4135 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4136 {
4137 emsg(_(e_using_sid_not_in_script_context));
4138 return NULL;
4139 }
4140 // Expand s: prefix into <SNR>nr_<name>
4141 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4142 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004143 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004144 if (newname == NULL)
4145 return NULL;
4146 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004147 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004148
4149 return newname;
4150}
4151
4152/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004153 * Return script-local "fname" with the 3-byte sequence replaced by
4154 * printable <SNR> in allocated memory.
4155 */
4156 char_u *
4157alloc_printable_func_name(char_u *fname)
4158{
4159 char_u *n = alloc(STRLEN(fname + 3) + 6);
4160
4161 if (n != NULL)
4162 {
4163 STRCPY(n, "<SNR>");
4164 STRCPY(n + 5, fname + 3);
4165 }
4166 return n;
4167}
4168
4169/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004170 * Call trans_function_name(), except that a lambda is returned as-is.
4171 * Returns the name in allocated memory.
4172 */
4173 char_u *
4174save_function_name(
4175 char_u **name,
4176 int *is_global,
4177 int skip,
4178 int flags,
4179 funcdict_T *fudi)
4180{
4181 char_u *p = *name;
4182 char_u *saved;
4183
4184 if (STRNCMP(p, "<lambda>", 8) == 0)
4185 {
4186 p += 8;
4187 (void)getdigits(&p);
4188 saved = vim_strnsave(*name, p - *name);
4189 if (fudi != NULL)
4190 CLEAR_POINTER(fudi);
4191 }
4192 else
4193 saved = trans_function_name(&p, is_global, skip,
4194 flags, fudi, NULL, NULL);
4195 *name = p;
4196 return saved;
4197}
4198
4199/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004200 * List functions. When "regmatch" is NULL all of then.
4201 * Otherwise functions matching "regmatch".
4202 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004203 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004204list_functions(regmatch_T *regmatch)
4205{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004206 int changed = func_hashtab.ht_changed;
4207 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004208 hashitem_T *hi;
4209
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004210 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004211 {
4212 if (!HASHITEM_EMPTY(hi))
4213 {
4214 ufunc_T *fp = HI2UF(hi);
4215
4216 --todo;
4217 if ((fp->uf_flags & FC_DEAD) == 0
4218 && (regmatch == NULL
4219 ? !message_filtered(fp->uf_name)
4220 && !func_name_refcount(fp->uf_name)
4221 : !isdigit(*fp->uf_name)
4222 && vim_regexec(regmatch, fp->uf_name, 0)))
4223 {
4224 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004225 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004226 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004227 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004228 return;
4229 }
4230 }
4231 }
4232 }
4233}
4234
4235/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004236 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004237 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4238 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004239 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004240 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004241 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004242 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004243define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004244{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004245 int j;
4246 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004247 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004248 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004249 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004250 char_u *p;
4251 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004252 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004253 char_u *line_arg = NULL;
4254 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004255 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004256 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004257 garray_T newlines;
4258 int varargs = FALSE;
4259 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004260 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004261 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004262 int fp_allocated = FALSE;
4263 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004264 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004265 dictitem_T *v;
4266 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004267 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004268 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004269 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004270 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004271 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004272 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004273
4274 /*
4275 * ":function" without argument: list functions.
4276 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004277 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004278 {
4279 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004280 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004281 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004282 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004283 }
4284
4285 /*
4286 * ":function /pat": list functions matching pattern.
4287 */
4288 if (*eap->arg == '/')
4289 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004290 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004291 if (!eap->skip)
4292 {
4293 regmatch_T regmatch;
4294
4295 c = *p;
4296 *p = NUL;
4297 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4298 *p = c;
4299 if (regmatch.regprog != NULL)
4300 {
4301 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004302 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004303 vim_regfree(regmatch.regprog);
4304 }
4305 }
4306 if (*p == '/')
4307 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004308 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004309 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 }
4311
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004312 ga_init(&newargs);
4313 ga_init(&argtypes);
4314 ga_init(&default_args);
4315
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004316 /*
4317 * Get the function name. There are these situations:
4318 * func normal function name
4319 * "name" == func, "fudi.fd_dict" == NULL
4320 * dict.func new dictionary entry
4321 * "name" == NULL, "fudi.fd_dict" set,
4322 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4323 * dict.func existing dict entry with a Funcref
4324 * "name" == func, "fudi.fd_dict" set,
4325 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4326 * dict.func existing dict entry that's not a Funcref
4327 * "name" == NULL, "fudi.fd_dict" set,
4328 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4329 * s:func script-local function name
4330 * g:func global function name, same as "func"
4331 */
4332 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004333 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004334 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004335 // nested function, argument is (args).
4336 paren = TRUE;
4337 CLEAR_FIELD(fudi);
4338 }
4339 else
4340 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004341 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004342 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004343 if (p[0] == 's' && p[1] == ':')
4344 {
4345 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4346 return NULL;
4347 }
4348 p = to_name_end(p, TRUE);
4349 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4350 {
4351 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4352 eap->arg);
4353 return NULL;
4354 }
4355 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004356 }
4357
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004358 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004359 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004360 paren = (vim_strchr(p, '(') != NULL);
4361 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004362 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004363 /*
4364 * Return on an invalid expression in braces, unless the expression
4365 * evaluation has been cancelled due to an aborting error, an
4366 * interrupt, or an exception.
4367 */
4368 if (!aborting())
4369 {
4370 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004371 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004372 vim_free(fudi.fd_newkey);
4373 return NULL;
4374 }
4375 else
4376 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004378
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004379 // For "export def FuncName()" in an autoload script the function name
4380 // is stored with the legacy autoload name "dir#script#FuncName" so
4381 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004382 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004383 {
4384 char_u *prefixed = may_prefix_autoload(name);
4385
4386 if (prefixed != NULL && prefixed != name)
4387 {
4388 vim_free(name);
4389 name = prefixed;
4390 }
4391 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004392 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004393 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004394 {
4395 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4396 goto ret_free;
4397 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 }
4399
Bram Moolenaare38eab22019-12-05 21:50:01 +01004400 // An error in a function call during evaluation of an expression in magic
4401 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 saved_did_emsg = did_emsg;
4403 did_emsg = FALSE;
4404
4405 /*
4406 * ":function func" with only function name: list function.
4407 */
4408 if (!paren)
4409 {
4410 if (!ends_excmd(*skipwhite(p)))
4411 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004412 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413 goto ret_free;
4414 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004415 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 if (eap->nextcmd != NULL)
4417 *p = NUL;
4418 if (!eap->skip && !got_int)
4419 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004420 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004421 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4422 {
4423 char_u *up = untrans_function_name(name);
4424
4425 // With Vim9 script the name was made script-local, if not
4426 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004427 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004428 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004429 }
4430
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004431 if (fp != NULL)
4432 {
4433 list_func_head(fp, TRUE);
4434 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4435 {
4436 if (FUNCLINE(fp, j) == NULL)
4437 continue;
4438 msg_putchar('\n');
4439 msg_outnum((long)(j + 1));
4440 if (j < 9)
4441 msg_putchar(' ');
4442 if (j < 99)
4443 msg_putchar(' ');
4444 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004445 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004446 ui_breakcheck();
4447 }
4448 if (!got_int)
4449 {
4450 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004451 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004452 msg_puts(" enddef");
4453 else
4454 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 }
4456 }
4457 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004458 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004459 }
4460 goto ret_free;
4461 }
4462
4463 /*
4464 * ":function name(arg1, arg2)" Define function.
4465 */
4466 p = skipwhite(p);
4467 if (*p != '(')
4468 {
4469 if (!eap->skip)
4470 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004471 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 goto ret_free;
4473 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004474 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004475 if (vim_strchr(p, '(') != NULL)
4476 p = vim_strchr(p, '(');
4477 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004478
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004479 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4480 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004481 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004482 goto ret_free;
4483 }
4484
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004485 // In Vim9 script only global functions can be redefined.
4486 if (vim9script && eap->forceit && !is_global)
4487 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004488 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004489 goto ret_free;
4490 }
4491
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004492 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004493
Bram Moolenaar04b12692020-05-04 23:24:44 +02004494 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004496 // Check the name of the function. Unless it's a dictionary function
4497 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004498 if (name != NULL)
4499 arg = name;
4500 else
4501 arg = fudi.fd_newkey;
4502 if (arg != NULL && (fudi.fd_di == NULL
4503 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4504 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4505 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004506 char_u *name_base = arg;
4507 int i;
4508
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004509 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004510 {
4511 name_base = vim_strchr(arg, '_');
4512 if (name_base == NULL)
4513 name_base = arg + 3;
4514 else
4515 ++name_base;
4516 }
4517 for (i = 0; name_base[i] != NUL && (i == 0
4518 ? eval_isnamec1(name_base[i])
4519 : eval_isnamec(name_base[i])); ++i)
4520 ;
4521 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004522 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004523
4524 // In Vim9 script a function cannot have the same name as a
4525 // variable.
4526 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004527 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4528 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004529 + EVAL_VAR_NO_FUNC) == OK)
4530 {
4531 semsg(_(e_redefining_script_item_str), name_base);
4532 goto ret_free;
4533 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004535 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004537 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004538 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004539 goto ret_free;
4540 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004541 }
4542
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004543 // This may get more lines and make the pointers into the first line
4544 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004545 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004546 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004547 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004548 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004549 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004551 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004552
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004553 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004554 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004555 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004556 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004557 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004558 if (*p != ':')
4559 {
4560 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4561 p = skipwhite(p);
4562 }
4563 else if (!IS_WHITE_OR_NUL(p[1]))
4564 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004565 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004566 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004567 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004568 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004569 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004570 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004571 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004572 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004573 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004574 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004575 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004576 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004577 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004578 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004579 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004580 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004581 else
4582 // find extra arguments "range", "dict", "abort" and "closure"
4583 for (;;)
4584 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004585 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004586 p = skipwhite(p);
4587 if (STRNCMP(p, "range", 5) == 0)
4588 {
4589 flags |= FC_RANGE;
4590 p += 5;
4591 }
4592 else if (STRNCMP(p, "dict", 4) == 0)
4593 {
4594 flags |= FC_DICT;
4595 p += 4;
4596 }
4597 else if (STRNCMP(p, "abort", 5) == 0)
4598 {
4599 flags |= FC_ABORT;
4600 p += 5;
4601 }
4602 else if (STRNCMP(p, "closure", 7) == 0)
4603 {
4604 flags |= FC_CLOSURE;
4605 p += 7;
4606 if (current_funccal == NULL)
4607 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004608 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004609 name == NULL ? (char_u *)"" : name);
4610 goto erret;
4611 }
4612 }
4613 else
4614 break;
4615 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616
Bram Moolenaare38eab22019-12-05 21:50:01 +01004617 // When there is a line break use what follows for the function body.
4618 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 if (*p == '\n')
4620 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004621 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004622 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4623 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004624 && !(VIM_ISWHITE(*whitep) && *p == '#'
4625 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004626 && !eap->skip
4627 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004628 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004629
4630 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004631 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4632 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004633 */
4634 if (KeyTyped)
4635 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004636 // Check if the function already exists, don't let the user type the
4637 // whole function before telling him it doesn't work! For a script we
4638 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639 if (!eap->skip && !eap->forceit)
4640 {
4641 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004642 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004643 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004644 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004645 }
4646
4647 if (!eap->skip && did_emsg)
4648 goto erret;
4649
Bram Moolenaare38eab22019-12-05 21:50:01 +01004650 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004651 cmdline_row = msg_row;
4652 }
4653
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004654 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004655 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004656
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004657 // Do not define the function when getting the body fails and when
4658 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004659 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004660 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004661 goto erret;
4662
4663 /*
4664 * If there are no errors, add the function
4665 */
4666 if (fudi.fd_dict == NULL)
4667 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004668 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004669 char_u *find_name = name;
4670 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004671 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004672
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004673 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004674 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004675 var_conflict = TRUE;
4676
4677 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4678 {
4679 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4680
4681 if (si->sn_autoload_prefix != NULL)
4682 {
4683 if (is_export)
4684 {
4685 find_name = name + STRLEN(si->sn_autoload_prefix);
4686 v = find_var(find_name, &ht, TRUE);
4687 if (v != NULL)
4688 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004689 // Only check if the function already exists in the script,
4690 // global functions can be shadowed.
4691 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004692 }
4693 else
4694 {
4695 char_u *prefixed = may_prefix_autoload(name);
4696
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004697 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004698 {
4699 v = find_var(prefixed, &ht, TRUE);
4700 if (v != NULL)
4701 var_conflict = TRUE;
4702 vim_free(prefixed);
4703 }
4704 }
4705 }
4706 }
4707 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004708 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004709 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004710 goto erret;
4711 }
4712
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004713 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004714 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004715 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004716 char_u *uname = untrans_function_name(name);
4717
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004718 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004719 }
4720
4721 if (fp != NULL || import != NULL)
4722 {
4723 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004724
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004725 // Function can be replaced with "function!" and when sourcing the
4726 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004727 // A name that is used by an import can not be overruled.
4728 if (import != NULL
4729 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004730 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004731 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004732 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004733 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004734 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004735 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004736 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004737 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004738 goto erret;
4739 }
4740 if (fp->uf_calls > 0)
4741 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004742 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004743 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744 goto erret;
4745 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004746 if (fp->uf_refcount > 1)
4747 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004748 // This function is referenced somewhere, don't redefine it but
4749 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004750 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004751 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004752 fp = NULL;
4753 overwrite = TRUE;
4754 }
4755 else
4756 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004757 char_u *exp_name = fp->uf_name_exp;
4758
4759 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004760 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004761 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004762 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004763 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004764 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004765#ifdef FEAT_PROFILE
4766 fp->uf_profiling = FALSE;
4767 fp->uf_prof_initialized = FALSE;
4768#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004769 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004770 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004771 }
4772 }
4773 else
4774 {
4775 char numbuf[20];
4776
4777 fp = NULL;
4778 if (fudi.fd_newkey == NULL && !eap->forceit)
4779 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004780 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004781 goto erret;
4782 }
4783 if (fudi.fd_di == NULL)
4784 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004785 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004786 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004787 goto erret;
4788 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004789 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004790 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004791 goto erret;
4792
Bram Moolenaare38eab22019-12-05 21:50:01 +01004793 // Give the function a sequential number. Can only be used with a
4794 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 vim_free(name);
4796 sprintf(numbuf, "%d", ++func_nr);
4797 name = vim_strsave((char_u *)numbuf);
4798 if (name == NULL)
4799 goto erret;
4800 }
4801
4802 if (fp == NULL)
4803 {
4804 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4805 {
4806 int slen, plen;
4807 char_u *scriptname;
4808
Bram Moolenaare38eab22019-12-05 21:50:01 +01004809 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004811 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 {
4813 scriptname = autoload_name(name);
4814 if (scriptname != NULL)
4815 {
4816 p = vim_strchr(scriptname, '/');
4817 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004818 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004819 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004820 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004821 j = OK;
4822 vim_free(scriptname);
4823 }
4824 }
4825 if (j == FAIL)
4826 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004827 linenr_T save_lnum = SOURCING_LNUM;
4828
4829 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004830 semsg(_(e_function_name_does_not_match_script_file_name_str),
4831 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004832 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004833 goto erret;
4834 }
4835 }
4836
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004837 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004838 if (fp == NULL)
4839 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004840 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004841
4842 if (fudi.fd_dict != NULL)
4843 {
4844 if (fudi.fd_di == NULL)
4845 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004846 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004847 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4848 if (fudi.fd_di == NULL)
4849 {
4850 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004851 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004852 goto erret;
4853 }
4854 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4855 {
4856 vim_free(fudi.fd_di);
4857 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004858 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004859 goto erret;
4860 }
4861 }
4862 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004863 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004864 clear_tv(&fudi.fd_di->di_tv);
4865 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004866 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004867
Bram Moolenaare38eab22019-12-05 21:50:01 +01004868 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004869 flags |= FC_DICT;
4870 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004871 }
4872 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004873 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004874 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004875 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004876
4877 if (eap->cmdidx == CMD_def)
4878 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004879 int lnum_save = SOURCING_LNUM;
4880 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004881
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004882 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004883
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004884 // error messages are for the first function line
4885 SOURCING_LNUM = sourcing_lnum_top;
4886
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004887 // The function may use script variables from the context.
4888 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004889
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004890 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004891 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004892 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004893 free_fp = fp_allocated;
4894 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004895 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004896 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004897
4898 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004899 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004900 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004901 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004902 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004903 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004904 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004905 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004906 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004907 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004908 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004909
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004910 if (fp_allocated)
4911 {
4912 // insert the new function in the function list
4913 set_ufunc_name(fp, name);
4914 if (overwrite)
4915 {
4916 hi = hash_find(&func_hashtab, name);
4917 hi->hi_key = UF2HIKEY(fp);
4918 }
4919 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4920 {
4921 free_fp = TRUE;
4922 goto erret;
4923 }
4924 fp->uf_refcount = 1;
4925 }
4926
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004927 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004928 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004929 if ((flags & FC_CLOSURE) != 0)
4930 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004931 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004932 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004933 }
4934 else
4935 fp->uf_scoped = NULL;
4936
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004937#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004938 if (prof_def_func())
4939 func_do_profile(fp);
4940#endif
4941 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004942 if (sandbox)
4943 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004944 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004945 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004946 fp->uf_flags = flags;
4947 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004948 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004949 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004950 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004951 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004952 if (is_export)
4953 {
4954 fp->uf_flags |= FC_EXPORT;
4955 // let ex_export() know the export worked.
4956 is_export = FALSE;
4957 }
4958
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004959 if (eap->cmdidx == CMD_def)
4960 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004961 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4962 // :func does not use Vim9 script syntax, even in a Vim9 script file
4963 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004964
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965 goto ret_free;
4966
4967erret:
4968 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004969 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004970 if (fp != NULL)
4971 {
4972 ga_init(&fp->uf_args);
4973 ga_init(&fp->uf_def_args);
4974 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004975errret_2:
4976 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01004977 if (fp != NULL)
4978 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004979 if (free_fp)
4980 {
4981 vim_free(fp);
4982 fp = NULL;
4983 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004984ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01004985 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004986 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004987 if (name != name_arg)
4988 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004989 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004990 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004991
4992 return fp;
4993}
4994
4995/*
4996 * ":function"
4997 */
4998 void
4999ex_function(exarg_T *eap)
5000{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005001 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005002
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005003 ga_init2(&lines_to_free, sizeof(char_u *), 50);
5004 (void)define_function(eap, NULL, &lines_to_free);
5005 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005006}
5007
5008/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005009 * Find a function by name, including "<lambda>123".
5010 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005011 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005012 * Return NULL if not found.
5013 */
5014 ufunc_T *
5015find_func_by_name(char_u *name, compiletype_T *compile_type)
5016{
5017 char_u *arg = name;
5018 char_u *fname;
5019 ufunc_T *ufunc;
5020 int is_global = FALSE;
5021
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005022 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5023 {
5024 *compile_type = CT_PROFILE;
5025 arg = skipwhite(arg + 7);
5026 }
5027 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5028 {
5029 *compile_type = CT_DEBUG;
5030 arg = skipwhite(arg + 5);
5031 }
5032
5033 if (STRNCMP(arg, "<lambda>", 8) == 0)
5034 {
5035 arg += 8;
5036 (void)getdigits(&arg);
5037 fname = vim_strnsave(name, arg - name);
5038 }
5039 else
5040 fname = trans_function_name(&arg, &is_global, FALSE,
5041 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5042 if (fname == NULL)
5043 {
5044 semsg(_(e_invalid_argument_str), name);
5045 return NULL;
5046 }
5047 if (!ends_excmd2(name, arg))
5048 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005049 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005050 emsg(ex_errmsg(e_trailing_characters_str, arg));
5051 return NULL;
5052 }
5053
5054 ufunc = find_func(fname, is_global);
5055 if (ufunc == NULL)
5056 {
5057 char_u *p = untrans_function_name(fname);
5058
5059 if (p != NULL)
5060 // Try again without making it script-local.
5061 ufunc = find_func(p, FALSE);
5062 }
5063 vim_free(fname);
5064 if (ufunc == NULL)
5065 semsg(_(e_cannot_find_function_str), name);
5066 return ufunc;
5067}
5068
5069/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005070 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005071 * be compiled or the one specified by the argument.
5072 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005073 */
5074 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005075ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005076{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005077 ufunc_T *ufunc;
5078
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005079 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005080 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005081 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005082
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005083 ufunc = find_func_by_name(eap->arg, &compile_type);
5084 if (ufunc != NULL)
5085 {
5086 if (func_needs_compiling(ufunc, compile_type))
5087 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5088 else
5089 smsg(_("Function %s does not need compiling"), eap->arg);
5090 }
5091 }
5092 else
5093 {
5094 long todo = (long)func_hashtab.ht_used;
5095 int changed = func_hashtab.ht_changed;
5096 hashitem_T *hi;
5097
5098 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5099 {
5100 if (!HASHITEM_EMPTY(hi))
5101 {
5102 --todo;
5103 ufunc = HI2UF(hi);
5104 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5105 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5106 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005107 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005108 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5109
5110 if (func_hashtab.ht_changed != changed)
5111 {
5112 // a function has been added or removed, need to start
5113 // over
5114 todo = (long)func_hashtab.ht_used;
5115 changed = func_hashtab.ht_changed;
5116 hi = func_hashtab.ht_array;
5117 --hi;
5118 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005119 }
5120 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005121 }
5122 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005123}
5124
5125/*
5126 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5127 * Return 2 if "p" starts with "s:".
5128 * Return 0 otherwise.
5129 */
5130 int
5131eval_fname_script(char_u *p)
5132{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005133 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5134 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005135 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5136 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5137 return 5;
5138 if (p[0] == 's' && p[1] == ':')
5139 return 2;
5140 return 0;
5141}
5142
5143 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005144translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005145{
5146 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005147 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005148 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005149}
5150
5151/*
5152 * Return TRUE when "ufunc" has old-style "..." varargs
5153 * or named varargs "...name: type".
5154 */
5155 int
5156has_varargs(ufunc_T *ufunc)
5157{
5158 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159}
5160
5161/*
5162 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005163 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005164 */
5165 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005166function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005167{
5168 char_u *nm = name;
5169 char_u *p;
5170 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005171 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005172 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005173
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005174 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5175 if (no_deref)
5176 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005177 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005178 nm = skipwhite(nm);
5179
Bram Moolenaare38eab22019-12-05 21:50:01 +01005180 // Only accept "funcname", "funcname ", "funcname (..." and
5181 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005182 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005183 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005184 vim_free(p);
5185 return n;
5186}
5187
Bram Moolenaar113e1072019-01-20 15:30:40 +01005188#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005189 char_u *
5190get_expanded_name(char_u *name, int check)
5191{
5192 char_u *nm = name;
5193 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005194 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005195
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005196 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005197 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005198
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005199 if (p != NULL && *nm == NUL
5200 && (!check || translated_function_exists(p, is_global)))
5201 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005202
5203 vim_free(p);
5204 return NULL;
5205}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005206#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005207
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208/*
5209 * Function given to ExpandGeneric() to obtain the list of user defined
5210 * function names.
5211 */
5212 char_u *
5213get_user_func_name(expand_T *xp, int idx)
5214{
5215 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005216 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005217 static hashitem_T *hi;
5218 ufunc_T *fp;
5219
5220 if (idx == 0)
5221 {
5222 done = 0;
5223 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005224 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005225 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005226 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005227 {
5228 if (done++ > 0)
5229 ++hi;
5230 while (HASHITEM_EMPTY(hi))
5231 ++hi;
5232 fp = HI2UF(hi);
5233
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005234 // don't show dead, dict and lambda functions
5235 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005236 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005237 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005238
5239 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005240 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241
5242 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005243 if (xp->xp_context != EXPAND_USER_FUNC
5244 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005245 {
5246 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005247 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005248 STRCAT(IObuff, ")");
5249 }
5250 return IObuff;
5251 }
5252 return NULL;
5253}
5254
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005255/*
5256 * ":delfunction {name}"
5257 */
5258 void
5259ex_delfunction(exarg_T *eap)
5260{
5261 ufunc_T *fp = NULL;
5262 char_u *p;
5263 char_u *name;
5264 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005265 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005266
5267 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005268 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5269 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005270 vim_free(fudi.fd_newkey);
5271 if (name == NULL)
5272 {
5273 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005274 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005275 return;
5276 }
5277 if (!ends_excmd(*skipwhite(p)))
5278 {
5279 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005280 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005281 return;
5282 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005283 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005284 if (eap->nextcmd != NULL)
5285 *p = NUL;
5286
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005287 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005288 {
5289 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005290 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005291 vim_free(name);
5292 return;
5293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005294 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005295 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005296 vim_free(name);
5297
5298 if (!eap->skip)
5299 {
5300 if (fp == NULL)
5301 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005302 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005303 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005304 return;
5305 }
5306 if (fp->uf_calls > 0)
5307 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005308 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005309 return;
5310 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005311 if (fp->uf_flags & FC_VIM9)
5312 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005313 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005314 return;
5315 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005316
5317 if (fudi.fd_dict != NULL)
5318 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005319 // Delete the dict item that refers to the function, it will
5320 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005321 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5322 }
5323 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005324 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005325 // A normal function (not a numbered function or lambda) has a
5326 // refcount of 1 for the entry in the hashtable. When deleting
5327 // it and the refcount is more than one, it should be kept.
5328 // A numbered function and lambda should be kept if the refcount is
5329 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005330 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005331 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005332 // Function is still referenced somewhere. Don't free it but
5333 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005334 if (func_remove(fp))
5335 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005336 }
5337 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005338 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005339 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005340 }
5341}
5342
5343/*
5344 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005345 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005346 */
5347 void
5348func_unref(char_u *name)
5349{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005350 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005352 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005353 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005354 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005355 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005356 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005357#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005358 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005359#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005360 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005361 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005362 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005363}
5364
5365/*
5366 * Unreference a Function: decrement the reference count and free it when it
5367 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005368 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005369 */
5370 void
5371func_ptr_unref(ufunc_T *fp)
5372{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005373 if (fp != NULL && (--fp->uf_refcount <= 0
5374 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5375 && fp->uf_partial->pt_refcount <= 1
5376 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005377 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005378 // Only delete it when it's not being used. Otherwise it's done
5379 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005380 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005381 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382 }
5383}
5384
5385/*
5386 * Count a reference to a Function.
5387 */
5388 void
5389func_ref(char_u *name)
5390{
5391 ufunc_T *fp;
5392
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005393 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005394 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005395 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005396 if (fp != NULL)
5397 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005398 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005399 // Only give an error for a numbered function.
5400 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005401 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005402}
5403
5404/*
5405 * Count a reference to a Function.
5406 */
5407 void
5408func_ptr_ref(ufunc_T *fp)
5409{
5410 if (fp != NULL)
5411 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005412}
5413
5414/*
5415 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5416 * referenced from anywhere that is in use.
5417 */
5418 static int
5419can_free_funccal(funccall_T *fc, int copyID)
5420{
5421 return (fc->l_varlist.lv_copyID != copyID
5422 && fc->l_vars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005423 && fc->l_avars.dv_copyID != copyID
5424 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005425}
5426
5427/*
5428 * ":return [expr]"
5429 */
5430 void
5431ex_return(exarg_T *eap)
5432{
5433 char_u *arg = eap->arg;
5434 typval_T rettv;
5435 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005436 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005437
5438 if (current_funccal == NULL)
5439 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005440 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005441 return;
5442 }
5443
Bram Moolenaar844fb642021-10-23 13:32:30 +01005444 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005445 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5446
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005447 if (eap->skip)
5448 ++emsg_skip;
5449
5450 eap->nextcmd = NULL;
5451 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005452 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 {
5454 if (!eap->skip)
5455 returning = do_return(eap, FALSE, TRUE, &rettv);
5456 else
5457 clear_tv(&rettv);
5458 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005459 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005460 else if (!eap->skip)
5461 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005462 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005463 update_force_abort();
5464
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005465 /*
5466 * Return unless the expression evaluation has been cancelled due to an
5467 * aborting error, an interrupt, or an exception.
5468 */
5469 if (!aborting())
5470 returning = do_return(eap, FALSE, TRUE, NULL);
5471 }
5472
Bram Moolenaare38eab22019-12-05 21:50:01 +01005473 // When skipping or the return gets pending, advance to the next command
5474 // in this line (!returning). Otherwise, ignore the rest of the line.
5475 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476 if (returning)
5477 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005478 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005479 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005480
5481 if (eap->skip)
5482 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005483 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005484}
5485
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005486 static int
5487ex_call_inner(
5488 exarg_T *eap,
5489 char_u *name,
5490 char_u **arg,
5491 char_u *startarg,
5492 funcexe_T *funcexe_init,
5493 evalarg_T *evalarg)
5494{
5495 linenr_T lnum;
5496 int doesrange;
5497 typval_T rettv;
5498 int failed = FALSE;
5499
5500 /*
5501 * When skipping, evaluate the function once, to find the end of the
5502 * arguments.
5503 * When the function takes a range, this is discovered after the first
5504 * call, and the loop is broken.
5505 */
5506 if (eap->skip)
5507 {
5508 ++emsg_skip;
5509 lnum = eap->line2; // do it once, also with an invalid range
5510 }
5511 else
5512 lnum = eap->line1;
5513 for ( ; lnum <= eap->line2; ++lnum)
5514 {
5515 funcexe_T funcexe;
5516
5517 if (!eap->skip && eap->addr_count > 0)
5518 {
5519 if (lnum > curbuf->b_ml.ml_line_count)
5520 {
5521 // If the function deleted lines or switched to another buffer
5522 // the line number may become invalid.
5523 emsg(_(e_invalid_range));
5524 break;
5525 }
5526 curwin->w_cursor.lnum = lnum;
5527 curwin->w_cursor.col = 0;
5528 curwin->w_cursor.coladd = 0;
5529 }
5530 *arg = startarg;
5531
5532 funcexe = *funcexe_init;
5533 funcexe.fe_doesrange = &doesrange;
5534 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5535 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5536 {
5537 failed = TRUE;
5538 break;
5539 }
5540 if (has_watchexpr())
5541 dbg_check_breakpoint(eap);
5542
5543 // Handle a function returning a Funcref, Dictionary or List.
5544 if (handle_subscript(arg, NULL, &rettv,
5545 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5546 {
5547 failed = TRUE;
5548 break;
5549 }
5550
5551 clear_tv(&rettv);
5552 if (doesrange || eap->skip)
5553 break;
5554
5555 // Stop when immediately aborting on error, or when an interrupt
5556 // occurred or an exception was thrown but not caught.
5557 // get_func_tv() returned OK, so that the check for trailing
5558 // characters below is executed.
5559 if (aborting())
5560 break;
5561 }
5562 if (eap->skip)
5563 --emsg_skip;
5564 return failed;
5565}
5566
5567/*
5568 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5569 * Returns FAIL or OK.
5570 */
5571 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005572ex_defer_inner(
5573 char_u *name,
5574 char_u **arg,
5575 partial_T *partial,
5576 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005577{
5578 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005579 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005580 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005581 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005582
5583 if (current_funccal == NULL)
5584 {
5585 semsg(_(e_str_not_inside_function), "defer");
5586 return FAIL;
5587 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005588 if (partial != NULL)
5589 {
5590 if (partial->pt_dict != NULL)
5591 {
5592 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5593 return FAIL;
5594 }
5595 if (partial->pt_argc > 0)
5596 {
5597 int i;
5598
5599 partial_argc = partial->pt_argc;
5600 for (i = 0; i < partial_argc; ++i)
5601 copy_tv(&partial->pt_argv[i], &argvars[i]);
5602 }
5603 }
5604 r = get_func_arguments(arg, evalarg, FALSE,
5605 argvars + partial_argc, &argcount);
5606 argcount += partial_argc;
5607 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01005608 {
5609 while (--argcount >= 0)
5610 clear_tv(&argvars[argcount]);
5611 return FAIL;
5612 }
5613 return add_defer(name, argcount, argvars);
5614}
5615
5616/*
5617 * Add a deferred call for "name" with arguments "argvars[argcount]".
5618 * Consumes "argvars[]".
5619 * Caller must check that in_def_function() returns TRUE or current_funccal is
5620 * not NULL.
5621 * Returns OK or FAIL.
5622 */
5623 int
5624add_defer(char_u *name, int argcount_arg, typval_T *argvars)
5625{
5626 char_u *saved_name = vim_strsave(name);
5627 int argcount = argcount_arg;
5628 defer_T *dr;
5629 int ret = FAIL;
5630
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005631 if (saved_name == NULL)
5632 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01005633 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005634 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01005635 if (add_defer_function(saved_name, argcount, argvars) == OK)
5636 argcount = 0;
5637 }
5638 else
5639 {
5640 if (current_funccal->fc_defer.ga_itemsize == 0)
5641 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
5642 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
5643 goto theend;
5644 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
5645 + current_funccal->fc_defer.ga_len++;
5646 dr->dr_name = saved_name;
5647 dr->dr_argcount = argcount;
5648 while (argcount > 0)
5649 {
5650 --argcount;
5651 dr->dr_argvars[argcount] = argvars[argcount];
5652 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005653 }
5654 ret = OK;
5655
5656theend:
5657 while (--argcount >= 0)
5658 clear_tv(&argvars[argcount]);
5659 return ret;
5660}
5661
5662/*
5663 * Invoked after a functions has finished: invoke ":defer" functions.
5664 */
Bram Moolenaar58779852022-09-06 18:31:14 +01005665 static void
5666handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005667{
5668 int idx;
5669
Bram Moolenaar58779852022-09-06 18:31:14 +01005670 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005671 {
5672 funcexe_T funcexe;
5673 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01005674 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005675 int i;
5676
5677 CLEAR_FIELD(funcexe);
5678 funcexe.fe_evaluate = TRUE;
5679
5680 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5681 call_func(dr->dr_name, -1, &rettv,
5682 dr->dr_argcount, dr->dr_argvars, &funcexe);
5683 clear_tv(&rettv);
5684 vim_free(dr->dr_name);
5685 for (i = dr->dr_argcount - 1; i >= 0; --i)
5686 clear_tv(&dr->dr_argvars[i]);
5687 }
Bram Moolenaar58779852022-09-06 18:31:14 +01005688 ga_clear(&funccal->fc_defer);
5689}
5690
5691/*
5692 * Called when exiting: call all defer functions.
5693 */
5694 void
5695invoke_all_defer(void)
5696{
5697 funccall_T *funccal;
5698
5699 for (funccal = current_funccal; funccal != NULL; funccal = funccal->caller)
5700 if (funccal->fc_ectx != NULL)
5701 {
5702 // :def function
5703 unwind_def_callstack(funccal->fc_ectx);
5704 may_invoke_defer_funcs(funccal->fc_ectx);
5705 }
5706 else
5707 {
5708 // legacy function
5709 handle_defer_one(funccal);
5710 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005711}
5712
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005713/*
5714 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005715 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005716 */
5717 void
5718ex_call(exarg_T *eap)
5719{
5720 char_u *arg = eap->arg;
5721 char_u *startarg;
5722 char_u *name;
5723 char_u *tofree;
5724 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005725 int failed = FALSE;
5726 funcdict_T fudi;
5727 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005728 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005729 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005730 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005731 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005732
Bram Moolenaare6b53242020-07-01 17:28:33 +02005733 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005734 if (eap->skip)
5735 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005736 typval_T rettv;
5737
Bram Moolenaare38eab22019-12-05 21:50:01 +01005738 // trans_function_name() doesn't work well when skipping, use eval0()
5739 // instead to skip to any following command, e.g. for:
5740 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005741 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005742 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005743 clear_tv(&rettv);
5744 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005745 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005746 return;
5747 }
5748
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005749 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005750 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005751 if (fudi.fd_newkey != NULL)
5752 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005753 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005754 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005755 vim_free(fudi.fd_newkey);
5756 }
5757 if (tofree == NULL)
5758 return;
5759
Bram Moolenaare38eab22019-12-05 21:50:01 +01005760 // Increase refcount on dictionary, it could get deleted when evaluating
5761 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005762 if (fudi.fd_dict != NULL)
5763 ++fudi.fd_dict->dv_refcount;
5764
Bram Moolenaare38eab22019-12-05 21:50:01 +01005765 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5766 // contents. For VAR_PARTIAL get its partial, unless we already have one
5767 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005768 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005769 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005770 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005771 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005772
Bram Moolenaare38eab22019-12-05 21:50:01 +01005773 // Skip white space to allow ":call func ()". Not good, but required for
5774 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005775 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005776 if (*startarg != '(')
5777 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005778 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005779 goto end;
5780 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005781 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005782 {
5783 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5784 goto end;
5785 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005786
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005787 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005788 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005789 arg = startarg;
Bram Moolenaar86d87252022-09-05 21:21:25 +01005790 failed = ex_defer_inner(name, &arg, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005791 }
5792 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005793 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005794 funcexe_T funcexe;
5795
Bram Moolenaara80faa82020-04-12 19:37:17 +02005796 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005797 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005798 funcexe.fe_partial = partial;
5799 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005800 funcexe.fe_firstline = eap->line1;
5801 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005802 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005803 funcexe.fe_evaluate = !eap->skip;
5804 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005805 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005806
Bram Moolenaar1d341892021-09-18 15:25:52 +02005807 // When inside :try we need to check for following "| catch" or "| endtry".
5808 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005809 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005810 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005811 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005812 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005813 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005814 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005815 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005816 {
5817 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005818 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005819 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005820 }
5821 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005822 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005823 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005824 // Must be after using "arg", it may point into memory cleared here.
5825 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005826
5827end:
5828 dict_unref(fudi.fd_dict);
5829 vim_free(tofree);
5830}
5831
5832/*
5833 * Return from a function. Possibly makes the return pending. Also called
5834 * for a pending return at the ":endtry" or after returning from an extra
5835 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5836 * when called due to a ":return" command. "rettv" may point to a typval_T
5837 * with the return rettv. Returns TRUE when the return can be carried out,
5838 * FALSE when the return gets pending.
5839 */
5840 int
5841do_return(
5842 exarg_T *eap,
5843 int reanimate,
5844 int is_cmd,
5845 void *rettv)
5846{
5847 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005848 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005849
5850 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005851 // Undo the return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005852 current_funccal->returned = FALSE;
5853
5854 /*
5855 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5856 * not in its finally clause (which then is to be executed next) is found.
5857 * In this case, make the ":return" pending for execution at the ":endtry".
5858 * Otherwise, return normally.
5859 */
5860 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5861 if (idx >= 0)
5862 {
5863 cstack->cs_pending[idx] = CSTP_RETURN;
5864
5865 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005866 // A pending return again gets pending. "rettv" points to an
5867 // allocated variable with the rettv of the original ":return"'s
5868 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005869 cstack->cs_rettv[idx] = rettv;
5870 else
5871 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005872 // When undoing a return in order to make it pending, get the stored
5873 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005874 if (reanimate)
5875 rettv = current_funccal->rettv;
5876
5877 if (rettv != NULL)
5878 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005879 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005880 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5881 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5882 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005883 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005884 }
5885 else
5886 cstack->cs_rettv[idx] = NULL;
5887
5888 if (reanimate)
5889 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005890 // The pending return value could be overwritten by a ":return"
5891 // without argument in a finally clause; reset the default
5892 // return value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005893 current_funccal->rettv->v_type = VAR_NUMBER;
5894 current_funccal->rettv->vval.v_number = 0;
5895 }
5896 }
5897 report_make_pending(CSTP_RETURN, rettv);
5898 }
5899 else
5900 {
5901 current_funccal->returned = TRUE;
5902
Bram Moolenaare38eab22019-12-05 21:50:01 +01005903 // If the return is carried out now, store the return value. For
5904 // a return immediately after reanimation, the value is already
5905 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005906 if (!reanimate && rettv != NULL)
5907 {
5908 clear_tv(current_funccal->rettv);
5909 *current_funccal->rettv = *(typval_T *)rettv;
5910 if (!is_cmd)
5911 vim_free(rettv);
5912 }
5913 }
5914
5915 return idx < 0;
5916}
5917
5918/*
5919 * Free the variable with a pending return value.
5920 */
5921 void
5922discard_pending_return(void *rettv)
5923{
5924 free_tv((typval_T *)rettv);
5925}
5926
5927/*
5928 * Generate a return command for producing the value of "rettv". The result
5929 * is an allocated string. Used by report_pending() for verbose messages.
5930 */
5931 char_u *
5932get_return_cmd(void *rettv)
5933{
5934 char_u *s = NULL;
5935 char_u *tofree = NULL;
5936 char_u numbuf[NUMBUFLEN];
5937
5938 if (rettv != NULL)
5939 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
5940 if (s == NULL)
5941 s = (char_u *)"";
5942
5943 STRCPY(IObuff, ":return ");
5944 STRNCPY(IObuff + 8, s, IOSIZE - 8);
5945 if (STRLEN(s) + 8 >= IOSIZE)
5946 STRCPY(IObuff + IOSIZE - 4, "...");
5947 vim_free(tofree);
5948 return vim_strsave(IObuff);
5949}
5950
5951/*
5952 * Get next function line.
5953 * Called by do_cmdline() to get the next line.
5954 * Returns allocated string, or NULL for end of function.
5955 */
5956 char_u *
5957get_func_line(
5958 int c UNUSED,
5959 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02005960 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02005961 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005962{
5963 funccall_T *fcp = (funccall_T *)cookie;
5964 ufunc_T *fp = fcp->func;
5965 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005966 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005967
Bram Moolenaare38eab22019-12-05 21:50:01 +01005968 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005969 if (fcp->dbg_tick != debug_tick)
5970 {
5971 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005972 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005973 fcp->dbg_tick = debug_tick;
5974 }
5975#ifdef FEAT_PROFILE
5976 if (do_profiling == PROF_YES)
5977 func_line_end(cookie);
5978#endif
5979
5980 gap = &fp->uf_lines;
5981 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
5982 || fcp->returned)
5983 retval = NULL;
5984 else
5985 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005986 // Skip NULL lines (continuation lines).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005987 while (fcp->linenr < gap->ga_len
5988 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL)
5989 ++fcp->linenr;
5990 if (fcp->linenr >= gap->ga_len)
5991 retval = NULL;
5992 else
5993 {
5994 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01005995 SOURCING_LNUM = fcp->linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005996#ifdef FEAT_PROFILE
5997 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01005998 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005999#endif
6000 }
6001 }
6002
Bram Moolenaare38eab22019-12-05 21:50:01 +01006003 // Did we encounter a breakpoint?
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006004 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006005 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006006 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006007 // Find next breakpoint.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006008 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006009 SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006010 fcp->dbg_tick = debug_tick;
6011 }
6012
6013 return retval;
6014}
6015
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006016/*
6017 * Return TRUE if the currently active function should be ended, because a
6018 * return was encountered or an error occurred. Used inside a ":while".
6019 */
6020 int
6021func_has_ended(void *cookie)
6022{
6023 funccall_T *fcp = (funccall_T *)cookie;
6024
Bram Moolenaare38eab22019-12-05 21:50:01 +01006025 // Ignore the "abort" flag if the abortion behavior has been changed due to
6026 // an error inside a try conditional.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006027 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
6028 || fcp->returned);
6029}
6030
6031/*
6032 * return TRUE if cookie indicates a function which "abort"s on errors.
6033 */
6034 int
6035func_has_abort(
6036 void *cookie)
6037{
6038 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT;
6039}
6040
6041
6042/*
6043 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6044 * Don't do this when "Func" is already a partial that was bound
6045 * explicitly (pt_auto is FALSE).
6046 * Changes "rettv" in-place.
6047 * Returns the updated "selfdict_in".
6048 */
6049 dict_T *
6050make_partial(dict_T *selfdict_in, typval_T *rettv)
6051{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006052 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006053 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006054 char_u fname_buf[FLEN_FIXED + 1];
6055 int error;
6056 dict_T *selfdict = selfdict_in;
6057
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006058 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6059 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006060 fp = rettv->vval.v_partial->pt_func;
6061 else
6062 {
6063 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006064 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006065 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006066 if (fname == NULL)
6067 {
6068 // There is no point binding a dict to a NULL function, just create
6069 // a function reference.
6070 rettv->v_type = VAR_FUNC;
6071 rettv->vval.v_string = NULL;
6072 }
6073 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006074 {
6075 char_u *tofree = NULL;
6076
6077 // Translate "s:func" to the stored function name.
6078 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6079 fp = find_func(fname, FALSE);
6080 vim_free(tofree);
6081 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006082 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006083
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006084 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006085 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006086 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006087
6088 if (pt != NULL)
6089 {
6090 pt->pt_refcount = 1;
6091 pt->pt_dict = selfdict;
6092 pt->pt_auto = TRUE;
6093 selfdict = NULL;
6094 if (rettv->v_type == VAR_FUNC)
6095 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006096 // Just a function: Take over the function name and use
6097 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006098 pt->pt_name = rettv->vval.v_string;
6099 }
6100 else
6101 {
6102 partial_T *ret_pt = rettv->vval.v_partial;
6103 int i;
6104
Bram Moolenaare38eab22019-12-05 21:50:01 +01006105 // Partial: copy the function name, use selfdict and copy
6106 // args. Can't take over name or args, the partial might
6107 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006108 if (ret_pt->pt_name != NULL)
6109 {
6110 pt->pt_name = vim_strsave(ret_pt->pt_name);
6111 func_ref(pt->pt_name);
6112 }
6113 else
6114 {
6115 pt->pt_func = ret_pt->pt_func;
6116 func_ptr_ref(pt->pt_func);
6117 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006118 if (ret_pt->pt_argc > 0)
6119 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006120 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006121 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006122 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006123 pt->pt_argc = 0;
6124 else
6125 {
6126 pt->pt_argc = ret_pt->pt_argc;
6127 for (i = 0; i < pt->pt_argc; i++)
6128 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6129 }
6130 }
6131 partial_unref(ret_pt);
6132 }
6133 rettv->v_type = VAR_PARTIAL;
6134 rettv->vval.v_partial = pt;
6135 }
6136 }
6137 return selfdict;
6138}
6139
6140/*
6141 * Return the name of the executed function.
6142 */
6143 char_u *
6144func_name(void *cookie)
6145{
6146 return ((funccall_T *)cookie)->func->uf_name;
6147}
6148
6149/*
6150 * Return the address holding the next breakpoint line for a funccall cookie.
6151 */
6152 linenr_T *
6153func_breakpoint(void *cookie)
6154{
6155 return &((funccall_T *)cookie)->breakpoint;
6156}
6157
6158/*
6159 * Return the address holding the debug tick for a funccall cookie.
6160 */
6161 int *
6162func_dbg_tick(void *cookie)
6163{
6164 return &((funccall_T *)cookie)->dbg_tick;
6165}
6166
6167/*
6168 * Return the nesting level for a funccall cookie.
6169 */
6170 int
6171func_level(void *cookie)
6172{
6173 return ((funccall_T *)cookie)->level;
6174}
6175
6176/*
6177 * Return TRUE when a function was ended by a ":return" command.
6178 */
6179 int
6180current_func_returned(void)
6181{
6182 return current_funccal->returned;
6183}
6184
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006185 int
6186free_unref_funccal(int copyID, int testing)
6187{
6188 int did_free = FALSE;
6189 int did_free_funccal = FALSE;
6190 funccall_T *fc, **pfc;
6191
6192 for (pfc = &previous_funccal; *pfc != NULL; )
6193 {
6194 if (can_free_funccal(*pfc, copyID))
6195 {
6196 fc = *pfc;
6197 *pfc = fc->caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006198 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006199 did_free = TRUE;
6200 did_free_funccal = TRUE;
6201 }
6202 else
6203 pfc = &(*pfc)->caller;
6204 }
6205 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006206 // When a funccal was freed some more items might be garbage
6207 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006208 (void)garbage_collect(testing);
6209
6210 return did_free;
6211}
6212
6213/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006214 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006215 */
6216 static funccall_T *
6217get_funccal(void)
6218{
6219 int i;
6220 funccall_T *funccal;
6221 funccall_T *temp_funccal;
6222
6223 funccal = current_funccal;
6224 if (debug_backtrace_level > 0)
6225 {
6226 for (i = 0; i < debug_backtrace_level; i++)
6227 {
6228 temp_funccal = funccal->caller;
6229 if (temp_funccal)
6230 funccal = temp_funccal;
6231 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006232 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006233 debug_backtrace_level = i;
6234 }
6235 }
6236 return funccal;
6237}
6238
6239/*
6240 * Return the hashtable used for local variables in the current funccal.
6241 * Return NULL if there is no current funccal.
6242 */
6243 hashtab_T *
6244get_funccal_local_ht()
6245{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006246 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006247 return NULL;
6248 return &get_funccal()->l_vars.dv_hashtab;
6249}
6250
6251/*
6252 * Return the l: scope variable.
6253 * Return NULL if there is no current funccal.
6254 */
6255 dictitem_T *
6256get_funccal_local_var()
6257{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006258 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006259 return NULL;
6260 return &get_funccal()->l_vars_var;
6261}
6262
6263/*
6264 * Return the hashtable used for argument in the current funccal.
6265 * Return NULL if there is no current funccal.
6266 */
6267 hashtab_T *
6268get_funccal_args_ht()
6269{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006270 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006271 return NULL;
6272 return &get_funccal()->l_avars.dv_hashtab;
6273}
6274
6275/*
6276 * Return the a: scope variable.
6277 * Return NULL if there is no current funccal.
6278 */
6279 dictitem_T *
6280get_funccal_args_var()
6281{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006282 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006283 return NULL;
Bram Moolenaarc7d9eac2017-02-01 20:26:51 +01006284 return &get_funccal()->l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006285}
6286
6287/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006288 * List function variables, if there is a function.
6289 */
6290 void
6291list_func_vars(int *first)
6292{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006293 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006294 list_hashtable_vars(&current_funccal->l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006295 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006296}
6297
6298/*
6299 * If "ht" is the hashtable for local variables in the current funccal, return
6300 * the dict that contains it.
6301 * Otherwise return NULL.
6302 */
6303 dict_T *
6304get_current_funccal_dict(hashtab_T *ht)
6305{
6306 if (current_funccal != NULL
6307 && ht == &current_funccal->l_vars.dv_hashtab)
6308 return &current_funccal->l_vars;
6309 return NULL;
6310}
6311
6312/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006313 * Search hashitem in parent scope.
6314 */
6315 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006316find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006317{
6318 funccall_T *old_current_funccal = current_funccal;
6319 hashtab_T *ht;
6320 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006321 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006322
6323 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6324 return NULL;
6325
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006326 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006327 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006328 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006329 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006330 ht = find_var_ht(name, &varname);
6331 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006332 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006333 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006334 if (!HASHITEM_EMPTY(hi))
6335 {
6336 *pht = ht;
6337 break;
6338 }
6339 }
6340 if (current_funccal == current_funccal->func->uf_scoped)
6341 break;
6342 current_funccal = current_funccal->func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006343 }
6344 current_funccal = old_current_funccal;
6345
6346 return hi;
6347}
6348
6349/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006350 * Search variable in parent scope.
6351 */
6352 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006353find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006354{
6355 dictitem_T *v = NULL;
6356 funccall_T *old_current_funccal = current_funccal;
6357 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006358 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006359
6360 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL)
6361 return NULL;
6362
Bram Moolenaare38eab22019-12-05 21:50:01 +01006363 // Search in parent scope which is possible to reference from lambda
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006364 current_funccal = current_funccal->func->uf_scoped;
6365 while (current_funccal)
6366 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006367 ht = find_var_ht(name, &varname);
6368 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006369 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006370 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006371 if (v != NULL)
6372 break;
6373 }
6374 if (current_funccal == current_funccal->func->uf_scoped)
6375 break;
6376 current_funccal = current_funccal->func->uf_scoped;
6377 }
6378 current_funccal = old_current_funccal;
6379
6380 return v;
6381}
6382
6383/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006384 * Set "copyID + 1" in previous_funccal and callers.
6385 */
6386 int
6387set_ref_in_previous_funccal(int copyID)
6388{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006389 funccall_T *fc;
6390
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006391 for (fc = previous_funccal; fc != NULL; fc = fc->caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006392 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006393 fc->fc_copyID = copyID + 1;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006394 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL)
6395 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL)
6396 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL))
6397 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006398 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006399 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006400}
6401
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006402 static int
6403set_ref_in_funccal(funccall_T *fc, int copyID)
6404{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006405 if (fc->fc_copyID != copyID)
6406 {
6407 fc->fc_copyID = copyID;
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006408 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL)
6409 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL)
6410 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL)
6411 || set_ref_in_func(NULL, fc->func, copyID))
6412 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006413 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006414 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006415}
6416
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006417/*
6418 * Set "copyID" in all local vars and arguments in the call stack.
6419 */
6420 int
6421set_ref_in_call_stack(int copyID)
6422{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006423 funccall_T *fc;
6424 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006425
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006426 for (fc = current_funccal; fc != NULL; fc = fc->caller)
6427 if (set_ref_in_funccal(fc, copyID))
6428 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006429
6430 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006431 for (entry = funccal_stack; entry != NULL; entry = entry->next)
6432 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller)
6433 if (set_ref_in_funccal(fc, copyID))
6434 return TRUE;
6435 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006436}
6437
6438/*
6439 * Set "copyID" in all functions available by name.
6440 */
6441 int
6442set_ref_in_functions(int copyID)
6443{
6444 int todo;
6445 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006446 ufunc_T *fp;
6447
6448 todo = (int)func_hashtab.ht_used;
6449 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006450 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006451 if (!HASHITEM_EMPTY(hi))
6452 {
6453 --todo;
6454 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006455 if (!func_name_refcount(fp->uf_name)
6456 && set_ref_in_func(NULL, fp, copyID))
6457 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006458 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006459 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006460 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006461}
6462
6463/*
6464 * Set "copyID" in all function arguments.
6465 */
6466 int
6467set_ref_in_func_args(int copyID)
6468{
6469 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006470
6471 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006472 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6473 copyID, NULL, NULL))
6474 return TRUE;
6475 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006476}
6477
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006478/*
6479 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006480 * Returns TRUE if setting references failed somehow.
6481 */
6482 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006483set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006484{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006485 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006486 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006487 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006488 char_u fname_buf[FLEN_FIXED + 1];
6489 char_u *tofree = NULL;
6490 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006491 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006492
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006493 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006494 return FALSE;
6495
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006496 if (fp_in == NULL)
6497 {
6498 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006499 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006500 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006501 if (fp != NULL)
6502 {
6503 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006504 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006505 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006506
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006507 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006508 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006509}
6510
Bram Moolenaare38eab22019-12-05 21:50:01 +01006511#endif // FEAT_EVAL