blob: 1412caa8e08ff1fc32ee887d5117f20760acc77b [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 Moolenaarfed9e832021-04-10 21:38:38 +02001169 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001170 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001171 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001172 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001173 exarg_T eap;
1174 garray_T newlines;
1175 char_u *cmdline = NULL;
1176 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001177 partial_T *pt;
1178 char_u *name;
1179 int lnum_save = -1;
1180 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1181
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001182 if (!ends_excmd2(*arg, skipwhite(*arg + 1)))
1183 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001184 semsg(_(e_trailing_characters_str), *arg + 1);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001185 return FAIL;
1186 }
1187
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001188 CLEAR_FIELD(eap);
1189 eap.cmdidx = CMD_block;
1190 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001191 eap.cmdlinep = &cmdline;
1192 eap.skip = !evaluate;
1193 if (evalarg->eval_cctx != NULL)
1194 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1195 else
1196 {
1197 eap.getline = evalarg->eval_getline;
1198 eap.cookie = evalarg->eval_cookie;
1199 }
1200
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001201 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001202 if (get_function_body(&eap, &newlines, NULL,
1203 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001204 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001205
1206 // When inside a lambda must add the function lines to evalarg.eval_ga.
1207 evalarg->eval_break_count += newlines.ga_len;
1208 if (gap->ga_itemsize > 0)
1209 {
1210 int idx;
1211 char_u *last;
1212 size_t plen;
1213 char_u *pnl;
1214
1215 for (idx = 0; idx < newlines.ga_len; ++idx)
1216 {
1217 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1218
Bram Moolenaarecb66452021-05-18 15:09:18 +02001219 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001220 goto erret;
1221
1222 // Going to concatenate the lines after parsing. For an empty or
1223 // comment line use an empty string.
1224 // Insert NL characters at the start of each line, the string will
1225 // be split again later in .get_lambda_tv().
1226 if (*p == NUL || vim9_comment_start(p))
1227 p = (char_u *)"";
1228 plen = STRLEN(p);
1229 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1230 if (pnl != NULL)
1231 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001232 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1233 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001234 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001235 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001237 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001238 // more is following after the "}", which was skipped
1239 last = cmdline;
1240 else
1241 // nothing is following the "}"
1242 last = (char_u *)"}";
1243 plen = STRLEN(last);
1244 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1245 if (pnl != NULL)
1246 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001247 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1248 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001249 }
1250
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001251 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001252 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001253 garray_T *tfgap = &evalarg->eval_tofree_ga;
1254
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001255 // Something comes after the "}".
1256 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001257
1258 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001259 if (ga_grow(tfgap, 1) == OK)
1260 {
1261 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1262 evalarg->eval_using_cmdline = TRUE;
1263 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001264 }
1265 else
1266 *arg = (char_u *)"";
1267
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001268 if (!evaluate)
1269 {
1270 ret = OK;
1271 goto erret;
1272 }
1273
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001274 name = get_lambda_name();
1275 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1276 if (ufunc == NULL)
1277 goto erret;
1278 set_ufunc_name(ufunc, name);
1279 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001280 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001281 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 ufunc->uf_refcount = 1;
1283 ufunc->uf_args = *newargs;
1284 newargs->ga_data = NULL;
1285 ufunc->uf_def_args = *default_args;
1286 default_args->ga_data = NULL;
1287 ufunc->uf_func_type = &t_func_any;
1288
1289 // error messages are for the first function line
1290 lnum_save = SOURCING_LNUM;
1291 SOURCING_LNUM = sourcing_lnum_top;
1292
1293 // parse argument types
1294 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1295 {
1296 SOURCING_LNUM = lnum_save;
1297 goto erret;
1298 }
1299
1300 // parse the return type, if any
1301 if (parse_return_type(ufunc, ret_type) == FAIL)
1302 goto erret;
1303
1304 pt = ALLOC_CLEAR_ONE(partial_T);
1305 if (pt == NULL)
1306 goto erret;
1307 pt->pt_func = ufunc;
1308 pt->pt_refcount = 1;
1309
1310 ufunc->uf_lines = newlines;
1311 newlines.ga_data = NULL;
1312 if (sandbox)
1313 ufunc->uf_flags |= FC_SANDBOX;
1314 if (!ASCII_ISUPPER(*ufunc->uf_name))
1315 ufunc->uf_flags |= FC_VIM9;
1316 ufunc->uf_script_ctx = current_sctx;
1317 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1318 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1319 set_function_type(ufunc);
1320
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001321 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1322
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001323 rettv->vval.v_partial = pt;
1324 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001325 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001326 ret = OK;
1327
1328erret:
1329 if (lnum_save >= 0)
1330 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001331 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001332 if (newargs != NULL)
1333 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001334 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001335 if (ufunc != NULL)
1336 {
1337 func_clear(ufunc, TRUE);
1338 func_free(ufunc, TRUE);
1339 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001340 return ret;
1341}
1342
1343/*
1344 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001345 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001346 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001347 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1348 */
1349 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001350get_lambda_tv(
1351 char_u **arg,
1352 typval_T *rettv,
1353 int types_optional,
1354 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001355{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001356 int evaluate = evalarg != NULL
1357 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001358 garray_T newargs;
1359 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001360 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001361 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001362 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001363 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001364 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001366 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001368 char_u *s;
1369 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001370 int *old_eval_lavars = eval_lavars_used;
1371 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001372 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001373 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001374 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001375 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001376 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001377 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001378
Bram Moolenaar4525a572022-02-13 11:57:33 +00001379 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001381
1382 ga_init(&newargs);
1383 ga_init(&newlines);
1384
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001385 // First, check if this is really a lambda expression. "->" or "=>" must
1386 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001387 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001388 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001389 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001390 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001391 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001392 {
1393 if (types_optional)
1394 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001395 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001396 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001397
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001398 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001399 if (evaluate)
1400 pnewargs = &newargs;
1401 else
1402 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001403 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001404 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001405 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001406 &varargs, &default_args,
1407 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001408 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001409 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001410 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001411 {
1412 if (types_optional)
1413 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001414 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001415 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001416 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001417 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001418
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001419 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1420 if (ret_type != NULL)
1421 {
1422 ret_type = vim_strsave(ret_type);
1423 tofree2 = ret_type;
1424 }
1425
Bram Moolenaare38eab22019-12-05 21:50:01 +01001426 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001427 if (evaluate)
1428 eval_lavars_used = &eval_lavars;
1429
Bram Moolenaar65c44152020-12-24 15:14:01 +01001430 *arg = skipwhite_and_linebreak(*arg, evalarg);
1431
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001432 // Recognize "{" as the start of a function body.
1433 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001434 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001435 if (evalarg == NULL)
1436 // cannot happen?
1437 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001438 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001439 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1440 types_optional ? &argtypes : NULL, varargs,
1441 &default_args, ret_type) == FAIL)
1442 goto errret;
1443 goto theend;
1444 }
1445 if (default_args.ga_len > 0)
1446 {
1447 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001448 goto errret;
1449 }
1450
Bram Moolenaare38eab22019-12-05 21:50:01 +01001451 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001452 start = *arg;
1453 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001454 if (ret == FAIL)
1455 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001456
Bram Moolenaar65c44152020-12-24 15:14:01 +01001457 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001458 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001459 *arg = skipwhite_and_linebreak(*arg, evalarg);
1460 if (**arg != '}')
1461 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001462 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001463 goto errret;
1464 }
1465 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001466 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001467
1468 if (evaluate)
1469 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001470 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001471 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001472 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001473 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001474 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001475
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001476 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001477 if (fp == NULL)
1478 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001479 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001480 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001481 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001482 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001483
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001484 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485 if (ga_grow(&newlines, 1) == FAIL)
1486 goto errret;
1487
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001488 // If there are line breaks, we need to split up the string.
1489 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001490 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001491 line_end = end;
1492
1493 // Add "return " before the expression (or the first line).
1494 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001495 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001496 if (p == NULL)
1497 goto errret;
1498 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1499 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001500 vim_strncpy(p + 7, start, line_end - start);
1501
1502 if (line_end != end)
1503 {
1504 // Add more lines, split by line breaks. Thus is used when a
1505 // lambda with { cmds } is encountered.
1506 while (*line_end == '\n')
1507 {
1508 if (ga_grow(&newlines, 1) == FAIL)
1509 goto errret;
1510 start = line_end + 1;
1511 line_end = vim_strchr(start, '\n');
1512 if (line_end == NULL)
1513 line_end = end;
1514 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1515 vim_strnsave(start, line_end - start);
1516 }
1517 }
1518
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001519 if (strstr((char *)p + 7, "a:") == NULL)
1520 // No a: variables are used for sure.
1521 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001522
1523 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001524 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001525 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001526 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001527 if (types_optional)
1528 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001529 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001530 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001531 goto errret;
1532 if (ret_type != NULL)
1533 {
1534 fp->uf_ret_type = parse_type(&ret_type,
1535 &fp->uf_type_list, TRUE);
1536 if (fp->uf_ret_type == NULL)
1537 goto errret;
1538 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001539 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001540 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001541 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001542
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001543 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001544 if (current_funccal != NULL && eval_lavars)
1545 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001546 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001547 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001548 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001549 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001550
1551#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552 if (prof_def_func())
1553 func_do_profile(fp);
1554#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001555 if (sandbox)
1556 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001557 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001558 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001559 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001560 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001561 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001562 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001563 // Use the line number of the arguments.
1564 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001565
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001566 function_using_block_scopes(fp, evalarg->eval_cstack);
1567
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001568 pt->pt_func = fp;
1569 pt->pt_refcount = 1;
1570 rettv->vval.v_partial = pt;
1571 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001572
1573 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001575
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001576theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001577 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001578 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001579 if (types_optional)
1580 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001581
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001582 return OK;
1583
1584errret:
1585 ga_clear_strings(&newargs);
1586 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001587 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001588 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001589 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001590 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001591 if (fp != NULL)
1592 vim_free(fp->uf_arg_types);
1593 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001594 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001595 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001596 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001597 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001598 return FAIL;
1599}
1600
1601/*
1602 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1603 * name it contains, otherwise return "name".
1604 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1605 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001606 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1607 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001608 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001609 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001610 */
1611 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001612deref_func_name(
1613 char_u *name,
1614 int *lenp,
1615 partial_T **partialp,
1616 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001617 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001618 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001619 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001620{
1621 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001622 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001623 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001624 char_u *s = NULL;
1625 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001626 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001627
1628 if (partialp != NULL)
1629 *partialp = NULL;
1630
1631 cc = name[*lenp];
1632 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001633
Bram Moolenaar71f21932022-01-07 18:20:55 +00001634 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001635 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001636 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001638 tv = &v->di_tv;
1639 }
1640 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1641 {
1642 imported_T *import;
1643 char_u *p = name;
1644 int len = *lenp;
1645
1646 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001647 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001648 p = name + 2;
1649 len -= 2;
1650 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001651 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001652
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001653 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001654 if (import != NULL)
1655 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001656 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001657 if (new_function)
1658 semsg(_(e_redefining_imported_item_str), name);
1659 else
1660 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001661 name[len] = cc;
1662 *lenp = 0;
1663 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001664 }
1665 }
1666
1667 if (tv != NULL)
1668 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001669 if (found_var != NULL)
1670 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001671 if (tv->v_type == VAR_FUNC)
1672 {
1673 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001674 {
1675 *lenp = 0;
1676 return (char_u *)""; // just in case
1677 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001678 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001679 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001680 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001681
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001682 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001684 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001685
1686 if (pt == NULL)
1687 {
1688 *lenp = 0;
1689 return (char_u *)""; // just in case
1690 }
1691 if (partialp != NULL)
1692 *partialp = pt;
1693 s = partial_name(pt);
1694 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001695 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001696
1697 if (s != NULL)
1698 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001699 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001700 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001701 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001702
1703 if (sv != NULL)
1704 *type = sv->sv_type;
1705 }
1706 return s;
1707 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001708 }
1709
1710 return name;
1711}
1712
1713/*
1714 * Give an error message with a function name. Handle <SNR> things.
1715 * "ermsg" is to be passed without translation, use N_() instead of _().
1716 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001717 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001718emsg_funcname(char *ermsg, char_u *name)
1719{
Bram Moolenaar54598062022-01-13 12:05:09 +00001720 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001721
Bram Moolenaar54598062022-01-13 12:05:09 +00001722 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001724 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 if (p != name)
1726 vim_free(p);
1727}
1728
1729/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001730 * Get function arguments at "*arg" and advance it.
1731 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001732 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001733 */
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001734 static int
1735get_func_arguments(
1736 char_u **arg,
1737 evalarg_T *evalarg,
1738 int partial_argc,
1739 typval_T *argvars,
1740 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001741{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001742 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001744 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001745 int evaluate = evalarg == NULL
1746 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001747
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001748 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001750 // skip the '(' or ',' and possibly line breaks
1751 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1752
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001753 if (*argp == ')' || *argp == ',' || *argp == NUL)
1754 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001755 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001756 {
1757 ret = FAIL;
1758 break;
1759 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001760 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001761 // The comma should come right after the argument, but this wasn't
1762 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001763 if (vim9script)
1764 {
1765 if (*argp != ',' && *skipwhite(argp) == ',')
1766 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001767 if (evaluate)
1768 semsg(_(e_no_white_space_allowed_before_str_str),
1769 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001770 ret = FAIL;
1771 break;
1772 }
1773 }
1774 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001775 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001776 if (*argp != ',')
1777 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001778 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1779 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001780 if (evaluate)
1781 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001782 ret = FAIL;
1783 break;
1784 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001785 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001786
Bram Moolenaare6b53242020-07-01 17:28:33 +02001787 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001788 if (*argp == ')')
1789 ++argp;
1790 else
1791 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001792 *arg = argp;
1793 return ret;
1794}
1795
1796/*
1797 * Call a function and put the result in "rettv".
1798 * Return OK or FAIL.
1799 */
1800 int
1801get_func_tv(
1802 char_u *name, // name of the function
1803 int len, // length of "name" or -1 to use strlen()
1804 typval_T *rettv,
1805 char_u **arg, // argument, pointing to the '('
1806 evalarg_T *evalarg, // for line continuation
1807 funcexe_T *funcexe) // various values
1808{
1809 char_u *argp;
1810 int ret = OK;
1811 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1812 int argcount = 0; // number of arguments found
1813 int vim9script = in_vim9script();
1814 int evaluate = evalarg == NULL
1815 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1816
1817 argp = *arg;
1818 ret = get_func_arguments(&argp, evalarg,
1819 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1820 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001821
1822 if (ret == OK)
1823 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001824 int i = 0;
1825 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001826
1827 if (get_vim_var_nr(VV_TESTING))
1828 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001829 // Prepare for calling test_garbagecollect_now(), need to know
1830 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001831 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001832 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 for (i = 0; i < argcount; ++i)
1834 if (ga_grow(&funcargs, 1) == OK)
1835 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1836 &argvars[i];
1837 }
1838
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001839 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001840 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001841 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001842 // An error in a builtin function does not return FAIL, but we do
1843 // want to abort further processing if an error was given.
1844 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001845 clear_tv(rettv);
1846 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001847
1848 funcargs.ga_len -= i;
1849 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001850 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001851 {
1852 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001853 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001854 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001855 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 }
1857
1858 while (--argcount >= 0)
1859 clear_tv(&argvars[argcount]);
1860
Bram Moolenaar4525a572022-02-13 11:57:33 +00001861 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001862 *arg = argp;
1863 else
1864 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001865 return ret;
1866}
1867
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001868/*
1869 * Return TRUE if "p" starts with "<SID>" or "s:".
1870 * Only works if eval_fname_script() returned non-zero for "p"!
1871 */
1872 static int
1873eval_fname_sid(char_u *p)
1874{
1875 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1876}
1877
1878/*
1879 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1880 * Change <SNR>123_name() to K_SNR 123_name().
1881 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
1882 * (slow).
1883 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001884 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1886{
1887 int llen;
1888 char_u *fname;
1889 int i;
1890
1891 llen = eval_fname_script(name);
1892 if (llen > 0)
1893 {
1894 fname_buf[0] = K_SPECIAL;
1895 fname_buf[1] = KS_EXTRA;
1896 fname_buf[2] = (int)KE_SNR;
1897 i = 3;
Bram Moolenaare38eab22019-12-05 21:50:01 +01001898 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001899 {
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001900 if (current_sctx.sc_sid <= 0)
Bram Moolenaaref140542019-12-31 21:27:13 +01001901 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902 else
1903 {
Bram Moolenaarad3ec762019-04-21 00:00:13 +02001904 sprintf((char *)fname_buf + 3, "%ld_",
1905 (long)current_sctx.sc_sid);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001906 i = (int)STRLEN(fname_buf);
1907 }
1908 }
1909 if (i + STRLEN(name + llen) < FLEN_FIXED)
1910 {
1911 STRCPY(fname_buf + i, name + llen);
1912 fname = fname_buf;
1913 }
1914 else
1915 {
Bram Moolenaar964b3742019-05-24 18:54:09 +02001916 fname = alloc(i + STRLEN(name + llen) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 if (fname == NULL)
Bram Moolenaaref140542019-12-31 21:27:13 +01001918 *error = FCERR_OTHER;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001919 else
1920 {
1921 *tofree = fname;
1922 mch_memmove(fname, fname_buf, (size_t)i);
1923 STRCPY(fname + i, name + llen);
1924 }
1925 }
1926 }
1927 else
1928 fname = name;
1929 return fname;
1930}
1931
1932/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001933 * Concatenate the script ID and function name into "<SNR>99_name".
1934 * "buffer" must have size MAX_FUNC_NAME_LEN.
1935 */
1936 void
1937func_name_with_sid(char_u *name, int sid, char_u *buffer)
1938{
1939 // A script-local function is stored as "<SNR>99_name".
1940 buffer[0] = K_SPECIAL;
1941 buffer[1] = KS_EXTRA;
1942 buffer[2] = (int)KE_SNR;
1943 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1944 (long)sid, name);
1945}
1946
1947/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948 * Find a function "name" in script "sid".
1949 */
1950 static ufunc_T *
1951find_func_with_sid(char_u *name, int sid)
1952{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001953 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001954 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955
Bram Moolenaarb8822442022-01-11 15:24:05 +00001956 if (!SCRIPT_ID_VALID(sid))
1957 return NULL; // not in a script
1958
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001959 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 hi = hash_find(&func_hashtab, buffer);
1961 if (!HASHITEM_EMPTY(hi))
1962 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001963 return NULL;
1964}
1965
1966/*
1967 * Find a function "name" in script "sid" prefixing the autoload prefix.
1968 */
1969 static ufunc_T *
1970find_func_with_prefix(char_u *name, int sid)
1971{
1972 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001973 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001974 scriptitem_T *si;
1975
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001976 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001977 return NULL; // already has the prefix
1978 if (!SCRIPT_ID_VALID(sid))
1979 return NULL; // not in a script
1980 si = SCRIPT_ITEM(sid);
1981 if (si->sn_autoload_prefix != NULL)
1982 {
1983 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1984 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001985 char_u *namep;
1986
1987 // skip a "<SNR>99_" prefix
1988 namep = untrans_function_name(name);
1989 if (namep == NULL)
1990 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001991
1992 // An exported function in an autoload script is stored as
1993 // "dir#path#name".
1994 if (len < sizeof(buffer))
1995 auto_name = buffer;
1996 else
1997 auto_name = alloc(len);
1998 if (auto_name != NULL)
1999 {
2000 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002001 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002002 hi = hash_find(&func_hashtab, auto_name);
2003 if (auto_name != buffer)
2004 vim_free(auto_name);
2005 if (!HASHITEM_EMPTY(hi))
2006 return HI2UF(hi);
2007 }
2008 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009
2010 return NULL;
2011}
2012
2013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002015 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2016 * functions.
2017 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002018 * Return NULL for unknown function.
2019 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002020 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002021find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002022{
2023 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002025
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002026 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002028 // Find script-local function before global one.
2029 if (in_vim9script() && eval_isnamec1(*name)
2030 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002032 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2033 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002034 if (func != NULL)
2035 return func;
2036 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002037 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2038 {
2039 char_u *p = name + 5;
2040 long sid;
2041
2042 // printable "<SNR>123_Name" form
2043 sid = getdigits(&p);
2044 if (*p == '_')
2045 {
2046 func = find_func_with_sid(p + 1, (int)sid);
2047 if (func != NULL)
2048 return func;
2049 }
2050 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002052
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002053 if ((flags & FFED_NO_GLOBAL) == 0)
2054 {
2055 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002056 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002057 if (!HASHITEM_EMPTY(hi))
2058 return HI2UF(hi);
2059 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002060
Bram Moolenaarb8822442022-01-11 15:24:05 +00002061 // Find autoload function if this is an autoload script.
2062 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2063 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002064}
2065
2066/*
2067 * Find a function by name, return pointer to it in ufuncs.
2068 * "cctx" is passed in a :def function to find imported functions.
2069 * Return NULL for unknown or dead function.
2070 */
2071 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002072find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002073{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002074 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002075
2076 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2077 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 return NULL;
2079}
2080
2081/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002082 * Return TRUE if "ufunc" is a global function.
2083 */
2084 int
2085func_is_global(ufunc_T *ufunc)
2086{
2087 return ufunc->uf_name[0] != K_SPECIAL;
2088}
2089
2090/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002091 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2092 */
2093 int
2094func_requires_g_prefix(ufunc_T *ufunc)
2095{
2096 return ufunc->uf_name[0] != K_SPECIAL
2097 && (ufunc->uf_flags & FC_LAMBDA) == 0
2098 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL;
2099}
2100
2101/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002102 * Copy the function name of "fp" to buffer "buf".
2103 * "buf" must be able to hold the function name plus three bytes.
2104 * Takes care of script-local function names.
2105 */
2106 static void
2107cat_func_name(char_u *buf, ufunc_T *fp)
2108{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002109 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002110 {
2111 STRCPY(buf, "<SNR>");
2112 STRCAT(buf, fp->uf_name + 3);
2113 }
2114 else
2115 STRCPY(buf, fp->uf_name);
2116}
2117
2118/*
2119 * Add a number variable "name" to dict "dp" with value "nr".
2120 */
2121 static void
2122add_nr_var(
2123 dict_T *dp,
2124 dictitem_T *v,
2125 char *name,
2126 varnumber_T nr)
2127{
2128 STRCPY(v->di_key, name);
2129 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2130 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2131 v->di_tv.v_type = VAR_NUMBER;
2132 v->di_tv.v_lock = VAR_FIXED;
2133 v->di_tv.vval.v_number = nr;
2134}
2135
2136/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002137 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002138 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002139 static void
2140free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002141{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002142 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002143
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
2455copy_func(char_u *lambda, char_u *global, ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002456{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002457 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002458 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002459
2460 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002461 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002462 semsg(_(e_lambda_function_not_found_str), lambda);
2463 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002464 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002465
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002466 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002467 if (fp != NULL)
2468 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002469 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002470 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002471 return FAIL;
2472 }
2473
2474 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2475 if (fp == NULL)
2476 return FAIL;
2477
2478 fp->uf_varargs = ufunc->uf_varargs;
2479 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2480 fp->uf_def_status = ufunc->uf_def_status;
2481 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2482 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2483 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2484 == FAIL
2485 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2486 goto failed;
2487
2488 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2489 : vim_strsave(ufunc->uf_name_exp);
2490 if (ufunc->uf_arg_types != NULL)
2491 {
2492 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2493 if (fp->uf_arg_types == NULL)
2494 goto failed;
2495 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2496 sizeof(type_T *) * fp->uf_args.ga_len);
2497 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002498 if (ufunc->uf_va_name != NULL)
2499 {
2500 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2501 if (fp->uf_va_name == NULL)
2502 goto failed;
2503 }
2504 fp->uf_ret_type = ufunc->uf_ret_type;
2505
2506 fp->uf_refcount = 1;
2507 STRCPY(fp->uf_name, global);
2508 hash_add(&func_hashtab, UF2HIKEY(fp));
2509
2510 // the referenced dfunc_T is now used one more time
2511 link_def_function(fp);
2512
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002513 // Create a partial to store the context of the function where it was
2514 // instantiated. Only needs to be done once. Do this on the original
2515 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002516 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2517 {
2518 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2519
2520 if (pt == NULL)
2521 goto failed;
2522 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002523 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002524 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002525 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002526 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002527 ufunc->uf_partial = pt;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002528 --pt->pt_refcount; // not actually referenced here
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002529 }
2530
2531 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002532
2533failed:
2534 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002535 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002536}
2537
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002538static int funcdepth = 0;
2539
2540/*
2541 * Increment the function call depth count.
2542 * Return FAIL when going over 'maxfuncdepth'.
2543 * Otherwise return OK, must call funcdepth_decrement() later!
2544 */
2545 int
2546funcdepth_increment(void)
2547{
2548 if (funcdepth >= p_mfd)
2549 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002550 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002551 return FAIL;
2552 }
2553 ++funcdepth;
2554 return OK;
2555}
2556
2557 void
2558funcdepth_decrement(void)
2559{
2560 --funcdepth;
2561}
2562
2563/*
2564 * Get the current function call depth.
2565 */
2566 int
2567funcdepth_get(void)
2568{
2569 return funcdepth;
2570}
2571
2572/*
2573 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002574 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002575 * times as funcdepth_increment().
2576 */
2577 void
2578funcdepth_restore(int depth)
2579{
2580 funcdepth = depth;
2581}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002582
2583/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002584 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2585 * "rettv".
2586 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2587 * Returns NULL when allocation fails.
2588 */
2589 funccall_T *
2590create_funccal(ufunc_T *fp, typval_T *rettv)
2591{
2592 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2593
2594 if (fc == NULL)
2595 return NULL;
2596 fc->fc_caller = current_funccal;
2597 current_funccal = fc;
2598 fc->fc_func = fp;
2599 func_ptr_ref(fp);
2600 fc->fc_rettv = rettv;
2601 return fc;
2602}
2603
2604/*
2605 * To be called when returning from a compiled function; restores
2606 * current_funccal.
2607 */
2608 void
2609remove_funccal()
2610{
2611 funccall_T *fc = current_funccal;
2612
2613 current_funccal = fc->fc_caller;
2614 free_funccal(fc);
2615}
2616
2617/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002618 * Call a user function.
2619 */
2620 static void
2621call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002622 ufunc_T *fp, // pointer to function
2623 int argcount, // nr of args
2624 typval_T *argvars, // arguments
2625 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002626 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002627 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002628{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002629 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002630 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002631 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002632 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002633 funccall_T *fc;
2634 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002635 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002636 dictitem_T *v;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002637 int fixvar_idx = 0; // index in fc_fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002638 int i;
2639 int ai;
2640 int islambda = FALSE;
2641 char_u numbuf[NUMBUFLEN];
2642 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002643 typval_T *tv_to_free[MAX_FUNC_ARGS];
2644 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002645#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002646 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002647#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002648 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649
Bram Moolenaarb2049902021-01-24 12:53:53 +01002650#ifdef FEAT_PROFILE
2651 CLEAR_FIELD(profile_info);
2652#endif
2653
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002654 // If depth of calling is getting too high, don't execute the function.
2655 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002656 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002657 rettv->v_type = VAR_NUMBER;
2658 rettv->vval.v_number = -1;
2659 return;
2660 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661
Bram Moolenaare38eab22019-12-05 21:50:01 +01002662 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002663
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002664 fc = create_funccal(fp, rettv);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002665 if (fc == NULL)
2666 return;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002667 fc->fc_level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002668 // Check if this function has a breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002669 fc->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2670 fc->fc_dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002671 // Set up fields for closure.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002672 ga_init2(&fc->fc_ufuncs, sizeof(ufunc_T *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002673
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002674 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002675 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002676#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01002677 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002678#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002679 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002680#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002681 if (do_profiling == PROF_YES)
2682 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002683#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002684 sticky_cmdmod_flags = 0;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01002685 call_def_function(fp, argcount, argvars, 0, funcexe->fe_partial,
Bram Moolenaar58779852022-09-06 18:31:14 +01002686 fc, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002687 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002688#ifdef FEAT_PROFILE
2689 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002690 || (caller != NULL && caller->uf_profiling)))
2691 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002692#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002693 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002694 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002695 return;
2696 }
2697
Bram Moolenaar38453522021-11-28 22:00:12 +00002698 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002699
2700 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002701 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2702 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2703 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002704 */
2705 /*
2706 * Init l: variables.
2707 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002708 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002709 if (selfdict != NULL)
2710 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002711 // Set l:self to "selfdict". Use "name" to avoid a warning from
2712 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002713 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002714 name = v->di_key;
2715 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002716 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002717 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 v->di_tv.v_type = VAR_DICT;
2719 v->di_tv.v_lock = 0;
2720 v->di_tv.vval.v_dict = selfdict;
2721 ++selfdict->dv_refcount;
2722 }
2723
2724 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002725 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002726 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002727 * Set a:000 to a list with room for the "..." arguments.
2728 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002729 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002730 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002731 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002732 (varnumber_T)(argcount >= fp->uf_args.ga_len
2733 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002734 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002735 if ((fp->uf_flags & FC_NOARGS) == 0)
2736 {
2737 // Use "name" to avoid a warning from some compiler that checks the
2738 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002739 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002740 name = v->di_key;
2741 STRCPY(name, "000");
2742 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002743 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002744 v->di_tv.v_type = VAR_LIST;
2745 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002746 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002747 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002748 CLEAR_FIELD(fc->fc_l_varlist);
2749 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2750 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002751
2752 /*
2753 * Set a:firstline to "firstline" and a:lastline to "lastline".
2754 * Set a:name to named arguments.
2755 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002756 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002757 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002758 if ((fp->uf_flags & FC_NOARGS) == 0)
2759 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002760 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2761 "firstline", (varnumber_T)funcexe->fe_firstline);
2762 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2763 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002764 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002765 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002766 {
2767 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002768 typval_T def_rettv;
2769 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770
2771 ai = i - fp->uf_args.ga_len;
2772 if (ai < 0)
2773 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002774 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002775 name = FUNCARG(fp, i);
2776 if (islambda)
2777 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002778
2779 // evaluate named argument default expression
2780 isdefault = ai + fp->uf_def_args.ga_len >= 0
2781 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2782 && argvars[i].vval.v_number == VVAL_NONE));
2783 if (isdefault)
2784 {
2785 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002786
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002787 def_rettv.v_type = VAR_NUMBER;
2788 def_rettv.vval.v_number = -1;
2789
2790 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2791 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002792 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002793 {
2794 default_arg_err = 1;
2795 break;
2796 }
2797 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002798 }
2799 else
2800 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002801 if ((fp->uf_flags & FC_NOARGS) != 0)
2802 // Bail out if no a: arguments used (in lambda).
2803 break;
2804
Bram Moolenaare38eab22019-12-05 21:50:01 +01002805 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002806 sprintf((char *)numbuf, "%d", ai + 1);
2807 name = numbuf;
2808 }
2809 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2810 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002811 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002812 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002813 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002814 }
2815 else
2816 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002817 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 if (v == NULL)
2819 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002820 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002821 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002823 // Note: the values are copied directly to avoid alloc/free.
2824 // "argvars" must have VAR_FIXED for v_lock.
2825 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826 v->di_tv.v_lock = VAR_FIXED;
2827
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002828 if (isdefault)
2829 // Need to free this later, no matter where it's stored.
2830 tv_to_free[tv_to_free_len++] = &v->di_tv;
2831
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002832 if (addlocal)
2833 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002834 // Named arguments should be accessed without the "a:" prefix in
2835 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002836 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002837 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002838 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002839 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01002840 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002841
2842 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2843 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002844 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002845
2846 li->li_tv = argvars[i];
2847 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002848 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002849 }
2850 }
2851
Bram Moolenaare38eab22019-12-05 21:50:01 +01002852 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002853 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002854
2855 if (fp->uf_flags & FC_SANDBOX)
2856 {
2857 using_sandbox = TRUE;
2858 ++sandbox;
2859 }
2860
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002861 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002862 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002863 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002864 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002865 ++no_wait_return;
2866 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002867
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002868 smsg(_("calling %s"), SOURCING_NAME);
2869 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002870 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002871 char_u buf[MSG_BUF_LEN];
2872 char_u numbuf2[NUMBUFLEN];
2873 char_u *tofree;
2874 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002875
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002876 msg_puts("(");
2877 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002878 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002879 if (i > 0)
2880 msg_puts(", ");
2881 if (argvars[i].v_type == VAR_NUMBER)
2882 msg_outnum((long)argvars[i].vval.v_number);
2883 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002884 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002885 // Do not want errors such as E724 here.
2886 ++emsg_off;
2887 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2888 --emsg_off;
2889 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002890 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002891 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002892 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002893 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2894 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002895 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002896 msg_puts((char *)s);
2897 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002898 }
2899 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002900 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002901 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002903 msg_puts("\n"); // don't overwrite this either
2904
2905 verbose_leave_scroll();
2906 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002907 }
2908#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002909 if (do_profiling == PROF_YES)
2910 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002911 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002912#endif
2913
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002914 // "legacy" does not apply to commands in the function
2915 sticky_cmdmod_flags = 0;
2916
Bram Moolenaar98aff652022-09-06 21:02:35 +01002917 // If called from a compiled :def function the execution context must be
2918 // hidden, any deferred functions need to be added to the function being
2919 // executed here.
2920 save_current_ectx = clear_currrent_ectx();
2921
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002922 save_current_sctx = current_sctx;
2923 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002924 save_did_emsg = did_emsg;
2925 did_emsg = FALSE;
2926
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002927 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2928 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002929 else if (islambda)
2930 {
2931 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2932
2933 // A Lambda always has the command "return {expr}". It is much faster
2934 // to evaluate {expr} directly.
2935 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002936 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002937 --ex_nesting_level;
2938 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002939 else
2940 // call do_cmdline() to execute the lines
2941 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002942 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2943
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002944 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01002945 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002946
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002947 --RedrawingDisabled;
2948
Bram Moolenaare38eab22019-12-05 21:50:01 +01002949 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002950 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2951 {
2952 clear_tv(rettv);
2953 rettv->v_type = VAR_NUMBER;
2954 rettv->vval.v_number = -1;
2955 }
2956
2957#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002958 if (do_profiling == PROF_YES)
2959 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002960 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002961
2962 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2963 profile_may_end_func(&profile_info, fp, caller);
2964 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002965#endif
2966
Bram Moolenaare38eab22019-12-05 21:50:01 +01002967 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002968 if (p_verbose >= 12)
2969 {
2970 ++no_wait_return;
2971 verbose_enter_scroll();
2972
2973 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002974 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002975 else if (fc->fc_rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002976 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002977 (long)fc->fc_rettv->vval.v_number);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002978 else
2979 {
2980 char_u buf[MSG_BUF_LEN];
2981 char_u numbuf2[NUMBUFLEN];
2982 char_u *tofree;
2983 char_u *s;
2984
Bram Moolenaare38eab22019-12-05 21:50:01 +01002985 // The value may be very long. Skip the middle part, so that we
2986 // have some idea how it starts and ends. smsg() would always
2987 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002988 ++emsg_off;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002989 s = tv2string(fc->fc_rettv, &tofree, numbuf2, 0);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002990 --emsg_off;
2991 if (s != NULL)
2992 {
2993 if (vim_strsize(s) > MSG_BUF_CLEN)
2994 {
2995 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2996 s = buf;
2997 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002998 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002999 vim_free(tofree);
3000 }
3001 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003002 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003
3004 verbose_leave_scroll();
3005 --no_wait_return;
3006 }
3007
Bram Moolenaare31ee862020-01-07 20:59:34 +01003008 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003009 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003010 current_sctx = save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01003011 restore_current_ectx(save_current_ectx);
3012
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003013#ifdef FEAT_PROFILE
3014 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003015 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003016#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02003017 if (using_sandbox)
3018 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003019 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003021 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003022 {
3023 ++no_wait_return;
3024 verbose_enter_scroll();
3025
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003026 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003027 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003028
3029 verbose_leave_scroll();
3030 --no_wait_return;
3031 }
3032
3033 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01003034 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02003035 for (i = 0; i < tv_to_free_len; ++i)
3036 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003037 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003038}
3039
3040/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003041 * Check the argument count for user function "fp".
3042 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3043 */
3044 int
3045check_user_func_argcount(ufunc_T *fp, int argcount)
3046{
3047 int regular_args = fp->uf_args.ga_len;
3048
3049 if (argcount < regular_args - fp->uf_def_args.ga_len)
3050 return FCERR_TOOFEW;
3051 else if (!has_varargs(fp) && argcount > regular_args)
3052 return FCERR_TOOMANY;
3053 return FCERR_UNKNOWN;
3054}
3055
3056/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003057 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003058 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003059 int
3060call_user_func_check(
3061 ufunc_T *fp,
3062 int argcount,
3063 typval_T *argvars,
3064 typval_T *rettv,
3065 funcexe_T *funcexe,
3066 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003067{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003068 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003069
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003070#ifdef FEAT_LUA
3071 if (fp->uf_flags & FC_CFUNC)
3072 {
3073 cfunc_T cb = fp->uf_cb;
3074
3075 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3076 }
3077#endif
3078
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003079 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3080 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003081 error = check_user_func_argcount(fp, argcount);
3082 if (error != FCERR_UNKNOWN)
3083 return error;
3084 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003085 error = FCERR_DICT;
3086 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003087 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003088 int did_save_redo = FALSE;
3089 save_redo_T save_redo;
3090
3091 /*
3092 * Call the user function.
3093 * Save and restore search patterns, script variables and
3094 * redo buffer.
3095 */
3096 save_search_patterns();
3097 if (!ins_compl_active())
3098 {
3099 saveRedobuff(&save_redo);
3100 did_save_redo = TRUE;
3101 }
3102 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003103 call_user_func(fp, argcount, argvars, rettv, funcexe,
3104 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003105 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3106 // Function was unreferenced while being used, free it now.
3107 func_clear_free(fp, FALSE);
3108 if (did_save_redo)
3109 restoreRedobuff(&save_redo);
3110 restore_search_patterns();
3111 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003112 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003113 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003114}
3115
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003116static funccal_entry_T *funccal_stack = NULL;
3117
3118/*
3119 * Save the current function call pointer, and set it to NULL.
3120 * Used when executing autocommands and for ":source".
3121 */
3122 void
3123save_funccal(funccal_entry_T *entry)
3124{
3125 entry->top_funccal = current_funccal;
3126 entry->next = funccal_stack;
3127 funccal_stack = entry;
3128 current_funccal = NULL;
3129}
3130
3131 void
3132restore_funccal(void)
3133{
3134 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003135 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003136 else
3137 {
3138 current_funccal = funccal_stack->top_funccal;
3139 funccal_stack = funccal_stack->next;
3140 }
3141}
3142
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003143 funccall_T *
3144get_current_funccal(void)
3145{
3146 return current_funccal;
3147}
3148
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003149/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003150 * Return TRUE when currently at the script level:
3151 * - not in a function
3152 * - not executing an autocommand
3153 * Note that when an autocommand sources a script the result is FALSE;
3154 */
3155 int
3156at_script_level(void)
3157{
3158 return current_funccal == NULL && autocmd_match == NULL;
3159}
3160
3161/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003162 * Mark all functions of script "sid" as deleted.
3163 */
3164 void
3165delete_script_functions(int sid)
3166{
3167 hashitem_T *hi;
3168 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003169 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003170 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003171 size_t len;
3172
3173 buf[0] = K_SPECIAL;
3174 buf[1] = KS_EXTRA;
3175 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003176 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003177 len = STRLEN(buf);
3178
Bram Moolenaarce658352020-07-31 23:47:12 +02003179 while (todo > 0)
3180 {
3181 todo = func_hashtab.ht_used;
3182 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3183 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003184 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003185 fp = HI2UF(hi);
3186 if (STRNCMP(fp->uf_name, buf, len) == 0)
3187 {
3188 int changed = func_hashtab.ht_changed;
3189
3190 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003191
3192 if (fp->uf_calls > 0)
3193 {
3194 // Function is executing, don't free it but do remove
3195 // it from the hashtable.
3196 if (func_remove(fp))
3197 fp->uf_refcount--;
3198 }
3199 else
3200 {
3201 func_clear(fp, TRUE);
3202 // When clearing a function another function can be
3203 // cleared as a side effect. When that happens start
3204 // over.
3205 if (changed != func_hashtab.ht_changed)
3206 break;
3207 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003208 }
3209 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003210 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003211 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003212}
3213
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003214#if defined(EXITFREE) || defined(PROTO)
3215 void
3216free_all_functions(void)
3217{
3218 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003219 ufunc_T *fp;
3220 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003221 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003222 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003223
Bram Moolenaare38eab22019-12-05 21:50:01 +01003224 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003225 while (current_funccal != NULL)
3226 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003227 clear_tv(current_funccal->fc_rettv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003228 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003229 if (current_funccal == NULL && funccal_stack != NULL)
3230 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003231 }
3232
Bram Moolenaare38eab22019-12-05 21:50:01 +01003233 // First clear what the functions contain. Since this may lower the
3234 // reference count of a function, it may also free a function and change
3235 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003236 while (todo > 0)
3237 {
3238 todo = func_hashtab.ht_used;
3239 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3240 if (!HASHITEM_EMPTY(hi))
3241 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003242 // clear the def function index now
3243 fp = HI2UF(hi);
3244 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003245 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003246
Bram Moolenaare38eab22019-12-05 21:50:01 +01003247 // Only free functions that are not refcounted, those are
3248 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003249 if (func_name_refcount(fp->uf_name))
3250 ++skipped;
3251 else
3252 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003253 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003254 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003255 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003256 {
3257 skipped = 0;
3258 break;
3259 }
3260 }
3261 --todo;
3262 }
3263 }
3264
Bram Moolenaare38eab22019-12-05 21:50:01 +01003265 // Now actually free the functions. Need to start all over every time,
3266 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003267 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003268 while (func_hashtab.ht_used > skipped)
3269 {
3270 todo = func_hashtab.ht_used;
3271 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003272 if (!HASHITEM_EMPTY(hi))
3273 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003274 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003275 // Only free functions that are not refcounted, those are
3276 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003277 fp = HI2UF(hi);
3278 if (func_name_refcount(fp->uf_name))
3279 ++skipped;
3280 else
3281 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003282 if (func_free(fp, FALSE) == OK)
3283 {
3284 skipped = 0;
3285 break;
3286 }
3287 // did not actually free it
3288 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003289 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003290 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003291 }
3292 if (skipped == 0)
3293 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003294
3295 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003296}
3297#endif
3298
3299/*
3300 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003301 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3302 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003303 * "len" is the length of "name", or -1 for NUL terminated.
3304 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003305 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003306builtin_function(char_u *name, int len)
3307{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003308 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003309
Bram Moolenaara26b9702020-04-18 19:53:28 +02003310 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003311 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003312 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3313 {
3314 if (name[i] == AUTOLOAD_CHAR)
3315 return FALSE;
3316 if (!eval_isnamec(name[i]))
3317 {
3318 // "name.something" is not a builtin function
3319 if (name[i] == '.')
3320 return FALSE;
3321 break;
3322 }
3323 }
3324 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003325}
3326
3327 int
3328func_call(
3329 char_u *name,
3330 typval_T *args,
3331 partial_T *partial,
3332 dict_T *selfdict,
3333 typval_T *rettv)
3334{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003335 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003336 listitem_T *item;
3337 typval_T argv[MAX_FUNC_ARGS + 1];
3338 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003339 int r = 0;
3340
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003341 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003342 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343 {
3344 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3345 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003346 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 break;
3348 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003349 // Make a copy of each argument. This is needed to be able to set
3350 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 copy_tv(&item->li_tv, &argv[argc++]);
3352 }
3353
3354 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003355 {
3356 funcexe_T funcexe;
3357
Bram Moolenaara80faa82020-04-12 19:37:17 +02003358 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003359 funcexe.fe_firstline = curwin->w_cursor.lnum;
3360 funcexe.fe_lastline = curwin->w_cursor.lnum;
3361 funcexe.fe_evaluate = TRUE;
3362 funcexe.fe_partial = partial;
3363 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003364 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3365 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003366
Bram Moolenaare38eab22019-12-05 21:50:01 +01003367 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003368 while (argc > 0)
3369 clear_tv(&argv[--argc]);
3370
3371 return r;
3372}
3373
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003374static int callback_depth = 0;
3375
3376 int
3377get_callback_depth(void)
3378{
3379 return callback_depth;
3380}
3381
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003382/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003383 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003384 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003385 */
3386 int
3387call_callback(
3388 callback_T *callback,
3389 int len, // length of "name" or -1 to use strlen()
3390 typval_T *rettv, // return value goes here
3391 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003392 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003393 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003394{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003395 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003396 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003397
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003398 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3399 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003400 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003401 funcexe.fe_evaluate = TRUE;
3402 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003403 ++callback_depth;
3404 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3405 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003406
3407 // When a :def function was called that uses :try an error would be turned
3408 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003409 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003410 {
3411 need_rethrow = FALSE;
3412 handle_did_throw();
3413 }
3414
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003415 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003416}
3417
3418/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003419 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003420 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003421 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3422 */
3423 varnumber_T
3424call_callback_retnr(
3425 callback_T *callback,
3426 int argcount, // number of "argvars"
3427 typval_T *argvars) // vars for arguments, must have "argcount"
3428 // PLUS ONE elements!
3429{
3430 typval_T rettv;
3431 varnumber_T retval;
3432
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003433 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003434 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003435
3436 retval = tv_get_number_chk(&rettv, NULL);
3437 clear_tv(&rettv);
3438 return retval;
3439}
3440
3441/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003442 * Give an error message for the result of a function.
3443 * Nothing if "error" is FCERR_NONE.
3444 */
3445 void
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003446user_func_error(int error, char_u *name, funcexe_T *funcexe)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003447{
3448 switch (error)
3449 {
3450 case FCERR_UNKNOWN:
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003451 if (funcexe->fe_found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003452 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003453 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003454 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003455 break;
3456 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003457 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003458 break;
3459 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003460 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003461 break;
3462 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003463 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003464 break;
3465 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003466 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003467 break;
3468 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003469 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003470 break;
3471 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003472 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3473 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003474 break;
3475 }
3476}
3477
3478/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003479 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003480 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003481 * Return FAIL when the function can't be called, OK otherwise.
3482 * Also returns OK when an error was encountered while executing the function.
3483 */
3484 int
3485call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003486 char_u *funcname, // name of the function
3487 int len, // length of "name" or -1 to use strlen()
3488 typval_T *rettv, // return value goes here
3489 int argcount_in, // number of "argvars"
3490 typval_T *argvars_in, // vars for arguments, must have "argcount"
3491 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003492 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003493{
3494 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003495 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003496 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003497 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003498 char_u fname_buf[FLEN_FIXED + 1];
3499 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003500 char_u *fname = NULL;
3501 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 int argcount = argcount_in;
3503 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003504 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003505 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003506 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003507 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003508 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003509 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003510 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003511 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003512
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003513 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3514 // even when call_func() returns FAIL.
3515 rettv->v_type = VAR_UNKNOWN;
3516
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003517 if (partial != NULL)
3518 fp = partial->pt_func;
3519 if (fp == NULL)
3520 {
3521 // Make a copy of the name, if it comes from a funcref variable it
3522 // could be changed or deleted in the called function.
3523 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3524 if (name == NULL)
3525 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003526
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003527 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3528 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003529
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003530 if (funcexe->fe_doesrange != NULL)
3531 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003532
3533 if (partial != NULL)
3534 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003535 // When the function has a partial with a dict and there is a dict
3536 // argument, use the dict argument. That is backwards compatible.
3537 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003538 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003539 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003540 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003541 {
3542 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003543 {
3544 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3545 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003546 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003547 goto theend;
3548 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003549 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003550 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003551 for (i = 0; i < argcount_in; ++i)
3552 argv[i + argv_clear] = argvars_in[i];
3553 argvars = argv;
3554 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003555
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003556 if (funcexe->fe_check_type != NULL
3557 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003558 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003559 // Now funcexe->fe_check_type is missing the added arguments,
3560 // make a copy of the type with the correction.
3561 check_type = *funcexe->fe_check_type;
3562 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003563 check_type.tt_args = check_type_args;
3564 CLEAR_FIELD(check_type_args);
3565 for (i = 0; i < check_type.tt_argcount; ++i)
3566 check_type_args[i + partial->pt_argc] =
3567 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003568 check_type.tt_argcount += partial->pt_argc;
3569 check_type.tt_min_argcount += partial->pt_argc;
3570 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003571 }
3572 }
3573
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003574 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3575 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003576 {
3577 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003578 if (check_argument_types(funcexe->fe_check_type,
3579 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003580 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003581 error = FCERR_OTHER;
3582 }
3583
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003584 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003585 {
3586 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003587 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003588
Bram Moolenaar333894b2020-08-01 18:53:07 +02003589 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003590 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003591 {
3592 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003593 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003594 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003595
Bram Moolenaare38eab22019-12-05 21:50:01 +01003596 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003598 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003600 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601 {
3602 /*
3603 * User defined function.
3604 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003605 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003606 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003607 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003608 if (fp != NULL && !is_global && in_vim9script()
3609 && func_requires_g_prefix(fp))
3610 // In Vim9 script g: is required to find a global
3611 // non-autoload function.
3612 fp = NULL;
3613 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003614
Bram Moolenaare38eab22019-12-05 21:50:01 +01003615 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003616 if (fp == NULL
3617 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003618 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003619 && !aborting())
3620 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003621 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003622 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003623 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003624 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003625 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3626 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003627 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003628 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003630 if (fp == NULL)
3631 {
3632 char_u *p = untrans_function_name(rfname);
3633
3634 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003635 // Don't do this if the name starts with "s:".
3636 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003637 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003638 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003639
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003640 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003641 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003642 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003643 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003644 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003645 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003646 argcount = funcexe->fe_argv_func(argcount, argvars,
3647 argv_clear, fp->uf_args.ga_len);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003648
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003649 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003650 {
3651 // Method call: base->Method()
3652 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003653 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003654 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003655 argvars = argv;
3656 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003657 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003658
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003659 error = call_user_func_check(fp, argcount, argvars, rettv,
3660 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003661 }
3662 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003663 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003664 {
3665 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003666 * expr->method(): Find the method name in the table, call its
3667 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003668 */
3669 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003670 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003671 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003672 else
3673 {
3674 /*
3675 * Find the function name in the table, call its implementation.
3676 */
3677 error = call_internal_func(fname, argcount, argvars, rettv);
3678 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003679
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003680 /*
3681 * The function call (or "FuncUndefined" autocommand sequence) might
3682 * have been aborted by an error, an interrupt, or an explicitly thrown
3683 * exception that has not been caught so far. This situation can be
3684 * tested for by calling aborting(). For an error in an internal
3685 * function or for the "E132" error in call_user_func(), however, the
3686 * throw point at which the "force_abort" flag (temporarily reset by
3687 * emsg()) is normally updated has not been reached yet. We need to
3688 * update that flag first to make aborting() reliable.
3689 */
3690 update_force_abort();
3691 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003692 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003693 ret = OK;
3694
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003695theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003696 /*
3697 * Report an error unless the argument evaluation or function call has been
3698 * cancelled due to an aborting error, an interrupt, or an exception.
3699 */
3700 if (!aborting())
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003701 user_func_error(error, (name != NULL) ? name : funcname, funcexe);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003702
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003703 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003704 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003705 clear_tv(&argv[--argv_clear + argv_base]);
3706
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707 vim_free(tofree);
3708 vim_free(name);
3709
3710 return ret;
3711}
3712
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003713 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003714printable_func_name(ufunc_T *fp)
3715{
3716 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3717}
3718
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003719/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003720 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003721 */
3722 static void
3723list_func_head(ufunc_T *fp, int indent)
3724{
3725 int j;
3726
3727 msg_start();
3728 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003729 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003730 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003731 msg_puts("def ");
3732 else
3733 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003734 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003735 msg_putchar('(');
3736 for (j = 0; j < fp->uf_args.ga_len; ++j)
3737 {
3738 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003739 msg_puts(", ");
3740 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003741 if (fp->uf_arg_types != NULL)
3742 {
3743 char *tofree;
3744
3745 msg_puts(": ");
3746 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3747 vim_free(tofree);
3748 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003749 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3750 {
3751 msg_puts(" = ");
3752 msg_puts(((char **)(fp->uf_def_args.ga_data))
3753 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3754 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003755 }
3756 if (fp->uf_varargs)
3757 {
3758 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003759 msg_puts(", ");
3760 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003761 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003762 if (fp->uf_va_name != NULL)
3763 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003764 if (!fp->uf_varargs)
3765 {
3766 if (j)
3767 msg_puts(", ");
3768 msg_puts("...");
3769 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003770 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003771 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003772 {
3773 char *tofree;
3774
3775 msg_puts(": ");
3776 msg_puts(type_name(fp->uf_va_type, &tofree));
3777 vim_free(tofree);
3778 }
3779 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003780 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003781
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003782 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003783 {
3784 if (fp->uf_ret_type != &t_void)
3785 {
3786 char *tofree;
3787
3788 msg_puts(": ");
3789 msg_puts(type_name(fp->uf_ret_type, &tofree));
3790 vim_free(tofree);
3791 }
3792 }
3793 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003794 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003796 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003797 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003798 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003799 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003800 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003801 msg_clr_eos();
3802 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003803 last_set_msg(fp->uf_script_ctx);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003804}
3805
3806/*
3807 * Get a function name, translating "<SID>" and "<SNR>".
3808 * Also handles a Funcref in a List or Dictionary.
3809 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003810 * Set "*is_global" to TRUE when the function must be global, unless
3811 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 * flags:
3813 * TFN_INT: internal function name OK
3814 * TFN_QUIET: be quiet
3815 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003816 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 * Advances "pp" to just after the function name (if no error).
3818 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003819 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003820trans_function_name(
3821 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003822 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003823 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003824 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003825 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003826 partial_T **partial, // return: partial of a FuncRef
3827 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003828{
3829 char_u *name = NULL;
3830 char_u *start;
3831 char_u *end;
3832 int lead;
3833 char_u sid_buf[20];
3834 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003835 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003836 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003837 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003838 int vim9script = in_vim9script();
3839 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003840
3841 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003842 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003843 start = *pp;
3844
Bram Moolenaare38eab22019-12-05 21:50:01 +01003845 // Check for hard coded <SNR>: already translated function ID (from a user
3846 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003847 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3848 && (*pp)[2] == (int)KE_SNR)
3849 {
3850 *pp += 3;
3851 len = get_id_len(pp) + 3;
3852 return vim_strnsave(start, len);
3853 }
3854
Bram Moolenaare38eab22019-12-05 21:50:01 +01003855 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3856 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003857 lead = eval_fname_script(start);
3858 if (lead > 2)
3859 start += lead;
3860
Bram Moolenaare38eab22019-12-05 21:50:01 +01003861 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003862 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003863 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003864 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003865 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003866 {
3867 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003868 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003869 goto theend;
3870 }
3871 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3872 {
3873 /*
3874 * Report an invalid expression in braces, unless the expression
3875 * evaluation has been cancelled due to an aborting error, an
3876 * interrupt, or an exception.
3877 */
3878 if (!aborting())
3879 {
3880 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003881 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003882 }
3883 else
3884 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3885 goto theend;
3886 }
3887
3888 if (lv.ll_tv != NULL)
3889 {
3890 if (fdp != NULL)
3891 {
3892 fdp->fd_dict = lv.ll_dict;
3893 fdp->fd_newkey = lv.ll_newkey;
3894 lv.ll_newkey = NULL;
3895 fdp->fd_di = lv.ll_di;
3896 }
3897 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3898 {
3899 name = vim_strsave(lv.ll_tv->vval.v_string);
3900 *pp = end;
3901 }
3902 else if (lv.ll_tv->v_type == VAR_PARTIAL
3903 && lv.ll_tv->vval.v_partial != NULL)
3904 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003905 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003906 *pp = end;
3907 if (partial != NULL)
3908 *partial = lv.ll_tv->vval.v_partial;
3909 }
3910 else
3911 {
3912 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
3913 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00003914 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003915 else
3916 *pp = end;
3917 name = NULL;
3918 }
3919 goto theend;
3920 }
3921
3922 if (lv.ll_name == NULL)
3923 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003924 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003925 *pp = end;
3926 goto theend;
3927 }
3928
Bram Moolenaare38eab22019-12-05 21:50:01 +01003929 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003930 if (lv.ll_exp_name != NULL)
3931 {
3932 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003933 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003934 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003935 if (name == lv.ll_exp_name)
3936 name = NULL;
3937 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003938 else if (lv.ll_sid > 0)
3939 {
3940 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
3941 int cc = *lv.ll_name_end;
3942
3943 // function in another script. Prefix <SNR>99_ or the autoload prefix.
3944 *lv.ll_name_end = NUL;
3945 if (si->sn_autoload_prefix != NULL)
3946 {
3947 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
3948 }
3949 else
3950 {
3951 sid_buf[0] = K_SPECIAL;
3952 sid_buf[1] = KS_EXTRA;
3953 sid_buf[2] = (int)KE_SNR;
3954 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00003955 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00003956 name = concat_str(sid_buf, lv.ll_name);
3957 }
3958 *lv.ll_name_end = cc;
3959 *pp = end;
3960 goto theend;
3961 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003962 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003963 {
3964 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003965 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00003966 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003967 if (name == *pp)
3968 name = NULL;
3969 }
3970 if (name != NULL)
3971 {
3972 name = vim_strsave(name);
3973 *pp = end;
3974 if (STRNCMP(name, "<SNR>", 5) == 0)
3975 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003976 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003977 name[0] = K_SPECIAL;
3978 name[1] = KS_EXTRA;
3979 name[2] = (int)KE_SNR;
3980 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
3981 }
3982 goto theend;
3983 }
3984
3985 if (lv.ll_exp_name != NULL)
3986 {
3987 len = (int)STRLEN(lv.ll_exp_name);
3988 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
3989 && STRNCMP(lv.ll_name, "s:", 2) == 0)
3990 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003991 // When there was "s:" already or the name expanded to get a
3992 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003993 lv.ll_name += 2;
3994 len -= 2;
3995 lead = 2;
3996 }
3997 }
3998 else
3999 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004000 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004001 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004002 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004003 if (lv.ll_name[0] == 'g')
4004 {
4005 if (is_global != NULL)
4006 {
4007 *is_global = TRUE;
4008 }
4009 else
4010 {
4011 // dropping "g:" without setting "is_global" won't work in
4012 // Vim9script, put it back later
4013 prefix_g = TRUE;
4014 extra = 2;
4015 }
4016 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004017 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004018 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004019 len = (int)(end - lv.ll_name);
4020 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004021 if (len <= 0)
4022 {
4023 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004024 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004025 goto theend;
4026 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004027
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004028 // In Vim9 script a user function is script-local by default, unless it
4029 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00004030 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004031
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004032 /*
4033 * Copy the function name to allocated memory.
4034 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4035 * Accept <SNR>123_name() outside a script.
4036 */
4037 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004038 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004039 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004040 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004041 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004042 {
Kota Kato948a3892022-08-16 16:09:59 +01004043 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4044 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004045 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004046 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004047 goto theend;
4048 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004049 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004050 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004051 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004052 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004053 || eval_fname_sid(*pp))
4054 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004055 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004056 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004057 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004058 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004059 goto theend;
4060 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004061 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004062 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004063 extra = 3 + (int)STRLEN(sid_buf);
4064 else
4065 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066 }
4067 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004068 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004069 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004070 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004071 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004072 : e_function_name_must_start_with_capital_or_s_str),
4073 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004074 goto theend;
4075 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004076 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004077 {
4078 char_u *cp = vim_strchr(lv.ll_name, ':');
4079
4080 if (cp != NULL && cp < end)
4081 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004082 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004083 goto theend;
4084 }
4085 }
4086
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004087 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004088 if (name != NULL)
4089 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004090 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004091 {
4092 name[0] = K_SPECIAL;
4093 name[1] = KS_EXTRA;
4094 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004095 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004096 STRCPY(name + 3, sid_buf);
4097 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004098 else if (prefix_g)
4099 {
4100 name[0] = 'g';
4101 name[1] = ':';
4102 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004103 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4104 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004105 }
4106 *pp = end;
4107
4108theend:
4109 clear_lval(&lv);
4110 return name;
4111}
4112
4113/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004114 * Assuming "name" is the result of trans_function_name() and it was prefixed
4115 * to use the script-local name, return the unmodified name (points into
4116 * "name"). Otherwise return NULL.
4117 * This can be used to first search for a script-local function and fall back
4118 * to the global function if not found.
4119 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004120 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004121untrans_function_name(char_u *name)
4122{
4123 char_u *p;
4124
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004125 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004126 {
4127 p = vim_strchr(name, '_');
4128 if (p != NULL)
4129 return p + 1;
4130 }
4131 return NULL;
4132}
4133
4134/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004135 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4136 * current script ID and returns the expanded function name. The caller should
4137 * free the returned name. If not called from a script context or the function
4138 * name doesn't start with these prefixes, then returns NULL.
4139 * This doesn't check whether the script-local function exists or not.
4140 */
4141 char_u *
4142get_scriptlocal_funcname(char_u *funcname)
4143{
4144 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004145 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004146 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004147 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004148
4149 if (funcname == NULL)
4150 return NULL;
4151
4152 if (STRNCMP(funcname, "s:", 2) != 0
4153 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004154 {
4155 ufunc_T *ufunc;
4156
4157 // The function name does not have a script-local prefix. Try finding
4158 // it when in a Vim9 script and there is no "g:" prefix.
4159 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4160 return NULL;
4161 ufunc = find_func(funcname, FALSE);
4162 if (ufunc == NULL || func_is_global(ufunc)
4163 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4164 return NULL;
4165 ++p;
4166 off = 0;
4167 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004168 else
4169 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004170
4171 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4172 {
4173 emsg(_(e_using_sid_not_in_script_context));
4174 return NULL;
4175 }
4176 // Expand s: prefix into <SNR>nr_<name>
4177 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4178 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004179 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004180 if (newname == NULL)
4181 return NULL;
4182 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004183 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004184
4185 return newname;
4186}
4187
4188/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004189 * Return script-local "fname" with the 3-byte sequence replaced by
4190 * printable <SNR> in allocated memory.
4191 */
4192 char_u *
4193alloc_printable_func_name(char_u *fname)
4194{
4195 char_u *n = alloc(STRLEN(fname + 3) + 6);
4196
4197 if (n != NULL)
4198 {
4199 STRCPY(n, "<SNR>");
4200 STRCPY(n + 5, fname + 3);
4201 }
4202 return n;
4203}
4204
4205/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004206 * Call trans_function_name(), except that a lambda is returned as-is.
4207 * Returns the name in allocated memory.
4208 */
4209 char_u *
4210save_function_name(
4211 char_u **name,
4212 int *is_global,
4213 int skip,
4214 int flags,
4215 funcdict_T *fudi)
4216{
4217 char_u *p = *name;
4218 char_u *saved;
4219
4220 if (STRNCMP(p, "<lambda>", 8) == 0)
4221 {
4222 p += 8;
4223 (void)getdigits(&p);
4224 saved = vim_strnsave(*name, p - *name);
4225 if (fudi != NULL)
4226 CLEAR_POINTER(fudi);
4227 }
4228 else
4229 saved = trans_function_name(&p, is_global, skip,
4230 flags, fudi, NULL, NULL);
4231 *name = p;
4232 return saved;
4233}
4234
4235/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004236 * List functions. When "regmatch" is NULL all of then.
4237 * Otherwise functions matching "regmatch".
4238 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004239 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004240list_functions(regmatch_T *regmatch)
4241{
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004242 int changed = func_hashtab.ht_changed;
4243 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004244 hashitem_T *hi;
4245
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004246 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004247 {
4248 if (!HASHITEM_EMPTY(hi))
4249 {
4250 ufunc_T *fp = HI2UF(hi);
4251
4252 --todo;
4253 if ((fp->uf_flags & FC_DEAD) == 0
4254 && (regmatch == NULL
4255 ? !message_filtered(fp->uf_name)
4256 && !func_name_refcount(fp->uf_name)
4257 : !isdigit(*fp->uf_name)
4258 && vim_regexec(regmatch, fp->uf_name, 0)))
4259 {
4260 list_func_head(fp, FALSE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004261 if (changed != func_hashtab.ht_changed)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004262 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00004263 emsg(_(e_function_list_was_modified));
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004264 return;
4265 }
4266 }
4267 }
4268 }
4269}
4270
4271/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004272 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004273 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4274 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004275 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004276 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004277 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004278 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004279define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004280{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004281 int j;
4282 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004283 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004284 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004285 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004286 char_u *p;
4287 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004288 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004289 char_u *line_arg = NULL;
4290 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004291 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004292 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004293 garray_T newlines;
4294 int varargs = FALSE;
4295 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004296 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004297 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004298 int fp_allocated = FALSE;
4299 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004300 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004301 dictitem_T *v;
4302 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004303 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004304 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004305 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004306 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004307 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004308 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004309
4310 /*
4311 * ":function" without argument: list functions.
4312 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004313 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004314 {
4315 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004316 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004317 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004318 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004319 }
4320
4321 /*
4322 * ":function /pat": list functions matching pattern.
4323 */
4324 if (*eap->arg == '/')
4325 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004326 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004327 if (!eap->skip)
4328 {
4329 regmatch_T regmatch;
4330
4331 c = *p;
4332 *p = NUL;
4333 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4334 *p = c;
4335 if (regmatch.regprog != NULL)
4336 {
4337 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004338 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004339 vim_regfree(regmatch.regprog);
4340 }
4341 }
4342 if (*p == '/')
4343 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004344 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004345 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004346 }
4347
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004348 ga_init(&newargs);
4349 ga_init(&argtypes);
4350 ga_init(&default_args);
4351
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004352 /*
4353 * Get the function name. There are these situations:
4354 * func normal function name
4355 * "name" == func, "fudi.fd_dict" == NULL
4356 * dict.func new dictionary entry
4357 * "name" == NULL, "fudi.fd_dict" set,
4358 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4359 * dict.func existing dict entry with a Funcref
4360 * "name" == func, "fudi.fd_dict" set,
4361 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4362 * dict.func existing dict entry that's not a Funcref
4363 * "name" == NULL, "fudi.fd_dict" set,
4364 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4365 * s:func script-local function name
4366 * g:func global function name, same as "func"
4367 */
4368 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004369 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004370 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004371 // nested function, argument is (args).
4372 paren = TRUE;
4373 CLEAR_FIELD(fudi);
4374 }
4375 else
4376 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004377 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004378 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004379 if (p[0] == 's' && p[1] == ':')
4380 {
4381 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4382 return NULL;
4383 }
4384 p = to_name_end(p, TRUE);
4385 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4386 {
4387 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4388 eap->arg);
4389 return NULL;
4390 }
4391 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004392 }
4393
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004394 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004395 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004396 paren = (vim_strchr(p, '(') != NULL);
4397 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004399 /*
4400 * Return on an invalid expression in braces, unless the expression
4401 * evaluation has been cancelled due to an aborting error, an
4402 * interrupt, or an exception.
4403 */
4404 if (!aborting())
4405 {
4406 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004407 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004408 vim_free(fudi.fd_newkey);
4409 return NULL;
4410 }
4411 else
4412 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004413 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004414
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004415 // For "export def FuncName()" in an autoload script the function name
4416 // is stored with the legacy autoload name "dir#script#FuncName" so
4417 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004418 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004419 {
4420 char_u *prefixed = may_prefix_autoload(name);
4421
4422 if (prefixed != NULL && prefixed != name)
4423 {
4424 vim_free(name);
4425 name = prefixed;
4426 }
4427 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004428 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004429 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004430 {
4431 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4432 goto ret_free;
4433 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004434 }
4435
Bram Moolenaare38eab22019-12-05 21:50:01 +01004436 // An error in a function call during evaluation of an expression in magic
4437 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004438 saved_did_emsg = did_emsg;
4439 did_emsg = FALSE;
4440
4441 /*
4442 * ":function func" with only function name: list function.
4443 */
4444 if (!paren)
4445 {
4446 if (!ends_excmd(*skipwhite(p)))
4447 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004448 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449 goto ret_free;
4450 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004451 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004452 if (eap->nextcmd != NULL)
4453 *p = NUL;
4454 if (!eap->skip && !got_int)
4455 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004456 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004457 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4458 {
4459 char_u *up = untrans_function_name(name);
4460
4461 // With Vim9 script the name was made script-local, if not
4462 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004463 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004464 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004465 }
4466
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467 if (fp != NULL)
4468 {
4469 list_func_head(fp, TRUE);
4470 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4471 {
4472 if (FUNCLINE(fp, j) == NULL)
4473 continue;
4474 msg_putchar('\n');
4475 msg_outnum((long)(j + 1));
4476 if (j < 9)
4477 msg_putchar(' ');
4478 if (j < 99)
4479 msg_putchar(' ');
4480 msg_prt_line(FUNCLINE(fp, j), FALSE);
Bram Moolenaare38eab22019-12-05 21:50:01 +01004481 out_flush(); // show a line at a time
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004482 ui_breakcheck();
4483 }
4484 if (!got_int)
4485 {
4486 msg_putchar('\n');
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004487 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004488 msg_puts(" enddef");
4489 else
4490 msg_puts(" endfunction");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004491 }
4492 }
4493 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004494 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495 }
4496 goto ret_free;
4497 }
4498
4499 /*
4500 * ":function name(arg1, arg2)" Define function.
4501 */
4502 p = skipwhite(p);
4503 if (*p != '(')
4504 {
4505 if (!eap->skip)
4506 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004507 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004508 goto ret_free;
4509 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004510 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004511 if (vim_strchr(p, '(') != NULL)
4512 p = vim_strchr(p, '(');
4513 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004514
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004515 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4516 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004517 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004518 goto ret_free;
4519 }
4520
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004521 // In Vim9 script only global functions can be redefined.
4522 if (vim9script && eap->forceit && !is_global)
4523 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004524 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004525 goto ret_free;
4526 }
4527
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004528 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004529
Bram Moolenaar04b12692020-05-04 23:24:44 +02004530 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004531 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004532 // Check the name of the function. Unless it's a dictionary function
4533 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004534 if (name != NULL)
4535 arg = name;
4536 else
4537 arg = fudi.fd_newkey;
4538 if (arg != NULL && (fudi.fd_di == NULL
4539 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4540 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4541 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004542 char_u *name_base = arg;
4543 int i;
4544
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004545 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004546 {
4547 name_base = vim_strchr(arg, '_');
4548 if (name_base == NULL)
4549 name_base = arg + 3;
4550 else
4551 ++name_base;
4552 }
4553 for (i = 0; name_base[i] != NUL && (i == 0
4554 ? eval_isnamec1(name_base[i])
4555 : eval_isnamec(name_base[i])); ++i)
4556 ;
4557 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004558 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004559
4560 // In Vim9 script a function cannot have the same name as a
4561 // variable.
4562 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004563 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4564 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004565 + EVAL_VAR_NO_FUNC) == OK)
4566 {
4567 semsg(_(e_redefining_script_item_str), name_base);
4568 goto ret_free;
4569 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004570 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004571 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004572 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004573 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004574 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004575 goto ret_free;
4576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004577 }
4578
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004579 // This may get more lines and make the pointers into the first line
4580 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004581 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004582 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004583 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004584 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004585 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004586 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004587 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004588
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004589 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004590 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004591 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004592 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004593 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004594 if (*p != ':')
4595 {
4596 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4597 p = skipwhite(p);
4598 }
4599 else if (!IS_WHITE_OR_NUL(p[1]))
4600 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004601 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004602 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004603 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004604 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004605 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004606 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004607 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004608 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004609 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004610 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004611 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004612 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004613 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004614 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004615 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004617 else
4618 // find extra arguments "range", "dict", "abort" and "closure"
4619 for (;;)
4620 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004621 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004622 p = skipwhite(p);
4623 if (STRNCMP(p, "range", 5) == 0)
4624 {
4625 flags |= FC_RANGE;
4626 p += 5;
4627 }
4628 else if (STRNCMP(p, "dict", 4) == 0)
4629 {
4630 flags |= FC_DICT;
4631 p += 4;
4632 }
4633 else if (STRNCMP(p, "abort", 5) == 0)
4634 {
4635 flags |= FC_ABORT;
4636 p += 5;
4637 }
4638 else if (STRNCMP(p, "closure", 7) == 0)
4639 {
4640 flags |= FC_CLOSURE;
4641 p += 7;
4642 if (current_funccal == NULL)
4643 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004644 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004645 name == NULL ? (char_u *)"" : name);
4646 goto erret;
4647 }
4648 }
4649 else
4650 break;
4651 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004652
Bram Moolenaare38eab22019-12-05 21:50:01 +01004653 // When there is a line break use what follows for the function body.
4654 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004655 if (*p == '\n')
4656 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004657 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004658 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4659 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004660 && !(VIM_ISWHITE(*whitep) && *p == '#'
4661 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004662 && !eap->skip
4663 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004664 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004665
4666 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004667 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4668 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004669 */
4670 if (KeyTyped)
4671 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004672 // Check if the function already exists, don't let the user type the
4673 // whole function before telling him it doesn't work! For a script we
4674 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004675 if (!eap->skip && !eap->forceit)
4676 {
4677 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004678 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004679 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004680 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004681 }
4682
4683 if (!eap->skip && did_emsg)
4684 goto erret;
4685
Bram Moolenaare38eab22019-12-05 21:50:01 +01004686 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004687 cmdline_row = msg_row;
4688 }
4689
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004690 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004691 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004692
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004693 // Do not define the function when getting the body fails and when
4694 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004695 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004696 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004697 goto erret;
4698
4699 /*
4700 * If there are no errors, add the function
4701 */
4702 if (fudi.fd_dict == NULL)
4703 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004704 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004705 char_u *find_name = name;
4706 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004707 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004708
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004709 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004710 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004711 var_conflict = TRUE;
4712
4713 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4714 {
4715 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4716
4717 if (si->sn_autoload_prefix != NULL)
4718 {
4719 if (is_export)
4720 {
4721 find_name = name + STRLEN(si->sn_autoload_prefix);
4722 v = find_var(find_name, &ht, TRUE);
4723 if (v != NULL)
4724 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004725 // Only check if the function already exists in the script,
4726 // global functions can be shadowed.
4727 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004728 }
4729 else
4730 {
4731 char_u *prefixed = may_prefix_autoload(name);
4732
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004733 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004734 {
4735 v = find_var(prefixed, &ht, TRUE);
4736 if (v != NULL)
4737 var_conflict = TRUE;
4738 vim_free(prefixed);
4739 }
4740 }
4741 }
4742 }
4743 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004744 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004745 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004746 goto erret;
4747 }
4748
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004749 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004750 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004751 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004752 char_u *uname = untrans_function_name(name);
4753
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004754 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004755 }
4756
4757 if (fp != NULL || import != NULL)
4758 {
4759 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004760
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004761 // Function can be replaced with "function!" and when sourcing the
4762 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004763 // A name that is used by an import can not be overruled.
4764 if (import != NULL
4765 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004766 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004767 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004768 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004769 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004770 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004771 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004772 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004773 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004774 goto erret;
4775 }
4776 if (fp->uf_calls > 0)
4777 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004778 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004779 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004780 goto erret;
4781 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004782 if (fp->uf_refcount > 1)
4783 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004784 // This function is referenced somewhere, don't redefine it but
4785 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004786 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004787 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004788 fp = NULL;
4789 overwrite = TRUE;
4790 }
4791 else
4792 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004793 char_u *exp_name = fp->uf_name_exp;
4794
4795 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004796 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004797 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004798 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004799 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004800 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004801#ifdef FEAT_PROFILE
4802 fp->uf_profiling = FALSE;
4803 fp->uf_prof_initialized = FALSE;
4804#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004805 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004806 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004807 }
4808 }
4809 else
4810 {
4811 char numbuf[20];
4812
4813 fp = NULL;
4814 if (fudi.fd_newkey == NULL && !eap->forceit)
4815 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004816 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004817 goto erret;
4818 }
4819 if (fudi.fd_di == NULL)
4820 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004821 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004822 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004823 goto erret;
4824 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004825 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004826 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004827 goto erret;
4828
Bram Moolenaare38eab22019-12-05 21:50:01 +01004829 // Give the function a sequential number. Can only be used with a
4830 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004831 vim_free(name);
4832 sprintf(numbuf, "%d", ++func_nr);
4833 name = vim_strsave((char_u *)numbuf);
4834 if (name == NULL)
4835 goto erret;
4836 }
4837
4838 if (fp == NULL)
4839 {
4840 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4841 {
4842 int slen, plen;
4843 char_u *scriptname;
4844
Bram Moolenaare38eab22019-12-05 21:50:01 +01004845 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004846 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004847 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004848 {
4849 scriptname = autoload_name(name);
4850 if (scriptname != NULL)
4851 {
4852 p = vim_strchr(scriptname, '/');
4853 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004854 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004855 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004856 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004857 j = OK;
4858 vim_free(scriptname);
4859 }
4860 }
4861 if (j == FAIL)
4862 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004863 linenr_T save_lnum = SOURCING_LNUM;
4864
4865 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004866 semsg(_(e_function_name_does_not_match_script_file_name_str),
4867 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004868 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004869 goto erret;
4870 }
4871 }
4872
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004873 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004874 if (fp == NULL)
4875 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004876 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004877
4878 if (fudi.fd_dict != NULL)
4879 {
4880 if (fudi.fd_di == NULL)
4881 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004882 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004883 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4884 if (fudi.fd_di == NULL)
4885 {
4886 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004887 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888 goto erret;
4889 }
4890 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4891 {
4892 vim_free(fudi.fd_di);
4893 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004894 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004895 goto erret;
4896 }
4897 }
4898 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01004899 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004900 clear_tv(&fudi.fd_di->di_tv);
4901 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004902 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004903
Bram Moolenaare38eab22019-12-05 21:50:01 +01004904 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004905 flags |= FC_DICT;
4906 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004907 }
4908 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004909 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004910 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02004911 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004912
4913 if (eap->cmdidx == CMD_def)
4914 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02004915 int lnum_save = SOURCING_LNUM;
4916 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004917
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004918 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02004919
Bram Moolenaarbfe12042020-02-04 21:54:07 +01004920 // error messages are for the first function line
4921 SOURCING_LNUM = sourcing_lnum_top;
4922
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02004923 // The function may use script variables from the context.
4924 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02004925
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004926 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004927 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004928 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004929 free_fp = fp_allocated;
4930 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004931 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004932 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004933
4934 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004935 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004936 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004937 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004938 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01004939 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004940 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02004941 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004942 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02004943 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02004944 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004945
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004946 if (fp_allocated)
4947 {
4948 // insert the new function in the function list
4949 set_ufunc_name(fp, name);
4950 if (overwrite)
4951 {
4952 hi = hash_find(&func_hashtab, name);
4953 hi->hi_key = UF2HIKEY(fp);
4954 }
4955 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
4956 {
4957 free_fp = TRUE;
4958 goto erret;
4959 }
4960 fp->uf_refcount = 1;
4961 }
4962
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004963 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004964 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004965 if ((flags & FC_CLOSURE) != 0)
4966 {
Bram Moolenaar58016442016-07-31 18:30:22 +02004967 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004968 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02004969 }
4970 else
4971 fp->uf_scoped = NULL;
4972
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004973#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004974 if (prof_def_func())
4975 func_do_profile(fp);
4976#endif
4977 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02004978 if (sandbox)
4979 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004980 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004981 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982 fp->uf_flags = flags;
4983 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01004984 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004985 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02004986 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004987 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004988 if (is_export)
4989 {
4990 fp->uf_flags |= FC_EXPORT;
4991 // let ex_export() know the export worked.
4992 is_export = FALSE;
4993 }
4994
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02004995 if (eap->cmdidx == CMD_def)
4996 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02004997 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
4998 // :func does not use Vim9 script syntax, even in a Vim9 script file
4999 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005000
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005001 goto ret_free;
5002
5003erret:
5004 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005005 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005006 if (fp != NULL)
5007 {
5008 ga_init(&fp->uf_args);
5009 ga_init(&fp->uf_def_args);
5010 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011errret_2:
5012 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005013 if (fp != NULL)
5014 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005015 if (free_fp)
5016 {
5017 vim_free(fp);
5018 fp = NULL;
5019 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005020ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005021 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005022 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005023 if (name != name_arg)
5024 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005025 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005026 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005027
5028 return fp;
5029}
5030
5031/*
5032 * ":function"
5033 */
5034 void
5035ex_function(exarg_T *eap)
5036{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005037 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005038
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005039 ga_init2(&lines_to_free, sizeof(char_u *), 50);
5040 (void)define_function(eap, NULL, &lines_to_free);
5041 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005042}
5043
5044/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005045 * Find a function by name, including "<lambda>123".
5046 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005047 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005048 * Return NULL if not found.
5049 */
5050 ufunc_T *
5051find_func_by_name(char_u *name, compiletype_T *compile_type)
5052{
5053 char_u *arg = name;
5054 char_u *fname;
5055 ufunc_T *ufunc;
5056 int is_global = FALSE;
5057
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005058 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5059 {
5060 *compile_type = CT_PROFILE;
5061 arg = skipwhite(arg + 7);
5062 }
5063 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5064 {
5065 *compile_type = CT_DEBUG;
5066 arg = skipwhite(arg + 5);
5067 }
5068
5069 if (STRNCMP(arg, "<lambda>", 8) == 0)
5070 {
5071 arg += 8;
5072 (void)getdigits(&arg);
5073 fname = vim_strnsave(name, arg - name);
5074 }
5075 else
5076 fname = trans_function_name(&arg, &is_global, FALSE,
5077 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5078 if (fname == NULL)
5079 {
5080 semsg(_(e_invalid_argument_str), name);
5081 return NULL;
5082 }
5083 if (!ends_excmd2(name, arg))
5084 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005085 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005086 emsg(ex_errmsg(e_trailing_characters_str, arg));
5087 return NULL;
5088 }
5089
5090 ufunc = find_func(fname, is_global);
5091 if (ufunc == NULL)
5092 {
5093 char_u *p = untrans_function_name(fname);
5094
5095 if (p != NULL)
5096 // Try again without making it script-local.
5097 ufunc = find_func(p, FALSE);
5098 }
5099 vim_free(fname);
5100 if (ufunc == NULL)
5101 semsg(_(e_cannot_find_function_str), name);
5102 return ufunc;
5103}
5104
5105/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005106 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005107 * be compiled or the one specified by the argument.
5108 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005109 */
5110 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005111ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005112{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005113 ufunc_T *ufunc;
5114
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005115 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005116 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005117 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005118
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005119 ufunc = find_func_by_name(eap->arg, &compile_type);
5120 if (ufunc != NULL)
5121 {
5122 if (func_needs_compiling(ufunc, compile_type))
5123 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5124 else
5125 smsg(_("Function %s does not need compiling"), eap->arg);
5126 }
5127 }
5128 else
5129 {
5130 long todo = (long)func_hashtab.ht_used;
5131 int changed = func_hashtab.ht_changed;
5132 hashitem_T *hi;
5133
5134 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5135 {
5136 if (!HASHITEM_EMPTY(hi))
5137 {
5138 --todo;
5139 ufunc = HI2UF(hi);
5140 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5141 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5142 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005143 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005144 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5145
5146 if (func_hashtab.ht_changed != changed)
5147 {
5148 // a function has been added or removed, need to start
5149 // over
5150 todo = (long)func_hashtab.ht_used;
5151 changed = func_hashtab.ht_changed;
5152 hi = func_hashtab.ht_array;
5153 --hi;
5154 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005155 }
5156 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005157 }
5158 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005159}
5160
5161/*
5162 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5163 * Return 2 if "p" starts with "s:".
5164 * Return 0 otherwise.
5165 */
5166 int
5167eval_fname_script(char_u *p)
5168{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005169 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5170 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005171 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5172 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5173 return 5;
5174 if (p[0] == 's' && p[1] == ':')
5175 return 2;
5176 return 0;
5177}
5178
5179 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005180translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005181{
5182 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005183 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005184 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005185}
5186
5187/*
5188 * Return TRUE when "ufunc" has old-style "..." varargs
5189 * or named varargs "...name: type".
5190 */
5191 int
5192has_varargs(ufunc_T *ufunc)
5193{
5194 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005195}
5196
5197/*
5198 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005199 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005200 */
5201 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005202function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005203{
5204 char_u *nm = name;
5205 char_u *p;
5206 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005207 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005208 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005209
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005210 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5211 if (no_deref)
5212 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005213 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005214 nm = skipwhite(nm);
5215
Bram Moolenaare38eab22019-12-05 21:50:01 +01005216 // Only accept "funcname", "funcname ", "funcname (..." and
5217 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005218 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005219 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005220 vim_free(p);
5221 return n;
5222}
5223
Bram Moolenaar113e1072019-01-20 15:30:40 +01005224#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005225 char_u *
5226get_expanded_name(char_u *name, int check)
5227{
5228 char_u *nm = name;
5229 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005230 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005231
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005232 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005233 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005234
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005235 if (p != NULL && *nm == NUL
5236 && (!check || translated_function_exists(p, is_global)))
5237 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005238
5239 vim_free(p);
5240 return NULL;
5241}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005242#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005243
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005244/*
5245 * Function given to ExpandGeneric() to obtain the list of user defined
5246 * function names.
5247 */
5248 char_u *
5249get_user_func_name(expand_T *xp, int idx)
5250{
5251 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005252 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005253 static hashitem_T *hi;
5254 ufunc_T *fp;
5255
5256 if (idx == 0)
5257 {
5258 done = 0;
5259 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005260 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005261 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005262 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005263 {
5264 if (done++ > 0)
5265 ++hi;
5266 while (HASHITEM_EMPTY(hi))
5267 ++hi;
5268 fp = HI2UF(hi);
5269
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005270 // don't show dead, dict and lambda functions
5271 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005272 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005273 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005274
5275 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005276 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005277
5278 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005279 if (xp->xp_context != EXPAND_USER_FUNC
5280 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005281 {
5282 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005283 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005284 STRCAT(IObuff, ")");
5285 }
5286 return IObuff;
5287 }
5288 return NULL;
5289}
5290
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005291/*
5292 * ":delfunction {name}"
5293 */
5294 void
5295ex_delfunction(exarg_T *eap)
5296{
5297 ufunc_T *fp = NULL;
5298 char_u *p;
5299 char_u *name;
5300 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005301 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005302
5303 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005304 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5305 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005306 vim_free(fudi.fd_newkey);
5307 if (name == NULL)
5308 {
5309 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005310 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005311 return;
5312 }
5313 if (!ends_excmd(*skipwhite(p)))
5314 {
5315 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005316 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005317 return;
5318 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005319 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005320 if (eap->nextcmd != NULL)
5321 *p = NUL;
5322
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005323 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005324 {
5325 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005326 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005327 vim_free(name);
5328 return;
5329 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005330 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005331 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005332 vim_free(name);
5333
5334 if (!eap->skip)
5335 {
5336 if (fp == NULL)
5337 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005338 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005339 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005340 return;
5341 }
5342 if (fp->uf_calls > 0)
5343 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005344 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005345 return;
5346 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005347 if (fp->uf_flags & FC_VIM9)
5348 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005349 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005350 return;
5351 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005352
5353 if (fudi.fd_dict != NULL)
5354 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005355 // Delete the dict item that refers to the function, it will
5356 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005357 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5358 }
5359 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005360 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005361 // A normal function (not a numbered function or lambda) has a
5362 // refcount of 1 for the entry in the hashtable. When deleting
5363 // it and the refcount is more than one, it should be kept.
5364 // A numbered function and lambda should be kept if the refcount is
5365 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005366 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005367 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005368 // Function is still referenced somewhere. Don't free it but
5369 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005370 if (func_remove(fp))
5371 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005372 }
5373 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005374 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005375 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005376 }
5377}
5378
5379/*
5380 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005381 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382 */
5383 void
5384func_unref(char_u *name)
5385{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005386 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005387
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005388 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005389 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005390 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005391 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005392 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005393#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005394 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005395#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005396 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005397 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005398 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005399}
5400
5401/*
5402 * Unreference a Function: decrement the reference count and free it when it
5403 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005404 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005405 */
5406 void
5407func_ptr_unref(ufunc_T *fp)
5408{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005409 if (fp != NULL && (--fp->uf_refcount <= 0
5410 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5411 && fp->uf_partial->pt_refcount <= 1
5412 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005413 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005414 // Only delete it when it's not being used. Otherwise it's done
5415 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005416 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005417 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005418 }
5419}
5420
5421/*
5422 * Count a reference to a Function.
5423 */
5424 void
5425func_ref(char_u *name)
5426{
5427 ufunc_T *fp;
5428
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005429 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005430 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005431 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005432 if (fp != NULL)
5433 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005434 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005435 // Only give an error for a numbered function.
5436 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005437 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005438}
5439
5440/*
5441 * Count a reference to a Function.
5442 */
5443 void
5444func_ptr_ref(ufunc_T *fp)
5445{
5446 if (fp != NULL)
5447 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005448}
5449
5450/*
5451 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5452 * referenced from anywhere that is in use.
5453 */
5454 static int
5455can_free_funccal(funccall_T *fc, int copyID)
5456{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005457 return (fc->fc_l_varlist.lv_copyID != copyID
5458 && fc->fc_l_vars.dv_copyID != copyID
5459 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005460 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005461}
5462
5463/*
5464 * ":return [expr]"
5465 */
5466 void
5467ex_return(exarg_T *eap)
5468{
5469 char_u *arg = eap->arg;
5470 typval_T rettv;
5471 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005472 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005473
5474 if (current_funccal == NULL)
5475 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005476 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005477 return;
5478 }
5479
Bram Moolenaar844fb642021-10-23 13:32:30 +01005480 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005481 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5482
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005483 if (eap->skip)
5484 ++emsg_skip;
5485
5486 eap->nextcmd = NULL;
5487 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005488 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005489 {
5490 if (!eap->skip)
5491 returning = do_return(eap, FALSE, TRUE, &rettv);
5492 else
5493 clear_tv(&rettv);
5494 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005495 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005496 else if (!eap->skip)
5497 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005498 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005499 update_force_abort();
5500
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005501 /*
5502 * Return unless the expression evaluation has been cancelled due to an
5503 * aborting error, an interrupt, or an exception.
5504 */
5505 if (!aborting())
5506 returning = do_return(eap, FALSE, TRUE, NULL);
5507 }
5508
Bram Moolenaare38eab22019-12-05 21:50:01 +01005509 // When skipping or the return gets pending, advance to the next command
5510 // in this line (!returning). Otherwise, ignore the rest of the line.
5511 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005512 if (returning)
5513 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005514 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005515 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005516
5517 if (eap->skip)
5518 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005519 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005520}
5521
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005522 static int
5523ex_call_inner(
5524 exarg_T *eap,
5525 char_u *name,
5526 char_u **arg,
5527 char_u *startarg,
5528 funcexe_T *funcexe_init,
5529 evalarg_T *evalarg)
5530{
5531 linenr_T lnum;
5532 int doesrange;
5533 typval_T rettv;
5534 int failed = FALSE;
5535
5536 /*
5537 * When skipping, evaluate the function once, to find the end of the
5538 * arguments.
5539 * When the function takes a range, this is discovered after the first
5540 * call, and the loop is broken.
5541 */
5542 if (eap->skip)
5543 {
5544 ++emsg_skip;
5545 lnum = eap->line2; // do it once, also with an invalid range
5546 }
5547 else
5548 lnum = eap->line1;
5549 for ( ; lnum <= eap->line2; ++lnum)
5550 {
5551 funcexe_T funcexe;
5552
5553 if (!eap->skip && eap->addr_count > 0)
5554 {
5555 if (lnum > curbuf->b_ml.ml_line_count)
5556 {
5557 // If the function deleted lines or switched to another buffer
5558 // the line number may become invalid.
5559 emsg(_(e_invalid_range));
5560 break;
5561 }
5562 curwin->w_cursor.lnum = lnum;
5563 curwin->w_cursor.col = 0;
5564 curwin->w_cursor.coladd = 0;
5565 }
5566 *arg = startarg;
5567
5568 funcexe = *funcexe_init;
5569 funcexe.fe_doesrange = &doesrange;
5570 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5571 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5572 {
5573 failed = TRUE;
5574 break;
5575 }
5576 if (has_watchexpr())
5577 dbg_check_breakpoint(eap);
5578
5579 // Handle a function returning a Funcref, Dictionary or List.
5580 if (handle_subscript(arg, NULL, &rettv,
5581 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5582 {
5583 failed = TRUE;
5584 break;
5585 }
5586
5587 clear_tv(&rettv);
5588 if (doesrange || eap->skip)
5589 break;
5590
5591 // Stop when immediately aborting on error, or when an interrupt
5592 // occurred or an exception was thrown but not caught.
5593 // get_func_tv() returned OK, so that the check for trailing
5594 // characters below is executed.
5595 if (aborting())
5596 break;
5597 }
5598 if (eap->skip)
5599 --emsg_skip;
5600 return failed;
5601}
5602
5603/*
5604 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5605 * Returns FAIL or OK.
5606 */
5607 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005608ex_defer_inner(
5609 char_u *name,
5610 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005611 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005612 partial_T *partial,
5613 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005614{
5615 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005616 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005617 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005618 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005619
5620 if (current_funccal == NULL)
5621 {
5622 semsg(_(e_str_not_inside_function), "defer");
5623 return FAIL;
5624 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005625 if (partial != NULL)
5626 {
5627 if (partial->pt_dict != NULL)
5628 {
5629 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5630 return FAIL;
5631 }
5632 if (partial->pt_argc > 0)
5633 {
5634 int i;
5635
5636 partial_argc = partial->pt_argc;
5637 for (i = 0; i < partial_argc; ++i)
5638 copy_tv(&partial->pt_argv[i], &argvars[i]);
5639 }
5640 }
5641 r = get_func_arguments(arg, evalarg, FALSE,
5642 argvars + partial_argc, &argcount);
5643 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005644
5645 if (r == OK)
5646 {
5647 if (type != NULL)
5648 {
5649 // Check that the arguments are OK for the types of the funcref.
5650 r = check_argument_types(type, argvars, argcount, NULL, name);
5651 }
5652 else if (builtin_function(name, -1))
5653 {
5654 int idx = find_internal_func(name);
5655
5656 if (idx < 0)
5657 {
5658 emsg_funcname(e_unknown_function_str, name);
5659 r = FAIL;
5660 }
5661 else if (check_internal_func(idx, argcount) == -1)
5662 r = FAIL;
5663 }
5664 else
5665 {
5666 ufunc_T *ufunc = find_func(name, FALSE);
5667
5668 // we tolerate an unknown function here, it might be defined later
5669 if (ufunc != NULL)
5670 {
5671 int error = check_user_func_argcount(ufunc, argcount);
5672
5673 if (error != FCERR_UNKNOWN)
5674 {
5675 user_func_error(error, name, NULL);
5676 r = FAIL;
5677 }
5678 }
5679 }
5680 }
5681
Bram Moolenaar86d87252022-09-05 21:21:25 +01005682 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01005683 {
5684 while (--argcount >= 0)
5685 clear_tv(&argvars[argcount]);
5686 return FAIL;
5687 }
5688 return add_defer(name, argcount, argvars);
5689}
5690
5691/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01005692 * Return TRUE if currently inside a function call.
5693 * Give an error message and return FALSE when not.
5694 */
5695 int
5696can_add_defer(void)
5697{
5698 if (!in_def_function() && get_current_funccal() == NULL)
5699 {
5700 semsg(_(e_str_not_inside_function), "defer");
5701 return FALSE;
5702 }
5703 return TRUE;
5704}
5705
5706/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01005707 * Add a deferred call for "name" with arguments "argvars[argcount]".
5708 * Consumes "argvars[]".
5709 * Caller must check that in_def_function() returns TRUE or current_funccal is
5710 * not NULL.
5711 * Returns OK or FAIL.
5712 */
5713 int
5714add_defer(char_u *name, int argcount_arg, typval_T *argvars)
5715{
5716 char_u *saved_name = vim_strsave(name);
5717 int argcount = argcount_arg;
5718 defer_T *dr;
5719 int ret = FAIL;
5720
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005721 if (saved_name == NULL)
5722 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01005723 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005724 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01005725 if (add_defer_function(saved_name, argcount, argvars) == OK)
5726 argcount = 0;
5727 }
5728 else
5729 {
5730 if (current_funccal->fc_defer.ga_itemsize == 0)
5731 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
5732 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
5733 goto theend;
5734 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
5735 + current_funccal->fc_defer.ga_len++;
5736 dr->dr_name = saved_name;
5737 dr->dr_argcount = argcount;
5738 while (argcount > 0)
5739 {
5740 --argcount;
5741 dr->dr_argvars[argcount] = argvars[argcount];
5742 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005743 }
5744 ret = OK;
5745
5746theend:
5747 while (--argcount >= 0)
5748 clear_tv(&argvars[argcount]);
5749 return ret;
5750}
5751
5752/*
5753 * Invoked after a functions has finished: invoke ":defer" functions.
5754 */
Bram Moolenaar58779852022-09-06 18:31:14 +01005755 static void
5756handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005757{
5758 int idx;
5759
Bram Moolenaar58779852022-09-06 18:31:14 +01005760 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005761 {
5762 funcexe_T funcexe;
5763 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01005764 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005765 int i;
5766
5767 CLEAR_FIELD(funcexe);
5768 funcexe.fe_evaluate = TRUE;
5769
5770 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5771 call_func(dr->dr_name, -1, &rettv,
5772 dr->dr_argcount, dr->dr_argvars, &funcexe);
5773 clear_tv(&rettv);
5774 vim_free(dr->dr_name);
5775 for (i = dr->dr_argcount - 1; i >= 0; --i)
5776 clear_tv(&dr->dr_argvars[i]);
5777 }
Bram Moolenaar58779852022-09-06 18:31:14 +01005778 ga_clear(&funccal->fc_defer);
5779}
5780
5781/*
5782 * Called when exiting: call all defer functions.
5783 */
5784 void
5785invoke_all_defer(void)
5786{
5787 funccall_T *funccal;
5788
Bram Moolenaarca16c602022-09-06 18:57:08 +01005789 for (funccal = current_funccal; funccal != NULL;
5790 funccal = funccal->fc_caller)
Bram Moolenaar58779852022-09-06 18:31:14 +01005791 if (funccal->fc_ectx != NULL)
5792 {
5793 // :def function
5794 unwind_def_callstack(funccal->fc_ectx);
5795 may_invoke_defer_funcs(funccal->fc_ectx);
5796 }
5797 else
5798 {
5799 // legacy function
5800 handle_defer_one(funccal);
5801 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005802}
5803
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005804/*
5805 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005806 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005807 */
5808 void
5809ex_call(exarg_T *eap)
5810{
5811 char_u *arg = eap->arg;
5812 char_u *startarg;
5813 char_u *name;
5814 char_u *tofree;
5815 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005816 int failed = FALSE;
5817 funcdict_T fudi;
5818 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005819 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005820 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005821 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005822 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005823
Bram Moolenaare6b53242020-07-01 17:28:33 +02005824 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005825 if (eap->skip)
5826 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005827 typval_T rettv;
5828
Bram Moolenaare38eab22019-12-05 21:50:01 +01005829 // trans_function_name() doesn't work well when skipping, use eval0()
5830 // instead to skip to any following command, e.g. for:
5831 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005832 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005833 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005834 clear_tv(&rettv);
5835 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005836 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005837 return;
5838 }
5839
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005840 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005841 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005842 if (fudi.fd_newkey != NULL)
5843 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005844 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005845 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005846 vim_free(fudi.fd_newkey);
5847 }
5848 if (tofree == NULL)
5849 return;
5850
Bram Moolenaare38eab22019-12-05 21:50:01 +01005851 // Increase refcount on dictionary, it could get deleted when evaluating
5852 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005853 if (fudi.fd_dict != NULL)
5854 ++fudi.fd_dict->dv_refcount;
5855
Bram Moolenaare38eab22019-12-05 21:50:01 +01005856 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5857 // contents. For VAR_PARTIAL get its partial, unless we already have one
5858 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005859 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005860 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005861 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005862 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005863
Bram Moolenaare38eab22019-12-05 21:50:01 +01005864 // Skip white space to allow ":call func ()". Not good, but required for
5865 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005866 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005867 if (*startarg != '(')
5868 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005869 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005870 goto end;
5871 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005872 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005873 {
5874 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5875 goto end;
5876 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005877
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005878 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005879 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005880 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01005881 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005882 }
5883 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005884 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005885 funcexe_T funcexe;
5886
Bram Moolenaara80faa82020-04-12 19:37:17 +02005887 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005888 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005889 funcexe.fe_partial = partial;
5890 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005891 funcexe.fe_firstline = eap->line1;
5892 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005893 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005894 funcexe.fe_evaluate = !eap->skip;
5895 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005896 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005897
Bram Moolenaar1d341892021-09-18 15:25:52 +02005898 // When inside :try we need to check for following "| catch" or "| endtry".
5899 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005900 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005901 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005902 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02005903 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02005904 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005905 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02005906 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005907 {
5908 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00005909 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01005910 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005911 }
5912 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02005913 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005914 }
Bram Moolenaara929c922022-04-18 15:21:17 +01005915 // Must be after using "arg", it may point into memory cleared here.
5916 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005917
5918end:
5919 dict_unref(fudi.fd_dict);
5920 vim_free(tofree);
5921}
5922
5923/*
5924 * Return from a function. Possibly makes the return pending. Also called
5925 * for a pending return at the ":endtry" or after returning from an extra
5926 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
5927 * when called due to a ":return" command. "rettv" may point to a typval_T
5928 * with the return rettv. Returns TRUE when the return can be carried out,
5929 * FALSE when the return gets pending.
5930 */
5931 int
5932do_return(
5933 exarg_T *eap,
5934 int reanimate,
5935 int is_cmd,
5936 void *rettv)
5937{
5938 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01005939 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005940
5941 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005942 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005943 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005944
5945 /*
5946 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5947 * not in its finally clause (which then is to be executed next) is found.
5948 * In this case, make the ":return" pending for execution at the ":endtry".
5949 * Otherwise, return normally.
5950 */
5951 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5952 if (idx >= 0)
5953 {
5954 cstack->cs_pending[idx] = CSTP_RETURN;
5955
5956 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005957 // A pending return again gets pending. "rettv" points to an
5958 // allocated variable with the rettv of the original ":return"'s
5959 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005960 cstack->cs_rettv[idx] = rettv;
5961 else
5962 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005963 // When undoing a return in order to make it pending, get the stored
5964 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005965 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01005966 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005967
5968 if (rettv != NULL)
5969 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005970 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005971 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
5972 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
5973 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005974 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005975 }
5976 else
5977 cstack->cs_rettv[idx] = NULL;
5978
5979 if (reanimate)
5980 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005981 // The pending return value could be overwritten by a ":return"
5982 // without argument in a finally clause; reset the default
5983 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01005984 current_funccal->fc_rettv->v_type = VAR_NUMBER;
5985 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005986 }
5987 }
5988 report_make_pending(CSTP_RETURN, rettv);
5989 }
5990 else
5991 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01005992 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005993
Bram Moolenaare38eab22019-12-05 21:50:01 +01005994 // If the return is carried out now, store the return value. For
5995 // a return immediately after reanimation, the value is already
5996 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005997 if (!reanimate && rettv != NULL)
5998 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01005999 clear_tv(current_funccal->fc_rettv);
6000 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006001 if (!is_cmd)
6002 vim_free(rettv);
6003 }
6004 }
6005
6006 return idx < 0;
6007}
6008
6009/*
6010 * Free the variable with a pending return value.
6011 */
6012 void
6013discard_pending_return(void *rettv)
6014{
6015 free_tv((typval_T *)rettv);
6016}
6017
6018/*
6019 * Generate a return command for producing the value of "rettv". The result
6020 * is an allocated string. Used by report_pending() for verbose messages.
6021 */
6022 char_u *
6023get_return_cmd(void *rettv)
6024{
6025 char_u *s = NULL;
6026 char_u *tofree = NULL;
6027 char_u numbuf[NUMBUFLEN];
6028
6029 if (rettv != NULL)
6030 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6031 if (s == NULL)
6032 s = (char_u *)"";
6033
6034 STRCPY(IObuff, ":return ");
6035 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6036 if (STRLEN(s) + 8 >= IOSIZE)
6037 STRCPY(IObuff + IOSIZE - 4, "...");
6038 vim_free(tofree);
6039 return vim_strsave(IObuff);
6040}
6041
6042/*
6043 * Get next function line.
6044 * Called by do_cmdline() to get the next line.
6045 * Returns allocated string, or NULL for end of function.
6046 */
6047 char_u *
6048get_func_line(
6049 int c UNUSED,
6050 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006051 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006052 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006053{
6054 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006055 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006056 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006057 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006058
Bram Moolenaare38eab22019-12-05 21:50:01 +01006059 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006060 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006061 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006062 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006063 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006064 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006065 }
6066#ifdef FEAT_PROFILE
6067 if (do_profiling == PROF_YES)
6068 func_line_end(cookie);
6069#endif
6070
6071 gap = &fp->uf_lines;
6072 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006073 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006074 retval = NULL;
6075 else
6076 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006077 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006078 while (fcp->fc_linenr < gap->ga_len
6079 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6080 ++fcp->fc_linenr;
6081 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006082 retval = NULL;
6083 else
6084 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006085 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6086 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006087#ifdef FEAT_PROFILE
6088 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006089 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006090#endif
6091 }
6092 }
6093
Bram Moolenaare38eab22019-12-05 21:50:01 +01006094 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006095 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006096 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006097 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006098 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006099 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006100 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006101 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006102 }
6103
6104 return retval;
6105}
6106
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006107/*
6108 * Return TRUE if the currently active function should be ended, because a
6109 * return was encountered or an error occurred. Used inside a ":while".
6110 */
6111 int
6112func_has_ended(void *cookie)
6113{
6114 funccall_T *fcp = (funccall_T *)cookie;
6115
Bram Moolenaare38eab22019-12-05 21:50:01 +01006116 // Ignore the "abort" flag if the abortion behavior has been changed due to
6117 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006118 return (((fcp->fc_func->uf_flags & FC_ABORT)
6119 && did_emsg && !aborted_in_try())
6120 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006121}
6122
6123/*
6124 * return TRUE if cookie indicates a function which "abort"s on errors.
6125 */
6126 int
6127func_has_abort(
6128 void *cookie)
6129{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006130 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006131}
6132
6133
6134/*
6135 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6136 * Don't do this when "Func" is already a partial that was bound
6137 * explicitly (pt_auto is FALSE).
6138 * Changes "rettv" in-place.
6139 * Returns the updated "selfdict_in".
6140 */
6141 dict_T *
6142make_partial(dict_T *selfdict_in, typval_T *rettv)
6143{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006144 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006145 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006146 char_u fname_buf[FLEN_FIXED + 1];
6147 int error;
6148 dict_T *selfdict = selfdict_in;
6149
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006150 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6151 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006152 fp = rettv->vval.v_partial->pt_func;
6153 else
6154 {
6155 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006156 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006157 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006158 if (fname == NULL)
6159 {
6160 // There is no point binding a dict to a NULL function, just create
6161 // a function reference.
6162 rettv->v_type = VAR_FUNC;
6163 rettv->vval.v_string = NULL;
6164 }
6165 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006166 {
6167 char_u *tofree = NULL;
6168
6169 // Translate "s:func" to the stored function name.
6170 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6171 fp = find_func(fname, FALSE);
6172 vim_free(tofree);
6173 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006174 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006175
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006176 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006177 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006178 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006179
6180 if (pt != NULL)
6181 {
6182 pt->pt_refcount = 1;
6183 pt->pt_dict = selfdict;
6184 pt->pt_auto = TRUE;
6185 selfdict = NULL;
6186 if (rettv->v_type == VAR_FUNC)
6187 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006188 // Just a function: Take over the function name and use
6189 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006190 pt->pt_name = rettv->vval.v_string;
6191 }
6192 else
6193 {
6194 partial_T *ret_pt = rettv->vval.v_partial;
6195 int i;
6196
Bram Moolenaare38eab22019-12-05 21:50:01 +01006197 // Partial: copy the function name, use selfdict and copy
6198 // args. Can't take over name or args, the partial might
6199 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006200 if (ret_pt->pt_name != NULL)
6201 {
6202 pt->pt_name = vim_strsave(ret_pt->pt_name);
6203 func_ref(pt->pt_name);
6204 }
6205 else
6206 {
6207 pt->pt_func = ret_pt->pt_func;
6208 func_ptr_ref(pt->pt_func);
6209 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006210 if (ret_pt->pt_argc > 0)
6211 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006212 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006213 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006214 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006215 pt->pt_argc = 0;
6216 else
6217 {
6218 pt->pt_argc = ret_pt->pt_argc;
6219 for (i = 0; i < pt->pt_argc; i++)
6220 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6221 }
6222 }
6223 partial_unref(ret_pt);
6224 }
6225 rettv->v_type = VAR_PARTIAL;
6226 rettv->vval.v_partial = pt;
6227 }
6228 }
6229 return selfdict;
6230}
6231
6232/*
6233 * Return the name of the executed function.
6234 */
6235 char_u *
6236func_name(void *cookie)
6237{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006238 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006239}
6240
6241/*
6242 * Return the address holding the next breakpoint line for a funccall cookie.
6243 */
6244 linenr_T *
6245func_breakpoint(void *cookie)
6246{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006247 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006248}
6249
6250/*
6251 * Return the address holding the debug tick for a funccall cookie.
6252 */
6253 int *
6254func_dbg_tick(void *cookie)
6255{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006256 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006257}
6258
6259/*
6260 * Return the nesting level for a funccall cookie.
6261 */
6262 int
6263func_level(void *cookie)
6264{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006265 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006266}
6267
6268/*
6269 * Return TRUE when a function was ended by a ":return" command.
6270 */
6271 int
6272current_func_returned(void)
6273{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006274 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006275}
6276
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006277 int
6278free_unref_funccal(int copyID, int testing)
6279{
6280 int did_free = FALSE;
6281 int did_free_funccal = FALSE;
6282 funccall_T *fc, **pfc;
6283
6284 for (pfc = &previous_funccal; *pfc != NULL; )
6285 {
6286 if (can_free_funccal(*pfc, copyID))
6287 {
6288 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006289 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006290 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006291 did_free = TRUE;
6292 did_free_funccal = TRUE;
6293 }
6294 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006295 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006296 }
6297 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006298 // When a funccal was freed some more items might be garbage
6299 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006300 (void)garbage_collect(testing);
6301
6302 return did_free;
6303}
6304
6305/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006306 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006307 */
6308 static funccall_T *
6309get_funccal(void)
6310{
6311 int i;
6312 funccall_T *funccal;
6313 funccall_T *temp_funccal;
6314
6315 funccal = current_funccal;
6316 if (debug_backtrace_level > 0)
6317 {
6318 for (i = 0; i < debug_backtrace_level; i++)
6319 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006320 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006321 if (temp_funccal)
6322 funccal = temp_funccal;
6323 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006324 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006325 debug_backtrace_level = i;
6326 }
6327 }
6328 return funccal;
6329}
6330
6331/*
6332 * Return the hashtable used for local variables in the current funccal.
6333 * Return NULL if there is no current funccal.
6334 */
6335 hashtab_T *
6336get_funccal_local_ht()
6337{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006338 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006339 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006340 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006341}
6342
6343/*
6344 * Return the l: scope variable.
6345 * Return NULL if there is no current funccal.
6346 */
6347 dictitem_T *
6348get_funccal_local_var()
6349{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006350 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006351 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006352 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006353}
6354
6355/*
6356 * Return the hashtable used for argument in the current funccal.
6357 * Return NULL if there is no current funccal.
6358 */
6359 hashtab_T *
6360get_funccal_args_ht()
6361{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006362 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006363 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006364 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006365}
6366
6367/*
6368 * Return the a: scope variable.
6369 * Return NULL if there is no current funccal.
6370 */
6371 dictitem_T *
6372get_funccal_args_var()
6373{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006374 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006375 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006376 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006377}
6378
6379/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006380 * List function variables, if there is a function.
6381 */
6382 void
6383list_func_vars(int *first)
6384{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006385 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6386 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006387 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006388}
6389
6390/*
6391 * If "ht" is the hashtable for local variables in the current funccal, return
6392 * the dict that contains it.
6393 * Otherwise return NULL.
6394 */
6395 dict_T *
6396get_current_funccal_dict(hashtab_T *ht)
6397{
6398 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006399 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6400 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006401 return NULL;
6402}
6403
6404/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006405 * Search hashitem in parent scope.
6406 */
6407 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006408find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006409{
6410 funccall_T *old_current_funccal = current_funccal;
6411 hashtab_T *ht;
6412 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006413 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006414
Bram Moolenaarca16c602022-09-06 18:57:08 +01006415 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006416 return NULL;
6417
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006418 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006419 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006420 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006421 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006422 ht = find_var_ht(name, &varname);
6423 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006424 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006425 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006426 if (!HASHITEM_EMPTY(hi))
6427 {
6428 *pht = ht;
6429 break;
6430 }
6431 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006432 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006433 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006434 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006435 }
6436 current_funccal = old_current_funccal;
6437
6438 return hi;
6439}
6440
6441/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006442 * Search variable in parent scope.
6443 */
6444 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006445find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006446{
6447 dictitem_T *v = NULL;
6448 funccall_T *old_current_funccal = current_funccal;
6449 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006450 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006451
Bram Moolenaarca16c602022-09-06 18:57:08 +01006452 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006453 return NULL;
6454
Bram Moolenaare38eab22019-12-05 21:50:01 +01006455 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006456 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006457 while (current_funccal)
6458 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006459 ht = find_var_ht(name, &varname);
6460 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006461 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006462 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006463 if (v != NULL)
6464 break;
6465 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006466 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006467 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006468 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006469 }
6470 current_funccal = old_current_funccal;
6471
6472 return v;
6473}
6474
6475/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006476 * Set "copyID + 1" in previous_funccal and callers.
6477 */
6478 int
6479set_ref_in_previous_funccal(int copyID)
6480{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006481 funccall_T *fc;
6482
Bram Moolenaarca16c602022-09-06 18:57:08 +01006483 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006484 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006485 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006486 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6487 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6488 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006489 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006490 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006491 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006492}
6493
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006494 static int
6495set_ref_in_funccal(funccall_T *fc, int copyID)
6496{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006497 if (fc->fc_copyID != copyID)
6498 {
6499 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006500 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6501 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6502 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6503 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006504 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006505 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006506 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006507}
6508
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006509/*
6510 * Set "copyID" in all local vars and arguments in the call stack.
6511 */
6512 int
6513set_ref_in_call_stack(int copyID)
6514{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006515 funccall_T *fc;
6516 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006517
Bram Moolenaarca16c602022-09-06 18:57:08 +01006518 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006519 if (set_ref_in_funccal(fc, copyID))
6520 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006521
6522 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006523 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006524 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006525 if (set_ref_in_funccal(fc, copyID))
6526 return TRUE;
6527 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006528}
6529
6530/*
6531 * Set "copyID" in all functions available by name.
6532 */
6533 int
6534set_ref_in_functions(int copyID)
6535{
6536 int todo;
6537 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006538 ufunc_T *fp;
6539
6540 todo = (int)func_hashtab.ht_used;
6541 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006542 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006543 if (!HASHITEM_EMPTY(hi))
6544 {
6545 --todo;
6546 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006547 if (!func_name_refcount(fp->uf_name)
6548 && set_ref_in_func(NULL, fp, copyID))
6549 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006550 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006551 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006552 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006553}
6554
6555/*
6556 * Set "copyID" in all function arguments.
6557 */
6558 int
6559set_ref_in_func_args(int copyID)
6560{
6561 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006562
6563 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006564 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6565 copyID, NULL, NULL))
6566 return TRUE;
6567 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006568}
6569
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006570/*
6571 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006572 * Returns TRUE if setting references failed somehow.
6573 */
6574 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006575set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006576{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006577 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006578 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006579 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006580 char_u fname_buf[FLEN_FIXED + 1];
6581 char_u *tofree = NULL;
6582 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006583 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006584
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006585 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006586 return FALSE;
6587
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006588 if (fp_in == NULL)
6589 {
6590 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006591 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006592 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006593 if (fp != NULL)
6594 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006595 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006596 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006597 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006598
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006599 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006600 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006601}
6602
Bram Moolenaare38eab22019-12-05 21:50:01 +01006603#endif // FEAT_EVAL