blob: cc90b95b735dd04d8755d3c0c4e7fcd744e90daa [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 Moolenaarca16c602022-09-06 18:57:08 +0100502 if (ga_grow(&current_funccal->fc_ufuncs, 1) == FAIL)
Bram Moolenaar58016442016-07-31 18:30:22 +0200503 return FAIL;
Bram Moolenaarca16c602022-09-06 18:57:08 +0100504 ((ufunc_T **)current_funccal->fc_ufuncs.ga_data)
505 [current_funccal->fc_ufuncs.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 Moolenaarf5f4e852022-09-22 22:03:14 +01001169 char_u *start = *arg;
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001170 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001171 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001172 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001173 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001174 exarg_T eap;
1175 garray_T newlines;
1176 char_u *cmdline = NULL;
1177 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001178 partial_T *pt;
1179 char_u *name;
1180 int lnum_save = -1;
1181 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1182
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001183 *arg = skipwhite(*arg + 1);
1184 if (**arg == '|' || !ends_excmd2(start, *arg))
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001185 {
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001186 semsg(_(e_trailing_characters_str), *arg);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001187 return FAIL;
1188 }
1189
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001190 CLEAR_FIELD(eap);
1191 eap.cmdidx = CMD_block;
1192 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001193 eap.cmdlinep = &cmdline;
1194 eap.skip = !evaluate;
1195 if (evalarg->eval_cctx != NULL)
1196 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1197 else
1198 {
1199 eap.getline = evalarg->eval_getline;
1200 eap.cookie = evalarg->eval_cookie;
1201 }
1202
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001203 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001204 if (get_function_body(&eap, &newlines, NULL,
1205 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001207
1208 // When inside a lambda must add the function lines to evalarg.eval_ga.
1209 evalarg->eval_break_count += newlines.ga_len;
1210 if (gap->ga_itemsize > 0)
1211 {
1212 int idx;
1213 char_u *last;
1214 size_t plen;
1215 char_u *pnl;
1216
1217 for (idx = 0; idx < newlines.ga_len; ++idx)
1218 {
1219 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1220
Bram Moolenaarecb66452021-05-18 15:09:18 +02001221 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001222 goto erret;
1223
1224 // Going to concatenate the lines after parsing. For an empty or
1225 // comment line use an empty string.
1226 // Insert NL characters at the start of each line, the string will
1227 // be split again later in .get_lambda_tv().
1228 if (*p == NUL || vim9_comment_start(p))
1229 p = (char_u *)"";
1230 plen = STRLEN(p);
1231 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1232 if (pnl != NULL)
1233 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001234 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1235 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001237 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001238 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001239 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001240 // more is following after the "}", which was skipped
1241 last = cmdline;
1242 else
1243 // nothing is following the "}"
1244 last = (char_u *)"}";
1245 plen = STRLEN(last);
1246 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1247 if (pnl != NULL)
1248 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001249 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1250 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001251 }
1252
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001253 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001254 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001255 garray_T *tfgap = &evalarg->eval_tofree_ga;
1256
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001257 // Something comes after the "}".
1258 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001259
1260 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001261 if (ga_grow(tfgap, 1) == OK)
1262 {
1263 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1264 evalarg->eval_using_cmdline = TRUE;
1265 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001266 }
1267 else
1268 *arg = (char_u *)"";
1269
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001270 if (!evaluate)
1271 {
1272 ret = OK;
1273 goto erret;
1274 }
1275
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001276 name = get_lambda_name();
1277 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1278 if (ufunc == NULL)
1279 goto erret;
1280 set_ufunc_name(ufunc, name);
1281 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001283 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001284 ufunc->uf_refcount = 1;
1285 ufunc->uf_args = *newargs;
1286 newargs->ga_data = NULL;
1287 ufunc->uf_def_args = *default_args;
1288 default_args->ga_data = NULL;
1289 ufunc->uf_func_type = &t_func_any;
1290
1291 // error messages are for the first function line
1292 lnum_save = SOURCING_LNUM;
1293 SOURCING_LNUM = sourcing_lnum_top;
1294
1295 // parse argument types
1296 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1297 {
1298 SOURCING_LNUM = lnum_save;
1299 goto erret;
1300 }
1301
1302 // parse the return type, if any
1303 if (parse_return_type(ufunc, ret_type) == FAIL)
1304 goto erret;
1305
1306 pt = ALLOC_CLEAR_ONE(partial_T);
1307 if (pt == NULL)
1308 goto erret;
1309 pt->pt_func = ufunc;
1310 pt->pt_refcount = 1;
1311
1312 ufunc->uf_lines = newlines;
1313 newlines.ga_data = NULL;
1314 if (sandbox)
1315 ufunc->uf_flags |= FC_SANDBOX;
1316 if (!ASCII_ISUPPER(*ufunc->uf_name))
1317 ufunc->uf_flags |= FC_VIM9;
1318 ufunc->uf_script_ctx = current_sctx;
1319 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1320 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1321 set_function_type(ufunc);
1322
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001323 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1324
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001325 rettv->vval.v_partial = pt;
1326 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001327 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001328 ret = OK;
1329
1330erret:
1331 if (lnum_save >= 0)
1332 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001333 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001334 if (newargs != NULL)
1335 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001336 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001337 if (ufunc != NULL)
1338 {
1339 func_clear(ufunc, TRUE);
1340 func_free(ufunc, TRUE);
1341 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001342 return ret;
1343}
1344
1345/*
1346 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001347 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001348 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001349 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1350 */
1351 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001352get_lambda_tv(
1353 char_u **arg,
1354 typval_T *rettv,
1355 int types_optional,
1356 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001357{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001358 int evaluate = evalarg != NULL
1359 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 garray_T newargs;
1361 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001362 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001363 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001364 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001366 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001368 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001370 char_u *s;
1371 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001372 int *old_eval_lavars = eval_lavars_used;
1373 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001374 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001375 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001376 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001377 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001378 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001379 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380
Bram Moolenaar4525a572022-02-13 11:57:33 +00001381 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001382 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383
1384 ga_init(&newargs);
1385 ga_init(&newlines);
1386
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001387 // First, check if this is really a lambda expression. "->" or "=>" must
1388 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001389 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001390 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001391 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001392 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001393 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001394 {
1395 if (types_optional)
1396 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001397 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001399
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001400 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001401 if (evaluate)
1402 pnewargs = &newargs;
1403 else
1404 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001405 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001406 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001407 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001408 &varargs, &default_args,
1409 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001410 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001411 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001412 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001413 {
1414 if (types_optional)
1415 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001416 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001417 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001418 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001419 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001420
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001421 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1422 if (ret_type != NULL)
1423 {
1424 ret_type = vim_strsave(ret_type);
1425 tofree2 = ret_type;
1426 }
1427
Bram Moolenaare38eab22019-12-05 21:50:01 +01001428 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001429 if (evaluate)
1430 eval_lavars_used = &eval_lavars;
1431
Bram Moolenaar65c44152020-12-24 15:14:01 +01001432 *arg = skipwhite_and_linebreak(*arg, evalarg);
1433
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001434 // Recognize "{" as the start of a function body.
1435 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001436 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001437 if (evalarg == NULL)
1438 // cannot happen?
1439 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001440 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001441 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1442 types_optional ? &argtypes : NULL, varargs,
1443 &default_args, ret_type) == FAIL)
1444 goto errret;
1445 goto theend;
1446 }
1447 if (default_args.ga_len > 0)
1448 {
1449 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001450 goto errret;
1451 }
1452
Bram Moolenaare38eab22019-12-05 21:50:01 +01001453 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001454 start = *arg;
1455 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456 if (ret == FAIL)
1457 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001458
Bram Moolenaar65c44152020-12-24 15:14:01 +01001459 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001460 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001461 *arg = skipwhite_and_linebreak(*arg, evalarg);
1462 if (**arg != '}')
1463 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001464 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001465 goto errret;
1466 }
1467 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001468 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001469
1470 if (evaluate)
1471 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001472 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001473 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001474 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001475 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001476 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001477
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001478 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001479 if (fp == NULL)
1480 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001481 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001482 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001483 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001484 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001486 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001487 if (ga_grow(&newlines, 1) == FAIL)
1488 goto errret;
1489
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001490 // If there are line breaks, we need to split up the string.
1491 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001492 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001493 line_end = end;
1494
1495 // Add "return " before the expression (or the first line).
1496 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001497 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 if (p == NULL)
1499 goto errret;
1500 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1501 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001502 vim_strncpy(p + 7, start, line_end - start);
1503
1504 if (line_end != end)
1505 {
1506 // Add more lines, split by line breaks. Thus is used when a
1507 // lambda with { cmds } is encountered.
1508 while (*line_end == '\n')
1509 {
1510 if (ga_grow(&newlines, 1) == FAIL)
1511 goto errret;
1512 start = line_end + 1;
1513 line_end = vim_strchr(start, '\n');
1514 if (line_end == NULL)
1515 line_end = end;
1516 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1517 vim_strnsave(start, line_end - start);
1518 }
1519 }
1520
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001521 if (strstr((char *)p + 7, "a:") == NULL)
1522 // No a: variables are used for sure.
1523 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001524
1525 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001526 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001527 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001528 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001529 if (types_optional)
1530 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001531 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001532 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001533 goto errret;
1534 if (ret_type != NULL)
1535 {
1536 fp->uf_ret_type = parse_type(&ret_type,
1537 &fp->uf_type_list, TRUE);
1538 if (fp->uf_ret_type == NULL)
1539 goto errret;
1540 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001541 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001542 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001543 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001544
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001545 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001546 if (current_funccal != NULL && eval_lavars)
1547 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001548 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001549 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001550 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552
1553#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554 if (prof_def_func())
1555 func_do_profile(fp);
1556#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001557 if (sandbox)
1558 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001559 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001560 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001561 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001562 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001564 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001565 // Use the line number of the arguments.
1566 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001567
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001568 function_using_block_scopes(fp, evalarg->eval_cstack);
1569
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001570 pt->pt_func = fp;
1571 pt->pt_refcount = 1;
1572 rettv->vval.v_partial = pt;
1573 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001574
1575 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001578theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001579 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001580 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001581 if (types_optional)
1582 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001583
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 return OK;
1585
1586errret:
1587 ga_clear_strings(&newargs);
1588 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001589 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001590 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001591 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001592 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001593 if (fp != NULL)
1594 vim_free(fp->uf_arg_types);
1595 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001596 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001597 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001598 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001599 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 return FAIL;
1601}
1602
1603/*
1604 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1605 * name it contains, otherwise return "name".
1606 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1607 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001608 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1609 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001610 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001611 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 */
1613 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001614deref_func_name(
1615 char_u *name,
1616 int *lenp,
1617 partial_T **partialp,
1618 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001619 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001620 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001621 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622{
1623 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001624 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001626 char_u *s = NULL;
1627 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001628 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629
1630 if (partialp != NULL)
1631 *partialp = NULL;
1632
1633 cc = name[*lenp];
1634 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001635
Bram Moolenaar71f21932022-01-07 18:20:55 +00001636 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001638 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001640 tv = &v->di_tv;
1641 }
1642 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1643 {
1644 imported_T *import;
1645 char_u *p = name;
1646 int len = *lenp;
1647
1648 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001650 p = name + 2;
1651 len -= 2;
1652 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001653 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001654
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001655 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001656 if (import != NULL)
1657 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001658 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001659 if (new_function)
1660 semsg(_(e_redefining_imported_item_str), name);
1661 else
1662 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001663 name[len] = cc;
1664 *lenp = 0;
1665 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001666 }
1667 }
1668
1669 if (tv != NULL)
1670 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001671 if (found_var != NULL)
1672 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001673 if (tv->v_type == VAR_FUNC)
1674 {
1675 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001676 {
1677 *lenp = 0;
1678 return (char_u *)""; // just in case
1679 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001680 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001681 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001682 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001684 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001686 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001687
1688 if (pt == NULL)
1689 {
1690 *lenp = 0;
1691 return (char_u *)""; // just in case
1692 }
1693 if (partialp != NULL)
1694 *partialp = pt;
1695 s = partial_name(pt);
1696 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001698
1699 if (s != NULL)
1700 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001701 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001702 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001703 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001704
1705 if (sv != NULL)
1706 *type = sv->sv_type;
1707 }
1708 return s;
1709 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 }
1711
1712 return name;
1713}
1714
1715/*
1716 * Give an error message with a function name. Handle <SNR> things.
1717 * "ermsg" is to be passed without translation, use N_() instead of _().
1718 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001719 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720emsg_funcname(char *ermsg, char_u *name)
1721{
Bram Moolenaar54598062022-01-13 12:05:09 +00001722 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723
Bram Moolenaar54598062022-01-13 12:05:09 +00001724 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001726 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001727 if (p != name)
1728 vim_free(p);
1729}
1730
1731/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001732 * Get function arguments at "*arg" and advance it.
1733 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001734 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001735 */
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001736 static int
1737get_func_arguments(
1738 char_u **arg,
1739 evalarg_T *evalarg,
1740 int partial_argc,
1741 typval_T *argvars,
1742 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001744 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001746 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001747 int evaluate = evalarg == NULL
1748 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001750 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001752 // skip the '(' or ',' and possibly line breaks
1753 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1754
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001755 if (*argp == ')' || *argp == ',' || *argp == NUL)
1756 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001757 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758 {
1759 ret = FAIL;
1760 break;
1761 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001762 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001763 // The comma should come right after the argument, but this wasn't
1764 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001765 if (vim9script)
1766 {
1767 if (*argp != ',' && *skipwhite(argp) == ',')
1768 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001769 if (evaluate)
1770 semsg(_(e_no_white_space_allowed_before_str_str),
1771 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001772 ret = FAIL;
1773 break;
1774 }
1775 }
1776 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001777 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778 if (*argp != ',')
1779 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001780 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1781 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001782 if (evaluate)
1783 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001784 ret = FAIL;
1785 break;
1786 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001788
Bram Moolenaare6b53242020-07-01 17:28:33 +02001789 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790 if (*argp == ')')
1791 ++argp;
1792 else
1793 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001794 *arg = argp;
1795 return ret;
1796}
1797
1798/*
1799 * Call a function and put the result in "rettv".
1800 * Return OK or FAIL.
1801 */
1802 int
1803get_func_tv(
1804 char_u *name, // name of the function
1805 int len, // length of "name" or -1 to use strlen()
1806 typval_T *rettv,
1807 char_u **arg, // argument, pointing to the '('
1808 evalarg_T *evalarg, // for line continuation
1809 funcexe_T *funcexe) // various values
1810{
1811 char_u *argp;
1812 int ret = OK;
1813 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1814 int argcount = 0; // number of arguments found
1815 int vim9script = in_vim9script();
1816 int evaluate = evalarg == NULL
1817 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1818
1819 argp = *arg;
1820 ret = get_func_arguments(&argp, evalarg,
1821 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1822 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823
1824 if (ret == OK)
1825 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001826 int i = 0;
1827 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828
1829 if (get_vim_var_nr(VV_TESTING))
1830 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001831 // Prepare for calling test_garbagecollect_now(), need to know
1832 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001834 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001835 for (i = 0; i < argcount; ++i)
1836 if (ga_grow(&funcargs, 1) == OK)
1837 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1838 &argvars[i];
1839 }
1840
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001841 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001842 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001843 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001844 // An error in a builtin function does not return FAIL, but we do
1845 // want to abort further processing if an error was given.
1846 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001847 clear_tv(rettv);
1848 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849
1850 funcargs.ga_len -= i;
1851 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001852 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 {
1854 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001855 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001857 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 }
1859
1860 while (--argcount >= 0)
1861 clear_tv(&argvars[argcount]);
1862
Bram Moolenaar4525a572022-02-13 11:57:33 +00001863 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001864 *arg = argp;
1865 else
1866 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001867 return ret;
1868}
1869
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001870/*
1871 * Return TRUE if "p" starts with "<SID>" or "s:".
1872 * Only works if eval_fname_script() returned non-zero for "p"!
1873 */
1874 static int
1875eval_fname_sid(char_u *p)
1876{
1877 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1878}
1879
1880/*
1881 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1882 * Change <SNR>123_name() to K_SNR 123_name().
1883 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1884 * (slow).
1885 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001886 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001887fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1888{
1889 int llen;
1890 char_u *fname;
1891 int i;
1892
1893 llen = eval_fname_script(name);
1894 if (llen > 0)
1895 {
1896 fname_buf[0] = K_SPECIAL;
1897 fname_buf[1] = KS_EXTRA;
1898 fname_buf[2] = (int)KE_SNR;
1899 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001900 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001901 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001902 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001903 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001904 else
1905 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001906 sprintf((char *)fname_buf + 3, "%ld_",
1907 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001908 i = (int)STRLEN(fname_buf);
1909 }
1910 }
1911 if (i + STRLEN(name + llen) < FLEN_FIXED)
1912 {
1913 STRCPY(fname_buf + i, name + llen);
1914 fname = fname_buf;
1915 }
1916 else
1917 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001918 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001920 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001921 else
1922 {
1923 *tofree = fname;
1924 mch_memmove(fname, fname_buf, (size_t)i);
1925 STRCPY(fname + i, name + llen);
1926 }
1927 }
1928 }
1929 else
1930 fname = name;
1931 return fname;
1932}
1933
1934/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001935 * Concatenate the script ID and function name into "<SNR>99_name".
1936 * "buffer" must have size MAX_FUNC_NAME_LEN.
1937 */
1938 void
1939func_name_with_sid(char_u *name, int sid, char_u *buffer)
1940{
1941 // A script-local function is stored as "<SNR>99_name".
1942 buffer[0] = K_SPECIAL;
1943 buffer[1] = KS_EXTRA;
1944 buffer[2] = (int)KE_SNR;
1945 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1946 (long)sid, name);
1947}
1948
1949/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001950 * Find a function "name" in script "sid".
1951 */
1952 static ufunc_T *
1953find_func_with_sid(char_u *name, int sid)
1954{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001955 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001956 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001957
Bram Moolenaarb8822442022-01-11 15:24:05 +00001958 if (!SCRIPT_ID_VALID(sid))
1959 return NULL; // not in a script
1960
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001961 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001962 hi = hash_find(&func_hashtab, buffer);
1963 if (!HASHITEM_EMPTY(hi))
1964 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001965 return NULL;
1966}
1967
1968/*
1969 * Find a function "name" in script "sid" prefixing the autoload prefix.
1970 */
1971 static ufunc_T *
1972find_func_with_prefix(char_u *name, int sid)
1973{
1974 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001975 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001976 scriptitem_T *si;
1977
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001978 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001979 return NULL; // already has the prefix
1980 if (!SCRIPT_ID_VALID(sid))
1981 return NULL; // not in a script
1982 si = SCRIPT_ITEM(sid);
1983 if (si->sn_autoload_prefix != NULL)
1984 {
1985 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1986 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001987 char_u *namep;
1988
1989 // skip a "<SNR>99_" prefix
1990 namep = untrans_function_name(name);
1991 if (namep == NULL)
1992 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001993
1994 // An exported function in an autoload script is stored as
1995 // "dir#path#name".
1996 if (len < sizeof(buffer))
1997 auto_name = buffer;
1998 else
1999 auto_name = alloc(len);
2000 if (auto_name != NULL)
2001 {
2002 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002003 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002004 hi = hash_find(&func_hashtab, auto_name);
2005 if (auto_name != buffer)
2006 vim_free(auto_name);
2007 if (!HASHITEM_EMPTY(hi))
2008 return HI2UF(hi);
2009 }
2010 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002011
2012 return NULL;
2013}
2014
2015/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002016 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002017 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2018 * functions.
2019 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002020 * Return NULL for unknown function.
2021 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002022 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002023find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002024{
2025 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002026 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002028 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002029 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002030 // Find script-local function before global one.
2031 if (in_vim9script() && eval_isnamec1(*name)
2032 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002033 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002034 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2035 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002036 if (func != NULL)
2037 return func;
2038 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002039 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2040 {
2041 char_u *p = name + 5;
2042 long sid;
2043
2044 // printable "<SNR>123_Name" form
2045 sid = getdigits(&p);
2046 if (*p == '_')
2047 {
2048 func = find_func_with_sid(p + 1, (int)sid);
2049 if (func != NULL)
2050 return func;
2051 }
2052 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002053 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002054
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002055 if ((flags & FFED_NO_GLOBAL) == 0)
2056 {
2057 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002058 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002059 if (!HASHITEM_EMPTY(hi))
2060 return HI2UF(hi);
2061 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002062
Bram Moolenaarb8822442022-01-11 15:24:05 +00002063 // Find autoload function if this is an autoload script.
2064 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2065 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002066}
2067
2068/*
2069 * Find a function by name, return pointer to it in ufuncs.
2070 * "cctx" is passed in a :def function to find imported functions.
2071 * Return NULL for unknown or dead function.
2072 */
2073 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002074find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002075{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002076 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002077
2078 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2079 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002080 return NULL;
2081}
2082
2083/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002084 * Return TRUE if "ufunc" is a global function.
2085 */
2086 int
2087func_is_global(ufunc_T *ufunc)
2088{
2089 return ufunc->uf_name[0] != K_SPECIAL;
2090}
2091
2092/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002093 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2094 */
2095 int
2096func_requires_g_prefix(ufunc_T *ufunc)
2097{
2098 return ufunc->uf_name[0] != K_SPECIAL
2099 && (ufunc->uf_flags & FC_LAMBDA) == 0
2100 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2101}
2102
2103/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002104 * Copy the function name of "fp" to buffer "buf".
2105 * "buf" must be able to hold the function name plus three bytes.
2106 * Takes care of script-local function names.
2107 */
2108 static void
2109cat_func_name(char_u *buf, ufunc_T *fp)
2110{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002111 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002112 {
2113 STRCPY(buf, "<SNR>");
2114 STRCAT(buf, fp->uf_name + 3);
2115 }
2116 else
2117 STRCPY(buf, fp->uf_name);
2118}
2119
2120/*
2121 * Add a number variable "name" to dict "dp" with value "nr".
2122 */
2123 static void
2124add_nr_var(
2125 dict_T *dp,
2126 dictitem_T *v,
2127 char *name,
2128 varnumber_T nr)
2129{
2130 STRCPY(v->di_key, name);
2131 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2132 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2133 v->di_tv.v_type = VAR_NUMBER;
2134 v->di_tv.v_lock = VAR_FIXED;
2135 v->di_tv.vval.v_number = nr;
2136}
2137
2138/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002139 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002140 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002141 static void
2142free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002143{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002144 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002145
Bram Moolenaarca16c602022-09-06 18:57:08 +01002146 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002147 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002148 ufunc_T *fp = ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002149
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002150 // When garbage collecting a funccall_T may be freed before the
2151 // function that references it, clear its uf_scoped field.
2152 // The function may have been redefined and point to another
2153 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002154 if (fp != NULL && fp->uf_scoped == fc)
2155 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002156 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002157 ga_clear(&fc->fc_ufuncs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002158
Bram Moolenaarca16c602022-09-06 18:57:08 +01002159 func_ptr_unref(fc->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002160 vim_free(fc);
2161}
2162
2163/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002164 * Free "fc" and what it contains.
2165 * Can be called only when "fc" is kept beyond the period of it called,
2166 * i.e. after cleanup_function_call(fc).
2167 */
2168 static void
2169free_funccal_contents(funccall_T *fc)
2170{
2171 listitem_T *li;
2172
2173 // Free all l: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002174 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002175
2176 // Free all a: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002177 vars_clear(&fc->fc_l_avars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002178
2179 // Free the a:000 variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002180 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002181 clear_tv(&li->li_tv);
2182
2183 free_funccal(fc);
2184}
2185
2186/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002187 * Handle the last part of returning from a function: free the local hashtable.
2188 * Unless it is still in use by a closure.
2189 */
2190 static void
2191cleanup_function_call(funccall_T *fc)
2192{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002193 int may_free_fc = fc->fc_refcount <= 0;
2194 int free_fc = TRUE;
2195
Bram Moolenaarca16c602022-09-06 18:57:08 +01002196 current_funccal = fc->fc_caller;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002197
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002198 // Free all l: variables if not referred.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002199 if (may_free_fc && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT)
2200 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002201 else
2202 free_fc = FALSE;
2203
2204 // If the a:000 list and the l: and a: dicts are not referenced and
2205 // there is no closure using it, we can free the funccall_T and what's
2206 // in it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002207 if (may_free_fc && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)
2208 vars_clear_ext(&fc->fc_l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002209 else
2210 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002211 int todo;
2212 hashitem_T *hi;
2213 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002214
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002215 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002216
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002217 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002218 todo = (int)fc->fc_l_avars.dv_hashtab.ht_used;
2219 for (hi = fc->fc_l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002220 {
2221 if (!HASHITEM_EMPTY(hi))
2222 {
2223 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002224 di = HI2DI(hi);
2225 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002226 }
2227 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002228 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002229
Bram Moolenaarca16c602022-09-06 18:57:08 +01002230 if (may_free_fc && fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2231 fc->fc_l_varlist.lv_first = NULL;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002232 else
2233 {
2234 listitem_T *li;
2235
2236 free_fc = FALSE;
2237
2238 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002239 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002240 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002241 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002242
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002243 if (free_fc)
2244 free_funccal(fc);
2245 else
2246 {
2247 static int made_copy = 0;
2248
2249 // "fc" is still in use. This can happen when returning "a:000",
2250 // assigning "l:" to a global variable or defining a closure.
2251 // Link "fc" in the list for garbage collection later.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002252 fc->fc_caller = previous_funccal;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002253 previous_funccal = fc;
2254
2255 if (want_garbage_collect)
2256 // If garbage collector is ready, clear count.
2257 made_copy = 0;
2258 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002259 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002260 // We have made a lot of copies, worth 4 Mbyte. This can happen
2261 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002262 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002263 // too much memory.
2264 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002265 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002266 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002267 }
2268}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002269
2270/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002271 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2272 */
2273 static int
2274numbered_function(char_u *name)
2275{
2276 return isdigit(*name)
2277 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2278}
2279
2280/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002281 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002282 * 1. ordinary names, function defined with :function or :def;
2283 * can start with "<SNR>123_" literally or with K_SPECIAL.
2284 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002285 * For the first we only count the name stored in func_hashtab as a reference,
2286 * using function() does not count as a reference, because the function is
2287 * looked up by name.
2288 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002289 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002290func_name_refcount(char_u *name)
2291{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002292 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002293}
2294
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002295/*
2296 * Unreference "fc": decrement the reference count and free it when it
2297 * becomes zero. "fp" is detached from "fc".
2298 * When "force" is TRUE we are exiting.
2299 */
2300 static void
2301funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2302{
2303 funccall_T **pfc;
2304 int i;
2305
2306 if (fc == NULL)
2307 return;
2308
2309 if (--fc->fc_refcount <= 0 && (force || (
Bram Moolenaarca16c602022-09-06 18:57:08 +01002310 fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT
2311 && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT
2312 && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2313 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->fc_caller)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002314 {
2315 if (fc == *pfc)
2316 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002317 *pfc = fc->fc_caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002318 free_funccal_contents(fc);
2319 return;
2320 }
2321 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002322 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
2323 if (((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] == fp)
2324 ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002325}
2326
2327/*
2328 * Remove the function from the function hashtable. If the function was
2329 * deleted while it still has references this was already done.
2330 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2331 */
2332 static int
2333func_remove(ufunc_T *fp)
2334{
2335 hashitem_T *hi;
2336
2337 // Return if it was already virtually deleted.
2338 if (fp->uf_flags & FC_DEAD)
2339 return FALSE;
2340
2341 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2342 if (!HASHITEM_EMPTY(hi))
2343 {
2344 // When there is a def-function index do not actually remove the
2345 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002346 // Do remove it when it's a copy.
2347 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002348 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002349 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002350 return FALSE;
2351 }
2352 hash_remove(&func_hashtab, hi);
2353 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002354 return TRUE;
2355 }
2356 return FALSE;
2357}
2358
2359 static void
2360func_clear_items(ufunc_T *fp)
2361{
2362 ga_clear_strings(&(fp->uf_args));
2363 ga_clear_strings(&(fp->uf_def_args));
2364 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002365 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002366 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002367 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002368 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002369
2370 // Increment the refcount of this function to avoid it being freed
2371 // recursively when the partial is freed.
2372 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002373 partial_unref(fp->uf_partial);
2374 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002375 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002376
2377#ifdef FEAT_LUA
2378 if (fp->uf_cb_free != NULL)
2379 {
2380 fp->uf_cb_free(fp->uf_cb_state);
2381 fp->uf_cb_free = NULL;
2382 }
2383
2384 fp->uf_cb_state = NULL;
2385 fp->uf_cb = NULL;
2386#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002387#ifdef FEAT_PROFILE
2388 VIM_CLEAR(fp->uf_tml_count);
2389 VIM_CLEAR(fp->uf_tml_total);
2390 VIM_CLEAR(fp->uf_tml_self);
2391#endif
2392}
2393
2394/*
2395 * Free all things that a function contains. Does not free the function
2396 * itself, use func_free() for that.
2397 * When "force" is TRUE we are exiting.
2398 */
2399 static void
2400func_clear(ufunc_T *fp, int force)
2401{
2402 if (fp->uf_cleared)
2403 return;
2404 fp->uf_cleared = TRUE;
2405
2406 // clear this function
2407 func_clear_items(fp);
2408 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002409 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002410}
2411
2412/*
2413 * Free a function and remove it from the list of functions. Does not free
2414 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002415 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002416 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002417 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002418 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002419func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002420{
2421 // Only remove it when not done already, otherwise we would remove a newer
2422 // version of the function with the same name.
2423 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2424 func_remove(fp);
2425
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002426 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002427 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002428 if (fp->uf_dfunc_idx > 0)
2429 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002430 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002431 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002432 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002433 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002434 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002435}
2436
2437/*
2438 * Free all things that a function contains and free the function itself.
2439 * When "force" is TRUE we are exiting.
2440 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002441 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002442func_clear_free(ufunc_T *fp, int force)
2443{
2444 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002445 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2446 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002447 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002448 else
2449 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002450}
2451
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002452/*
2453 * Copy already defined function "lambda" to a new function with name "global".
2454 * This is for when a compiled function defines a global function.
2455 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002456 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002457copy_lambda_to_global_func(
Bram Moolenaarcc341812022-09-19 15:54:34 +01002458 char_u *lambda,
2459 char_u *global,
2460 loopvarinfo_T *loopvarinfo,
2461 ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002462{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002463 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002464 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002465
2466 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002467 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002468 semsg(_(e_lambda_function_not_found_str), lambda);
2469 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002470 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002471
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002472 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002473 if (fp != NULL)
2474 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002475 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002476 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002477 return FAIL;
2478 }
2479
2480 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2481 if (fp == NULL)
2482 return FAIL;
2483
2484 fp->uf_varargs = ufunc->uf_varargs;
2485 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2486 fp->uf_def_status = ufunc->uf_def_status;
2487 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2488 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2489 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2490 == FAIL
2491 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2492 goto failed;
2493
2494 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2495 : vim_strsave(ufunc->uf_name_exp);
2496 if (ufunc->uf_arg_types != NULL)
2497 {
2498 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2499 if (fp->uf_arg_types == NULL)
2500 goto failed;
2501 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2502 sizeof(type_T *) * fp->uf_args.ga_len);
2503 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002504 if (ufunc->uf_va_name != NULL)
2505 {
2506 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2507 if (fp->uf_va_name == NULL)
2508 goto failed;
2509 }
2510 fp->uf_ret_type = ufunc->uf_ret_type;
2511
2512 fp->uf_refcount = 1;
2513 STRCPY(fp->uf_name, global);
2514 hash_add(&func_hashtab, UF2HIKEY(fp));
2515
2516 // the referenced dfunc_T is now used one more time
2517 link_def_function(fp);
2518
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002519 // Create a partial to store the context of the function where it was
2520 // instantiated. Only needs to be done once. Do this on the original
2521 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002522 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2523 {
2524 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2525
2526 if (pt == NULL)
2527 goto failed;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002528 if (fill_partial_and_closure(pt, ufunc, loopvarinfo, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002529 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002530 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002531 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002532 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002533 ufunc->uf_partial = pt;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002534 }
2535
2536 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002537
2538failed:
2539 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002540 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002541}
2542
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002543static int funcdepth = 0;
2544
2545/*
2546 * Increment the function call depth count.
2547 * Return FAIL when going over 'maxfuncdepth'.
2548 * Otherwise return OK, must call funcdepth_decrement() later!
2549 */
2550 int
2551funcdepth_increment(void)
2552{
2553 if (funcdepth >= p_mfd)
2554 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002555 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002556 return FAIL;
2557 }
2558 ++funcdepth;
2559 return OK;
2560}
2561
2562 void
2563funcdepth_decrement(void)
2564{
2565 --funcdepth;
2566}
2567
2568/*
2569 * Get the current function call depth.
2570 */
2571 int
2572funcdepth_get(void)
2573{
2574 return funcdepth;
2575}
2576
2577/*
2578 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002579 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002580 * times as funcdepth_increment().
2581 */
2582 void
2583funcdepth_restore(int depth)
2584{
2585 funcdepth = depth;
2586}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002587
2588/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002589 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2590 * "rettv".
2591 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2592 * Returns NULL when allocation fails.
2593 */
2594 funccall_T *
2595create_funccal(ufunc_T *fp, typval_T *rettv)
2596{
2597 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2598
2599 if (fc == NULL)
2600 return NULL;
2601 fc->fc_caller = current_funccal;
2602 current_funccal = fc;
2603 fc->fc_func = fp;
2604 func_ptr_ref(fp);
2605 fc->fc_rettv = rettv;
2606 return fc;
2607}
2608
2609/*
2610 * To be called when returning from a compiled function; restores
2611 * current_funccal.
2612 */
2613 void
2614remove_funccal()
2615{
2616 funccall_T *fc = current_funccal;
2617
2618 current_funccal = fc->fc_caller;
2619 free_funccal(fc);
2620}
2621
2622/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002623 * Call a user function.
2624 */
2625 static void
2626call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002627 ufunc_T *fp, // pointer to function
2628 int argcount, // nr of args
2629 typval_T *argvars, // arguments
2630 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002631 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002632 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002634 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002635 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002636 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002637 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 funccall_T *fc;
2639 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002640 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002641 dictitem_T *v;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002642 int fixvar_idx = 0; // index in fc_fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002643 int i;
2644 int ai;
2645 int islambda = FALSE;
2646 char_u numbuf[NUMBUFLEN];
2647 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002648 typval_T *tv_to_free[MAX_FUNC_ARGS];
2649 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002651 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002653 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002654
Bram Moolenaarb2049902021-01-24 12:53:53 +01002655#ifdef FEAT_PROFILE
2656 CLEAR_FIELD(profile_info);
2657#endif
2658
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002659 // If depth of calling is getting too high, don't execute the function.
2660 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002662 rettv->v_type = VAR_NUMBER;
2663 rettv->vval.v_number = -1;
2664 return;
2665 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666
Bram Moolenaare38eab22019-12-05 21:50:01 +01002667 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002668
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002669 fc = create_funccal(fp, rettv);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002670 if (fc == NULL)
2671 return;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002672 fc->fc_level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002673 // Check if this function has a breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002674 fc->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2675 fc->fc_dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002676 // Set up fields for closure.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002677 ga_init2(&fc->fc_ufuncs, sizeof(ufunc_T *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002678
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002679 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002680 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002681#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01002682 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002683#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002684 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002685#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002686 if (do_profiling == PROF_YES)
2687 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002688#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002689 sticky_cmdmod_flags = 0;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01002690 call_def_function(fp, argcount, argvars, 0, funcexe->fe_partial,
Bram Moolenaar58779852022-09-06 18:31:14 +01002691 fc, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002692 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002693#ifdef FEAT_PROFILE
2694 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002695 || (caller != NULL && caller->uf_profiling)))
2696 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002697#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002698 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002699 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002700 return;
2701 }
2702
Bram Moolenaar38453522021-11-28 22:00:12 +00002703 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704
2705 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002706 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2707 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2708 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 */
2710 /*
2711 * Init l: variables.
2712 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002713 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 if (selfdict != NULL)
2715 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002716 // Set l:self to "selfdict". Use "name" to avoid a warning from
2717 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002718 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002719 name = v->di_key;
2720 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002721 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002722 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002723 v->di_tv.v_type = VAR_DICT;
2724 v->di_tv.v_lock = 0;
2725 v->di_tv.vval.v_dict = selfdict;
2726 ++selfdict->dv_refcount;
2727 }
2728
2729 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002730 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002731 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002732 * Set a:000 to a list with room for the "..." arguments.
2733 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002734 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002735 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002736 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002737 (varnumber_T)(argcount >= fp->uf_args.ga_len
2738 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002739 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002740 if ((fp->uf_flags & FC_NOARGS) == 0)
2741 {
2742 // Use "name" to avoid a warning from some compiler that checks the
2743 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002744 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002745 name = v->di_key;
2746 STRCPY(name, "000");
2747 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002748 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002749 v->di_tv.v_type = VAR_LIST;
2750 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002751 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002752 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002753 CLEAR_FIELD(fc->fc_l_varlist);
2754 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2755 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002756
2757 /*
2758 * Set a:firstline to "firstline" and a:lastline to "lastline".
2759 * Set a:name to named arguments.
2760 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002761 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002762 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002763 if ((fp->uf_flags & FC_NOARGS) == 0)
2764 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002765 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2766 "firstline", (varnumber_T)funcexe->fe_firstline);
2767 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2768 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002769 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002770 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002771 {
2772 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002773 typval_T def_rettv;
2774 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775
2776 ai = i - fp->uf_args.ga_len;
2777 if (ai < 0)
2778 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002779 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002780 name = FUNCARG(fp, i);
2781 if (islambda)
2782 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002783
2784 // evaluate named argument default expression
2785 isdefault = ai + fp->uf_def_args.ga_len >= 0
2786 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2787 && argvars[i].vval.v_number == VVAL_NONE));
2788 if (isdefault)
2789 {
2790 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002791
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002792 def_rettv.v_type = VAR_NUMBER;
2793 def_rettv.vval.v_number = -1;
2794
2795 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2796 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002797 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002798 {
2799 default_arg_err = 1;
2800 break;
2801 }
2802 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002803 }
2804 else
2805 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002806 if ((fp->uf_flags & FC_NOARGS) != 0)
2807 // Bail out if no a: arguments used (in lambda).
2808 break;
2809
Bram Moolenaare38eab22019-12-05 21:50:01 +01002810 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002811 sprintf((char *)numbuf, "%d", ai + 1);
2812 name = numbuf;
2813 }
2814 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2815 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002816 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002818 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002819 }
2820 else
2821 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002822 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002823 if (v == NULL)
2824 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002825 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002827
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002828 // Note: the values are copied directly to avoid alloc/free.
2829 // "argvars" must have VAR_FIXED for v_lock.
2830 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002831 v->di_tv.v_lock = VAR_FIXED;
2832
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002833 if (isdefault)
2834 // Need to free this later, no matter where it's stored.
2835 tv_to_free[tv_to_free_len++] = &v->di_tv;
2836
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002837 if (addlocal)
2838 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002839 // Named arguments should be accessed without the "a:" prefix in
2840 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002841 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002842 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002843 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002844 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01002845 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002846
2847 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2848 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002849 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002850
2851 li->li_tv = argvars[i];
2852 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002853 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002854 }
2855 }
2856
Bram Moolenaare38eab22019-12-05 21:50:01 +01002857 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002858 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002859
2860 if (fp->uf_flags & FC_SANDBOX)
2861 {
2862 using_sandbox = TRUE;
2863 ++sandbox;
2864 }
2865
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002866 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002867 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002868 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002869 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002870 ++no_wait_return;
2871 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002872
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002873 smsg(_("calling %s"), SOURCING_NAME);
2874 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002876 char_u buf[MSG_BUF_LEN];
2877 char_u numbuf2[NUMBUFLEN];
2878 char_u *tofree;
2879 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002880
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002881 msg_puts("(");
2882 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002883 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002884 if (i > 0)
2885 msg_puts(", ");
2886 if (argvars[i].v_type == VAR_NUMBER)
2887 msg_outnum((long)argvars[i].vval.v_number);
2888 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002889 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002890 // Do not want errors such as E724 here.
2891 ++emsg_off;
2892 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2893 --emsg_off;
2894 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002895 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002896 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002897 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002898 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2899 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002900 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002901 msg_puts((char *)s);
2902 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903 }
2904 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002905 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002906 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002908 msg_puts("\n"); // don't overwrite this either
2909
2910 verbose_leave_scroll();
2911 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912 }
2913#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002914 if (do_profiling == PROF_YES)
2915 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002916 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002917#endif
2918
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002919 // "legacy" does not apply to commands in the function
2920 sticky_cmdmod_flags = 0;
2921
Bram Moolenaar98aff652022-09-06 21:02:35 +01002922 // If called from a compiled :def function the execution context must be
2923 // hidden, any deferred functions need to be added to the function being
2924 // executed here.
2925 save_current_ectx = clear_currrent_ectx();
2926
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002927 save_current_sctx = current_sctx;
2928 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002929 save_did_emsg = did_emsg;
2930 did_emsg = FALSE;
2931
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002932 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2933 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002934 else if (islambda)
2935 {
2936 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2937
2938 // A Lambda always has the command "return {expr}". It is much faster
2939 // to evaluate {expr} directly.
2940 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002941 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002942 --ex_nesting_level;
2943 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002944 else
2945 // call do_cmdline() to execute the lines
2946 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002947 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2948
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002949 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01002950 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002951
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002952 --RedrawingDisabled;
2953
Bram Moolenaare38eab22019-12-05 21:50:01 +01002954 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002955 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2956 {
2957 clear_tv(rettv);
2958 rettv->v_type = VAR_NUMBER;
2959 rettv->vval.v_number = -1;
2960 }
2961
2962#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002963 if (do_profiling == PROF_YES)
2964 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002965 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002966
2967 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2968 profile_may_end_func(&profile_info, fp, caller);
2969 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002970#endif
2971
Bram Moolenaare38eab22019-12-05 21:50:01 +01002972 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002973 if (p_verbose >= 12)
2974 {
2975 ++no_wait_return;
2976 verbose_enter_scroll();
2977
2978 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002979 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002980 else if (fc->fc_rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002981 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002982 (long)fc->fc_rettv->vval.v_number);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002983 else
2984 {
2985 char_u buf[MSG_BUF_LEN];
2986 char_u numbuf2[NUMBUFLEN];
2987 char_u *tofree;
2988 char_u *s;
2989
Bram Moolenaare38eab22019-12-05 21:50:01 +01002990 // The value may be very long. Skip the middle part, so that we
2991 // have some idea how it starts and ends. smsg() would always
2992 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993 ++emsg_off;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002994 s = tv2string(fc->fc_rettv, &tofree, numbuf2, 0);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002995 --emsg_off;
2996 if (s != NULL)
2997 {
2998 if (vim_strsize(s) > MSG_BUF_CLEN)
2999 {
3000 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
3001 s = buf;
3002 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003003 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003004 vim_free(tofree);
3005 }
3006 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003007 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003008
3009 verbose_leave_scroll();
3010 --no_wait_return;
3011 }
3012
Bram Moolenaare31ee862020-01-07 20:59:34 +01003013 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003014 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003015 current_sctx = save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01003016 restore_current_ectx(save_current_ectx);
3017
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003018#ifdef FEAT_PROFILE
3019 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003020 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003021#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02003022 if (using_sandbox)
3023 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003024 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003026 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003027 {
3028 ++no_wait_return;
3029 verbose_enter_scroll();
3030
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003031 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003032 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003033
3034 verbose_leave_scroll();
3035 --no_wait_return;
3036 }
3037
3038 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01003039 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02003040 for (i = 0; i < tv_to_free_len; ++i)
3041 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003042 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003043}
3044
3045/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003046 * Check the argument count for user function "fp".
3047 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3048 */
3049 int
3050check_user_func_argcount(ufunc_T *fp, int argcount)
3051{
3052 int regular_args = fp->uf_args.ga_len;
3053
3054 if (argcount < regular_args - fp->uf_def_args.ga_len)
3055 return FCERR_TOOFEW;
3056 else if (!has_varargs(fp) && argcount > regular_args)
3057 return FCERR_TOOMANY;
3058 return FCERR_UNKNOWN;
3059}
3060
3061/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003062 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003063 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003064 int
3065call_user_func_check(
3066 ufunc_T *fp,
3067 int argcount,
3068 typval_T *argvars,
3069 typval_T *rettv,
3070 funcexe_T *funcexe,
3071 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003072{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003073 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003074
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003075#ifdef FEAT_LUA
3076 if (fp->uf_flags & FC_CFUNC)
3077 {
3078 cfunc_T cb = fp->uf_cb;
3079
3080 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3081 }
3082#endif
3083
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003084 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3085 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003086 error = check_user_func_argcount(fp, argcount);
3087 if (error != FCERR_UNKNOWN)
3088 return error;
3089 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003090 error = FCERR_DICT;
3091 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003092 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003093 int did_save_redo = FALSE;
3094 save_redo_T save_redo;
3095
3096 /*
3097 * Call the user function.
3098 * Save and restore search patterns, script variables and
3099 * redo buffer.
3100 */
3101 save_search_patterns();
3102 if (!ins_compl_active())
3103 {
3104 saveRedobuff(&save_redo);
3105 did_save_redo = TRUE;
3106 }
3107 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003108 call_user_func(fp, argcount, argvars, rettv, funcexe,
3109 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003110 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3111 // Function was unreferenced while being used, free it now.
3112 func_clear_free(fp, FALSE);
3113 if (did_save_redo)
3114 restoreRedobuff(&save_redo);
3115 restore_search_patterns();
3116 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003117 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003118 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003119}
3120
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003121static funccal_entry_T *funccal_stack = NULL;
3122
3123/*
3124 * Save the current function call pointer, and set it to NULL.
3125 * Used when executing autocommands and for ":source".
3126 */
3127 void
3128save_funccal(funccal_entry_T *entry)
3129{
3130 entry->top_funccal = current_funccal;
3131 entry->next = funccal_stack;
3132 funccal_stack = entry;
3133 current_funccal = NULL;
3134}
3135
3136 void
3137restore_funccal(void)
3138{
3139 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003140 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003141 else
3142 {
3143 current_funccal = funccal_stack->top_funccal;
3144 funccal_stack = funccal_stack->next;
3145 }
3146}
3147
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003148 funccall_T *
3149get_current_funccal(void)
3150{
3151 return current_funccal;
3152}
3153
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003154/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003155 * Return TRUE when currently at the script level:
3156 * - not in a function
3157 * - not executing an autocommand
3158 * Note that when an autocommand sources a script the result is FALSE;
3159 */
3160 int
3161at_script_level(void)
3162{
3163 return current_funccal == NULL && autocmd_match == NULL;
3164}
3165
3166/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003167 * Mark all functions of script "sid" as deleted.
3168 */
3169 void
3170delete_script_functions(int sid)
3171{
3172 hashitem_T *hi;
3173 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003174 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003175 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003176 size_t len;
3177
3178 buf[0] = K_SPECIAL;
3179 buf[1] = KS_EXTRA;
3180 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003181 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003182 len = STRLEN(buf);
3183
Bram Moolenaarce658352020-07-31 23:47:12 +02003184 while (todo > 0)
3185 {
3186 todo = func_hashtab.ht_used;
3187 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3188 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003189 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003190 fp = HI2UF(hi);
3191 if (STRNCMP(fp->uf_name, buf, len) == 0)
3192 {
3193 int changed = func_hashtab.ht_changed;
3194
3195 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003196
3197 if (fp->uf_calls > 0)
3198 {
3199 // Function is executing, don't free it but do remove
3200 // it from the hashtable.
3201 if (func_remove(fp))
3202 fp->uf_refcount--;
3203 }
3204 else
3205 {
3206 func_clear(fp, TRUE);
3207 // When clearing a function another function can be
3208 // cleared as a side effect. When that happens start
3209 // over.
3210 if (changed != func_hashtab.ht_changed)
3211 break;
3212 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003213 }
3214 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003215 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003216 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003217}
3218
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003219#if defined(EXITFREE) || defined(PROTO)
3220 void
3221free_all_functions(void)
3222{
3223 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003224 ufunc_T *fp;
3225 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003226 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003227 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003228
Bram Moolenaare38eab22019-12-05 21:50:01 +01003229 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003230 while (current_funccal != NULL)
3231 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003232 clear_tv(current_funccal->fc_rettv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003233 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003234 if (current_funccal == NULL && funccal_stack != NULL)
3235 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003236 }
3237
Bram Moolenaare38eab22019-12-05 21:50:01 +01003238 // First clear what the functions contain. Since this may lower the
3239 // reference count of a function, it may also free a function and change
3240 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003241 while (todo > 0)
3242 {
3243 todo = func_hashtab.ht_used;
3244 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3245 if (!HASHITEM_EMPTY(hi))
3246 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003247 // clear the def function index now
3248 fp = HI2UF(hi);
3249 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003250 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003251
Bram Moolenaare38eab22019-12-05 21:50:01 +01003252 // Only free functions that are not refcounted, those are
3253 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003254 if (func_name_refcount(fp->uf_name))
3255 ++skipped;
3256 else
3257 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003258 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003259 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003260 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003261 {
3262 skipped = 0;
3263 break;
3264 }
3265 }
3266 --todo;
3267 }
3268 }
3269
Bram Moolenaare38eab22019-12-05 21:50:01 +01003270 // Now actually free the functions. Need to start all over every time,
3271 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003272 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003273 while (func_hashtab.ht_used > skipped)
3274 {
3275 todo = func_hashtab.ht_used;
3276 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003277 if (!HASHITEM_EMPTY(hi))
3278 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003279 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003280 // Only free functions that are not refcounted, those are
3281 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003282 fp = HI2UF(hi);
3283 if (func_name_refcount(fp->uf_name))
3284 ++skipped;
3285 else
3286 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003287 if (func_free(fp, FALSE) == OK)
3288 {
3289 skipped = 0;
3290 break;
3291 }
3292 // did not actually free it
3293 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003294 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003295 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003296 }
3297 if (skipped == 0)
3298 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003299
3300 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003301}
3302#endif
3303
3304/*
3305 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003306 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3307 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003308 * "len" is the length of "name", or -1 for NUL terminated.
3309 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003310 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311builtin_function(char_u *name, int len)
3312{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003313 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003314
Bram Moolenaara26b9702020-04-18 19:53:28 +02003315 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003316 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003317 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3318 {
3319 if (name[i] == AUTOLOAD_CHAR)
3320 return FALSE;
3321 if (!eval_isnamec(name[i]))
3322 {
3323 // "name.something" is not a builtin function
3324 if (name[i] == '.')
3325 return FALSE;
3326 break;
3327 }
3328 }
3329 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003330}
3331
3332 int
3333func_call(
3334 char_u *name,
3335 typval_T *args,
3336 partial_T *partial,
3337 dict_T *selfdict,
3338 typval_T *rettv)
3339{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003340 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003341 listitem_T *item;
3342 typval_T argv[MAX_FUNC_ARGS + 1];
3343 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003344 int r = 0;
3345
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003346 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003347 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003348 {
3349 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3350 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003351 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003352 break;
3353 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003354 // Make a copy of each argument. This is needed to be able to set
3355 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003356 copy_tv(&item->li_tv, &argv[argc++]);
3357 }
3358
3359 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003360 {
3361 funcexe_T funcexe;
3362
Bram Moolenaara80faa82020-04-12 19:37:17 +02003363 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003364 funcexe.fe_firstline = curwin->w_cursor.lnum;
3365 funcexe.fe_lastline = curwin->w_cursor.lnum;
3366 funcexe.fe_evaluate = TRUE;
3367 funcexe.fe_partial = partial;
3368 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003369 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3370 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371
Bram Moolenaare38eab22019-12-05 21:50:01 +01003372 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003373 while (argc > 0)
3374 clear_tv(&argv[--argc]);
3375
3376 return r;
3377}
3378
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003379static int callback_depth = 0;
3380
3381 int
3382get_callback_depth(void)
3383{
3384 return callback_depth;
3385}
3386
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003387/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003388 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003389 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003390 */
3391 int
3392call_callback(
3393 callback_T *callback,
3394 int len, // length of "name" or -1 to use strlen()
3395 typval_T *rettv, // return value goes here
3396 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003397 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003398 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003399{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003400 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003401 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003402
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003403 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3404 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003405 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003406 funcexe.fe_evaluate = TRUE;
3407 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003408 ++callback_depth;
3409 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3410 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003411
3412 // When a :def function was called that uses :try an error would be turned
3413 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003414 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003415 {
3416 need_rethrow = FALSE;
3417 handle_did_throw();
3418 }
3419
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003420 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003421}
3422
3423/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003424 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003425 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003426 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3427 */
3428 varnumber_T
3429call_callback_retnr(
3430 callback_T *callback,
3431 int argcount, // number of "argvars"
3432 typval_T *argvars) // vars for arguments, must have "argcount"
3433 // PLUS ONE elements!
3434{
3435 typval_T rettv;
3436 varnumber_T retval;
3437
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003438 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003439 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003440
3441 retval = tv_get_number_chk(&rettv, NULL);
3442 clear_tv(&rettv);
3443 return retval;
3444}
3445
3446/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003447 * Give an error message for the result of a function.
3448 * Nothing if "error" is FCERR_NONE.
3449 */
3450 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003451user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003452{
3453 switch (error)
3454 {
3455 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003456 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003457 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003458 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003459 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003460 break;
3461 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003462 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003463 break;
3464 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003465 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003466 break;
3467 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003468 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003469 break;
3470 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003471 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003472 break;
3473 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003474 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003475 break;
3476 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003477 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3478 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003479 break;
3480 }
3481}
3482
3483/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003485 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003486 * Return FAIL when the function can't be called, OK otherwise.
3487 * Also returns OK when an error was encountered while executing the function.
3488 */
3489 int
3490call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003491 char_u *funcname, // name of the function
3492 int len, // length of "name" or -1 to use strlen()
3493 typval_T *rettv, // return value goes here
3494 int argcount_in, // number of "argvars"
3495 typval_T *argvars_in, // vars for arguments, must have "argcount"
3496 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003497 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498{
3499 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003500 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003502 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003503 char_u fname_buf[FLEN_FIXED + 1];
3504 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003505 char_u *fname = NULL;
3506 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 int argcount = argcount_in;
3508 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003509 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003510 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003511 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003513 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003514 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003515 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003516 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003517
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003518 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3519 // even when call_func() returns FAIL.
3520 rettv->v_type = VAR_UNKNOWN;
3521
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003522 if (partial != NULL)
3523 fp = partial->pt_func;
3524 if (fp == NULL)
3525 {
3526 // Make a copy of the name, if it comes from a funcref variable it
3527 // could be changed or deleted in the called function.
3528 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3529 if (name == NULL)
3530 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003531
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003532 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3533 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003534
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003535 if (funcexe->fe_doesrange != NULL)
3536 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003537
3538 if (partial != NULL)
3539 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003540 // When the function has a partial with a dict and there is a dict
3541 // argument, use the dict argument. That is backwards compatible.
3542 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003543 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003545 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003546 {
3547 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003548 {
3549 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3550 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003551 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003552 goto theend;
3553 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003555 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003556 for (i = 0; i < argcount_in; ++i)
3557 argv[i + argv_clear] = argvars_in[i];
3558 argvars = argv;
3559 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003560
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003561 if (funcexe->fe_check_type != NULL
3562 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003563 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003564 // Now funcexe->fe_check_type is missing the added arguments,
3565 // make a copy of the type with the correction.
3566 check_type = *funcexe->fe_check_type;
3567 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003568 check_type.tt_args = check_type_args;
3569 CLEAR_FIELD(check_type_args);
3570 for (i = 0; i < check_type.tt_argcount; ++i)
3571 check_type_args[i + partial->pt_argc] =
3572 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003573 check_type.tt_argcount += partial->pt_argc;
3574 check_type.tt_min_argcount += partial->pt_argc;
3575 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003576 }
3577 }
3578
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003579 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3580 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003581 {
3582 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003583 if (check_argument_types(funcexe->fe_check_type,
3584 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003585 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003586 error = FCERR_OTHER;
3587 }
3588
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003589 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003590 {
3591 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003592 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003593
Bram Moolenaar333894b2020-08-01 18:53:07 +02003594 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003595 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003596 {
3597 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003599 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003600
Bram Moolenaare38eab22019-12-05 21:50:01 +01003601 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003603 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003605 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003606 {
3607 /*
3608 * User defined function.
3609 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003610 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003611 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003612 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003613 if (fp != NULL && !is_global && in_vim9script()
3614 && func_requires_g_prefix(fp))
3615 // In Vim9 script g: is required to find a global
3616 // non-autoload function.
3617 fp = NULL;
3618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619
Bram Moolenaare38eab22019-12-05 21:50:01 +01003620 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003621 if (fp == NULL
3622 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003623 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003624 && !aborting())
3625 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003626 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003627 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003629 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003630 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3631 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003632 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003633 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003634 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003635 if (fp == NULL)
3636 {
3637 char_u *p = untrans_function_name(rfname);
3638
3639 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003640 // Don't do this if the name starts with "s:".
3641 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003642 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003643 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003644
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003645 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003646 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003647 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003648 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003649 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003650 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003651 argcount = funcexe->fe_argv_func(argcount, argvars,
zeertzjq48db5da2022-09-16 12:10:03 +01003652 argv_clear, fp);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003653
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003654 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003655 {
3656 // Method call: base->Method()
3657 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003658 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003659 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003660 argvars = argv;
3661 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003662 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003663
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003664 error = call_user_func_check(fp, argcount, argvars, rettv,
3665 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003666 }
3667 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003668 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003669 {
3670 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003671 * expr->method(): Find the method name in the table, call its
3672 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003673 */
3674 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003675 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003676 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003677 else
3678 {
3679 /*
3680 * Find the function name in the table, call its implementation.
3681 */
3682 error = call_internal_func(fname, argcount, argvars, rettv);
3683 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003684
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003685 /*
3686 * The function call (or "FuncUndefined" autocommand sequence) might
3687 * have been aborted by an error, an interrupt, or an explicitly thrown
3688 * exception that has not been caught so far. This situation can be
3689 * tested for by calling aborting(). For an error in an internal
3690 * function or for the "E132" error in call_user_func(), however, the
3691 * throw point at which the "force_abort" flag (temporarily reset by
3692 * emsg()) is normally updated has not been reached yet. We need to
3693 * update that flag first to make aborting() reliable.
3694 */
3695 update_force_abort();
3696 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003697 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003698 ret = OK;
3699
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003700theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003701 /*
3702 * Report an error unless the argument evaluation or function call has been
3703 * cancelled due to an aborting error, an interrupt, or an exception.
3704 */
3705 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003706 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003708 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003710 clear_tv(&argv[--argv_clear + argv_base]);
3711
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 vim_free(tofree);
3713 vim_free(name);
3714
3715 return ret;
3716}
3717
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003718 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003719printable_func_name(ufunc_T *fp)
3720{
3721 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3722}
3723
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003725 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003726 */
3727 static void
3728list_func_head(ufunc_T *fp, int indent)
3729{
3730 int j;
3731
3732 msg_start();
3733 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003734 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003735 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003736 msg_puts("def ");
3737 else
3738 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003739 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003740 msg_putchar('(');
3741 for (j = 0; j < fp->uf_args.ga_len; ++j)
3742 {
3743 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003744 msg_puts(", ");
3745 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003746 if (fp->uf_arg_types != NULL)
3747 {
3748 char *tofree;
3749
3750 msg_puts(": ");
3751 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3752 vim_free(tofree);
3753 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003754 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3755 {
3756 msg_puts(" = ");
3757 msg_puts(((char **)(fp->uf_def_args.ga_data))
3758 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3759 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003760 }
3761 if (fp->uf_varargs)
3762 {
3763 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003764 msg_puts(", ");
3765 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003766 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003767 if (fp->uf_va_name != NULL)
3768 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003769 if (!fp->uf_varargs)
3770 {
3771 if (j)
3772 msg_puts(", ");
3773 msg_puts("...");
3774 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003775 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003776 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003777 {
3778 char *tofree;
3779
3780 msg_puts(": ");
3781 msg_puts(type_name(fp->uf_va_type, &tofree));
3782 vim_free(tofree);
3783 }
3784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003785 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003786
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003787 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003788 {
3789 if (fp->uf_ret_type != &t_void)
3790 {
3791 char *tofree;
3792
3793 msg_puts(": ");
3794 msg_puts(type_name(fp->uf_ret_type, &tofree));
3795 vim_free(tofree);
3796 }
3797 }
3798 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003799 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003801 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003802 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003803 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003804 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003805 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003806 msg_clr_eos();
3807 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003808 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003809}
3810
3811/*
3812 * Get a function name, translating "<SID>" and "<SNR>".
3813 * Also handles a Funcref in a List or Dictionary.
3814 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003815 * Set "*is_global" to TRUE when the function must be global, unless
3816 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 * flags:
3818 * TFN_INT: internal function name OK
3819 * TFN_QUIET: be quiet
3820 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003821 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003822 * Advances "pp" to just after the function name (if no error).
3823 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003824 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825trans_function_name(
3826 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003827 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003828 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003829 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003830 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003831 partial_T **partial, // return: partial of a FuncRef
3832 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003833{
3834 char_u *name = NULL;
3835 char_u *start;
3836 char_u *end;
3837 int lead;
3838 char_u sid_buf[20];
3839 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003840 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003841 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003842 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003843 int vim9script = in_vim9script();
3844 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003845
3846 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003847 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003848 start = *pp;
3849
Bram Moolenaare38eab22019-12-05 21:50:01 +01003850 // Check for hard coded <SNR>: already translated function ID (from a user
3851 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3853 && (*pp)[2] == (int)KE_SNR)
3854 {
3855 *pp += 3;
3856 len = get_id_len(pp) + 3;
3857 return vim_strnsave(start, len);
3858 }
3859
Bram Moolenaare38eab22019-12-05 21:50:01 +01003860 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3861 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003862 lead = eval_fname_script(start);
3863 if (lead > 2)
3864 start += lead;
3865
Bram Moolenaare38eab22019-12-05 21:50:01 +01003866 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003867 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003868 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003869 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003870 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003871 {
3872 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003873 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003874 goto theend;
3875 }
3876 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3877 {
3878 /*
3879 * Report an invalid expression in braces, unless the expression
3880 * evaluation has been cancelled due to an aborting error, an
3881 * interrupt, or an exception.
3882 */
3883 if (!aborting())
3884 {
3885 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003886 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003887 }
3888 else
3889 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3890 goto theend;
3891 }
3892
3893 if (lv.ll_tv != NULL)
3894 {
3895 if (fdp != NULL)
3896 {
3897 fdp->fd_dict = lv.ll_dict;
3898 fdp->fd_newkey = lv.ll_newkey;
3899 lv.ll_newkey = NULL;
3900 fdp->fd_di = lv.ll_di;
3901 }
3902 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3903 {
3904 name = vim_strsave(lv.ll_tv->vval.v_string);
3905 *pp = end;
3906 }
3907 else if (lv.ll_tv->v_type == VAR_PARTIAL
3908 && lv.ll_tv->vval.v_partial != NULL)
3909 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003910 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 *pp = end;
3912 if (partial != NULL)
3913 *partial = lv.ll_tv->vval.v_partial;
3914 }
3915 else
3916 {
3917 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3918 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003919 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003920 else
3921 *pp = end;
3922 name = NULL;
3923 }
3924 goto theend;
3925 }
3926
3927 if (lv.ll_name == NULL)
3928 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003929 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 *pp = end;
3931 goto theend;
3932 }
3933
Bram Moolenaare38eab22019-12-05 21:50:01 +01003934 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 if (lv.ll_exp_name != NULL)
3936 {
3937 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003938 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003939 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003940 if (name == lv.ll_exp_name)
3941 name = NULL;
3942 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003943 else if (lv.ll_sid > 0)
3944 {
3945 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3946 int cc = *lv.ll_name_end;
3947
3948 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3949 *lv.ll_name_end = NUL;
3950 if (si->sn_autoload_prefix != NULL)
3951 {
3952 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3953 }
3954 else
3955 {
3956 sid_buf[0] = K_SPECIAL;
3957 sid_buf[1] = KS_EXTRA;
3958 sid_buf[2] = (int)KE_SNR;
3959 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003960 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003961 name = concat_str(sid_buf, lv.ll_name);
3962 }
3963 *lv.ll_name_end = cc;
3964 *pp = end;
3965 goto theend;
3966 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003967 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 {
3969 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003970 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003971 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003972 if (name == *pp)
3973 name = NULL;
3974 }
3975 if (name != NULL)
3976 {
3977 name = vim_strsave(name);
3978 *pp = end;
3979 if (STRNCMP(name, "<SNR>", 5) == 0)
3980 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003981 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003982 name[0] = K_SPECIAL;
3983 name[1] = KS_EXTRA;
3984 name[2] = (int)KE_SNR;
3985 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3986 }
3987 goto theend;
3988 }
3989
3990 if (lv.ll_exp_name != NULL)
3991 {
3992 len = (int)STRLEN(lv.ll_exp_name);
3993 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3994 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3995 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003996 // When there was "s:" already or the name expanded to get a
3997 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003998 lv.ll_name += 2;
3999 len -= 2;
4000 lead = 2;
4001 }
4002 }
4003 else
4004 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004005 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004006 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004007 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004008 if (lv.ll_name[0] == 'g')
4009 {
4010 if (is_global != NULL)
4011 {
4012 *is_global = TRUE;
4013 }
4014 else
4015 {
4016 // dropping "g:" without setting "is_global" won't work in
4017 // Vim9script, put it back later
4018 prefix_g = TRUE;
4019 extra = 2;
4020 }
4021 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004023 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024 len = (int)(end - lv.ll_name);
4025 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004026 if (len <= 0)
4027 {
4028 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004029 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004030 goto theend;
4031 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004033 // In Vim9 script a user function is script-local by default, unless it
4034 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00004035 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004036
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004037 /*
4038 * Copy the function name to allocated memory.
4039 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4040 * Accept <SNR>123_name() outside a script.
4041 */
4042 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004043 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004044 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004045 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004046 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004047 {
Kota Kato948a3892022-08-16 16:09:59 +01004048 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4049 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004050 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004051 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004052 goto theend;
4053 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004054 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004055 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004056 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004057 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004058 || eval_fname_sid(*pp))
4059 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004060 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004061 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004063 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004064 goto theend;
4065 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004066 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004067 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004068 extra = 3 + (int)STRLEN(sid_buf);
4069 else
4070 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004071 }
4072 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004073 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004074 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004075 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004076 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004077 : e_function_name_must_start_with_capital_or_s_str),
4078 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004079 goto theend;
4080 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004081 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004082 {
4083 char_u *cp = vim_strchr(lv.ll_name, ':');
4084
4085 if (cp != NULL && cp < end)
4086 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004087 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088 goto theend;
4089 }
4090 }
4091
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004092 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004093 if (name != NULL)
4094 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004095 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004096 {
4097 name[0] = K_SPECIAL;
4098 name[1] = KS_EXTRA;
4099 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004100 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004101 STRCPY(name + 3, sid_buf);
4102 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004103 else if (prefix_g)
4104 {
4105 name[0] = 'g';
4106 name[1] = ':';
4107 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004108 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4109 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004110 }
4111 *pp = end;
4112
4113theend:
4114 clear_lval(&lv);
4115 return name;
4116}
4117
4118/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004119 * Assuming "name" is the result of trans_function_name() and it was prefixed
4120 * to use the script-local name, return the unmodified name (points into
4121 * "name"). Otherwise return NULL.
4122 * This can be used to first search for a script-local function and fall back
4123 * to the global function if not found.
4124 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004125 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004126untrans_function_name(char_u *name)
4127{
4128 char_u *p;
4129
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004130 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004131 {
4132 p = vim_strchr(name, '_');
4133 if (p != NULL)
4134 return p + 1;
4135 }
4136 return NULL;
4137}
4138
4139/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004140 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4141 * current script ID and returns the expanded function name. The caller should
4142 * free the returned name. If not called from a script context or the function
4143 * name doesn't start with these prefixes, then returns NULL.
4144 * This doesn't check whether the script-local function exists or not.
4145 */
4146 char_u *
4147get_scriptlocal_funcname(char_u *funcname)
4148{
4149 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004150 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004151 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004152 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004153
4154 if (funcname == NULL)
4155 return NULL;
4156
4157 if (STRNCMP(funcname, "s:", 2) != 0
4158 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004159 {
4160 ufunc_T *ufunc;
4161
4162 // The function name does not have a script-local prefix. Try finding
4163 // it when in a Vim9 script and there is no "g:" prefix.
4164 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4165 return NULL;
4166 ufunc = find_func(funcname, FALSE);
4167 if (ufunc == NULL || func_is_global(ufunc)
4168 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4169 return NULL;
4170 ++p;
4171 off = 0;
4172 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004173 else
4174 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004175
4176 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4177 {
4178 emsg(_(e_using_sid_not_in_script_context));
4179 return NULL;
4180 }
4181 // Expand s: prefix into <SNR>nr_<name>
4182 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4183 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004184 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004185 if (newname == NULL)
4186 return NULL;
4187 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004188 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004189
4190 return newname;
4191}
4192
4193/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004194 * Return script-local "fname" with the 3-byte sequence replaced by
4195 * printable <SNR> in allocated memory.
4196 */
4197 char_u *
4198alloc_printable_func_name(char_u *fname)
4199{
4200 char_u *n = alloc(STRLEN(fname + 3) + 6);
4201
4202 if (n != NULL)
4203 {
4204 STRCPY(n, "<SNR>");
4205 STRCPY(n + 5, fname + 3);
4206 }
4207 return n;
4208}
4209
4210/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004211 * Call trans_function_name(), except that a lambda is returned as-is.
4212 * Returns the name in allocated memory.
4213 */
4214 char_u *
4215save_function_name(
4216 char_u **name,
4217 int *is_global,
4218 int skip,
4219 int flags,
4220 funcdict_T *fudi)
4221{
4222 char_u *p = *name;
4223 char_u *saved;
4224
4225 if (STRNCMP(p, "<lambda>", 8) == 0)
4226 {
4227 p += 8;
4228 (void)getdigits(&p);
4229 saved = vim_strnsave(*name, p - *name);
4230 if (fudi != NULL)
4231 CLEAR_POINTER(fudi);
4232 }
4233 else
4234 saved = trans_function_name(&p, is_global, skip,
4235 flags, fudi, NULL, NULL);
4236 *name = p;
4237 return saved;
4238}
4239
4240/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004241 * List functions. When "regmatch" is NULL all of then.
4242 * Otherwise functions matching "regmatch".
4243 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004244 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004245list_functions(regmatch_T *regmatch)
4246{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004247 int changed = func_hashtab.ht_changed;
4248 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004249 hashitem_T *hi;
4250
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004251 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004252 {
4253 if (!HASHITEM_EMPTY(hi))
4254 {
4255 ufunc_T *fp = HI2UF(hi);
4256
4257 --todo;
4258 if ((fp->uf_flags & FC_DEAD) == 0
4259 && (regmatch == NULL
4260 ? !message_filtered(fp->uf_name)
4261 && !func_name_refcount(fp->uf_name)
4262 : !isdigit(*fp->uf_name)
4263 && vim_regexec(regmatch, fp->uf_name, 0)))
4264 {
4265 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004266 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004267 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004268 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004269 return;
4270 }
4271 }
4272 }
4273 }
4274}
4275
4276/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004277 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004278 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4279 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004280 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004281 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004282 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004283 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004284define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004285{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 int j;
4287 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004288 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004289 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004290 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004291 char_u *p;
4292 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004293 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004294 char_u *line_arg = NULL;
4295 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004296 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004297 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004298 garray_T newlines;
4299 int varargs = FALSE;
4300 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004301 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004302 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004303 int fp_allocated = FALSE;
4304 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004305 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004306 dictitem_T *v;
4307 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004308 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004310 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004311 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004312 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004313 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314
4315 /*
4316 * ":function" without argument: list functions.
4317 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004318 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319 {
4320 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004321 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004322 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004323 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004324 }
4325
4326 /*
4327 * ":function /pat": list functions matching pattern.
4328 */
4329 if (*eap->arg == '/')
4330 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004331 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004332 if (!eap->skip)
4333 {
4334 regmatch_T regmatch;
4335
4336 c = *p;
4337 *p = NUL;
4338 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4339 *p = c;
4340 if (regmatch.regprog != NULL)
4341 {
4342 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004343 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004344 vim_regfree(regmatch.regprog);
4345 }
4346 }
4347 if (*p == '/')
4348 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004349 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004350 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004351 }
4352
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004353 ga_init(&newargs);
4354 ga_init(&argtypes);
4355 ga_init(&default_args);
4356
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004357 /*
4358 * Get the function name. There are these situations:
4359 * func normal function name
4360 * "name" == func, "fudi.fd_dict" == NULL
4361 * dict.func new dictionary entry
4362 * "name" == NULL, "fudi.fd_dict" set,
4363 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4364 * dict.func existing dict entry with a Funcref
4365 * "name" == func, "fudi.fd_dict" set,
4366 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4367 * dict.func existing dict entry that's not a Funcref
4368 * "name" == NULL, "fudi.fd_dict" set,
4369 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4370 * s:func script-local function name
4371 * g:func global function name, same as "func"
4372 */
4373 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004374 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004375 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004376 // nested function, argument is (args).
4377 paren = TRUE;
4378 CLEAR_FIELD(fudi);
4379 }
4380 else
4381 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004382 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004383 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004384 if (p[0] == 's' && p[1] == ':')
4385 {
4386 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4387 return NULL;
4388 }
4389 p = to_name_end(p, TRUE);
4390 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4391 {
4392 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4393 eap->arg);
4394 return NULL;
4395 }
4396 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004397 }
4398
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004399 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004400 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004401 paren = (vim_strchr(p, '(') != NULL);
4402 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004403 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004404 /*
4405 * Return on an invalid expression in braces, unless the expression
4406 * evaluation has been cancelled due to an aborting error, an
4407 * interrupt, or an exception.
4408 */
4409 if (!aborting())
4410 {
4411 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004412 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004413 vim_free(fudi.fd_newkey);
4414 return NULL;
4415 }
4416 else
4417 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004418 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004419
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004420 // For "export def FuncName()" in an autoload script the function name
4421 // is stored with the legacy autoload name "dir#script#FuncName" so
4422 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004423 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004424 {
4425 char_u *prefixed = may_prefix_autoload(name);
4426
4427 if (prefixed != NULL && prefixed != name)
4428 {
4429 vim_free(name);
4430 name = prefixed;
4431 }
4432 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004433 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004434 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004435 {
4436 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4437 goto ret_free;
4438 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004439 }
4440
Bram Moolenaare38eab22019-12-05 21:50:01 +01004441 // An error in a function call during evaluation of an expression in magic
4442 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443 saved_did_emsg = did_emsg;
4444 did_emsg = FALSE;
4445
4446 /*
4447 * ":function func" with only function name: list function.
4448 */
4449 if (!paren)
4450 {
4451 if (!ends_excmd(*skipwhite(p)))
4452 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004453 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004454 goto ret_free;
4455 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004456 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004457 if (eap->nextcmd != NULL)
4458 *p = NUL;
4459 if (!eap->skip && !got_int)
4460 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004461 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004462 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4463 {
4464 char_u *up = untrans_function_name(name);
4465
4466 // With Vim9 script the name was made script-local, if not
4467 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004468 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004469 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004470 }
4471
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004472 if (fp != NULL)
4473 {
4474 list_func_head(fp, TRUE);
4475 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4476 {
4477 if (FUNCLINE(fp, j) == NULL)
4478 continue;
4479 msg_putchar('\n');
4480 msg_outnum((long)(j + 1));
4481 if (j < 9)
4482 msg_putchar(' ');
4483 if (j < 99)
4484 msg_putchar(' ');
4485 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004486 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004487 ui_breakcheck();
4488 }
4489 if (!got_int)
4490 {
4491 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004492 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004493 msg_puts(" enddef");
4494 else
4495 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004496 }
4497 }
4498 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004499 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004500 }
4501 goto ret_free;
4502 }
4503
4504 /*
4505 * ":function name(arg1, arg2)" Define function.
4506 */
4507 p = skipwhite(p);
4508 if (*p != '(')
4509 {
4510 if (!eap->skip)
4511 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004512 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004513 goto ret_free;
4514 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004515 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004516 if (vim_strchr(p, '(') != NULL)
4517 p = vim_strchr(p, '(');
4518 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004519
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004520 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4521 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004522 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004523 goto ret_free;
4524 }
4525
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004526 // In Vim9 script only global functions can be redefined.
4527 if (vim9script && eap->forceit && !is_global)
4528 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004529 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004530 goto ret_free;
4531 }
4532
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004533 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534
Bram Moolenaar04b12692020-05-04 23:24:44 +02004535 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004536 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004537 // Check the name of the function. Unless it's a dictionary function
4538 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004539 if (name != NULL)
4540 arg = name;
4541 else
4542 arg = fudi.fd_newkey;
4543 if (arg != NULL && (fudi.fd_di == NULL
4544 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4545 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4546 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004547 char_u *name_base = arg;
4548 int i;
4549
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004550 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004551 {
4552 name_base = vim_strchr(arg, '_');
4553 if (name_base == NULL)
4554 name_base = arg + 3;
4555 else
4556 ++name_base;
4557 }
4558 for (i = 0; name_base[i] != NUL && (i == 0
4559 ? eval_isnamec1(name_base[i])
4560 : eval_isnamec(name_base[i])); ++i)
4561 ;
4562 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004563 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004564
4565 // In Vim9 script a function cannot have the same name as a
4566 // variable.
4567 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004568 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4569 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004570 + EVAL_VAR_NO_FUNC) == OK)
4571 {
4572 semsg(_(e_redefining_script_item_str), name_base);
4573 goto ret_free;
4574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004576 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004578 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004579 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004580 goto ret_free;
4581 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004582 }
4583
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004584 // This may get more lines and make the pointers into the first line
4585 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004586 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004587 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004588 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004589 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004590 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004592 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004594 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004595 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004596 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004597 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004598 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004599 if (*p != ':')
4600 {
4601 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4602 p = skipwhite(p);
4603 }
4604 else if (!IS_WHITE_OR_NUL(p[1]))
4605 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004606 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004607 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004608 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004609 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004610 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004611 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004612 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004613 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004614 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004615 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004616 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004617 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004618 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004620 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004621 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004622 else
4623 // find extra arguments "range", "dict", "abort" and "closure"
4624 for (;;)
4625 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004626 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004627 p = skipwhite(p);
4628 if (STRNCMP(p, "range", 5) == 0)
4629 {
4630 flags |= FC_RANGE;
4631 p += 5;
4632 }
4633 else if (STRNCMP(p, "dict", 4) == 0)
4634 {
4635 flags |= FC_DICT;
4636 p += 4;
4637 }
4638 else if (STRNCMP(p, "abort", 5) == 0)
4639 {
4640 flags |= FC_ABORT;
4641 p += 5;
4642 }
4643 else if (STRNCMP(p, "closure", 7) == 0)
4644 {
4645 flags |= FC_CLOSURE;
4646 p += 7;
4647 if (current_funccal == NULL)
4648 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004649 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004650 name == NULL ? (char_u *)"" : name);
4651 goto erret;
4652 }
4653 }
4654 else
4655 break;
4656 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004657
Bram Moolenaare38eab22019-12-05 21:50:01 +01004658 // When there is a line break use what follows for the function body.
4659 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004660 if (*p == '\n')
4661 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004662 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004663 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4664 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004665 && !(VIM_ISWHITE(*whitep) && *p == '#'
4666 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004667 && !eap->skip
4668 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004669 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004670
4671 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004672 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4673 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004674 */
4675 if (KeyTyped)
4676 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004677 // Check if the function already exists, don't let the user type the
4678 // whole function before telling him it doesn't work! For a script we
4679 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 if (!eap->skip && !eap->forceit)
4681 {
4682 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004683 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004684 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004685 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004686 }
4687
4688 if (!eap->skip && did_emsg)
4689 goto erret;
4690
Bram Moolenaare38eab22019-12-05 21:50:01 +01004691 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004692 cmdline_row = msg_row;
4693 }
4694
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004695 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004696 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004697
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004698 // Do not define the function when getting the body fails and when
4699 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004700 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004701 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004702 goto erret;
4703
4704 /*
4705 * If there are no errors, add the function
4706 */
4707 if (fudi.fd_dict == NULL)
4708 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004709 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004710 char_u *find_name = name;
4711 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004712 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004713
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004714 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004715 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004716 var_conflict = TRUE;
4717
4718 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4719 {
4720 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4721
4722 if (si->sn_autoload_prefix != NULL)
4723 {
4724 if (is_export)
4725 {
4726 find_name = name + STRLEN(si->sn_autoload_prefix);
4727 v = find_var(find_name, &ht, TRUE);
4728 if (v != NULL)
4729 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004730 // Only check if the function already exists in the script,
4731 // global functions can be shadowed.
4732 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004733 }
4734 else
4735 {
4736 char_u *prefixed = may_prefix_autoload(name);
4737
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004738 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004739 {
4740 v = find_var(prefixed, &ht, TRUE);
4741 if (v != NULL)
4742 var_conflict = TRUE;
4743 vim_free(prefixed);
4744 }
4745 }
4746 }
4747 }
4748 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004750 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 goto erret;
4752 }
4753
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004754 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004755 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004756 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004757 char_u *uname = untrans_function_name(name);
4758
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004759 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004760 }
4761
4762 if (fp != NULL || import != NULL)
4763 {
4764 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004765
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004766 // Function can be replaced with "function!" and when sourcing the
4767 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004768 // A name that is used by an import can not be overruled.
4769 if (import != NULL
4770 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004771 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004772 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004774 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004775 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004776 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004777 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004778 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004779 goto erret;
4780 }
4781 if (fp->uf_calls > 0)
4782 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004783 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004784 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004785 goto erret;
4786 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004787 if (fp->uf_refcount > 1)
4788 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004789 // This function is referenced somewhere, don't redefine it but
4790 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004791 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004792 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004793 fp = NULL;
4794 overwrite = TRUE;
4795 }
4796 else
4797 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004798 char_u *exp_name = fp->uf_name_exp;
4799
4800 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004801 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004802 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004803 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004804 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004805 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004806#ifdef FEAT_PROFILE
4807 fp->uf_profiling = FALSE;
4808 fp->uf_prof_initialized = FALSE;
4809#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004810 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004811 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004812 }
4813 }
4814 else
4815 {
4816 char numbuf[20];
4817
4818 fp = NULL;
4819 if (fudi.fd_newkey == NULL && !eap->forceit)
4820 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004821 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004822 goto erret;
4823 }
4824 if (fudi.fd_di == NULL)
4825 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004826 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004827 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004828 goto erret;
4829 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004830 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004831 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004832 goto erret;
4833
Bram Moolenaare38eab22019-12-05 21:50:01 +01004834 // Give the function a sequential number. Can only be used with a
4835 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004836 vim_free(name);
4837 sprintf(numbuf, "%d", ++func_nr);
4838 name = vim_strsave((char_u *)numbuf);
4839 if (name == NULL)
4840 goto erret;
4841 }
4842
4843 if (fp == NULL)
4844 {
4845 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4846 {
4847 int slen, plen;
4848 char_u *scriptname;
4849
Bram Moolenaare38eab22019-12-05 21:50:01 +01004850 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004851 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004852 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004853 {
4854 scriptname = autoload_name(name);
4855 if (scriptname != NULL)
4856 {
4857 p = vim_strchr(scriptname, '/');
4858 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004859 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004861 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004862 j = OK;
4863 vim_free(scriptname);
4864 }
4865 }
4866 if (j == FAIL)
4867 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004868 linenr_T save_lnum = SOURCING_LNUM;
4869
4870 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004871 semsg(_(e_function_name_does_not_match_script_file_name_str),
4872 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004873 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 goto erret;
4875 }
4876 }
4877
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004878 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004879 if (fp == NULL)
4880 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004881 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004882
4883 if (fudi.fd_dict != NULL)
4884 {
4885 if (fudi.fd_di == NULL)
4886 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004887 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4889 if (fudi.fd_di == NULL)
4890 {
4891 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004892 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004893 goto erret;
4894 }
4895 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4896 {
4897 vim_free(fudi.fd_di);
4898 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004899 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004900 goto erret;
4901 }
4902 }
4903 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004904 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905 clear_tv(&fudi.fd_di->di_tv);
4906 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908
Bram Moolenaare38eab22019-12-05 21:50:01 +01004909 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910 flags |= FC_DICT;
4911 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004912 }
4913 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004914 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004915 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004916 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004917
4918 if (eap->cmdidx == CMD_def)
4919 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004920 int lnum_save = SOURCING_LNUM;
4921 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004922
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004923 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004924
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004925 // error messages are for the first function line
4926 SOURCING_LNUM = sourcing_lnum_top;
4927
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004928 // The function may use script variables from the context.
4929 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004930
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004931 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004932 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004933 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004934 free_fp = fp_allocated;
4935 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004936 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004937 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004938
4939 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004940 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004941 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004942 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004943 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004944 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004945 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004946 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004947 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004948 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004949 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004950
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004951 if (fp_allocated)
4952 {
4953 // insert the new function in the function list
4954 set_ufunc_name(fp, name);
4955 if (overwrite)
4956 {
4957 hi = hash_find(&func_hashtab, name);
4958 hi->hi_key = UF2HIKEY(fp);
4959 }
4960 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4961 {
4962 free_fp = TRUE;
4963 goto erret;
4964 }
4965 fp->uf_refcount = 1;
4966 }
4967
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004968 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004969 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004970 if ((flags & FC_CLOSURE) != 0)
4971 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004972 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004973 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004974 }
4975 else
4976 fp->uf_scoped = NULL;
4977
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004978#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004979 if (prof_def_func())
4980 func_do_profile(fp);
4981#endif
4982 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004983 if (sandbox)
4984 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004985 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004986 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004987 fp->uf_flags = flags;
4988 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004989 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004990 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004991 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004992 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004993 if (is_export)
4994 {
4995 fp->uf_flags |= FC_EXPORT;
4996 // let ex_export() know the export worked.
4997 is_export = FALSE;
4998 }
4999
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005000 if (eap->cmdidx == CMD_def)
5001 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02005002 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
5003 // :func does not use Vim9 script syntax, even in a Vim9 script file
5004 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005005
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005006 goto ret_free;
5007
5008erret:
5009 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005010 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005011 if (fp != NULL)
5012 {
5013 ga_init(&fp->uf_args);
5014 ga_init(&fp->uf_def_args);
5015 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005016errret_2:
5017 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005018 if (fp != NULL)
5019 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005020 if (free_fp)
5021 {
5022 vim_free(fp);
5023 fp = NULL;
5024 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005025ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005026 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005027 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005028 if (name != name_arg)
5029 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005030 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005031 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005032
5033 return fp;
5034}
5035
5036/*
5037 * ":function"
5038 */
5039 void
5040ex_function(exarg_T *eap)
5041{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005042 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005043
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005044 ga_init2(&lines_to_free, sizeof(char_u *), 50);
5045 (void)define_function(eap, NULL, &lines_to_free);
5046 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005047}
5048
5049/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005050 * Find a function by name, including "<lambda>123".
5051 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005052 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005053 * Return NULL if not found.
5054 */
5055 ufunc_T *
5056find_func_by_name(char_u *name, compiletype_T *compile_type)
5057{
5058 char_u *arg = name;
5059 char_u *fname;
5060 ufunc_T *ufunc;
5061 int is_global = FALSE;
5062
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005063 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5064 {
5065 *compile_type = CT_PROFILE;
5066 arg = skipwhite(arg + 7);
5067 }
5068 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5069 {
5070 *compile_type = CT_DEBUG;
5071 arg = skipwhite(arg + 5);
5072 }
5073
5074 if (STRNCMP(arg, "<lambda>", 8) == 0)
5075 {
5076 arg += 8;
5077 (void)getdigits(&arg);
5078 fname = vim_strnsave(name, arg - name);
5079 }
5080 else
5081 fname = trans_function_name(&arg, &is_global, FALSE,
5082 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5083 if (fname == NULL)
5084 {
5085 semsg(_(e_invalid_argument_str), name);
5086 return NULL;
5087 }
5088 if (!ends_excmd2(name, arg))
5089 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005090 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005091 emsg(ex_errmsg(e_trailing_characters_str, arg));
5092 return NULL;
5093 }
5094
5095 ufunc = find_func(fname, is_global);
5096 if (ufunc == NULL)
5097 {
5098 char_u *p = untrans_function_name(fname);
5099
5100 if (p != NULL)
5101 // Try again without making it script-local.
5102 ufunc = find_func(p, FALSE);
5103 }
5104 vim_free(fname);
5105 if (ufunc == NULL)
5106 semsg(_(e_cannot_find_function_str), name);
5107 return ufunc;
5108}
5109
5110/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005111 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005112 * be compiled or the one specified by the argument.
5113 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005114 */
5115 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005116ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005117{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005118 ufunc_T *ufunc;
5119
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005120 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005121 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005122 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005123
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005124 ufunc = find_func_by_name(eap->arg, &compile_type);
5125 if (ufunc != NULL)
5126 {
5127 if (func_needs_compiling(ufunc, compile_type))
5128 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5129 else
5130 smsg(_("Function %s does not need compiling"), eap->arg);
5131 }
5132 }
5133 else
5134 {
5135 long todo = (long)func_hashtab.ht_used;
5136 int changed = func_hashtab.ht_changed;
5137 hashitem_T *hi;
5138
5139 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5140 {
5141 if (!HASHITEM_EMPTY(hi))
5142 {
5143 --todo;
5144 ufunc = HI2UF(hi);
5145 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5146 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5147 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005148 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005149 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5150
5151 if (func_hashtab.ht_changed != changed)
5152 {
5153 // a function has been added or removed, need to start
5154 // over
5155 todo = (long)func_hashtab.ht_used;
5156 changed = func_hashtab.ht_changed;
5157 hi = func_hashtab.ht_array;
5158 --hi;
5159 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005160 }
5161 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005162 }
5163 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005164}
5165
5166/*
5167 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5168 * Return 2 if "p" starts with "s:".
5169 * Return 0 otherwise.
5170 */
5171 int
5172eval_fname_script(char_u *p)
5173{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005174 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5175 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005176 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5177 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5178 return 5;
5179 if (p[0] == 's' && p[1] == ':')
5180 return 2;
5181 return 0;
5182}
5183
5184 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005185translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005186{
5187 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005188 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005189 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005190}
5191
5192/*
5193 * Return TRUE when "ufunc" has old-style "..." varargs
5194 * or named varargs "...name: type".
5195 */
5196 int
5197has_varargs(ufunc_T *ufunc)
5198{
5199 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200}
5201
5202/*
5203 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005204 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005205 */
5206 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005207function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005208{
5209 char_u *nm = name;
5210 char_u *p;
5211 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005212 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005213 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005214
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005215 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5216 if (no_deref)
5217 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005218 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005219 nm = skipwhite(nm);
5220
Bram Moolenaare38eab22019-12-05 21:50:01 +01005221 // Only accept "funcname", "funcname ", "funcname (..." and
5222 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005224 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005225 vim_free(p);
5226 return n;
5227}
5228
Bram Moolenaar113e1072019-01-20 15:30:40 +01005229#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005230 char_u *
5231get_expanded_name(char_u *name, int check)
5232{
5233 char_u *nm = name;
5234 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005235 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005236
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005237 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005238 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005239
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005240 if (p != NULL && *nm == NUL
5241 && (!check || translated_function_exists(p, is_global)))
5242 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005243
5244 vim_free(p);
5245 return NULL;
5246}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005247#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005248
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005249/*
5250 * Function given to ExpandGeneric() to obtain the list of user defined
5251 * function names.
5252 */
5253 char_u *
5254get_user_func_name(expand_T *xp, int idx)
5255{
5256 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005257 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005258 static hashitem_T *hi;
5259 ufunc_T *fp;
5260
5261 if (idx == 0)
5262 {
5263 done = 0;
5264 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005265 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005266 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005267 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005268 {
5269 if (done++ > 0)
5270 ++hi;
5271 while (HASHITEM_EMPTY(hi))
5272 ++hi;
5273 fp = HI2UF(hi);
5274
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005275 // don't show dead, dict and lambda functions
5276 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005277 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005278 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005279
5280 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005281 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005282
5283 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005284 if (xp->xp_context != EXPAND_USER_FUNC
5285 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005286 {
5287 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005288 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005289 STRCAT(IObuff, ")");
5290 }
5291 return IObuff;
5292 }
5293 return NULL;
5294}
5295
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005296/*
5297 * ":delfunction {name}"
5298 */
5299 void
5300ex_delfunction(exarg_T *eap)
5301{
5302 ufunc_T *fp = NULL;
5303 char_u *p;
5304 char_u *name;
5305 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005306 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005307
5308 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005309 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5310 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005311 vim_free(fudi.fd_newkey);
5312 if (name == NULL)
5313 {
5314 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005315 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005316 return;
5317 }
5318 if (!ends_excmd(*skipwhite(p)))
5319 {
5320 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005321 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005322 return;
5323 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005324 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005325 if (eap->nextcmd != NULL)
5326 *p = NUL;
5327
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005328 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005329 {
5330 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005331 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005332 vim_free(name);
5333 return;
5334 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005335 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005336 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005337 vim_free(name);
5338
5339 if (!eap->skip)
5340 {
5341 if (fp == NULL)
5342 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005343 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005344 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005345 return;
5346 }
5347 if (fp->uf_calls > 0)
5348 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005349 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005350 return;
5351 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005352 if (fp->uf_flags & FC_VIM9)
5353 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005354 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005355 return;
5356 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005357
5358 if (fudi.fd_dict != NULL)
5359 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005360 // Delete the dict item that refers to the function, it will
5361 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005362 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5363 }
5364 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005365 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005366 // A normal function (not a numbered function or lambda) has a
5367 // refcount of 1 for the entry in the hashtable. When deleting
5368 // it and the refcount is more than one, it should be kept.
5369 // A numbered function and lambda should be kept if the refcount is
5370 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005371 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005372 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005373 // Function is still referenced somewhere. Don't free it but
5374 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005375 if (func_remove(fp))
5376 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005377 }
5378 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005379 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005380 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005381 }
5382}
5383
5384/*
5385 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005386 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005387 */
5388 void
5389func_unref(char_u *name)
5390{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005391 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005392
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 Moolenaar57bc2332021-12-15 12:06:43 +00005396 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005397 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005398#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005399 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005400#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005401 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005402 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005403 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005404}
5405
5406/*
5407 * Unreference a Function: decrement the reference count and free it when it
5408 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005409 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005410 */
5411 void
5412func_ptr_unref(ufunc_T *fp)
5413{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005414 if (fp != NULL && (--fp->uf_refcount <= 0
5415 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5416 && fp->uf_partial->pt_refcount <= 1
5417 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005418 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005419 // Only delete it when it's not being used. Otherwise it's done
5420 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005421 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005422 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005423 }
5424}
5425
5426/*
5427 * Count a reference to a Function.
5428 */
5429 void
5430func_ref(char_u *name)
5431{
5432 ufunc_T *fp;
5433
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005434 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005435 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005436 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005437 if (fp != NULL)
5438 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005439 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005440 // Only give an error for a numbered function.
5441 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005442 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005443}
5444
5445/*
5446 * Count a reference to a Function.
5447 */
5448 void
5449func_ptr_ref(ufunc_T *fp)
5450{
5451 if (fp != NULL)
5452 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453}
5454
5455/*
5456 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5457 * referenced from anywhere that is in use.
5458 */
5459 static int
5460can_free_funccal(funccall_T *fc, int copyID)
5461{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005462 return (fc->fc_l_varlist.lv_copyID != copyID
5463 && fc->fc_l_vars.dv_copyID != copyID
5464 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005465 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005466}
5467
5468/*
5469 * ":return [expr]"
5470 */
5471 void
5472ex_return(exarg_T *eap)
5473{
5474 char_u *arg = eap->arg;
5475 typval_T rettv;
5476 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005477 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005478
5479 if (current_funccal == NULL)
5480 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005481 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005482 return;
5483 }
5484
Bram Moolenaar844fb642021-10-23 13:32:30 +01005485 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005486 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5487
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005488 if (eap->skip)
5489 ++emsg_skip;
5490
5491 eap->nextcmd = NULL;
5492 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005493 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005494 {
5495 if (!eap->skip)
5496 returning = do_return(eap, FALSE, TRUE, &rettv);
5497 else
5498 clear_tv(&rettv);
5499 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005500 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005501 else if (!eap->skip)
5502 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005503 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005504 update_force_abort();
5505
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005506 /*
5507 * Return unless the expression evaluation has been cancelled due to an
5508 * aborting error, an interrupt, or an exception.
5509 */
5510 if (!aborting())
5511 returning = do_return(eap, FALSE, TRUE, NULL);
5512 }
5513
Bram Moolenaare38eab22019-12-05 21:50:01 +01005514 // When skipping or the return gets pending, advance to the next command
5515 // in this line (!returning). Otherwise, ignore the rest of the line.
5516 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005517 if (returning)
5518 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005519 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005520 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005521
5522 if (eap->skip)
5523 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005524 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005525}
5526
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005527 static int
5528ex_call_inner(
5529 exarg_T *eap,
5530 char_u *name,
5531 char_u **arg,
5532 char_u *startarg,
5533 funcexe_T *funcexe_init,
5534 evalarg_T *evalarg)
5535{
5536 linenr_T lnum;
5537 int doesrange;
5538 typval_T rettv;
5539 int failed = FALSE;
5540
5541 /*
5542 * When skipping, evaluate the function once, to find the end of the
5543 * arguments.
5544 * When the function takes a range, this is discovered after the first
5545 * call, and the loop is broken.
5546 */
5547 if (eap->skip)
5548 {
5549 ++emsg_skip;
5550 lnum = eap->line2; // do it once, also with an invalid range
5551 }
5552 else
5553 lnum = eap->line1;
5554 for ( ; lnum <= eap->line2; ++lnum)
5555 {
5556 funcexe_T funcexe;
5557
5558 if (!eap->skip && eap->addr_count > 0)
5559 {
5560 if (lnum > curbuf->b_ml.ml_line_count)
5561 {
5562 // If the function deleted lines or switched to another buffer
5563 // the line number may become invalid.
5564 emsg(_(e_invalid_range));
5565 break;
5566 }
5567 curwin->w_cursor.lnum = lnum;
5568 curwin->w_cursor.col = 0;
5569 curwin->w_cursor.coladd = 0;
5570 }
5571 *arg = startarg;
5572
5573 funcexe = *funcexe_init;
5574 funcexe.fe_doesrange = &doesrange;
5575 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5576 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5577 {
5578 failed = TRUE;
5579 break;
5580 }
5581 if (has_watchexpr())
5582 dbg_check_breakpoint(eap);
5583
5584 // Handle a function returning a Funcref, Dictionary or List.
5585 if (handle_subscript(arg, NULL, &rettv,
5586 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5587 {
5588 failed = TRUE;
5589 break;
5590 }
5591
5592 clear_tv(&rettv);
5593 if (doesrange || eap->skip)
5594 break;
5595
5596 // Stop when immediately aborting on error, or when an interrupt
5597 // occurred or an exception was thrown but not caught.
5598 // get_func_tv() returned OK, so that the check for trailing
5599 // characters below is executed.
5600 if (aborting())
5601 break;
5602 }
5603 if (eap->skip)
5604 --emsg_skip;
5605 return failed;
5606}
5607
5608/*
5609 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5610 * Returns FAIL or OK.
5611 */
5612 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005613ex_defer_inner(
5614 char_u *name,
5615 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005616 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005617 partial_T *partial,
5618 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005619{
5620 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005621 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005622 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005623 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005624
5625 if (current_funccal == NULL)
5626 {
5627 semsg(_(e_str_not_inside_function), "defer");
5628 return FAIL;
5629 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005630 if (partial != NULL)
5631 {
5632 if (partial->pt_dict != NULL)
5633 {
5634 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5635 return FAIL;
5636 }
5637 if (partial->pt_argc > 0)
5638 {
5639 int i;
5640
5641 partial_argc = partial->pt_argc;
5642 for (i = 0; i < partial_argc; ++i)
5643 copy_tv(&partial->pt_argv[i], &argvars[i]);
5644 }
5645 }
5646 r = get_func_arguments(arg, evalarg, FALSE,
5647 argvars + partial_argc, &argcount);
5648 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005649
5650 if (r == OK)
5651 {
5652 if (type != NULL)
5653 {
5654 // Check that the arguments are OK for the types of the funcref.
5655 r = check_argument_types(type, argvars, argcount, NULL, name);
5656 }
5657 else if (builtin_function(name, -1))
5658 {
5659 int idx = find_internal_func(name);
5660
5661 if (idx < 0)
5662 {
5663 emsg_funcname(e_unknown_function_str, name);
5664 r = FAIL;
5665 }
5666 else if (check_internal_func(idx, argcount) == -1)
5667 r = FAIL;
5668 }
5669 else
5670 {
5671 ufunc_T *ufunc = find_func(name, FALSE);
5672
5673 // we tolerate an unknown function here, it might be defined later
5674 if (ufunc != NULL)
5675 {
5676 int error = check_user_func_argcount(ufunc, argcount);
5677
5678 if (error != FCERR_UNKNOWN)
5679 {
5680 user_func_error(error, name, NULL);
5681 r = FAIL;
5682 }
5683 }
5684 }
5685 }
5686
Bram Moolenaar86d87252022-09-05 21:21:25 +01005687 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01005688 {
5689 while (--argcount >= 0)
5690 clear_tv(&argvars[argcount]);
5691 return FAIL;
5692 }
5693 return add_defer(name, argcount, argvars);
5694}
5695
5696/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01005697 * Return TRUE if currently inside a function call.
5698 * Give an error message and return FALSE when not.
5699 */
5700 int
5701can_add_defer(void)
5702{
5703 if (!in_def_function() && get_current_funccal() == NULL)
5704 {
5705 semsg(_(e_str_not_inside_function), "defer");
5706 return FALSE;
5707 }
5708 return TRUE;
5709}
5710
5711/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01005712 * Add a deferred call for "name" with arguments "argvars[argcount]".
5713 * Consumes "argvars[]".
5714 * Caller must check that in_def_function() returns TRUE or current_funccal is
5715 * not NULL.
5716 * Returns OK or FAIL.
5717 */
5718 int
5719add_defer(char_u *name, int argcount_arg, typval_T *argvars)
5720{
5721 char_u *saved_name = vim_strsave(name);
5722 int argcount = argcount_arg;
5723 defer_T *dr;
5724 int ret = FAIL;
5725
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005726 if (saved_name == NULL)
5727 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01005728 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005729 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01005730 if (add_defer_function(saved_name, argcount, argvars) == OK)
5731 argcount = 0;
5732 }
5733 else
5734 {
5735 if (current_funccal->fc_defer.ga_itemsize == 0)
5736 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
5737 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
5738 goto theend;
5739 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
5740 + current_funccal->fc_defer.ga_len++;
5741 dr->dr_name = saved_name;
5742 dr->dr_argcount = argcount;
5743 while (argcount > 0)
5744 {
5745 --argcount;
5746 dr->dr_argvars[argcount] = argvars[argcount];
5747 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005748 }
5749 ret = OK;
5750
5751theend:
5752 while (--argcount >= 0)
5753 clear_tv(&argvars[argcount]);
5754 return ret;
5755}
5756
5757/*
5758 * Invoked after a functions has finished: invoke ":defer" functions.
5759 */
Bram Moolenaar58779852022-09-06 18:31:14 +01005760 static void
5761handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005762{
5763 int idx;
5764
Bram Moolenaar58779852022-09-06 18:31:14 +01005765 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005766 {
5767 funcexe_T funcexe;
5768 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01005769 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005770 int i;
5771
5772 CLEAR_FIELD(funcexe);
5773 funcexe.fe_evaluate = TRUE;
5774
5775 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5776 call_func(dr->dr_name, -1, &rettv,
5777 dr->dr_argcount, dr->dr_argvars, &funcexe);
5778 clear_tv(&rettv);
5779 vim_free(dr->dr_name);
5780 for (i = dr->dr_argcount - 1; i >= 0; --i)
5781 clear_tv(&dr->dr_argvars[i]);
5782 }
Bram Moolenaar58779852022-09-06 18:31:14 +01005783 ga_clear(&funccal->fc_defer);
5784}
5785
5786/*
5787 * Called when exiting: call all defer functions.
5788 */
5789 void
5790invoke_all_defer(void)
5791{
5792 funccall_T *funccal;
5793
Bram Moolenaarca16c602022-09-06 18:57:08 +01005794 for (funccal = current_funccal; funccal != NULL;
5795 funccal = funccal->fc_caller)
Bram Moolenaar58779852022-09-06 18:31:14 +01005796 if (funccal->fc_ectx != NULL)
5797 {
5798 // :def function
5799 unwind_def_callstack(funccal->fc_ectx);
5800 may_invoke_defer_funcs(funccal->fc_ectx);
5801 }
5802 else
5803 {
5804 // legacy function
5805 handle_defer_one(funccal);
5806 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005807}
5808
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005809/*
5810 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005811 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005812 */
5813 void
5814ex_call(exarg_T *eap)
5815{
5816 char_u *arg = eap->arg;
5817 char_u *startarg;
5818 char_u *name;
5819 char_u *tofree;
5820 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005821 int failed = FALSE;
5822 funcdict_T fudi;
5823 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005824 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005825 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005826 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005827 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005828
Bram Moolenaare6b53242020-07-01 17:28:33 +02005829 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005830 if (eap->skip)
5831 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005832 typval_T rettv;
5833
Bram Moolenaare38eab22019-12-05 21:50:01 +01005834 // trans_function_name() doesn't work well when skipping, use eval0()
5835 // instead to skip to any following command, e.g. for:
5836 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005837 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005838 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005839 clear_tv(&rettv);
5840 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005841 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005842 return;
5843 }
5844
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005845 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005846 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005847 if (fudi.fd_newkey != NULL)
5848 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005849 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005850 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005851 vim_free(fudi.fd_newkey);
5852 }
5853 if (tofree == NULL)
5854 return;
5855
Bram Moolenaare38eab22019-12-05 21:50:01 +01005856 // Increase refcount on dictionary, it could get deleted when evaluating
5857 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005858 if (fudi.fd_dict != NULL)
5859 ++fudi.fd_dict->dv_refcount;
5860
Bram Moolenaare38eab22019-12-05 21:50:01 +01005861 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5862 // contents. For VAR_PARTIAL get its partial, unless we already have one
5863 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005864 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005865 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005866 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005867 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005868
Bram Moolenaare38eab22019-12-05 21:50:01 +01005869 // Skip white space to allow ":call func ()". Not good, but required for
5870 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005871 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005872 if (*startarg != '(')
5873 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005874 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005875 goto end;
5876 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005877 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005878 {
5879 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5880 goto end;
5881 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005882
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005883 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005884 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005885 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01005886 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005887 }
5888 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005889 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005890 funcexe_T funcexe;
5891
Bram Moolenaara80faa82020-04-12 19:37:17 +02005892 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005893 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005894 funcexe.fe_partial = partial;
5895 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005896 funcexe.fe_firstline = eap->line1;
5897 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005898 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005899 funcexe.fe_evaluate = !eap->skip;
5900 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005901 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005902
Bram Moolenaar1d341892021-09-18 15:25:52 +02005903 // When inside :try we need to check for following "| catch" or "| endtry".
5904 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005905 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005906 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005907 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005908 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005909 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005910 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005911 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005912 {
5913 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005914 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005915 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005916 }
5917 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005918 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005919 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005920 // Must be after using "arg", it may point into memory cleared here.
5921 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005922
5923end:
5924 dict_unref(fudi.fd_dict);
5925 vim_free(tofree);
5926}
5927
5928/*
5929 * Return from a function. Possibly makes the return pending. Also called
5930 * for a pending return at the ":endtry" or after returning from an extra
5931 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5932 * when called due to a ":return" command. "rettv" may point to a typval_T
5933 * with the return rettv. Returns TRUE when the return can be carried out,
5934 * FALSE when the return gets pending.
5935 */
5936 int
5937do_return(
5938 exarg_T *eap,
5939 int reanimate,
5940 int is_cmd,
5941 void *rettv)
5942{
5943 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005944 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005945
5946 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005947 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005948 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005949
5950 /*
5951 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5952 * not in its finally clause (which then is to be executed next) is found.
5953 * In this case, make the ":return" pending for execution at the ":endtry".
5954 * Otherwise, return normally.
5955 */
5956 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5957 if (idx >= 0)
5958 {
5959 cstack->cs_pending[idx] = CSTP_RETURN;
5960
5961 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005962 // A pending return again gets pending. "rettv" points to an
5963 // allocated variable with the rettv of the original ":return"'s
5964 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005965 cstack->cs_rettv[idx] = rettv;
5966 else
5967 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005968 // When undoing a return in order to make it pending, get the stored
5969 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005970 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01005971 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005972
5973 if (rettv != NULL)
5974 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005975 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005976 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5977 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5978 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005979 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005980 }
5981 else
5982 cstack->cs_rettv[idx] = NULL;
5983
5984 if (reanimate)
5985 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005986 // The pending return value could be overwritten by a ":return"
5987 // without argument in a finally clause; reset the default
5988 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005989 current_funccal->fc_rettv->v_type = VAR_NUMBER;
5990 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005991 }
5992 }
5993 report_make_pending(CSTP_RETURN, rettv);
5994 }
5995 else
5996 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01005997 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005998
Bram Moolenaare38eab22019-12-05 21:50:01 +01005999 // If the return is carried out now, store the return value. For
6000 // a return immediately after reanimation, the value is already
6001 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006002 if (!reanimate && rettv != NULL)
6003 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006004 clear_tv(current_funccal->fc_rettv);
6005 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006006 if (!is_cmd)
6007 vim_free(rettv);
6008 }
6009 }
6010
6011 return idx < 0;
6012}
6013
6014/*
6015 * Free the variable with a pending return value.
6016 */
6017 void
6018discard_pending_return(void *rettv)
6019{
6020 free_tv((typval_T *)rettv);
6021}
6022
6023/*
6024 * Generate a return command for producing the value of "rettv". The result
6025 * is an allocated string. Used by report_pending() for verbose messages.
6026 */
6027 char_u *
6028get_return_cmd(void *rettv)
6029{
6030 char_u *s = NULL;
6031 char_u *tofree = NULL;
6032 char_u numbuf[NUMBUFLEN];
6033
6034 if (rettv != NULL)
6035 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6036 if (s == NULL)
6037 s = (char_u *)"";
6038
6039 STRCPY(IObuff, ":return ");
6040 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6041 if (STRLEN(s) + 8 >= IOSIZE)
6042 STRCPY(IObuff + IOSIZE - 4, "...");
6043 vim_free(tofree);
6044 return vim_strsave(IObuff);
6045}
6046
6047/*
6048 * Get next function line.
6049 * Called by do_cmdline() to get the next line.
6050 * Returns allocated string, or NULL for end of function.
6051 */
6052 char_u *
6053get_func_line(
6054 int c UNUSED,
6055 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006056 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006057 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006058{
6059 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006060 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006061 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006062 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006063
Bram Moolenaare38eab22019-12-05 21:50:01 +01006064 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006065 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006066 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006067 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006068 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006069 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006070 }
6071#ifdef FEAT_PROFILE
6072 if (do_profiling == PROF_YES)
6073 func_line_end(cookie);
6074#endif
6075
6076 gap = &fp->uf_lines;
6077 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006078 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006079 retval = NULL;
6080 else
6081 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006082 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006083 while (fcp->fc_linenr < gap->ga_len
6084 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6085 ++fcp->fc_linenr;
6086 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006087 retval = NULL;
6088 else
6089 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006090 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6091 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006092#ifdef FEAT_PROFILE
6093 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006094 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006095#endif
6096 }
6097 }
6098
Bram Moolenaare38eab22019-12-05 21:50:01 +01006099 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006100 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006101 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006102 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006103 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006104 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006105 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006106 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006107 }
6108
6109 return retval;
6110}
6111
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006112/*
6113 * Return TRUE if the currently active function should be ended, because a
6114 * return was encountered or an error occurred. Used inside a ":while".
6115 */
6116 int
6117func_has_ended(void *cookie)
6118{
6119 funccall_T *fcp = (funccall_T *)cookie;
6120
Bram Moolenaare38eab22019-12-05 21:50:01 +01006121 // Ignore the "abort" flag if the abortion behavior has been changed due to
6122 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006123 return (((fcp->fc_func->uf_flags & FC_ABORT)
6124 && did_emsg && !aborted_in_try())
6125 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006126}
6127
6128/*
6129 * return TRUE if cookie indicates a function which "abort"s on errors.
6130 */
6131 int
6132func_has_abort(
6133 void *cookie)
6134{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006135 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006136}
6137
6138
6139/*
6140 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6141 * Don't do this when "Func" is already a partial that was bound
6142 * explicitly (pt_auto is FALSE).
6143 * Changes "rettv" in-place.
6144 * Returns the updated "selfdict_in".
6145 */
6146 dict_T *
6147make_partial(dict_T *selfdict_in, typval_T *rettv)
6148{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006149 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006150 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006151 char_u fname_buf[FLEN_FIXED + 1];
6152 int error;
6153 dict_T *selfdict = selfdict_in;
6154
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006155 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6156 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006157 fp = rettv->vval.v_partial->pt_func;
6158 else
6159 {
6160 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006161 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006162 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006163 if (fname == NULL)
6164 {
6165 // There is no point binding a dict to a NULL function, just create
6166 // a function reference.
6167 rettv->v_type = VAR_FUNC;
6168 rettv->vval.v_string = NULL;
6169 }
6170 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006171 {
6172 char_u *tofree = NULL;
6173
6174 // Translate "s:func" to the stored function name.
6175 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6176 fp = find_func(fname, FALSE);
6177 vim_free(tofree);
6178 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006179 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006180
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006181 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006182 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006183 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006184
6185 if (pt != NULL)
6186 {
6187 pt->pt_refcount = 1;
6188 pt->pt_dict = selfdict;
6189 pt->pt_auto = TRUE;
6190 selfdict = NULL;
6191 if (rettv->v_type == VAR_FUNC)
6192 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006193 // Just a function: Take over the function name and use
6194 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006195 pt->pt_name = rettv->vval.v_string;
6196 }
6197 else
6198 {
6199 partial_T *ret_pt = rettv->vval.v_partial;
6200 int i;
6201
Bram Moolenaare38eab22019-12-05 21:50:01 +01006202 // Partial: copy the function name, use selfdict and copy
6203 // args. Can't take over name or args, the partial might
6204 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006205 if (ret_pt->pt_name != NULL)
6206 {
6207 pt->pt_name = vim_strsave(ret_pt->pt_name);
6208 func_ref(pt->pt_name);
6209 }
6210 else
6211 {
6212 pt->pt_func = ret_pt->pt_func;
6213 func_ptr_ref(pt->pt_func);
6214 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006215 if (ret_pt->pt_argc > 0)
6216 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006217 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006218 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006219 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006220 pt->pt_argc = 0;
6221 else
6222 {
6223 pt->pt_argc = ret_pt->pt_argc;
6224 for (i = 0; i < pt->pt_argc; i++)
6225 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6226 }
6227 }
6228 partial_unref(ret_pt);
6229 }
6230 rettv->v_type = VAR_PARTIAL;
6231 rettv->vval.v_partial = pt;
6232 }
6233 }
6234 return selfdict;
6235}
6236
6237/*
6238 * Return the name of the executed function.
6239 */
6240 char_u *
6241func_name(void *cookie)
6242{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006243 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006244}
6245
6246/*
6247 * Return the address holding the next breakpoint line for a funccall cookie.
6248 */
6249 linenr_T *
6250func_breakpoint(void *cookie)
6251{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006252 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006253}
6254
6255/*
6256 * Return the address holding the debug tick for a funccall cookie.
6257 */
6258 int *
6259func_dbg_tick(void *cookie)
6260{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006261 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006262}
6263
6264/*
6265 * Return the nesting level for a funccall cookie.
6266 */
6267 int
6268func_level(void *cookie)
6269{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006270 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006271}
6272
6273/*
6274 * Return TRUE when a function was ended by a ":return" command.
6275 */
6276 int
6277current_func_returned(void)
6278{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006279 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006280}
6281
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006282 int
6283free_unref_funccal(int copyID, int testing)
6284{
6285 int did_free = FALSE;
6286 int did_free_funccal = FALSE;
6287 funccall_T *fc, **pfc;
6288
6289 for (pfc = &previous_funccal; *pfc != NULL; )
6290 {
6291 if (can_free_funccal(*pfc, copyID))
6292 {
6293 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006294 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006295 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006296 did_free = TRUE;
6297 did_free_funccal = TRUE;
6298 }
6299 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006300 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006301 }
6302 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006303 // When a funccal was freed some more items might be garbage
6304 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006305 (void)garbage_collect(testing);
6306
6307 return did_free;
6308}
6309
6310/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006311 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006312 */
6313 static funccall_T *
6314get_funccal(void)
6315{
6316 int i;
6317 funccall_T *funccal;
6318 funccall_T *temp_funccal;
6319
6320 funccal = current_funccal;
6321 if (debug_backtrace_level > 0)
6322 {
6323 for (i = 0; i < debug_backtrace_level; i++)
6324 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006325 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006326 if (temp_funccal)
6327 funccal = temp_funccal;
6328 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006329 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006330 debug_backtrace_level = i;
6331 }
6332 }
6333 return funccal;
6334}
6335
6336/*
6337 * Return the hashtable used for local variables in the current funccal.
6338 * Return NULL if there is no current funccal.
6339 */
6340 hashtab_T *
6341get_funccal_local_ht()
6342{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006343 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006344 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006345 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006346}
6347
6348/*
6349 * Return the l: scope variable.
6350 * Return NULL if there is no current funccal.
6351 */
6352 dictitem_T *
6353get_funccal_local_var()
6354{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006355 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006356 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006357 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006358}
6359
6360/*
6361 * Return the hashtable used for argument in the current funccal.
6362 * Return NULL if there is no current funccal.
6363 */
6364 hashtab_T *
6365get_funccal_args_ht()
6366{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006367 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006368 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006369 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006370}
6371
6372/*
6373 * Return the a: scope variable.
6374 * Return NULL if there is no current funccal.
6375 */
6376 dictitem_T *
6377get_funccal_args_var()
6378{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006379 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006380 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006381 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006382}
6383
6384/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006385 * List function variables, if there is a function.
6386 */
6387 void
6388list_func_vars(int *first)
6389{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006390 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6391 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006392 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006393}
6394
6395/*
6396 * If "ht" is the hashtable for local variables in the current funccal, return
6397 * the dict that contains it.
6398 * Otherwise return NULL.
6399 */
6400 dict_T *
6401get_current_funccal_dict(hashtab_T *ht)
6402{
6403 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006404 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6405 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006406 return NULL;
6407}
6408
6409/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006410 * Search hashitem in parent scope.
6411 */
6412 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006413find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006414{
6415 funccall_T *old_current_funccal = current_funccal;
6416 hashtab_T *ht;
6417 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006418 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006419
Bram Moolenaarca16c602022-09-06 18:57:08 +01006420 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006421 return NULL;
6422
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006423 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006424 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006425 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006426 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006427 ht = find_var_ht(name, &varname);
6428 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006429 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006430 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006431 if (!HASHITEM_EMPTY(hi))
6432 {
6433 *pht = ht;
6434 break;
6435 }
6436 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006437 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006438 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006439 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006440 }
6441 current_funccal = old_current_funccal;
6442
6443 return hi;
6444}
6445
6446/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006447 * Search variable in parent scope.
6448 */
6449 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006450find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006451{
6452 dictitem_T *v = NULL;
6453 funccall_T *old_current_funccal = current_funccal;
6454 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006455 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006456
Bram Moolenaarca16c602022-09-06 18:57:08 +01006457 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006458 return NULL;
6459
Bram Moolenaare38eab22019-12-05 21:50:01 +01006460 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006461 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006462 while (current_funccal)
6463 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006464 ht = find_var_ht(name, &varname);
6465 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006466 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006467 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006468 if (v != NULL)
6469 break;
6470 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006471 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006472 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006473 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006474 }
6475 current_funccal = old_current_funccal;
6476
6477 return v;
6478}
6479
6480/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006481 * Set "copyID + 1" in previous_funccal and callers.
6482 */
6483 int
6484set_ref_in_previous_funccal(int copyID)
6485{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006486 funccall_T *fc;
6487
Bram Moolenaarca16c602022-09-06 18:57:08 +01006488 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006489 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006490 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006491 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6492 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6493 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006494 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006495 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006496 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006497}
6498
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006499 static int
6500set_ref_in_funccal(funccall_T *fc, int copyID)
6501{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006502 if (fc->fc_copyID != copyID)
6503 {
6504 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006505 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6506 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6507 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6508 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006509 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006510 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006511 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006512}
6513
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006514/*
6515 * Set "copyID" in all local vars and arguments in the call stack.
6516 */
6517 int
6518set_ref_in_call_stack(int copyID)
6519{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006520 funccall_T *fc;
6521 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006522
Bram Moolenaarca16c602022-09-06 18:57:08 +01006523 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006524 if (set_ref_in_funccal(fc, copyID))
6525 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006526
6527 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006528 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006529 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006530 if (set_ref_in_funccal(fc, copyID))
6531 return TRUE;
6532 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006533}
6534
6535/*
6536 * Set "copyID" in all functions available by name.
6537 */
6538 int
6539set_ref_in_functions(int copyID)
6540{
6541 int todo;
6542 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006543 ufunc_T *fp;
6544
6545 todo = (int)func_hashtab.ht_used;
6546 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006547 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006548 if (!HASHITEM_EMPTY(hi))
6549 {
6550 --todo;
6551 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006552 if (!func_name_refcount(fp->uf_name)
6553 && set_ref_in_func(NULL, fp, copyID))
6554 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006555 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006556 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006557 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006558}
6559
6560/*
6561 * Set "copyID" in all function arguments.
6562 */
6563 int
6564set_ref_in_func_args(int copyID)
6565{
6566 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006567
6568 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006569 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6570 copyID, NULL, NULL))
6571 return TRUE;
6572 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006573}
6574
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006575/*
6576 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006577 * Returns TRUE if setting references failed somehow.
6578 */
6579 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006580set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006581{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006582 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006583 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006584 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006585 char_u fname_buf[FLEN_FIXED + 1];
6586 char_u *tofree = NULL;
6587 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006588 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006589
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006590 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006591 return FALSE;
6592
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006593 if (fp_in == NULL)
6594 {
6595 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006596 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006597 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006598 if (fp != NULL)
6599 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006600 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006601 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006602 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006603
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006604 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006605 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006606}
6607
Bram Moolenaare38eab22019-12-05 21:50:01 +01006608#endif // FEAT_EVAL