blob: 0f194d57e6b1f8c11bf542be15ccc710d36cdf4b [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
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001884 * and set "tofree".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885 */
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);
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001894 if (llen == 0)
1895 return name; // no prefix
1896
1897 fname_buf[0] = K_SPECIAL;
1898 fname_buf[1] = KS_EXTRA;
1899 fname_buf[2] = (int)KE_SNR;
1900 i = 3;
1901 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001903 if (current_sctx.sc_sid <= 0)
1904 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001905 else
1906 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001907 sprintf((char *)fname_buf + 3, "%ld_",
1908 (long)current_sctx.sc_sid);
1909 i = (int)STRLEN(fname_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001910 }
1911 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001912 if (i + STRLEN(name + llen) < FLEN_FIXED)
1913 {
1914 STRCPY(fname_buf + i, name + llen);
1915 fname = fname_buf;
1916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 else
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001918 {
1919 fname = alloc(i + STRLEN(name + llen) + 1);
1920 if (fname == NULL)
1921 *error = FCERR_OTHER;
1922 else
1923 {
1924 *tofree = fname;
1925 mch_memmove(fname, fname_buf, (size_t)i);
1926 STRCPY(fname + i, name + llen);
1927 }
1928 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001929 return fname;
1930}
1931
1932/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001933 * Concatenate the script ID and function name into "<SNR>99_name".
1934 * "buffer" must have size MAX_FUNC_NAME_LEN.
1935 */
1936 void
1937func_name_with_sid(char_u *name, int sid, char_u *buffer)
1938{
1939 // A script-local function is stored as "<SNR>99_name".
1940 buffer[0] = K_SPECIAL;
1941 buffer[1] = KS_EXTRA;
1942 buffer[2] = (int)KE_SNR;
1943 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1944 (long)sid, name);
1945}
1946
1947/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948 * Find a function "name" in script "sid".
1949 */
1950 static ufunc_T *
1951find_func_with_sid(char_u *name, int sid)
1952{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001953 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001954 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955
Bram Moolenaarb8822442022-01-11 15:24:05 +00001956 if (!SCRIPT_ID_VALID(sid))
1957 return NULL; // not in a script
1958
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001959 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 hi = hash_find(&func_hashtab, buffer);
1961 if (!HASHITEM_EMPTY(hi))
1962 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001963 return NULL;
1964}
1965
1966/*
1967 * Find a function "name" in script "sid" prefixing the autoload prefix.
1968 */
1969 static ufunc_T *
1970find_func_with_prefix(char_u *name, int sid)
1971{
1972 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001973 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001974 scriptitem_T *si;
1975
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001976 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001977 return NULL; // already has the prefix
1978 if (!SCRIPT_ID_VALID(sid))
1979 return NULL; // not in a script
1980 si = SCRIPT_ITEM(sid);
1981 if (si->sn_autoload_prefix != NULL)
1982 {
1983 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1984 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001985 char_u *namep;
1986
1987 // skip a "<SNR>99_" prefix
1988 namep = untrans_function_name(name);
1989 if (namep == NULL)
1990 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001991
1992 // An exported function in an autoload script is stored as
1993 // "dir#path#name".
1994 if (len < sizeof(buffer))
1995 auto_name = buffer;
1996 else
1997 auto_name = alloc(len);
1998 if (auto_name != NULL)
1999 {
2000 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002001 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002002 hi = hash_find(&func_hashtab, auto_name);
2003 if (auto_name != buffer)
2004 vim_free(auto_name);
2005 if (!HASHITEM_EMPTY(hi))
2006 return HI2UF(hi);
2007 }
2008 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009
2010 return NULL;
2011}
2012
2013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002015 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2016 * functions.
2017 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002018 * Return NULL for unknown function.
2019 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002020 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002021find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002022{
2023 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002025
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002026 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002028 // Find script-local function before global one.
2029 if (in_vim9script() && eval_isnamec1(*name)
2030 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002032 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2033 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002034 if (func != NULL)
2035 return func;
2036 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002037 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2038 {
2039 char_u *p = name + 5;
2040 long sid;
2041
2042 // printable "<SNR>123_Name" form
2043 sid = getdigits(&p);
2044 if (*p == '_')
2045 {
2046 func = find_func_with_sid(p + 1, (int)sid);
2047 if (func != NULL)
2048 return func;
2049 }
2050 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002052
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002053 if ((flags & FFED_NO_GLOBAL) == 0)
2054 {
2055 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002056 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002057 if (!HASHITEM_EMPTY(hi))
2058 return HI2UF(hi);
2059 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002060
Bram Moolenaarb8822442022-01-11 15:24:05 +00002061 // Find autoload function if this is an autoload script.
2062 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2063 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002064}
2065
2066/*
2067 * Find a function by name, return pointer to it in ufuncs.
2068 * "cctx" is passed in a :def function to find imported functions.
2069 * Return NULL for unknown or dead function.
2070 */
2071 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002072find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002073{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002074 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002075
2076 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2077 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 return NULL;
2079}
2080
2081/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002082 * Return TRUE if "ufunc" is a global function.
2083 */
2084 int
2085func_is_global(ufunc_T *ufunc)
2086{
2087 return ufunc->uf_name[0] != K_SPECIAL;
2088}
2089
2090/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002091 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2092 */
2093 int
2094func_requires_g_prefix(ufunc_T *ufunc)
2095{
2096 return ufunc->uf_name[0] != K_SPECIAL
2097 && (ufunc->uf_flags & FC_LAMBDA) == 0
2098 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2099}
2100
2101/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102 * Copy the function name of "fp" to buffer "buf".
2103 * "buf" must be able to hold the function name plus three bytes.
2104 * Takes care of script-local function names.
2105 */
2106 static void
2107cat_func_name(char_u *buf, ufunc_T *fp)
2108{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002109 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 {
2111 STRCPY(buf, "<SNR>");
2112 STRCAT(buf, fp->uf_name + 3);
2113 }
2114 else
2115 STRCPY(buf, fp->uf_name);
2116}
2117
2118/*
2119 * Add a number variable "name" to dict "dp" with value "nr".
2120 */
2121 static void
2122add_nr_var(
2123 dict_T *dp,
2124 dictitem_T *v,
2125 char *name,
2126 varnumber_T nr)
2127{
2128 STRCPY(v->di_key, name);
2129 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2130 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2131 v->di_tv.v_type = VAR_NUMBER;
2132 v->di_tv.v_lock = VAR_FIXED;
2133 v->di_tv.vval.v_number = nr;
2134}
2135
2136/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002137 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002138 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002139 static void
2140free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002143
Bram Moolenaarca16c602022-09-06 18:57:08 +01002144 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002145 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002146 ufunc_T *fp = ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002147
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002148 // When garbage collecting a funccall_T may be freed before the
2149 // function that references it, clear its uf_scoped field.
2150 // The function may have been redefined and point to another
2151 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002152 if (fp != NULL && fp->uf_scoped == fc)
2153 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002154 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002155 ga_clear(&fc->fc_ufuncs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002156
Bram Moolenaarca16c602022-09-06 18:57:08 +01002157 func_ptr_unref(fc->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002158 vim_free(fc);
2159}
2160
2161/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002162 * Free "fc" and what it contains.
2163 * Can be called only when "fc" is kept beyond the period of it called,
2164 * i.e. after cleanup_function_call(fc).
2165 */
2166 static void
2167free_funccal_contents(funccall_T *fc)
2168{
2169 listitem_T *li;
2170
2171 // Free all l: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002172 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002173
2174 // Free all a: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002175 vars_clear(&fc->fc_l_avars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002176
2177 // Free the a:000 variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002178 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002179 clear_tv(&li->li_tv);
2180
2181 free_funccal(fc);
2182}
2183
2184/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002185 * Handle the last part of returning from a function: free the local hashtable.
2186 * Unless it is still in use by a closure.
2187 */
2188 static void
2189cleanup_function_call(funccall_T *fc)
2190{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002191 int may_free_fc = fc->fc_refcount <= 0;
2192 int free_fc = TRUE;
2193
Bram Moolenaarca16c602022-09-06 18:57:08 +01002194 current_funccal = fc->fc_caller;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002195
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002196 // Free all l: variables if not referred.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002197 if (may_free_fc && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT)
2198 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002199 else
2200 free_fc = FALSE;
2201
2202 // If the a:000 list and the l: and a: dicts are not referenced and
2203 // there is no closure using it, we can free the funccall_T and what's
2204 // in it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002205 if (may_free_fc && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)
2206 vars_clear_ext(&fc->fc_l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002207 else
2208 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002209 int todo;
2210 hashitem_T *hi;
2211 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002212
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002213 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002214
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002215 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002216 todo = (int)fc->fc_l_avars.dv_hashtab.ht_used;
2217 for (hi = fc->fc_l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002218 {
2219 if (!HASHITEM_EMPTY(hi))
2220 {
2221 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002222 di = HI2DI(hi);
2223 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002224 }
2225 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002226 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002227
Bram Moolenaarca16c602022-09-06 18:57:08 +01002228 if (may_free_fc && fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2229 fc->fc_l_varlist.lv_first = NULL;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002230 else
2231 {
2232 listitem_T *li;
2233
2234 free_fc = FALSE;
2235
2236 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002237 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002238 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002239 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002240
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002241 if (free_fc)
2242 free_funccal(fc);
2243 else
2244 {
2245 static int made_copy = 0;
2246
2247 // "fc" is still in use. This can happen when returning "a:000",
2248 // assigning "l:" to a global variable or defining a closure.
2249 // Link "fc" in the list for garbage collection later.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002250 fc->fc_caller = previous_funccal;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002251 previous_funccal = fc;
2252
2253 if (want_garbage_collect)
2254 // If garbage collector is ready, clear count.
2255 made_copy = 0;
2256 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002257 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002258 // We have made a lot of copies, worth 4 Mbyte. This can happen
2259 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002260 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002261 // too much memory.
2262 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002263 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002264 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002265 }
2266}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002267
2268/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002269 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2270 */
2271 static int
2272numbered_function(char_u *name)
2273{
2274 return isdigit(*name)
2275 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2276}
2277
2278/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002279 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002280 * 1. ordinary names, function defined with :function or :def;
2281 * can start with "<SNR>123_" literally or with K_SPECIAL.
2282 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002283 * For the first we only count the name stored in func_hashtab as a reference,
2284 * using function() does not count as a reference, because the function is
2285 * looked up by name.
2286 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002287 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002288func_name_refcount(char_u *name)
2289{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002290 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002291}
2292
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002293/*
2294 * Unreference "fc": decrement the reference count and free it when it
2295 * becomes zero. "fp" is detached from "fc".
2296 * When "force" is TRUE we are exiting.
2297 */
2298 static void
2299funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2300{
2301 funccall_T **pfc;
2302 int i;
2303
2304 if (fc == NULL)
2305 return;
2306
2307 if (--fc->fc_refcount <= 0 && (force || (
Bram Moolenaarca16c602022-09-06 18:57:08 +01002308 fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT
2309 && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT
2310 && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2311 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->fc_caller)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002312 {
2313 if (fc == *pfc)
2314 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002315 *pfc = fc->fc_caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002316 free_funccal_contents(fc);
2317 return;
2318 }
2319 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002320 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
2321 if (((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] == fp)
2322 ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002323}
2324
2325/*
2326 * Remove the function from the function hashtable. If the function was
2327 * deleted while it still has references this was already done.
2328 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2329 */
2330 static int
2331func_remove(ufunc_T *fp)
2332{
2333 hashitem_T *hi;
2334
2335 // Return if it was already virtually deleted.
2336 if (fp->uf_flags & FC_DEAD)
2337 return FALSE;
2338
2339 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2340 if (!HASHITEM_EMPTY(hi))
2341 {
2342 // When there is a def-function index do not actually remove the
2343 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002344 // Do remove it when it's a copy.
2345 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002346 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002347 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002348 return FALSE;
2349 }
2350 hash_remove(&func_hashtab, hi);
2351 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002352 return TRUE;
2353 }
2354 return FALSE;
2355}
2356
2357 static void
2358func_clear_items(ufunc_T *fp)
2359{
2360 ga_clear_strings(&(fp->uf_args));
2361 ga_clear_strings(&(fp->uf_def_args));
2362 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002363 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002364 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002365 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002366 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002367
2368 // Increment the refcount of this function to avoid it being freed
2369 // recursively when the partial is freed.
2370 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002371 partial_unref(fp->uf_partial);
2372 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002373 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002374
2375#ifdef FEAT_LUA
2376 if (fp->uf_cb_free != NULL)
2377 {
2378 fp->uf_cb_free(fp->uf_cb_state);
2379 fp->uf_cb_free = NULL;
2380 }
2381
2382 fp->uf_cb_state = NULL;
2383 fp->uf_cb = NULL;
2384#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002385#ifdef FEAT_PROFILE
2386 VIM_CLEAR(fp->uf_tml_count);
2387 VIM_CLEAR(fp->uf_tml_total);
2388 VIM_CLEAR(fp->uf_tml_self);
2389#endif
2390}
2391
2392/*
2393 * Free all things that a function contains. Does not free the function
2394 * itself, use func_free() for that.
2395 * When "force" is TRUE we are exiting.
2396 */
2397 static void
2398func_clear(ufunc_T *fp, int force)
2399{
2400 if (fp->uf_cleared)
2401 return;
2402 fp->uf_cleared = TRUE;
2403
2404 // clear this function
2405 func_clear_items(fp);
2406 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002407 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002408}
2409
2410/*
2411 * Free a function and remove it from the list of functions. Does not free
2412 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002413 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002414 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002415 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002416 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002417func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002418{
2419 // Only remove it when not done already, otherwise we would remove a newer
2420 // version of the function with the same name.
2421 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2422 func_remove(fp);
2423
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002424 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002425 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002426 if (fp->uf_dfunc_idx > 0)
2427 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002428 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002429 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002430 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002431 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002432 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002433}
2434
2435/*
2436 * Free all things that a function contains and free the function itself.
2437 * When "force" is TRUE we are exiting.
2438 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002439 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002440func_clear_free(ufunc_T *fp, int force)
2441{
2442 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002443 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2444 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002445 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002446 else
2447 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002448}
2449
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002450/*
2451 * Copy already defined function "lambda" to a new function with name "global".
2452 * This is for when a compiled function defines a global function.
2453 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002454 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002455copy_lambda_to_global_func(
Bram Moolenaarcc341812022-09-19 15:54:34 +01002456 char_u *lambda,
2457 char_u *global,
2458 loopvarinfo_T *loopvarinfo,
2459 ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002460{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002461 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002462 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002463
2464 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002465 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002466 semsg(_(e_lambda_function_not_found_str), lambda);
2467 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002468 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002469
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002470 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002471 if (fp != NULL)
2472 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002473 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002474 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002475 return FAIL;
2476 }
2477
2478 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2479 if (fp == NULL)
2480 return FAIL;
2481
2482 fp->uf_varargs = ufunc->uf_varargs;
2483 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2484 fp->uf_def_status = ufunc->uf_def_status;
2485 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2486 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2487 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2488 == FAIL
2489 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2490 goto failed;
2491
2492 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2493 : vim_strsave(ufunc->uf_name_exp);
2494 if (ufunc->uf_arg_types != NULL)
2495 {
2496 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2497 if (fp->uf_arg_types == NULL)
2498 goto failed;
2499 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2500 sizeof(type_T *) * fp->uf_args.ga_len);
2501 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002502 if (ufunc->uf_va_name != NULL)
2503 {
2504 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2505 if (fp->uf_va_name == NULL)
2506 goto failed;
2507 }
2508 fp->uf_ret_type = ufunc->uf_ret_type;
2509
2510 fp->uf_refcount = 1;
2511 STRCPY(fp->uf_name, global);
2512 hash_add(&func_hashtab, UF2HIKEY(fp));
2513
2514 // the referenced dfunc_T is now used one more time
2515 link_def_function(fp);
2516
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002517 // Create a partial to store the context of the function where it was
2518 // instantiated. Only needs to be done once. Do this on the original
2519 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002520 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2521 {
2522 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2523
2524 if (pt == NULL)
2525 goto failed;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002526 if (fill_partial_and_closure(pt, ufunc, loopvarinfo, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002527 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002528 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002529 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002530 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002531 ufunc->uf_partial = pt;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002532 }
2533
2534 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002535
2536failed:
2537 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002538 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002539}
2540
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002541static int funcdepth = 0;
2542
2543/*
2544 * Increment the function call depth count.
2545 * Return FAIL when going over 'maxfuncdepth'.
2546 * Otherwise return OK, must call funcdepth_decrement() later!
2547 */
2548 int
2549funcdepth_increment(void)
2550{
2551 if (funcdepth >= p_mfd)
2552 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002553 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002554 return FAIL;
2555 }
2556 ++funcdepth;
2557 return OK;
2558}
2559
2560 void
2561funcdepth_decrement(void)
2562{
2563 --funcdepth;
2564}
2565
2566/*
2567 * Get the current function call depth.
2568 */
2569 int
2570funcdepth_get(void)
2571{
2572 return funcdepth;
2573}
2574
2575/*
2576 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002577 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002578 * times as funcdepth_increment().
2579 */
2580 void
2581funcdepth_restore(int depth)
2582{
2583 funcdepth = depth;
2584}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002585
2586/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002587 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2588 * "rettv".
2589 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2590 * Returns NULL when allocation fails.
2591 */
2592 funccall_T *
2593create_funccal(ufunc_T *fp, typval_T *rettv)
2594{
2595 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2596
2597 if (fc == NULL)
2598 return NULL;
2599 fc->fc_caller = current_funccal;
2600 current_funccal = fc;
2601 fc->fc_func = fp;
2602 func_ptr_ref(fp);
2603 fc->fc_rettv = rettv;
2604 return fc;
2605}
2606
2607/*
2608 * To be called when returning from a compiled function; restores
2609 * current_funccal.
2610 */
2611 void
2612remove_funccal()
2613{
2614 funccall_T *fc = current_funccal;
2615
2616 current_funccal = fc->fc_caller;
2617 free_funccal(fc);
2618}
2619
2620/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002621 * Call a user function.
2622 */
2623 static void
2624call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002625 ufunc_T *fp, // pointer to function
2626 int argcount, // nr of args
2627 typval_T *argvars, // arguments
2628 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002629 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002630 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002631{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002632 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002633 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002634 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002635 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 funccall_T *fc;
2637 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002638 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002639 dictitem_T *v;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002640 int fixvar_idx = 0; // index in fc_fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002641 int i;
2642 int ai;
2643 int islambda = FALSE;
2644 char_u numbuf[NUMBUFLEN];
2645 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002646 typval_T *tv_to_free[MAX_FUNC_ARGS];
2647 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002648#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002649 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002650#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002651 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002652
Bram Moolenaarb2049902021-01-24 12:53:53 +01002653#ifdef FEAT_PROFILE
2654 CLEAR_FIELD(profile_info);
2655#endif
2656
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002657 // If depth of calling is getting too high, don't execute the function.
2658 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002659 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660 rettv->v_type = VAR_NUMBER;
2661 rettv->vval.v_number = -1;
2662 return;
2663 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002664
Bram Moolenaare38eab22019-12-05 21:50:01 +01002665 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002666
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002667 fc = create_funccal(fp, rettv);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002668 if (fc == NULL)
2669 return;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002670 fc->fc_level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002671 // Check if this function has a breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002672 fc->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2673 fc->fc_dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002674 // Set up fields for closure.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002675 ga_init2(&fc->fc_ufuncs, sizeof(ufunc_T *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002676
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002677 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002678 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002679#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01002680 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002681#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002682 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002683#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002684 if (do_profiling == PROF_YES)
2685 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002686#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002687 sticky_cmdmod_flags = 0;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01002688 call_def_function(fp, argcount, argvars, 0, funcexe->fe_partial,
Bram Moolenaar58779852022-09-06 18:31:14 +01002689 fc, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002690 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002691#ifdef FEAT_PROFILE
2692 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002693 || (caller != NULL && caller->uf_profiling)))
2694 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002695#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002696 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002697 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002698 return;
2699 }
2700
Bram Moolenaar38453522021-11-28 22:00:12 +00002701 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002702
2703 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002704 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2705 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2706 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002707 */
2708 /*
2709 * Init l: variables.
2710 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002711 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002712 if (selfdict != NULL)
2713 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002714 // Set l:self to "selfdict". Use "name" to avoid a warning from
2715 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002716 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002717 name = v->di_key;
2718 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002719 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002720 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002721 v->di_tv.v_type = VAR_DICT;
2722 v->di_tv.v_lock = 0;
2723 v->di_tv.vval.v_dict = selfdict;
2724 ++selfdict->dv_refcount;
2725 }
2726
2727 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002728 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002729 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002730 * Set a:000 to a list with room for the "..." arguments.
2731 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002732 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002733 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002734 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002735 (varnumber_T)(argcount >= fp->uf_args.ga_len
2736 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002737 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002738 if ((fp->uf_flags & FC_NOARGS) == 0)
2739 {
2740 // Use "name" to avoid a warning from some compiler that checks the
2741 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002742 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002743 name = v->di_key;
2744 STRCPY(name, "000");
2745 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002746 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002747 v->di_tv.v_type = VAR_LIST;
2748 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002749 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002750 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002751 CLEAR_FIELD(fc->fc_l_varlist);
2752 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2753 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002754
2755 /*
2756 * Set a:firstline to "firstline" and a:lastline to "lastline".
2757 * Set a:name to named arguments.
2758 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002759 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002760 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002761 if ((fp->uf_flags & FC_NOARGS) == 0)
2762 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002763 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2764 "firstline", (varnumber_T)funcexe->fe_firstline);
2765 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2766 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002767 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002768 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002769 {
2770 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002771 typval_T def_rettv;
2772 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002773
2774 ai = i - fp->uf_args.ga_len;
2775 if (ai < 0)
2776 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002777 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002778 name = FUNCARG(fp, i);
2779 if (islambda)
2780 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002781
2782 // evaluate named argument default expression
2783 isdefault = ai + fp->uf_def_args.ga_len >= 0
2784 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2785 && argvars[i].vval.v_number == VVAL_NONE));
2786 if (isdefault)
2787 {
2788 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002789
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002790 def_rettv.v_type = VAR_NUMBER;
2791 def_rettv.vval.v_number = -1;
2792
2793 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2794 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002795 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002796 {
2797 default_arg_err = 1;
2798 break;
2799 }
2800 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002801 }
2802 else
2803 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002804 if ((fp->uf_flags & FC_NOARGS) != 0)
2805 // Bail out if no a: arguments used (in lambda).
2806 break;
2807
Bram Moolenaare38eab22019-12-05 21:50:01 +01002808 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002809 sprintf((char *)numbuf, "%d", ai + 1);
2810 name = numbuf;
2811 }
2812 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2813 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002814 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002815 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002816 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002817 }
2818 else
2819 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002820 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 if (v == NULL)
2822 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002823 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002824 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002826 // Note: the values are copied directly to avoid alloc/free.
2827 // "argvars" must have VAR_FIXED for v_lock.
2828 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002829 v->di_tv.v_lock = VAR_FIXED;
2830
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002831 if (isdefault)
2832 // Need to free this later, no matter where it's stored.
2833 tv_to_free[tv_to_free_len++] = &v->di_tv;
2834
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002835 if (addlocal)
2836 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002837 // Named arguments should be accessed without the "a:" prefix in
2838 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002839 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002840 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002842 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01002843 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002844
2845 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2846 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002847 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002848
2849 li->li_tv = argvars[i];
2850 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002851 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002852 }
2853 }
2854
Bram Moolenaare38eab22019-12-05 21:50:01 +01002855 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002856 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002857
2858 if (fp->uf_flags & FC_SANDBOX)
2859 {
2860 using_sandbox = TRUE;
2861 ++sandbox;
2862 }
2863
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002864 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002865 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002866 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002868 ++no_wait_return;
2869 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002871 smsg(_("calling %s"), SOURCING_NAME);
2872 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002873 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002874 char_u buf[MSG_BUF_LEN];
2875 char_u numbuf2[NUMBUFLEN];
2876 char_u *tofree;
2877 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002879 msg_puts("(");
2880 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002881 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002882 if (i > 0)
2883 msg_puts(", ");
2884 if (argvars[i].v_type == VAR_NUMBER)
2885 msg_outnum((long)argvars[i].vval.v_number);
2886 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002887 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002888 // Do not want errors such as E724 here.
2889 ++emsg_off;
2890 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2891 --emsg_off;
2892 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002893 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002894 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002895 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002896 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2897 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002899 msg_puts((char *)s);
2900 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002901 }
2902 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002903 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002904 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002905 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002906 msg_puts("\n"); // don't overwrite this either
2907
2908 verbose_leave_scroll();
2909 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002910 }
2911#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002912 if (do_profiling == PROF_YES)
2913 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002914 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002915#endif
2916
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002917 // "legacy" does not apply to commands in the function
2918 sticky_cmdmod_flags = 0;
2919
Bram Moolenaar98aff652022-09-06 21:02:35 +01002920 // If called from a compiled :def function the execution context must be
2921 // hidden, any deferred functions need to be added to the function being
2922 // executed here.
2923 save_current_ectx = clear_currrent_ectx();
2924
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002925 save_current_sctx = current_sctx;
2926 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002927 save_did_emsg = did_emsg;
2928 did_emsg = FALSE;
2929
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002930 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2931 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002932 else if (islambda)
2933 {
2934 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2935
2936 // A Lambda always has the command "return {expr}". It is much faster
2937 // to evaluate {expr} directly.
2938 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002939 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002940 --ex_nesting_level;
2941 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002942 else
2943 // call do_cmdline() to execute the lines
2944 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002945 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2946
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002947 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01002948 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002949
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950 --RedrawingDisabled;
2951
Bram Moolenaare38eab22019-12-05 21:50:01 +01002952 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002953 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2954 {
2955 clear_tv(rettv);
2956 rettv->v_type = VAR_NUMBER;
2957 rettv->vval.v_number = -1;
2958 }
2959
2960#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002961 if (do_profiling == PROF_YES)
2962 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002963 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002964
2965 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2966 profile_may_end_func(&profile_info, fp, caller);
2967 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968#endif
2969
Bram Moolenaare38eab22019-12-05 21:50:01 +01002970 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002971 if (p_verbose >= 12)
2972 {
2973 ++no_wait_return;
2974 verbose_enter_scroll();
2975
2976 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002977 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002978 else if (fc->fc_rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002979 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002980 (long)fc->fc_rettv->vval.v_number);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002981 else
2982 {
2983 char_u buf[MSG_BUF_LEN];
2984 char_u numbuf2[NUMBUFLEN];
2985 char_u *tofree;
2986 char_u *s;
2987
Bram Moolenaare38eab22019-12-05 21:50:01 +01002988 // The value may be very long. Skip the middle part, so that we
2989 // have some idea how it starts and ends. smsg() would always
2990 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002991 ++emsg_off;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002992 s = tv2string(fc->fc_rettv, &tofree, numbuf2, 0);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002993 --emsg_off;
2994 if (s != NULL)
2995 {
2996 if (vim_strsize(s) > MSG_BUF_CLEN)
2997 {
2998 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2999 s = buf;
3000 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003001 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003002 vim_free(tofree);
3003 }
3004 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003005 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003006
3007 verbose_leave_scroll();
3008 --no_wait_return;
3009 }
3010
Bram Moolenaare31ee862020-01-07 20:59:34 +01003011 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003012 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003013 current_sctx = save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01003014 restore_current_ectx(save_current_ectx);
3015
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016#ifdef FEAT_PROFILE
3017 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003018 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003019#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02003020 if (using_sandbox)
3021 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003022 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003023
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003024 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003025 {
3026 ++no_wait_return;
3027 verbose_enter_scroll();
3028
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003029 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003030 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003031
3032 verbose_leave_scroll();
3033 --no_wait_return;
3034 }
3035
3036 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01003037 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02003038 for (i = 0; i < tv_to_free_len; ++i)
3039 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003040 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003041}
3042
3043/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003044 * Check the argument count for user function "fp".
3045 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3046 */
3047 int
3048check_user_func_argcount(ufunc_T *fp, int argcount)
3049{
3050 int regular_args = fp->uf_args.ga_len;
3051
3052 if (argcount < regular_args - fp->uf_def_args.ga_len)
3053 return FCERR_TOOFEW;
3054 else if (!has_varargs(fp) && argcount > regular_args)
3055 return FCERR_TOOMANY;
3056 return FCERR_UNKNOWN;
3057}
3058
3059/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003060 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003061 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003062 int
3063call_user_func_check(
3064 ufunc_T *fp,
3065 int argcount,
3066 typval_T *argvars,
3067 typval_T *rettv,
3068 funcexe_T *funcexe,
3069 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003070{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003071 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003072
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003073#ifdef FEAT_LUA
3074 if (fp->uf_flags & FC_CFUNC)
3075 {
3076 cfunc_T cb = fp->uf_cb;
3077
3078 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3079 }
3080#endif
3081
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003082 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3083 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003084 error = check_user_func_argcount(fp, argcount);
3085 if (error != FCERR_UNKNOWN)
3086 return error;
3087 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003088 error = FCERR_DICT;
3089 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003090 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003091 int did_save_redo = FALSE;
3092 save_redo_T save_redo;
3093
3094 /*
3095 * Call the user function.
3096 * Save and restore search patterns, script variables and
3097 * redo buffer.
3098 */
3099 save_search_patterns();
3100 if (!ins_compl_active())
3101 {
3102 saveRedobuff(&save_redo);
3103 did_save_redo = TRUE;
3104 }
3105 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003106 call_user_func(fp, argcount, argvars, rettv, funcexe,
3107 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003108 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3109 // Function was unreferenced while being used, free it now.
3110 func_clear_free(fp, FALSE);
3111 if (did_save_redo)
3112 restoreRedobuff(&save_redo);
3113 restore_search_patterns();
3114 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003115 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003116 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003117}
3118
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003119static funccal_entry_T *funccal_stack = NULL;
3120
3121/*
3122 * Save the current function call pointer, and set it to NULL.
3123 * Used when executing autocommands and for ":source".
3124 */
3125 void
3126save_funccal(funccal_entry_T *entry)
3127{
3128 entry->top_funccal = current_funccal;
3129 entry->next = funccal_stack;
3130 funccal_stack = entry;
3131 current_funccal = NULL;
3132}
3133
3134 void
3135restore_funccal(void)
3136{
3137 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003138 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003139 else
3140 {
3141 current_funccal = funccal_stack->top_funccal;
3142 funccal_stack = funccal_stack->next;
3143 }
3144}
3145
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003146 funccall_T *
3147get_current_funccal(void)
3148{
3149 return current_funccal;
3150}
3151
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003152/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003153 * Return TRUE when currently at the script level:
3154 * - not in a function
3155 * - not executing an autocommand
3156 * Note that when an autocommand sources a script the result is FALSE;
3157 */
3158 int
3159at_script_level(void)
3160{
3161 return current_funccal == NULL && autocmd_match == NULL;
3162}
3163
3164/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003165 * Mark all functions of script "sid" as deleted.
3166 */
3167 void
3168delete_script_functions(int sid)
3169{
3170 hashitem_T *hi;
3171 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003172 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003173 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003174 size_t len;
3175
3176 buf[0] = K_SPECIAL;
3177 buf[1] = KS_EXTRA;
3178 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003179 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003180 len = STRLEN(buf);
3181
Bram Moolenaarce658352020-07-31 23:47:12 +02003182 while (todo > 0)
3183 {
3184 todo = func_hashtab.ht_used;
3185 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3186 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003187 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003188 fp = HI2UF(hi);
3189 if (STRNCMP(fp->uf_name, buf, len) == 0)
3190 {
3191 int changed = func_hashtab.ht_changed;
3192
3193 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003194
3195 if (fp->uf_calls > 0)
3196 {
3197 // Function is executing, don't free it but do remove
3198 // it from the hashtable.
3199 if (func_remove(fp))
3200 fp->uf_refcount--;
3201 }
3202 else
3203 {
3204 func_clear(fp, TRUE);
3205 // When clearing a function another function can be
3206 // cleared as a side effect. When that happens start
3207 // over.
3208 if (changed != func_hashtab.ht_changed)
3209 break;
3210 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003211 }
3212 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003213 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003214 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003215}
3216
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003217#if defined(EXITFREE) || defined(PROTO)
3218 void
3219free_all_functions(void)
3220{
3221 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003222 ufunc_T *fp;
3223 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003224 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003225 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003226
Bram Moolenaare38eab22019-12-05 21:50:01 +01003227 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003228 while (current_funccal != NULL)
3229 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003230 clear_tv(current_funccal->fc_rettv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003231 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003232 if (current_funccal == NULL && funccal_stack != NULL)
3233 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003234 }
3235
Bram Moolenaare38eab22019-12-05 21:50:01 +01003236 // First clear what the functions contain. Since this may lower the
3237 // reference count of a function, it may also free a function and change
3238 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003239 while (todo > 0)
3240 {
3241 todo = func_hashtab.ht_used;
3242 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3243 if (!HASHITEM_EMPTY(hi))
3244 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003245 // clear the def function index now
3246 fp = HI2UF(hi);
3247 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003248 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003249
Bram Moolenaare38eab22019-12-05 21:50:01 +01003250 // Only free functions that are not refcounted, those are
3251 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003252 if (func_name_refcount(fp->uf_name))
3253 ++skipped;
3254 else
3255 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003256 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003257 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003258 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003259 {
3260 skipped = 0;
3261 break;
3262 }
3263 }
3264 --todo;
3265 }
3266 }
3267
Bram Moolenaare38eab22019-12-05 21:50:01 +01003268 // Now actually free the functions. Need to start all over every time,
3269 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003270 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003271 while (func_hashtab.ht_used > skipped)
3272 {
3273 todo = func_hashtab.ht_used;
3274 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003275 if (!HASHITEM_EMPTY(hi))
3276 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003277 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003278 // Only free functions that are not refcounted, those are
3279 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003280 fp = HI2UF(hi);
3281 if (func_name_refcount(fp->uf_name))
3282 ++skipped;
3283 else
3284 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003285 if (func_free(fp, FALSE) == OK)
3286 {
3287 skipped = 0;
3288 break;
3289 }
3290 // did not actually free it
3291 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003292 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003293 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003294 }
3295 if (skipped == 0)
3296 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003297
3298 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003299}
3300#endif
3301
3302/*
3303 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003304 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3305 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306 * "len" is the length of "name", or -1 for NUL terminated.
3307 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003308 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309builtin_function(char_u *name, int len)
3310{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003311 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003312
Bram Moolenaara26b9702020-04-18 19:53:28 +02003313 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003314 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003315 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3316 {
3317 if (name[i] == AUTOLOAD_CHAR)
3318 return FALSE;
3319 if (!eval_isnamec(name[i]))
3320 {
3321 // "name.something" is not a builtin function
3322 if (name[i] == '.')
3323 return FALSE;
3324 break;
3325 }
3326 }
3327 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003328}
3329
3330 int
3331func_call(
3332 char_u *name,
3333 typval_T *args,
3334 partial_T *partial,
3335 dict_T *selfdict,
3336 typval_T *rettv)
3337{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003338 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 listitem_T *item;
3340 typval_T argv[MAX_FUNC_ARGS + 1];
3341 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003342 int r = 0;
3343
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003344 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003345 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003346 {
3347 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3348 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003349 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003350 break;
3351 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003352 // Make a copy of each argument. This is needed to be able to set
3353 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003354 copy_tv(&item->li_tv, &argv[argc++]);
3355 }
3356
3357 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003358 {
3359 funcexe_T funcexe;
3360
Bram Moolenaara80faa82020-04-12 19:37:17 +02003361 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003362 funcexe.fe_firstline = curwin->w_cursor.lnum;
3363 funcexe.fe_lastline = curwin->w_cursor.lnum;
3364 funcexe.fe_evaluate = TRUE;
3365 funcexe.fe_partial = partial;
3366 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003367 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3368 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003369
Bram Moolenaare38eab22019-12-05 21:50:01 +01003370 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003371 while (argc > 0)
3372 clear_tv(&argv[--argc]);
3373
3374 return r;
3375}
3376
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003377static int callback_depth = 0;
3378
3379 int
3380get_callback_depth(void)
3381{
3382 return callback_depth;
3383}
3384
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003385/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003386 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003387 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003388 */
3389 int
3390call_callback(
3391 callback_T *callback,
3392 int len, // length of "name" or -1 to use strlen()
3393 typval_T *rettv, // return value goes here
3394 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003395 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003396 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003397{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003398 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003399 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003400
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003401 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3402 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003403 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003404 funcexe.fe_evaluate = TRUE;
3405 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003406 ++callback_depth;
3407 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3408 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003409
3410 // When a :def function was called that uses :try an error would be turned
3411 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003412 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003413 {
3414 need_rethrow = FALSE;
3415 handle_did_throw();
3416 }
3417
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003418 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003419}
3420
3421/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003422 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003423 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003424 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3425 */
3426 varnumber_T
3427call_callback_retnr(
3428 callback_T *callback,
3429 int argcount, // number of "argvars"
3430 typval_T *argvars) // vars for arguments, must have "argcount"
3431 // PLUS ONE elements!
3432{
3433 typval_T rettv;
3434 varnumber_T retval;
3435
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003436 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003437 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003438
3439 retval = tv_get_number_chk(&rettv, NULL);
3440 clear_tv(&rettv);
3441 return retval;
3442}
3443
3444/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003445 * Give an error message for the result of a function.
3446 * Nothing if "error" is FCERR_NONE.
3447 */
3448 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003449user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003450{
3451 switch (error)
3452 {
3453 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003454 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003455 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003456 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003457 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003458 break;
3459 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003460 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003461 break;
3462 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003463 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 break;
3465 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003466 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003467 break;
3468 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003469 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 break;
3471 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003472 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003473 break;
3474 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003475 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3476 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003477 break;
3478 }
3479}
3480
3481/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003482 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003483 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003484 * Return FAIL when the function can't be called, OK otherwise.
3485 * Also returns OK when an error was encountered while executing the function.
3486 */
3487 int
3488call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003489 char_u *funcname, // name of the function
3490 int len, // length of "name" or -1 to use strlen()
3491 typval_T *rettv, // return value goes here
3492 int argcount_in, // number of "argvars"
3493 typval_T *argvars_in, // vars for arguments, must have "argcount"
3494 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003495 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496{
3497 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003498 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003499 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003500 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003501 char_u fname_buf[FLEN_FIXED + 1];
3502 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003503 char_u *fname = NULL;
3504 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003505 int argcount = argcount_in;
3506 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003507 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003508 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003509 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003510 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003511 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003512 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003513 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003514 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003515
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003516 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3517 // even when call_func() returns FAIL.
3518 rettv->v_type = VAR_UNKNOWN;
3519
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003520 if (partial != NULL)
3521 fp = partial->pt_func;
3522 if (fp == NULL)
3523 {
3524 // Make a copy of the name, if it comes from a funcref variable it
3525 // could be changed or deleted in the called function.
3526 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3527 if (name == NULL)
3528 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003529
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003530 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3531 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003533 if (funcexe->fe_doesrange != NULL)
3534 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003535
3536 if (partial != NULL)
3537 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003538 // When the function has a partial with a dict and there is a dict
3539 // argument, use the dict argument. That is backwards compatible.
3540 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003541 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003542 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003543 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003544 {
3545 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003546 {
3547 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3548 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003549 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003550 goto theend;
3551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003552 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003553 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003554 for (i = 0; i < argcount_in; ++i)
3555 argv[i + argv_clear] = argvars_in[i];
3556 argvars = argv;
3557 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003558
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003559 if (funcexe->fe_check_type != NULL
3560 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003561 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003562 // Now funcexe->fe_check_type is missing the added arguments,
3563 // make a copy of the type with the correction.
3564 check_type = *funcexe->fe_check_type;
3565 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003566 check_type.tt_args = check_type_args;
3567 CLEAR_FIELD(check_type_args);
3568 for (i = 0; i < check_type.tt_argcount; ++i)
3569 check_type_args[i + partial->pt_argc] =
3570 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003571 check_type.tt_argcount += partial->pt_argc;
3572 check_type.tt_min_argcount += partial->pt_argc;
3573 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003574 }
3575 }
3576
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003577 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3578 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003579 {
3580 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003581 if (check_argument_types(funcexe->fe_check_type,
3582 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003583 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003584 error = FCERR_OTHER;
3585 }
3586
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003587 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003588 {
3589 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003590 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003591
Bram Moolenaar333894b2020-08-01 18:53:07 +02003592 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003593 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003594 {
3595 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003596 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003597 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003598
Bram Moolenaare38eab22019-12-05 21:50:01 +01003599 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003600 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003601 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003602
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003603 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003604 {
3605 /*
3606 * User defined function.
3607 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003608 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003609 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003610 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003611 if (fp != NULL && !is_global && in_vim9script()
3612 && func_requires_g_prefix(fp))
3613 // In Vim9 script g: is required to find a global
3614 // non-autoload function.
3615 fp = NULL;
3616 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003617
Bram Moolenaare38eab22019-12-05 21:50:01 +01003618 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 if (fp == NULL
3620 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003621 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003622 && !aborting())
3623 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003624 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003625 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003626 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003627 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003628 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3629 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003630 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003631 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003632 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003633 if (fp == NULL)
3634 {
3635 char_u *p = untrans_function_name(rfname);
3636
3637 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003638 // Don't do this if the name starts with "s:".
3639 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003640 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003641 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003642
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003643 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003644 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003645 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003646 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003647 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003648 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003649 argcount = funcexe->fe_argv_func(argcount, argvars,
zeertzjq48db5da2022-09-16 12:10:03 +01003650 argv_clear, fp);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003651
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003652 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003653 {
3654 // Method call: base->Method()
3655 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003656 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003657 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003658 argvars = argv;
3659 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003660 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003661
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003662 error = call_user_func_check(fp, argcount, argvars, rettv,
3663 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003664 }
3665 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003666 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003667 {
3668 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003669 * expr->method(): Find the method name in the table, call its
3670 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003671 */
3672 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003673 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003674 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003675 else
3676 {
3677 /*
3678 * Find the function name in the table, call its implementation.
3679 */
3680 error = call_internal_func(fname, argcount, argvars, rettv);
3681 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003682
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003683 /*
3684 * The function call (or "FuncUndefined" autocommand sequence) might
3685 * have been aborted by an error, an interrupt, or an explicitly thrown
3686 * exception that has not been caught so far. This situation can be
3687 * tested for by calling aborting(). For an error in an internal
3688 * function or for the "E132" error in call_user_func(), however, the
3689 * throw point at which the "force_abort" flag (temporarily reset by
3690 * emsg()) is normally updated has not been reached yet. We need to
3691 * update that flag first to make aborting() reliable.
3692 */
3693 update_force_abort();
3694 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003695 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 ret = OK;
3697
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003698theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003699 /*
3700 * Report an error unless the argument evaluation or function call has been
3701 * cancelled due to an aborting error, an interrupt, or an exception.
3702 */
3703 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003704 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003705
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003706 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003708 clear_tv(&argv[--argv_clear + argv_base]);
3709
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003710 vim_free(tofree);
3711 vim_free(name);
3712
3713 return ret;
3714}
3715
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003716 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003717printable_func_name(ufunc_T *fp)
3718{
3719 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3720}
3721
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003722/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003723 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003724 */
3725 static void
3726list_func_head(ufunc_T *fp, int indent)
3727{
3728 int j;
3729
3730 msg_start();
3731 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003732 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003733 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003734 msg_puts("def ");
3735 else
3736 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003737 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003738 msg_putchar('(');
3739 for (j = 0; j < fp->uf_args.ga_len; ++j)
3740 {
3741 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003742 msg_puts(", ");
3743 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003744 if (fp->uf_arg_types != NULL)
3745 {
3746 char *tofree;
3747
3748 msg_puts(": ");
3749 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3750 vim_free(tofree);
3751 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003752 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3753 {
3754 msg_puts(" = ");
3755 msg_puts(((char **)(fp->uf_def_args.ga_data))
3756 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3757 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003758 }
3759 if (fp->uf_varargs)
3760 {
3761 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003762 msg_puts(", ");
3763 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003764 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003765 if (fp->uf_va_name != NULL)
3766 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003767 if (!fp->uf_varargs)
3768 {
3769 if (j)
3770 msg_puts(", ");
3771 msg_puts("...");
3772 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003773 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003774 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003775 {
3776 char *tofree;
3777
3778 msg_puts(": ");
3779 msg_puts(type_name(fp->uf_va_type, &tofree));
3780 vim_free(tofree);
3781 }
3782 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003783 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003784
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003785 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003786 {
3787 if (fp->uf_ret_type != &t_void)
3788 {
3789 char *tofree;
3790
3791 msg_puts(": ");
3792 msg_puts(type_name(fp->uf_ret_type, &tofree));
3793 vim_free(tofree);
3794 }
3795 }
3796 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003797 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003798 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003799 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003800 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003801 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003802 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003803 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804 msg_clr_eos();
3805 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003806 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003807}
3808
3809/*
3810 * Get a function name, translating "<SID>" and "<SNR>".
3811 * Also handles a Funcref in a List or Dictionary.
3812 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003813 * Set "*is_global" to TRUE when the function must be global, unless
3814 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003815 * flags:
3816 * TFN_INT: internal function name OK
3817 * TFN_QUIET: be quiet
3818 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003819 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820 * Advances "pp" to just after the function name (if no error).
3821 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003822 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003823trans_function_name(
3824 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003825 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003826 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003827 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003828 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003829 partial_T **partial, // return: partial of a FuncRef
3830 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003831{
3832 char_u *name = NULL;
3833 char_u *start;
3834 char_u *end;
3835 int lead;
3836 char_u sid_buf[20];
3837 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003838 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003839 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003841 int vim9script = in_vim9script();
3842 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843
3844 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003845 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003846 start = *pp;
3847
Bram Moolenaare38eab22019-12-05 21:50:01 +01003848 // Check for hard coded <SNR>: already translated function ID (from a user
3849 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003850 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3851 && (*pp)[2] == (int)KE_SNR)
3852 {
3853 *pp += 3;
3854 len = get_id_len(pp) + 3;
3855 return vim_strnsave(start, len);
3856 }
3857
Bram Moolenaare38eab22019-12-05 21:50:01 +01003858 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3859 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003860 lead = eval_fname_script(start);
3861 if (lead > 2)
3862 start += lead;
3863
Bram Moolenaare38eab22019-12-05 21:50:01 +01003864 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003865 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003867 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003868 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 {
3870 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003871 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003872 goto theend;
3873 }
3874 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3875 {
3876 /*
3877 * Report an invalid expression in braces, unless the expression
3878 * evaluation has been cancelled due to an aborting error, an
3879 * interrupt, or an exception.
3880 */
3881 if (!aborting())
3882 {
3883 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003884 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003885 }
3886 else
3887 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3888 goto theend;
3889 }
3890
3891 if (lv.ll_tv != NULL)
3892 {
3893 if (fdp != NULL)
3894 {
3895 fdp->fd_dict = lv.ll_dict;
3896 fdp->fd_newkey = lv.ll_newkey;
3897 lv.ll_newkey = NULL;
3898 fdp->fd_di = lv.ll_di;
3899 }
3900 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3901 {
3902 name = vim_strsave(lv.ll_tv->vval.v_string);
3903 *pp = end;
3904 }
3905 else if (lv.ll_tv->v_type == VAR_PARTIAL
3906 && lv.ll_tv->vval.v_partial != NULL)
3907 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003908 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003909 *pp = end;
3910 if (partial != NULL)
3911 *partial = lv.ll_tv->vval.v_partial;
3912 }
3913 else
3914 {
3915 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3916 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003917 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003918 else
3919 *pp = end;
3920 name = NULL;
3921 }
3922 goto theend;
3923 }
3924
3925 if (lv.ll_name == NULL)
3926 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003927 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003928 *pp = end;
3929 goto theend;
3930 }
3931
Bram Moolenaare38eab22019-12-05 21:50:01 +01003932 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003933 if (lv.ll_exp_name != NULL)
3934 {
3935 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003936 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003937 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003938 if (name == lv.ll_exp_name)
3939 name = NULL;
3940 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003941 else if (lv.ll_sid > 0)
3942 {
3943 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3944 int cc = *lv.ll_name_end;
3945
3946 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3947 *lv.ll_name_end = NUL;
3948 if (si->sn_autoload_prefix != NULL)
3949 {
3950 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3951 }
3952 else
3953 {
3954 sid_buf[0] = K_SPECIAL;
3955 sid_buf[1] = KS_EXTRA;
3956 sid_buf[2] = (int)KE_SNR;
3957 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003958 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003959 name = concat_str(sid_buf, lv.ll_name);
3960 }
3961 *lv.ll_name_end = cc;
3962 *pp = end;
3963 goto theend;
3964 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003965 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003966 {
3967 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003968 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003969 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003970 if (name == *pp)
3971 name = NULL;
3972 }
3973 if (name != NULL)
3974 {
3975 name = vim_strsave(name);
3976 *pp = end;
3977 if (STRNCMP(name, "<SNR>", 5) == 0)
3978 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003979 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003980 name[0] = K_SPECIAL;
3981 name[1] = KS_EXTRA;
3982 name[2] = (int)KE_SNR;
3983 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3984 }
3985 goto theend;
3986 }
3987
3988 if (lv.ll_exp_name != NULL)
3989 {
3990 len = (int)STRLEN(lv.ll_exp_name);
3991 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3992 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3993 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003994 // When there was "s:" already or the name expanded to get a
3995 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003996 lv.ll_name += 2;
3997 len -= 2;
3998 lead = 2;
3999 }
4000 }
4001 else
4002 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004003 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004004 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004005 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004006 if (lv.ll_name[0] == 'g')
4007 {
4008 if (is_global != NULL)
4009 {
4010 *is_global = TRUE;
4011 }
4012 else
4013 {
4014 // dropping "g:" without setting "is_global" won't work in
4015 // Vim9script, put it back later
4016 prefix_g = TRUE;
4017 extra = 2;
4018 }
4019 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004020 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004021 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004022 len = (int)(end - lv.ll_name);
4023 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004024 if (len <= 0)
4025 {
4026 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004027 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004028 goto theend;
4029 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004030
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004031 // In Vim9 script a user function is script-local by default, unless it
4032 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00004033 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004034
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004035 /*
4036 * Copy the function name to allocated memory.
4037 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4038 * Accept <SNR>123_name() outside a script.
4039 */
4040 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004041 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004042 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004043 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004044 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004045 {
Kota Kato948a3892022-08-16 16:09:59 +01004046 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4047 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004048 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004049 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004050 goto theend;
4051 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004052 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004053 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004054 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004055 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004056 || eval_fname_sid(*pp))
4057 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004058 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004059 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004060 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004061 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 goto theend;
4063 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004064 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004065 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004066 extra = 3 + (int)STRLEN(sid_buf);
4067 else
4068 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004069 }
4070 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004071 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004072 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004073 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004074 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004075 : e_function_name_must_start_with_capital_or_s_str),
4076 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 goto theend;
4078 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004079 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004080 {
4081 char_u *cp = vim_strchr(lv.ll_name, ':');
4082
4083 if (cp != NULL && cp < end)
4084 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004085 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004086 goto theend;
4087 }
4088 }
4089
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004090 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091 if (name != NULL)
4092 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004093 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004094 {
4095 name[0] = K_SPECIAL;
4096 name[1] = KS_EXTRA;
4097 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004098 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004099 STRCPY(name + 3, sid_buf);
4100 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004101 else if (prefix_g)
4102 {
4103 name[0] = 'g';
4104 name[1] = ':';
4105 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004106 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4107 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004108 }
4109 *pp = end;
4110
4111theend:
4112 clear_lval(&lv);
4113 return name;
4114}
4115
4116/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004117 * Assuming "name" is the result of trans_function_name() and it was prefixed
4118 * to use the script-local name, return the unmodified name (points into
4119 * "name"). Otherwise return NULL.
4120 * This can be used to first search for a script-local function and fall back
4121 * to the global function if not found.
4122 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004123 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004124untrans_function_name(char_u *name)
4125{
4126 char_u *p;
4127
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004128 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004129 {
4130 p = vim_strchr(name, '_');
4131 if (p != NULL)
4132 return p + 1;
4133 }
4134 return NULL;
4135}
4136
4137/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004138 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4139 * current script ID and returns the expanded function name. The caller should
4140 * free the returned name. If not called from a script context or the function
4141 * name doesn't start with these prefixes, then returns NULL.
4142 * This doesn't check whether the script-local function exists or not.
4143 */
4144 char_u *
4145get_scriptlocal_funcname(char_u *funcname)
4146{
4147 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004148 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004149 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004150 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004151
4152 if (funcname == NULL)
4153 return NULL;
4154
4155 if (STRNCMP(funcname, "s:", 2) != 0
4156 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004157 {
4158 ufunc_T *ufunc;
4159
4160 // The function name does not have a script-local prefix. Try finding
4161 // it when in a Vim9 script and there is no "g:" prefix.
4162 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4163 return NULL;
4164 ufunc = find_func(funcname, FALSE);
4165 if (ufunc == NULL || func_is_global(ufunc)
4166 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4167 return NULL;
4168 ++p;
4169 off = 0;
4170 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004171 else
4172 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004173
4174 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4175 {
4176 emsg(_(e_using_sid_not_in_script_context));
4177 return NULL;
4178 }
4179 // Expand s: prefix into <SNR>nr_<name>
4180 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4181 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004182 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004183 if (newname == NULL)
4184 return NULL;
4185 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004186 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004187
4188 return newname;
4189}
4190
4191/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004192 * Return script-local "fname" with the 3-byte sequence replaced by
4193 * printable <SNR> in allocated memory.
4194 */
4195 char_u *
4196alloc_printable_func_name(char_u *fname)
4197{
4198 char_u *n = alloc(STRLEN(fname + 3) + 6);
4199
4200 if (n != NULL)
4201 {
4202 STRCPY(n, "<SNR>");
4203 STRCPY(n + 5, fname + 3);
4204 }
4205 return n;
4206}
4207
4208/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004209 * Call trans_function_name(), except that a lambda is returned as-is.
4210 * Returns the name in allocated memory.
4211 */
4212 char_u *
4213save_function_name(
4214 char_u **name,
4215 int *is_global,
4216 int skip,
4217 int flags,
4218 funcdict_T *fudi)
4219{
4220 char_u *p = *name;
4221 char_u *saved;
4222
4223 if (STRNCMP(p, "<lambda>", 8) == 0)
4224 {
4225 p += 8;
4226 (void)getdigits(&p);
4227 saved = vim_strnsave(*name, p - *name);
4228 if (fudi != NULL)
4229 CLEAR_POINTER(fudi);
4230 }
4231 else
4232 saved = trans_function_name(&p, is_global, skip,
4233 flags, fudi, NULL, NULL);
4234 *name = p;
4235 return saved;
4236}
4237
4238/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004239 * List functions. When "regmatch" is NULL all of then.
4240 * Otherwise functions matching "regmatch".
4241 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004242 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004243list_functions(regmatch_T *regmatch)
4244{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004245 int changed = func_hashtab.ht_changed;
4246 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004247 hashitem_T *hi;
4248
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004249 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004250 {
4251 if (!HASHITEM_EMPTY(hi))
4252 {
4253 ufunc_T *fp = HI2UF(hi);
4254
4255 --todo;
4256 if ((fp->uf_flags & FC_DEAD) == 0
4257 && (regmatch == NULL
4258 ? !message_filtered(fp->uf_name)
4259 && !func_name_refcount(fp->uf_name)
4260 : !isdigit(*fp->uf_name)
4261 && vim_regexec(regmatch, fp->uf_name, 0)))
4262 {
4263 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004264 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004265 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004266 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004267 return;
4268 }
4269 }
4270 }
4271 }
4272}
4273
4274/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004275 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004276 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4277 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004278 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004279 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004281 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004282define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004283{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004284 int j;
4285 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004286 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004287 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004288 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 char_u *p;
4290 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004291 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004292 char_u *line_arg = NULL;
4293 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004294 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004295 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004296 garray_T newlines;
4297 int varargs = FALSE;
4298 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004299 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004300 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004301 int fp_allocated = FALSE;
4302 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004303 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 dictitem_T *v;
4305 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004306 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004307 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004308 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004309 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004310 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004311 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004312
4313 /*
4314 * ":function" without argument: list functions.
4315 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004316 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004317 {
4318 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004319 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004320 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004321 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004322 }
4323
4324 /*
4325 * ":function /pat": list functions matching pattern.
4326 */
4327 if (*eap->arg == '/')
4328 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004329 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004330 if (!eap->skip)
4331 {
4332 regmatch_T regmatch;
4333
4334 c = *p;
4335 *p = NUL;
4336 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4337 *p = c;
4338 if (regmatch.regprog != NULL)
4339 {
4340 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004341 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004342 vim_regfree(regmatch.regprog);
4343 }
4344 }
4345 if (*p == '/')
4346 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004347 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004348 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004349 }
4350
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004351 ga_init(&newargs);
4352 ga_init(&argtypes);
4353 ga_init(&default_args);
4354
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004355 /*
4356 * Get the function name. There are these situations:
4357 * func normal function name
4358 * "name" == func, "fudi.fd_dict" == NULL
4359 * dict.func new dictionary entry
4360 * "name" == NULL, "fudi.fd_dict" set,
4361 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4362 * dict.func existing dict entry with a Funcref
4363 * "name" == func, "fudi.fd_dict" set,
4364 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4365 * dict.func existing dict entry that's not a Funcref
4366 * "name" == NULL, "fudi.fd_dict" set,
4367 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4368 * s:func script-local function name
4369 * g:func global function name, same as "func"
4370 */
4371 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004372 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004373 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004374 // nested function, argument is (args).
4375 paren = TRUE;
4376 CLEAR_FIELD(fudi);
4377 }
4378 else
4379 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004380 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004381 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004382 if (p[0] == 's' && p[1] == ':')
4383 {
4384 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4385 return NULL;
4386 }
4387 p = to_name_end(p, TRUE);
4388 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4389 {
4390 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4391 eap->arg);
4392 return NULL;
4393 }
4394 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004395 }
4396
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004397 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004398 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004399 paren = (vim_strchr(p, '(') != NULL);
4400 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004401 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004402 /*
4403 * Return on an invalid expression in braces, unless the expression
4404 * evaluation has been cancelled due to an aborting error, an
4405 * interrupt, or an exception.
4406 */
4407 if (!aborting())
4408 {
4409 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004410 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004411 vim_free(fudi.fd_newkey);
4412 return NULL;
4413 }
4414 else
4415 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004417
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004418 // For "export def FuncName()" in an autoload script the function name
4419 // is stored with the legacy autoload name "dir#script#FuncName" so
4420 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004421 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004422 {
4423 char_u *prefixed = may_prefix_autoload(name);
4424
4425 if (prefixed != NULL && prefixed != name)
4426 {
4427 vim_free(name);
4428 name = prefixed;
4429 }
4430 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004431 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004432 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004433 {
4434 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4435 goto ret_free;
4436 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004437 }
4438
Bram Moolenaare38eab22019-12-05 21:50:01 +01004439 // An error in a function call during evaluation of an expression in magic
4440 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004441 saved_did_emsg = did_emsg;
4442 did_emsg = FALSE;
4443
4444 /*
4445 * ":function func" with only function name: list function.
4446 */
4447 if (!paren)
4448 {
4449 if (!ends_excmd(*skipwhite(p)))
4450 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004451 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 goto ret_free;
4453 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004454 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004455 if (eap->nextcmd != NULL)
4456 *p = NUL;
4457 if (!eap->skip && !got_int)
4458 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004459 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004460 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4461 {
4462 char_u *up = untrans_function_name(name);
4463
4464 // With Vim9 script the name was made script-local, if not
4465 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004466 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004467 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004468 }
4469
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004470 if (fp != NULL)
4471 {
4472 list_func_head(fp, TRUE);
4473 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4474 {
4475 if (FUNCLINE(fp, j) == NULL)
4476 continue;
4477 msg_putchar('\n');
4478 msg_outnum((long)(j + 1));
4479 if (j < 9)
4480 msg_putchar(' ');
4481 if (j < 99)
4482 msg_putchar(' ');
4483 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004484 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004485 ui_breakcheck();
4486 }
4487 if (!got_int)
4488 {
4489 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004490 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004491 msg_puts(" enddef");
4492 else
4493 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004494 }
4495 }
4496 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004497 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004498 }
4499 goto ret_free;
4500 }
4501
4502 /*
4503 * ":function name(arg1, arg2)" Define function.
4504 */
4505 p = skipwhite(p);
4506 if (*p != '(')
4507 {
4508 if (!eap->skip)
4509 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004510 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 goto ret_free;
4512 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004513 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514 if (vim_strchr(p, '(') != NULL)
4515 p = vim_strchr(p, '(');
4516 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004517
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004518 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4519 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004520 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004521 goto ret_free;
4522 }
4523
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004524 // In Vim9 script only global functions can be redefined.
4525 if (vim9script && eap->forceit && !is_global)
4526 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004527 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004528 goto ret_free;
4529 }
4530
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004531 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004532
Bram Moolenaar04b12692020-05-04 23:24:44 +02004533 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004535 // Check the name of the function. Unless it's a dictionary function
4536 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004537 if (name != NULL)
4538 arg = name;
4539 else
4540 arg = fudi.fd_newkey;
4541 if (arg != NULL && (fudi.fd_di == NULL
4542 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4543 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4544 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004545 char_u *name_base = arg;
4546 int i;
4547
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004548 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004549 {
4550 name_base = vim_strchr(arg, '_');
4551 if (name_base == NULL)
4552 name_base = arg + 3;
4553 else
4554 ++name_base;
4555 }
4556 for (i = 0; name_base[i] != NUL && (i == 0
4557 ? eval_isnamec1(name_base[i])
4558 : eval_isnamec(name_base[i])); ++i)
4559 ;
4560 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004561 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004562
4563 // In Vim9 script a function cannot have the same name as a
4564 // variable.
4565 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004566 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4567 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004568 + EVAL_VAR_NO_FUNC) == OK)
4569 {
4570 semsg(_(e_redefining_script_item_str), name_base);
4571 goto ret_free;
4572 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004573 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004574 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004575 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004576 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004577 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004578 goto ret_free;
4579 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004580 }
4581
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004582 // This may get more lines and make the pointers into the first line
4583 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004584 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004585 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004586 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004587 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004588 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004589 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004590 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004591
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004592 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004594 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004595 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004596 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004597 if (*p != ':')
4598 {
4599 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4600 p = skipwhite(p);
4601 }
4602 else if (!IS_WHITE_OR_NUL(p[1]))
4603 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004604 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004605 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004606 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004607 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004608 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004609 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004610 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004611 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004612 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004613 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004614 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004615 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004616 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004617 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004618 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004620 else
4621 // find extra arguments "range", "dict", "abort" and "closure"
4622 for (;;)
4623 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004624 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004625 p = skipwhite(p);
4626 if (STRNCMP(p, "range", 5) == 0)
4627 {
4628 flags |= FC_RANGE;
4629 p += 5;
4630 }
4631 else if (STRNCMP(p, "dict", 4) == 0)
4632 {
4633 flags |= FC_DICT;
4634 p += 4;
4635 }
4636 else if (STRNCMP(p, "abort", 5) == 0)
4637 {
4638 flags |= FC_ABORT;
4639 p += 5;
4640 }
4641 else if (STRNCMP(p, "closure", 7) == 0)
4642 {
4643 flags |= FC_CLOSURE;
4644 p += 7;
4645 if (current_funccal == NULL)
4646 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004647 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004648 name == NULL ? (char_u *)"" : name);
4649 goto erret;
4650 }
4651 }
4652 else
4653 break;
4654 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655
Bram Moolenaare38eab22019-12-05 21:50:01 +01004656 // When there is a line break use what follows for the function body.
4657 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004658 if (*p == '\n')
4659 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004660 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004661 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4662 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004663 && !(VIM_ISWHITE(*whitep) && *p == '#'
4664 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004665 && !eap->skip
4666 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004667 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004668
4669 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004670 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4671 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004672 */
4673 if (KeyTyped)
4674 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004675 // Check if the function already exists, don't let the user type the
4676 // whole function before telling him it doesn't work! For a script we
4677 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004678 if (!eap->skip && !eap->forceit)
4679 {
4680 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004681 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004682 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004683 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004684 }
4685
4686 if (!eap->skip && did_emsg)
4687 goto erret;
4688
Bram Moolenaare38eab22019-12-05 21:50:01 +01004689 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004690 cmdline_row = msg_row;
4691 }
4692
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004693 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004694 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004695
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004696 // Do not define the function when getting the body fails and when
4697 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004698 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004699 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004700 goto erret;
4701
4702 /*
4703 * If there are no errors, add the function
4704 */
4705 if (fudi.fd_dict == NULL)
4706 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004707 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004708 char_u *find_name = name;
4709 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004710 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004711
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004712 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004713 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004714 var_conflict = TRUE;
4715
4716 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4717 {
4718 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4719
4720 if (si->sn_autoload_prefix != NULL)
4721 {
4722 if (is_export)
4723 {
4724 find_name = name + STRLEN(si->sn_autoload_prefix);
4725 v = find_var(find_name, &ht, TRUE);
4726 if (v != NULL)
4727 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004728 // Only check if the function already exists in the script,
4729 // global functions can be shadowed.
4730 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004731 }
4732 else
4733 {
4734 char_u *prefixed = may_prefix_autoload(name);
4735
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004736 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004737 {
4738 v = find_var(prefixed, &ht, TRUE);
4739 if (v != NULL)
4740 var_conflict = TRUE;
4741 vim_free(prefixed);
4742 }
4743 }
4744 }
4745 }
4746 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004747 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004748 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004749 goto erret;
4750 }
4751
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004752 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004753 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004754 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004755 char_u *uname = untrans_function_name(name);
4756
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004757 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004758 }
4759
4760 if (fp != NULL || import != NULL)
4761 {
4762 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004763
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004764 // Function can be replaced with "function!" and when sourcing the
4765 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004766 // A name that is used by an import can not be overruled.
4767 if (import != NULL
4768 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004769 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004770 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004771 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004772 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004773 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004774 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004775 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004776 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777 goto erret;
4778 }
4779 if (fp->uf_calls > 0)
4780 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004781 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004782 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 goto erret;
4784 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004785 if (fp->uf_refcount > 1)
4786 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004787 // This function is referenced somewhere, don't redefine it but
4788 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004789 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004790 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004791 fp = NULL;
4792 overwrite = TRUE;
4793 }
4794 else
4795 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004796 char_u *exp_name = fp->uf_name_exp;
4797
4798 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004799 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004800 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004801 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004802 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004803 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004804#ifdef FEAT_PROFILE
4805 fp->uf_profiling = FALSE;
4806 fp->uf_prof_initialized = FALSE;
4807#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004808 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004809 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004810 }
4811 }
4812 else
4813 {
4814 char numbuf[20];
4815
4816 fp = NULL;
4817 if (fudi.fd_newkey == NULL && !eap->forceit)
4818 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004819 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004820 goto erret;
4821 }
4822 if (fudi.fd_di == NULL)
4823 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004824 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004825 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004826 goto erret;
4827 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004828 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004829 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004830 goto erret;
4831
Bram Moolenaare38eab22019-12-05 21:50:01 +01004832 // Give the function a sequential number. Can only be used with a
4833 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004834 vim_free(name);
4835 sprintf(numbuf, "%d", ++func_nr);
4836 name = vim_strsave((char_u *)numbuf);
4837 if (name == NULL)
4838 goto erret;
4839 }
4840
4841 if (fp == NULL)
4842 {
4843 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4844 {
4845 int slen, plen;
4846 char_u *scriptname;
4847
Bram Moolenaare38eab22019-12-05 21:50:01 +01004848 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004849 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004850 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004851 {
4852 scriptname = autoload_name(name);
4853 if (scriptname != NULL)
4854 {
4855 p = vim_strchr(scriptname, '/');
4856 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004857 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004858 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004859 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004860 j = OK;
4861 vim_free(scriptname);
4862 }
4863 }
4864 if (j == FAIL)
4865 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004866 linenr_T save_lnum = SOURCING_LNUM;
4867
4868 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004869 semsg(_(e_function_name_does_not_match_script_file_name_str),
4870 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004871 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004872 goto erret;
4873 }
4874 }
4875
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004876 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004877 if (fp == NULL)
4878 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004879 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004880
4881 if (fudi.fd_dict != NULL)
4882 {
4883 if (fudi.fd_di == NULL)
4884 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004885 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004886 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4887 if (fudi.fd_di == NULL)
4888 {
4889 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004890 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004891 goto erret;
4892 }
4893 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4894 {
4895 vim_free(fudi.fd_di);
4896 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004897 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004898 goto erret;
4899 }
4900 }
4901 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004902 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903 clear_tv(&fudi.fd_di->di_tv);
4904 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004906
Bram Moolenaare38eab22019-12-05 21:50:01 +01004907 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004908 flags |= FC_DICT;
4909 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004910 }
4911 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004912 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004913 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004914 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004915
4916 if (eap->cmdidx == CMD_def)
4917 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004918 int lnum_save = SOURCING_LNUM;
4919 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004920
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004921 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004922
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004923 // error messages are for the first function line
4924 SOURCING_LNUM = sourcing_lnum_top;
4925
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004926 // The function may use script variables from the context.
4927 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004928
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004929 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004930 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004931 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004932 free_fp = fp_allocated;
4933 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004934 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004935 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004936
4937 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004938 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004939 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004940 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004941 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004942 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004943 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004944 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004945 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004946 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004947 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004948
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004949 if (fp_allocated)
4950 {
4951 // insert the new function in the function list
4952 set_ufunc_name(fp, name);
4953 if (overwrite)
4954 {
4955 hi = hash_find(&func_hashtab, name);
4956 hi->hi_key = UF2HIKEY(fp);
4957 }
4958 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4959 {
4960 free_fp = TRUE;
4961 goto erret;
4962 }
4963 fp->uf_refcount = 1;
4964 }
4965
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004966 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004967 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004968 if ((flags & FC_CLOSURE) != 0)
4969 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004970 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004971 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004972 }
4973 else
4974 fp->uf_scoped = NULL;
4975
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004976#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004977 if (prof_def_func())
4978 func_do_profile(fp);
4979#endif
4980 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004981 if (sandbox)
4982 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004983 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004984 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985 fp->uf_flags = flags;
4986 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004987 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004988 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004989 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004990 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004991 if (is_export)
4992 {
4993 fp->uf_flags |= FC_EXPORT;
4994 // let ex_export() know the export worked.
4995 is_export = FALSE;
4996 }
4997
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004998 if (eap->cmdidx == CMD_def)
4999 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02005000 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
5001 // :func does not use Vim9 script syntax, even in a Vim9 script file
5002 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005003
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005004 goto ret_free;
5005
5006erret:
5007 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005008 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005009 if (fp != NULL)
5010 {
5011 ga_init(&fp->uf_args);
5012 ga_init(&fp->uf_def_args);
5013 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005014errret_2:
5015 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005016 if (fp != NULL)
5017 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005018 if (free_fp)
5019 {
5020 vim_free(fp);
5021 fp = NULL;
5022 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005023ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005024 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005025 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005026 if (name != name_arg)
5027 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005028 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005029 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005030
5031 return fp;
5032}
5033
5034/*
5035 * ":function"
5036 */
5037 void
5038ex_function(exarg_T *eap)
5039{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005040 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005041
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005042 ga_init2(&lines_to_free, sizeof(char_u *), 50);
5043 (void)define_function(eap, NULL, &lines_to_free);
5044 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005045}
5046
5047/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005048 * Find a function by name, including "<lambda>123".
5049 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005050 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005051 * Return NULL if not found.
5052 */
5053 ufunc_T *
5054find_func_by_name(char_u *name, compiletype_T *compile_type)
5055{
5056 char_u *arg = name;
5057 char_u *fname;
5058 ufunc_T *ufunc;
5059 int is_global = FALSE;
5060
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005061 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5062 {
5063 *compile_type = CT_PROFILE;
5064 arg = skipwhite(arg + 7);
5065 }
5066 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5067 {
5068 *compile_type = CT_DEBUG;
5069 arg = skipwhite(arg + 5);
5070 }
5071
5072 if (STRNCMP(arg, "<lambda>", 8) == 0)
5073 {
5074 arg += 8;
5075 (void)getdigits(&arg);
5076 fname = vim_strnsave(name, arg - name);
5077 }
5078 else
5079 fname = trans_function_name(&arg, &is_global, FALSE,
5080 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5081 if (fname == NULL)
5082 {
5083 semsg(_(e_invalid_argument_str), name);
5084 return NULL;
5085 }
5086 if (!ends_excmd2(name, arg))
5087 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005088 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005089 emsg(ex_errmsg(e_trailing_characters_str, arg));
5090 return NULL;
5091 }
5092
5093 ufunc = find_func(fname, is_global);
5094 if (ufunc == NULL)
5095 {
5096 char_u *p = untrans_function_name(fname);
5097
5098 if (p != NULL)
5099 // Try again without making it script-local.
5100 ufunc = find_func(p, FALSE);
5101 }
5102 vim_free(fname);
5103 if (ufunc == NULL)
5104 semsg(_(e_cannot_find_function_str), name);
5105 return ufunc;
5106}
5107
5108/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005109 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005110 * be compiled or the one specified by the argument.
5111 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005112 */
5113 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005114ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005115{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005116 ufunc_T *ufunc;
5117
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005118 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005119 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005120 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005121
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005122 ufunc = find_func_by_name(eap->arg, &compile_type);
5123 if (ufunc != NULL)
5124 {
5125 if (func_needs_compiling(ufunc, compile_type))
5126 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5127 else
5128 smsg(_("Function %s does not need compiling"), eap->arg);
5129 }
5130 }
5131 else
5132 {
5133 long todo = (long)func_hashtab.ht_used;
5134 int changed = func_hashtab.ht_changed;
5135 hashitem_T *hi;
5136
5137 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5138 {
5139 if (!HASHITEM_EMPTY(hi))
5140 {
5141 --todo;
5142 ufunc = HI2UF(hi);
5143 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5144 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5145 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005146 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005147 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5148
5149 if (func_hashtab.ht_changed != changed)
5150 {
5151 // a function has been added or removed, need to start
5152 // over
5153 todo = (long)func_hashtab.ht_used;
5154 changed = func_hashtab.ht_changed;
5155 hi = func_hashtab.ht_array;
5156 --hi;
5157 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005158 }
5159 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005160 }
5161 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005162}
5163
5164/*
5165 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5166 * Return 2 if "p" starts with "s:".
5167 * Return 0 otherwise.
5168 */
5169 int
5170eval_fname_script(char_u *p)
5171{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005172 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5173 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005174 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5175 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5176 return 5;
5177 if (p[0] == 's' && p[1] == ':')
5178 return 2;
5179 return 0;
5180}
5181
5182 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005183translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005184{
5185 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005186 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005187 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005188}
5189
5190/*
5191 * Return TRUE when "ufunc" has old-style "..." varargs
5192 * or named varargs "...name: type".
5193 */
5194 int
5195has_varargs(ufunc_T *ufunc)
5196{
5197 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005198}
5199
5200/*
5201 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005202 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203 */
5204 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005205function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005206{
5207 char_u *nm = name;
5208 char_u *p;
5209 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005210 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005211 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005212
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005213 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5214 if (no_deref)
5215 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005216 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005217 nm = skipwhite(nm);
5218
Bram Moolenaare38eab22019-12-05 21:50:01 +01005219 // Only accept "funcname", "funcname ", "funcname (..." and
5220 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005221 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005222 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005223 vim_free(p);
5224 return n;
5225}
5226
Bram Moolenaar113e1072019-01-20 15:30:40 +01005227#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005228 char_u *
5229get_expanded_name(char_u *name, int check)
5230{
5231 char_u *nm = name;
5232 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005233 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005234
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005235 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005236 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005237
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005238 if (p != NULL && *nm == NUL
5239 && (!check || translated_function_exists(p, is_global)))
5240 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005241
5242 vim_free(p);
5243 return NULL;
5244}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005245#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005246
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005247/*
5248 * Function given to ExpandGeneric() to obtain the list of user defined
5249 * function names.
5250 */
5251 char_u *
5252get_user_func_name(expand_T *xp, int idx)
5253{
5254 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005255 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005256 static hashitem_T *hi;
5257 ufunc_T *fp;
5258
5259 if (idx == 0)
5260 {
5261 done = 0;
5262 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005263 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005264 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005265 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005266 {
5267 if (done++ > 0)
5268 ++hi;
5269 while (HASHITEM_EMPTY(hi))
5270 ++hi;
5271 fp = HI2UF(hi);
5272
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005273 // don't show dead, dict and lambda functions
5274 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005275 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005276 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005277
5278 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005279 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005280
5281 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005282 if (xp->xp_context != EXPAND_USER_FUNC
5283 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005284 {
5285 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005286 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005287 STRCAT(IObuff, ")");
5288 }
5289 return IObuff;
5290 }
5291 return NULL;
5292}
5293
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005294/*
5295 * ":delfunction {name}"
5296 */
5297 void
5298ex_delfunction(exarg_T *eap)
5299{
5300 ufunc_T *fp = NULL;
5301 char_u *p;
5302 char_u *name;
5303 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005304 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005305
5306 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005307 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5308 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005309 vim_free(fudi.fd_newkey);
5310 if (name == NULL)
5311 {
5312 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005313 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005314 return;
5315 }
5316 if (!ends_excmd(*skipwhite(p)))
5317 {
5318 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005319 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005320 return;
5321 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005322 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005323 if (eap->nextcmd != NULL)
5324 *p = NUL;
5325
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005326 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005327 {
5328 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005329 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005330 vim_free(name);
5331 return;
5332 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005333 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005334 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005335 vim_free(name);
5336
5337 if (!eap->skip)
5338 {
5339 if (fp == NULL)
5340 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005341 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005342 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005343 return;
5344 }
5345 if (fp->uf_calls > 0)
5346 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005347 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005348 return;
5349 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005350 if (fp->uf_flags & FC_VIM9)
5351 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005352 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005353 return;
5354 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005355
5356 if (fudi.fd_dict != NULL)
5357 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005358 // Delete the dict item that refers to the function, it will
5359 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005360 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5361 }
5362 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005363 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005364 // A normal function (not a numbered function or lambda) has a
5365 // refcount of 1 for the entry in the hashtable. When deleting
5366 // it and the refcount is more than one, it should be kept.
5367 // A numbered function and lambda should be kept if the refcount is
5368 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005369 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005370 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005371 // Function is still referenced somewhere. Don't free it but
5372 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005373 if (func_remove(fp))
5374 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005375 }
5376 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005377 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005378 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005379 }
5380}
5381
5382/*
5383 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005384 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385 */
5386 void
5387func_unref(char_u *name)
5388{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005389 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005390
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005391 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005392 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005393 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005394 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005395 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005396#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005397 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005398#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005399 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005400 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005401 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005402}
5403
5404/*
5405 * Unreference a Function: decrement the reference count and free it when it
5406 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005407 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005408 */
5409 void
5410func_ptr_unref(ufunc_T *fp)
5411{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005412 if (fp != NULL && (--fp->uf_refcount <= 0
5413 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5414 && fp->uf_partial->pt_refcount <= 1
5415 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005416 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005417 // Only delete it when it's not being used. Otherwise it's done
5418 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005419 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005420 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005421 }
5422}
5423
5424/*
5425 * Count a reference to a Function.
5426 */
5427 void
5428func_ref(char_u *name)
5429{
5430 ufunc_T *fp;
5431
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005432 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005433 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005434 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005435 if (fp != NULL)
5436 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005437 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005438 // Only give an error for a numbered function.
5439 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005440 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005441}
5442
5443/*
5444 * Count a reference to a Function.
5445 */
5446 void
5447func_ptr_ref(ufunc_T *fp)
5448{
5449 if (fp != NULL)
5450 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005451}
5452
5453/*
5454 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5455 * referenced from anywhere that is in use.
5456 */
5457 static int
5458can_free_funccal(funccall_T *fc, int copyID)
5459{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005460 return (fc->fc_l_varlist.lv_copyID != copyID
5461 && fc->fc_l_vars.dv_copyID != copyID
5462 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005463 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005464}
5465
5466/*
5467 * ":return [expr]"
5468 */
5469 void
5470ex_return(exarg_T *eap)
5471{
5472 char_u *arg = eap->arg;
5473 typval_T rettv;
5474 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005475 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005476
5477 if (current_funccal == NULL)
5478 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005479 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005480 return;
5481 }
5482
Bram Moolenaar844fb642021-10-23 13:32:30 +01005483 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005484 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5485
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005486 if (eap->skip)
5487 ++emsg_skip;
5488
5489 eap->nextcmd = NULL;
5490 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005491 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005492 {
5493 if (!eap->skip)
5494 returning = do_return(eap, FALSE, TRUE, &rettv);
5495 else
5496 clear_tv(&rettv);
5497 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005498 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005499 else if (!eap->skip)
5500 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005501 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005502 update_force_abort();
5503
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005504 /*
5505 * Return unless the expression evaluation has been cancelled due to an
5506 * aborting error, an interrupt, or an exception.
5507 */
5508 if (!aborting())
5509 returning = do_return(eap, FALSE, TRUE, NULL);
5510 }
5511
Bram Moolenaare38eab22019-12-05 21:50:01 +01005512 // When skipping or the return gets pending, advance to the next command
5513 // in this line (!returning). Otherwise, ignore the rest of the line.
5514 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005515 if (returning)
5516 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005517 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005518 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005519
5520 if (eap->skip)
5521 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005522 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005523}
5524
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005525 static int
5526ex_call_inner(
5527 exarg_T *eap,
5528 char_u *name,
5529 char_u **arg,
5530 char_u *startarg,
5531 funcexe_T *funcexe_init,
5532 evalarg_T *evalarg)
5533{
5534 linenr_T lnum;
5535 int doesrange;
5536 typval_T rettv;
5537 int failed = FALSE;
5538
5539 /*
5540 * When skipping, evaluate the function once, to find the end of the
5541 * arguments.
5542 * When the function takes a range, this is discovered after the first
5543 * call, and the loop is broken.
5544 */
5545 if (eap->skip)
5546 {
5547 ++emsg_skip;
5548 lnum = eap->line2; // do it once, also with an invalid range
5549 }
5550 else
5551 lnum = eap->line1;
5552 for ( ; lnum <= eap->line2; ++lnum)
5553 {
5554 funcexe_T funcexe;
5555
5556 if (!eap->skip && eap->addr_count > 0)
5557 {
5558 if (lnum > curbuf->b_ml.ml_line_count)
5559 {
5560 // If the function deleted lines or switched to another buffer
5561 // the line number may become invalid.
5562 emsg(_(e_invalid_range));
5563 break;
5564 }
5565 curwin->w_cursor.lnum = lnum;
5566 curwin->w_cursor.col = 0;
5567 curwin->w_cursor.coladd = 0;
5568 }
5569 *arg = startarg;
5570
5571 funcexe = *funcexe_init;
5572 funcexe.fe_doesrange = &doesrange;
5573 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5574 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5575 {
5576 failed = TRUE;
5577 break;
5578 }
5579 if (has_watchexpr())
5580 dbg_check_breakpoint(eap);
5581
5582 // Handle a function returning a Funcref, Dictionary or List.
5583 if (handle_subscript(arg, NULL, &rettv,
5584 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5585 {
5586 failed = TRUE;
5587 break;
5588 }
5589
5590 clear_tv(&rettv);
5591 if (doesrange || eap->skip)
5592 break;
5593
5594 // Stop when immediately aborting on error, or when an interrupt
5595 // occurred or an exception was thrown but not caught.
5596 // get_func_tv() returned OK, so that the check for trailing
5597 // characters below is executed.
5598 if (aborting())
5599 break;
5600 }
5601 if (eap->skip)
5602 --emsg_skip;
5603 return failed;
5604}
5605
5606/*
5607 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5608 * Returns FAIL or OK.
5609 */
5610 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005611ex_defer_inner(
5612 char_u *name,
5613 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005614 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005615 partial_T *partial,
5616 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005617{
5618 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005619 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005620 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005621 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005622
5623 if (current_funccal == NULL)
5624 {
5625 semsg(_(e_str_not_inside_function), "defer");
5626 return FAIL;
5627 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005628 if (partial != NULL)
5629 {
5630 if (partial->pt_dict != NULL)
5631 {
5632 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5633 return FAIL;
5634 }
5635 if (partial->pt_argc > 0)
5636 {
5637 int i;
5638
5639 partial_argc = partial->pt_argc;
5640 for (i = 0; i < partial_argc; ++i)
5641 copy_tv(&partial->pt_argv[i], &argvars[i]);
5642 }
5643 }
5644 r = get_func_arguments(arg, evalarg, FALSE,
5645 argvars + partial_argc, &argcount);
5646 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005647
5648 if (r == OK)
5649 {
5650 if (type != NULL)
5651 {
5652 // Check that the arguments are OK for the types of the funcref.
5653 r = check_argument_types(type, argvars, argcount, NULL, name);
5654 }
5655 else if (builtin_function(name, -1))
5656 {
5657 int idx = find_internal_func(name);
5658
5659 if (idx < 0)
5660 {
5661 emsg_funcname(e_unknown_function_str, name);
5662 r = FAIL;
5663 }
5664 else if (check_internal_func(idx, argcount) == -1)
5665 r = FAIL;
5666 }
5667 else
5668 {
5669 ufunc_T *ufunc = find_func(name, FALSE);
5670
5671 // we tolerate an unknown function here, it might be defined later
5672 if (ufunc != NULL)
5673 {
5674 int error = check_user_func_argcount(ufunc, argcount);
5675
5676 if (error != FCERR_UNKNOWN)
5677 {
5678 user_func_error(error, name, NULL);
5679 r = FAIL;
5680 }
5681 }
5682 }
5683 }
5684
Bram Moolenaar86d87252022-09-05 21:21:25 +01005685 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01005686 {
5687 while (--argcount >= 0)
5688 clear_tv(&argvars[argcount]);
5689 return FAIL;
5690 }
5691 return add_defer(name, argcount, argvars);
5692}
5693
5694/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01005695 * Return TRUE if currently inside a function call.
5696 * Give an error message and return FALSE when not.
5697 */
5698 int
5699can_add_defer(void)
5700{
5701 if (!in_def_function() && get_current_funccal() == NULL)
5702 {
5703 semsg(_(e_str_not_inside_function), "defer");
5704 return FALSE;
5705 }
5706 return TRUE;
5707}
5708
5709/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01005710 * Add a deferred call for "name" with arguments "argvars[argcount]".
5711 * Consumes "argvars[]".
5712 * Caller must check that in_def_function() returns TRUE or current_funccal is
5713 * not NULL.
5714 * Returns OK or FAIL.
5715 */
5716 int
5717add_defer(char_u *name, int argcount_arg, typval_T *argvars)
5718{
5719 char_u *saved_name = vim_strsave(name);
5720 int argcount = argcount_arg;
5721 defer_T *dr;
5722 int ret = FAIL;
5723
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005724 if (saved_name == NULL)
5725 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01005726 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005727 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01005728 if (add_defer_function(saved_name, argcount, argvars) == OK)
5729 argcount = 0;
5730 }
5731 else
5732 {
5733 if (current_funccal->fc_defer.ga_itemsize == 0)
5734 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
5735 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
5736 goto theend;
5737 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
5738 + current_funccal->fc_defer.ga_len++;
5739 dr->dr_name = saved_name;
5740 dr->dr_argcount = argcount;
5741 while (argcount > 0)
5742 {
5743 --argcount;
5744 dr->dr_argvars[argcount] = argvars[argcount];
5745 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005746 }
5747 ret = OK;
5748
5749theend:
5750 while (--argcount >= 0)
5751 clear_tv(&argvars[argcount]);
5752 return ret;
5753}
5754
5755/*
5756 * Invoked after a functions has finished: invoke ":defer" functions.
5757 */
Bram Moolenaar58779852022-09-06 18:31:14 +01005758 static void
5759handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005760{
5761 int idx;
5762
Bram Moolenaar58779852022-09-06 18:31:14 +01005763 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005764 {
5765 funcexe_T funcexe;
5766 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01005767 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005768 int i;
5769
5770 CLEAR_FIELD(funcexe);
5771 funcexe.fe_evaluate = TRUE;
5772
5773 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5774 call_func(dr->dr_name, -1, &rettv,
5775 dr->dr_argcount, dr->dr_argvars, &funcexe);
5776 clear_tv(&rettv);
5777 vim_free(dr->dr_name);
5778 for (i = dr->dr_argcount - 1; i >= 0; --i)
5779 clear_tv(&dr->dr_argvars[i]);
5780 }
Bram Moolenaar58779852022-09-06 18:31:14 +01005781 ga_clear(&funccal->fc_defer);
5782}
5783
5784/*
5785 * Called when exiting: call all defer functions.
5786 */
5787 void
5788invoke_all_defer(void)
5789{
5790 funccall_T *funccal;
5791
Bram Moolenaarca16c602022-09-06 18:57:08 +01005792 for (funccal = current_funccal; funccal != NULL;
5793 funccal = funccal->fc_caller)
Bram Moolenaar58779852022-09-06 18:31:14 +01005794 if (funccal->fc_ectx != NULL)
5795 {
5796 // :def function
5797 unwind_def_callstack(funccal->fc_ectx);
5798 may_invoke_defer_funcs(funccal->fc_ectx);
5799 }
5800 else
5801 {
5802 // legacy function
5803 handle_defer_one(funccal);
5804 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005805}
5806
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005807/*
5808 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005809 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005810 */
5811 void
5812ex_call(exarg_T *eap)
5813{
5814 char_u *arg = eap->arg;
5815 char_u *startarg;
5816 char_u *name;
5817 char_u *tofree;
5818 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005819 int failed = FALSE;
5820 funcdict_T fudi;
5821 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005822 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005823 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005824 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005825 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005826
Bram Moolenaare6b53242020-07-01 17:28:33 +02005827 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005828 if (eap->skip)
5829 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005830 typval_T rettv;
5831
Bram Moolenaare38eab22019-12-05 21:50:01 +01005832 // trans_function_name() doesn't work well when skipping, use eval0()
5833 // instead to skip to any following command, e.g. for:
5834 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005835 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005836 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005837 clear_tv(&rettv);
5838 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005839 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005840 return;
5841 }
5842
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005843 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005844 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005845 if (fudi.fd_newkey != NULL)
5846 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005847 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005848 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005849 vim_free(fudi.fd_newkey);
5850 }
5851 if (tofree == NULL)
5852 return;
5853
Bram Moolenaare38eab22019-12-05 21:50:01 +01005854 // Increase refcount on dictionary, it could get deleted when evaluating
5855 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005856 if (fudi.fd_dict != NULL)
5857 ++fudi.fd_dict->dv_refcount;
5858
Bram Moolenaare38eab22019-12-05 21:50:01 +01005859 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5860 // contents. For VAR_PARTIAL get its partial, unless we already have one
5861 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005862 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005863 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005864 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005865 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005866
Bram Moolenaare38eab22019-12-05 21:50:01 +01005867 // Skip white space to allow ":call func ()". Not good, but required for
5868 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005869 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005870 if (*startarg != '(')
5871 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005872 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005873 goto end;
5874 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005875 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005876 {
5877 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5878 goto end;
5879 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005880
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005881 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005882 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005883 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01005884 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005885 }
5886 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005887 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005888 funcexe_T funcexe;
5889
Bram Moolenaara80faa82020-04-12 19:37:17 +02005890 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005891 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005892 funcexe.fe_partial = partial;
5893 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005894 funcexe.fe_firstline = eap->line1;
5895 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005896 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005897 funcexe.fe_evaluate = !eap->skip;
5898 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005899 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005900
Bram Moolenaar1d341892021-09-18 15:25:52 +02005901 // When inside :try we need to check for following "| catch" or "| endtry".
5902 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005903 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005904 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005905 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005906 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005907 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005908 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005909 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005910 {
5911 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005912 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005913 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005914 }
5915 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005916 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005917 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005918 // Must be after using "arg", it may point into memory cleared here.
5919 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005920
5921end:
5922 dict_unref(fudi.fd_dict);
5923 vim_free(tofree);
5924}
5925
5926/*
5927 * Return from a function. Possibly makes the return pending. Also called
5928 * for a pending return at the ":endtry" or after returning from an extra
5929 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5930 * when called due to a ":return" command. "rettv" may point to a typval_T
5931 * with the return rettv. Returns TRUE when the return can be carried out,
5932 * FALSE when the return gets pending.
5933 */
5934 int
5935do_return(
5936 exarg_T *eap,
5937 int reanimate,
5938 int is_cmd,
5939 void *rettv)
5940{
5941 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005942 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005943
5944 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005945 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005946 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005947
5948 /*
5949 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5950 * not in its finally clause (which then is to be executed next) is found.
5951 * In this case, make the ":return" pending for execution at the ":endtry".
5952 * Otherwise, return normally.
5953 */
5954 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5955 if (idx >= 0)
5956 {
5957 cstack->cs_pending[idx] = CSTP_RETURN;
5958
5959 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005960 // A pending return again gets pending. "rettv" points to an
5961 // allocated variable with the rettv of the original ":return"'s
5962 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005963 cstack->cs_rettv[idx] = rettv;
5964 else
5965 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005966 // When undoing a return in order to make it pending, get the stored
5967 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005968 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01005969 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005970
5971 if (rettv != NULL)
5972 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005973 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005974 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5975 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5976 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005977 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005978 }
5979 else
5980 cstack->cs_rettv[idx] = NULL;
5981
5982 if (reanimate)
5983 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005984 // The pending return value could be overwritten by a ":return"
5985 // without argument in a finally clause; reset the default
5986 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005987 current_funccal->fc_rettv->v_type = VAR_NUMBER;
5988 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005989 }
5990 }
5991 report_make_pending(CSTP_RETURN, rettv);
5992 }
5993 else
5994 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01005995 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005996
Bram Moolenaare38eab22019-12-05 21:50:01 +01005997 // If the return is carried out now, store the return value. For
5998 // a return immediately after reanimation, the value is already
5999 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006000 if (!reanimate && rettv != NULL)
6001 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006002 clear_tv(current_funccal->fc_rettv);
6003 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006004 if (!is_cmd)
6005 vim_free(rettv);
6006 }
6007 }
6008
6009 return idx < 0;
6010}
6011
6012/*
6013 * Free the variable with a pending return value.
6014 */
6015 void
6016discard_pending_return(void *rettv)
6017{
6018 free_tv((typval_T *)rettv);
6019}
6020
6021/*
6022 * Generate a return command for producing the value of "rettv". The result
6023 * is an allocated string. Used by report_pending() for verbose messages.
6024 */
6025 char_u *
6026get_return_cmd(void *rettv)
6027{
6028 char_u *s = NULL;
6029 char_u *tofree = NULL;
6030 char_u numbuf[NUMBUFLEN];
6031
6032 if (rettv != NULL)
6033 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6034 if (s == NULL)
6035 s = (char_u *)"";
6036
6037 STRCPY(IObuff, ":return ");
6038 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6039 if (STRLEN(s) + 8 >= IOSIZE)
6040 STRCPY(IObuff + IOSIZE - 4, "...");
6041 vim_free(tofree);
6042 return vim_strsave(IObuff);
6043}
6044
6045/*
6046 * Get next function line.
6047 * Called by do_cmdline() to get the next line.
6048 * Returns allocated string, or NULL for end of function.
6049 */
6050 char_u *
6051get_func_line(
6052 int c UNUSED,
6053 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006054 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006055 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006056{
6057 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006058 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006059 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006060 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006061
Bram Moolenaare38eab22019-12-05 21:50:01 +01006062 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006063 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006064 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006065 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006066 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006067 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006068 }
6069#ifdef FEAT_PROFILE
6070 if (do_profiling == PROF_YES)
6071 func_line_end(cookie);
6072#endif
6073
6074 gap = &fp->uf_lines;
6075 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006076 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006077 retval = NULL;
6078 else
6079 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006080 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006081 while (fcp->fc_linenr < gap->ga_len
6082 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6083 ++fcp->fc_linenr;
6084 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006085 retval = NULL;
6086 else
6087 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006088 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6089 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006090#ifdef FEAT_PROFILE
6091 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006092 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006093#endif
6094 }
6095 }
6096
Bram Moolenaare38eab22019-12-05 21:50:01 +01006097 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006098 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006099 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006100 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006101 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006102 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006103 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006104 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006105 }
6106
6107 return retval;
6108}
6109
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006110/*
6111 * Return TRUE if the currently active function should be ended, because a
6112 * return was encountered or an error occurred. Used inside a ":while".
6113 */
6114 int
6115func_has_ended(void *cookie)
6116{
6117 funccall_T *fcp = (funccall_T *)cookie;
6118
Bram Moolenaare38eab22019-12-05 21:50:01 +01006119 // Ignore the "abort" flag if the abortion behavior has been changed due to
6120 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006121 return (((fcp->fc_func->uf_flags & FC_ABORT)
6122 && did_emsg && !aborted_in_try())
6123 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006124}
6125
6126/*
6127 * return TRUE if cookie indicates a function which "abort"s on errors.
6128 */
6129 int
6130func_has_abort(
6131 void *cookie)
6132{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006133 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006134}
6135
6136
6137/*
6138 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6139 * Don't do this when "Func" is already a partial that was bound
6140 * explicitly (pt_auto is FALSE).
6141 * Changes "rettv" in-place.
6142 * Returns the updated "selfdict_in".
6143 */
6144 dict_T *
6145make_partial(dict_T *selfdict_in, typval_T *rettv)
6146{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006147 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006148 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006149 char_u fname_buf[FLEN_FIXED + 1];
6150 int error;
6151 dict_T *selfdict = selfdict_in;
6152
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006153 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6154 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006155 fp = rettv->vval.v_partial->pt_func;
6156 else
6157 {
6158 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006159 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006160 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006161 if (fname == NULL)
6162 {
6163 // There is no point binding a dict to a NULL function, just create
6164 // a function reference.
6165 rettv->v_type = VAR_FUNC;
6166 rettv->vval.v_string = NULL;
6167 }
6168 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006169 {
6170 char_u *tofree = NULL;
6171
6172 // Translate "s:func" to the stored function name.
6173 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6174 fp = find_func(fname, FALSE);
6175 vim_free(tofree);
6176 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006177 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006178
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006179 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006180 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006181 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006182
6183 if (pt != NULL)
6184 {
6185 pt->pt_refcount = 1;
6186 pt->pt_dict = selfdict;
6187 pt->pt_auto = TRUE;
6188 selfdict = NULL;
6189 if (rettv->v_type == VAR_FUNC)
6190 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006191 // Just a function: Take over the function name and use
6192 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006193 pt->pt_name = rettv->vval.v_string;
6194 }
6195 else
6196 {
6197 partial_T *ret_pt = rettv->vval.v_partial;
6198 int i;
6199
Bram Moolenaare38eab22019-12-05 21:50:01 +01006200 // Partial: copy the function name, use selfdict and copy
6201 // args. Can't take over name or args, the partial might
6202 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006203 if (ret_pt->pt_name != NULL)
6204 {
6205 pt->pt_name = vim_strsave(ret_pt->pt_name);
6206 func_ref(pt->pt_name);
6207 }
6208 else
6209 {
6210 pt->pt_func = ret_pt->pt_func;
6211 func_ptr_ref(pt->pt_func);
6212 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006213 if (ret_pt->pt_argc > 0)
6214 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006215 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006216 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006217 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006218 pt->pt_argc = 0;
6219 else
6220 {
6221 pt->pt_argc = ret_pt->pt_argc;
6222 for (i = 0; i < pt->pt_argc; i++)
6223 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6224 }
6225 }
6226 partial_unref(ret_pt);
6227 }
6228 rettv->v_type = VAR_PARTIAL;
6229 rettv->vval.v_partial = pt;
6230 }
6231 }
6232 return selfdict;
6233}
6234
6235/*
6236 * Return the name of the executed function.
6237 */
6238 char_u *
6239func_name(void *cookie)
6240{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006241 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006242}
6243
6244/*
6245 * Return the address holding the next breakpoint line for a funccall cookie.
6246 */
6247 linenr_T *
6248func_breakpoint(void *cookie)
6249{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006250 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006251}
6252
6253/*
6254 * Return the address holding the debug tick for a funccall cookie.
6255 */
6256 int *
6257func_dbg_tick(void *cookie)
6258{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006259 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006260}
6261
6262/*
6263 * Return the nesting level for a funccall cookie.
6264 */
6265 int
6266func_level(void *cookie)
6267{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006268 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006269}
6270
6271/*
6272 * Return TRUE when a function was ended by a ":return" command.
6273 */
6274 int
6275current_func_returned(void)
6276{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006277 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006278}
6279
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006280 int
6281free_unref_funccal(int copyID, int testing)
6282{
6283 int did_free = FALSE;
6284 int did_free_funccal = FALSE;
6285 funccall_T *fc, **pfc;
6286
6287 for (pfc = &previous_funccal; *pfc != NULL; )
6288 {
6289 if (can_free_funccal(*pfc, copyID))
6290 {
6291 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006292 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006293 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006294 did_free = TRUE;
6295 did_free_funccal = TRUE;
6296 }
6297 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006298 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006299 }
6300 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006301 // When a funccal was freed some more items might be garbage
6302 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006303 (void)garbage_collect(testing);
6304
6305 return did_free;
6306}
6307
6308/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006309 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006310 */
6311 static funccall_T *
6312get_funccal(void)
6313{
6314 int i;
6315 funccall_T *funccal;
6316 funccall_T *temp_funccal;
6317
6318 funccal = current_funccal;
6319 if (debug_backtrace_level > 0)
6320 {
6321 for (i = 0; i < debug_backtrace_level; i++)
6322 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006323 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006324 if (temp_funccal)
6325 funccal = temp_funccal;
6326 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006327 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006328 debug_backtrace_level = i;
6329 }
6330 }
6331 return funccal;
6332}
6333
6334/*
6335 * Return the hashtable used for local variables in the current funccal.
6336 * Return NULL if there is no current funccal.
6337 */
6338 hashtab_T *
6339get_funccal_local_ht()
6340{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006341 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006342 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006343 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006344}
6345
6346/*
6347 * Return the l: scope variable.
6348 * Return NULL if there is no current funccal.
6349 */
6350 dictitem_T *
6351get_funccal_local_var()
6352{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006353 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006354 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006355 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006356}
6357
6358/*
6359 * Return the hashtable used for argument in the current funccal.
6360 * Return NULL if there is no current funccal.
6361 */
6362 hashtab_T *
6363get_funccal_args_ht()
6364{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006365 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006366 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006367 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006368}
6369
6370/*
6371 * Return the a: scope variable.
6372 * Return NULL if there is no current funccal.
6373 */
6374 dictitem_T *
6375get_funccal_args_var()
6376{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006377 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006378 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006379 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006380}
6381
6382/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006383 * List function variables, if there is a function.
6384 */
6385 void
6386list_func_vars(int *first)
6387{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006388 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6389 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006390 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006391}
6392
6393/*
6394 * If "ht" is the hashtable for local variables in the current funccal, return
6395 * the dict that contains it.
6396 * Otherwise return NULL.
6397 */
6398 dict_T *
6399get_current_funccal_dict(hashtab_T *ht)
6400{
6401 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006402 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6403 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006404 return NULL;
6405}
6406
6407/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006408 * Search hashitem in parent scope.
6409 */
6410 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006411find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006412{
6413 funccall_T *old_current_funccal = current_funccal;
6414 hashtab_T *ht;
6415 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006416 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006417
Bram Moolenaarca16c602022-09-06 18:57:08 +01006418 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006419 return NULL;
6420
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006421 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006422 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006423 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006424 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006425 ht = find_var_ht(name, &varname);
6426 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006427 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006428 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006429 if (!HASHITEM_EMPTY(hi))
6430 {
6431 *pht = ht;
6432 break;
6433 }
6434 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006435 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006436 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006437 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006438 }
6439 current_funccal = old_current_funccal;
6440
6441 return hi;
6442}
6443
6444/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006445 * Search variable in parent scope.
6446 */
6447 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006448find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006449{
6450 dictitem_T *v = NULL;
6451 funccall_T *old_current_funccal = current_funccal;
6452 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006453 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006454
Bram Moolenaarca16c602022-09-06 18:57:08 +01006455 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006456 return NULL;
6457
Bram Moolenaare38eab22019-12-05 21:50:01 +01006458 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006459 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006460 while (current_funccal)
6461 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006462 ht = find_var_ht(name, &varname);
6463 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006464 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006465 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006466 if (v != NULL)
6467 break;
6468 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006469 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006470 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006471 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006472 }
6473 current_funccal = old_current_funccal;
6474
6475 return v;
6476}
6477
6478/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006479 * Set "copyID + 1" in previous_funccal and callers.
6480 */
6481 int
6482set_ref_in_previous_funccal(int copyID)
6483{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006484 funccall_T *fc;
6485
Bram Moolenaarca16c602022-09-06 18:57:08 +01006486 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006487 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006488 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006489 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6490 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6491 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006492 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006493 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006494 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006495}
6496
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006497 static int
6498set_ref_in_funccal(funccall_T *fc, int copyID)
6499{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006500 if (fc->fc_copyID != copyID)
6501 {
6502 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006503 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6504 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6505 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6506 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006507 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006508 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006509 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006510}
6511
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006512/*
6513 * Set "copyID" in all local vars and arguments in the call stack.
6514 */
6515 int
6516set_ref_in_call_stack(int copyID)
6517{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006518 funccall_T *fc;
6519 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006520
Bram Moolenaarca16c602022-09-06 18:57:08 +01006521 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006522 if (set_ref_in_funccal(fc, copyID))
6523 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006524
6525 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006526 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006527 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006528 if (set_ref_in_funccal(fc, copyID))
6529 return TRUE;
6530 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006531}
6532
6533/*
6534 * Set "copyID" in all functions available by name.
6535 */
6536 int
6537set_ref_in_functions(int copyID)
6538{
6539 int todo;
6540 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006541 ufunc_T *fp;
6542
6543 todo = (int)func_hashtab.ht_used;
6544 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006545 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006546 if (!HASHITEM_EMPTY(hi))
6547 {
6548 --todo;
6549 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006550 if (!func_name_refcount(fp->uf_name)
6551 && set_ref_in_func(NULL, fp, copyID))
6552 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006553 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006554 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006555 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006556}
6557
6558/*
6559 * Set "copyID" in all function arguments.
6560 */
6561 int
6562set_ref_in_func_args(int copyID)
6563{
6564 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006565
6566 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006567 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6568 copyID, NULL, NULL))
6569 return TRUE;
6570 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006571}
6572
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006573/*
6574 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006575 * Returns TRUE if setting references failed somehow.
6576 */
6577 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006578set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006579{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006580 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006581 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006582 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006583 char_u fname_buf[FLEN_FIXED + 1];
6584 char_u *tofree = NULL;
6585 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006586 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006587
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006588 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006589 return FALSE;
6590
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006591 if (fp_in == NULL)
6592 {
6593 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006594 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006595 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006596 if (fp != NULL)
6597 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006598 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006599 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006600 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006601
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006602 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006603 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006604}
6605
Bram Moolenaare38eab22019-12-05 21:50:01 +01006606#endif // FEAT_EVAL