blob: ff4cae7322fe1f14771eafaf395256001c2b6f78 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
Bram Moolenaar14c01f82019-10-09 22:53:08 +020011 * userfunc.c: User defined function support
Bram Moolenaara9b579f2016-07-17 18:29:19 +020012 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +020017/*
18 * All user-defined functions are found in this hashtable.
19 */
20static hashtab_T func_hashtab;
21
Bram Moolenaare38eab22019-12-05 21:50:01 +010022// Used by get_func_tv()
Bram Moolenaara9b579f2016-07-17 18:29:19 +020023static garray_T funcargs = GA_EMPTY;
24
Bram Moolenaar209b8e32019-03-14 13:43:24 +010025// pointer to funccal for currently active function
26static funccall_T *current_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020027
Bram Moolenaar209b8e32019-03-14 13:43:24 +010028// Pointer to list of previously used funccal, still around because some
29// item in it is still being used.
30static funccall_T *previous_funccal = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +020031
Bram Moolenaarbc7ce672016-08-01 22:49:22 +020032static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +010033static void func_clear(ufunc_T *fp, int force);
34static int func_free(ufunc_T *fp, int force);
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +010035static char_u *untrans_function_name(char_u *name);
Bram Moolenaar58779852022-09-06 18:31:14 +010036static void handle_defer_one(funccall_T *funccal);
Bram Moolenaara9b579f2016-07-17 18:29:19 +020037
38 void
39func_init()
40{
41 hash_init(&func_hashtab);
42}
43
Bram Moolenaar4f0383b2016-07-19 22:43:11 +020044/*
Bram Moolenaar660a10a2019-07-14 15:48:38 +020045 * Return the function hash table
46 */
47 hashtab_T *
48func_tbl_get(void)
49{
50 return &func_hashtab;
51}
52
53/*
Bram Moolenaar6e949782020-04-13 17:21:00 +020054 * Get one function argument.
Bram Moolenaar51e7e782021-04-10 17:46:52 +020055 * If "argtypes" is not NULL also get the type: "arg: type" (:def function).
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010056 * If "types_optional" is TRUE a missing type is OK, use "any".
Bram Moolenaar057e84a2021-02-28 16:55:11 +010057 * If "evalarg" is not NULL use it to check for an already declared name.
Bram Moolenaardce24412022-02-08 20:35:30 +000058 * If "eap" is not NULL use it to check for an already declared name.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010059 * Return a pointer to after the type.
60 * When something is wrong return "arg".
61 */
62 static char_u *
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010063one_function_arg(
64 char_u *arg,
65 garray_T *newargs,
66 garray_T *argtypes,
67 int types_optional,
Bram Moolenaar057e84a2021-02-28 16:55:11 +010068 evalarg_T *evalarg,
Bram Moolenaardce24412022-02-08 20:35:30 +000069 exarg_T *eap,
Bram Moolenaar2a389082021-04-09 20:24:31 +020070 int is_vararg,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +010071 int skip)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010072{
Bram Moolenaar6e949782020-04-13 17:21:00 +020073 char_u *p = arg;
74 char_u *arg_copy = NULL;
Bram Moolenaar51e7e782021-04-10 17:46:52 +020075 int is_underscore = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010076
77 while (ASCII_ISALNUM(*p) || *p == '_')
78 ++p;
79 if (arg == p || isdigit(*arg)
Bram Moolenaarb816dae2020-09-20 22:04:00 +020080 || (argtypes == NULL
81 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0)
82 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0))))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010083 {
84 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +000085 semsg(_(e_illegal_argument_str), arg);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010086 return arg;
87 }
Bram Moolenaarb4893b82021-02-21 22:20:24 +010088
Bram Moolenaar057e84a2021-02-28 16:55:11 +010089 // Vim9 script: cannot use script var name for argument. In function: also
90 // check local vars and arguments.
91 if (!skip && argtypes != NULL && check_defined(arg, p - arg,
Bram Moolenaardce24412022-02-08 20:35:30 +000092 evalarg == NULL ? NULL : evalarg->eval_cctx,
93 eap == NULL ? NULL : eap->cstack, TRUE) == FAIL)
Bram Moolenaarb4893b82021-02-21 22:20:24 +010094 return arg;
Bram Moolenaarb4893b82021-02-21 22:20:24 +010095
Bram Moolenaar8a7d6542020-01-26 15:56:19 +010096 if (newargs != NULL && ga_grow(newargs, 1) == FAIL)
97 return arg;
98 if (newargs != NULL)
99 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100100 int c;
101 int i;
102
103 c = *p;
104 *p = NUL;
105 arg_copy = vim_strsave(arg);
106 if (arg_copy == NULL)
107 {
108 *p = c;
109 return arg;
110 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL;
Bram Moolenaar87795932021-04-10 18:21:30 +0200112 if (argtypes == NULL || !is_underscore)
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200113 // Check for duplicate argument name.
114 for (i = 0; i < newargs->ga_len; ++i)
115 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg_copy) == 0)
116 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +0000117 semsg(_(e_duplicate_argument_name_str), arg_copy);
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200118 vim_free(arg_copy);
119 return arg;
120 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100121 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg_copy;
122 newargs->ga_len++;
123
124 *p = c;
125 }
126
127 // get any type from "arg: type"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100129 {
130 char_u *type = NULL;
131
Bram Moolenaar6e949782020-04-13 17:21:00 +0200132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':')
133 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200134 semsg(_(e_no_white_space_allowed_before_colon_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200135 arg_copy == NULL ? arg : arg_copy);
136 p = skipwhite(p);
137 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100138 if (*p == ':')
139 {
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200140 ++p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100141 if (!skip && !VIM_ISWHITE(*p))
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200142 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100143 semsg(_(e_white_space_required_after_str_str), ":", p - 1);
Bram Moolenaarf93c7fe2020-04-23 22:16:53 +0200144 return arg;
145 }
146 type = skipwhite(p);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +0200147 p = skip_type(type, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100148 if (!skip)
149 type = vim_strnsave(type, p - type);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100150 }
Bram Moolenaar51e7e782021-04-10 17:46:52 +0200151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore)
Bram Moolenaar6e949782020-04-13 17:21:00 +0200152 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +0200153 semsg(_(e_missing_argument_type_for_str),
Bram Moolenaar6e949782020-04-13 17:21:00 +0200154 arg_copy == NULL ? arg : arg_copy);
155 return arg;
156 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100157 if (!skip)
158 {
159 if (type == NULL && types_optional)
160 // lambda arguments default to "any" type
Bram Moolenaar2a389082021-04-09 20:24:31 +0200161 type = vim_strsave((char_u *)
162 (is_vararg ? "list<any>" : "any"));
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type;
164 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100165 }
166
167 return p;
168}
169
170/*
Bram Moolenaar7473a842021-12-28 17:55:26 +0000171 * Handle line continuation in function arguments or body.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000172 * Get a next line, store it in "eap" if appropriate and put the line in
173 * "lines_to_free" to free the line later.
Bram Moolenaar7473a842021-12-28 17:55:26 +0000174 */
175 static char_u *
176get_function_line(
177 exarg_T *eap,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000178 garray_T *lines_to_free,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000179 int indent,
180 getline_opt_T getline_options)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000181{
182 char_u *theline;
183
184 if (eap->getline == NULL)
Bram Moolenaarc97f9a52021-12-28 20:59:56 +0000185 theline = getcmdline(':', 0L, indent, 0);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000186 else
187 theline = eap->getline(':', eap->cookie, indent, getline_options);
188 if (theline != NULL)
189 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000190 if (lines_to_free->ga_len > 0
191 && *eap->cmdlinep == ((char_u **)lines_to_free->ga_data)
192 [lines_to_free->ga_len - 1])
Bram Moolenaar7473a842021-12-28 17:55:26 +0000193 *eap->cmdlinep = theline;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000194 ga_add_string(lines_to_free, theline);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000195 }
196
197 return theline;
198}
199
200/*
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200201 * Get function arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +0100202 * "argp" should point to just after the "(", possibly to white space.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100203 * "argp" is advanced just after "endchar".
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200204 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100205 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200206get_function_args(
207 char_u **argp,
208 char_u endchar,
209 garray_T *newargs,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100210 garray_T *argtypes, // NULL unless using :def
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100211 int types_optional, // types optional if "argtypes" is not NULL
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100212 evalarg_T *evalarg, // context or NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200213 int *varargs,
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200214 garray_T *default_args,
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200215 int skip,
Bram Moolenaardce24412022-02-08 20:35:30 +0000216 exarg_T *eap, // can be NULL
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000217 garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200218{
219 int mustend = FALSE;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100220 char_u *arg;
221 char_u *p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200222 int c;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200223 int any_default = FALSE;
224 char_u *expr;
Bram Moolenaarcef12702021-01-04 14:09:43 +0100225 char_u *whitep = *argp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200226
227 if (newargs != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000228 ga_init2(newargs, sizeof(char_u *), 3);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100229 if (argtypes != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000230 ga_init2(argtypes, sizeof(char_u *), 3);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200231 if (!skip && default_args != NULL)
Bram Moolenaar04935fb2022-01-08 16:19:22 +0000232 ga_init2(default_args, sizeof(char_u *), 3);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200233
234 if (varargs != NULL)
235 *varargs = FALSE;
236
237 /*
238 * Isolate the arguments: "arg1, arg2, ...)"
239 */
Bram Moolenaarcef12702021-01-04 14:09:43 +0100240 arg = skipwhite(*argp);
241 p = arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200242 while (*p != endchar)
243 {
Bram Moolenaar2c330432020-04-13 14:41:35 +0200244 while (eap != NULL && eap->getline != NULL
245 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#')))
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200246 {
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200247 // End of the line, get the next one.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000248 char_u *theline = get_function_line(eap, lines_to_free, 0,
Bram Moolenaar11ceb7d2021-12-28 20:49:56 +0000249 GETLINE_CONCAT_CONT);
Bram Moolenaar7473a842021-12-28 17:55:26 +0000250
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200251 if (theline == NULL)
252 break;
Bram Moolenaar2c330432020-04-13 14:41:35 +0200253 whitep = (char_u *)" ";
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200254 p = skipwhite(theline);
255 }
256
257 if (mustend && *p != endchar)
258 {
259 if (!skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000260 semsg(_(e_invalid_argument_str), *argp);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100261 goto err_ret;
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200262 }
263 if (*p == endchar)
264 break;
265
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200266 if (p[0] == '.' && p[1] == '.' && p[2] == '.')
267 {
268 if (varargs != NULL)
269 *varargs = TRUE;
270 p += 3;
271 mustend = TRUE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100272
273 if (argtypes != NULL)
274 {
275 // ...name: list<type>
Bram Moolenaar28022722020-09-21 22:02:49 +0200276 if (!eval_isnamec1(*p))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100277 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100278 if (!skip)
279 emsg(_(e_missing_name_after_dots));
280 goto err_ret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100281 }
282
283 arg = p;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100284 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000285 evalarg, eap, TRUE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100286 if (p == arg)
287 break;
Bram Moolenaar4f53b792021-02-07 15:59:49 +0100288 if (*skipwhite(p) == '=')
289 {
290 emsg(_(e_cannot_use_default_for_variable_arguments));
291 break;
292 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200294 }
295 else
296 {
Bram Moolenaar015cf102021-06-26 21:52:02 +0200297 char_u *np;
298
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200299 arg = p;
Bram Moolenaar057e84a2021-02-28 16:55:11 +0100300 p = one_function_arg(p, newargs, argtypes, types_optional,
Bram Moolenaardce24412022-02-08 20:35:30 +0000301 evalarg, eap, FALSE, skip);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100302 if (p == arg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200303 break;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200304
Bram Moolenaar015cf102021-06-26 21:52:02 +0200305 // Recognize " = expr" but not " == expr". A lambda can have
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200306 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda.
Bram Moolenaar015cf102021-06-26 21:52:02 +0200307 np = skipwhite(p);
Bram Moolenaar98f9a5f2021-06-26 22:22:38 +0200308 if (*np == '=' && np[1] != '=' && np[1] != '~'
309 && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200310 {
311 typval_T rettv;
312
Bram Moolenaar170fcfc2020-02-06 17:51:35 +0100313 // find the end of the expression (doesn't evaluate it)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200314 any_default = TRUE;
Bram Moolenaareb5adf12022-09-04 13:41:37 +0100315 p = skipwhite(np + 1);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200316 expr = p;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200317 if (eval1(&p, &rettv, NULL) != FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200318 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200319 if (!skip)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200320 {
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200321 if (ga_grow(default_args, 1) == FAIL)
322 goto err_ret;
323
324 // trim trailing whitespace
325 while (p > expr && VIM_ISWHITE(p[-1]))
326 p--;
327 c = *p;
328 *p = NUL;
329 expr = vim_strsave(expr);
330 if (expr == NULL)
331 {
332 *p = c;
333 goto err_ret;
334 }
335 ((char_u **)(default_args->ga_data))
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200336 [default_args->ga_len] = expr;
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200337 default_args->ga_len++;
338 *p = c;
339 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200340 }
341 else
342 mustend = TRUE;
343 }
344 else if (any_default)
345 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +0000346 emsg(_(e_non_default_argument_follows_default_argument));
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200347 goto err_ret;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200348 }
Bram Moolenaar86cdb8a2021-04-06 19:01:03 +0200349
350 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',')
351 {
352 // Be tolerant when skipping
353 if (!skip)
354 {
355 semsg(_(e_no_white_space_allowed_before_str_str), ",", p);
356 goto err_ret;
357 }
358 p = skipwhite(p);
359 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200360 if (*p == ',')
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200361 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200362 ++p;
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200363 // Don't give this error when skipping, it makes the "->" not
364 // found in "{k,v -> x}" and give a confusing error.
Bram Moolenaar608d78f2021-03-06 22:33:12 +0100365 // Allow missing space after comma in legacy functions.
366 if (!skip && argtypes != NULL
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200367 && !IS_WHITE_OR_NUL(*p) && *p != endchar)
368 {
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100369 semsg(_(e_white_space_required_after_str_str), ",", p - 1);
Bram Moolenaar914e7ea2020-07-11 15:20:48 +0200370 goto err_ret;
371 }
372 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200373 else
374 mustend = TRUE;
375 }
Bram Moolenaar2c330432020-04-13 14:41:35 +0200376 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200377 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200378 }
Bram Moolenaar5e774c72020-04-12 21:53:00 +0200379
Bram Moolenaar4f0383b2016-07-19 22:43:11 +0200380 if (*p != endchar)
381 goto err_ret;
Bram Moolenaare38eab22019-12-05 21:50:01 +0100382 ++p; // skip "endchar"
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200383
384 *argp = p;
385 return OK;
386
387err_ret:
388 if (newargs != NULL)
389 ga_clear_strings(newargs);
Bram Moolenaare3ffaa62021-06-26 22:17:35 +0200390 if (!skip && default_args != NULL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +0200391 ga_clear_strings(default_args);
Bram Moolenaara9b579f2016-07-17 18:29:19 +0200392 return FAIL;
393}
394
395/*
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100396 * Parse the argument types, filling "fp->uf_arg_types".
397 * Return OK or FAIL.
398 */
399 static int
400parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs)
401{
Bram Moolenaar2a389082021-04-09 20:24:31 +0200402 int len = 0;
403
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100404 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10);
405 if (argtypes->ga_len > 0)
406 {
407 // When "varargs" is set the last name/type goes into uf_va_name
408 // and uf_va_type.
Bram Moolenaar2a389082021-04-09 20:24:31 +0200409 len = argtypes->ga_len - (varargs ? 1 : 0);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100410
411 if (len > 0)
412 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len);
413 if (fp->uf_arg_types != NULL)
414 {
415 int i;
416 type_T *type;
417
418 for (i = 0; i < len; ++ i)
419 {
420 char_u *p = ((char_u **)argtypes->ga_data)[i];
421
422 if (p == NULL)
423 // will get the type from the default value
424 type = &t_unknown;
425 else
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100426 type = parse_type(&p, &fp->uf_type_list, TRUE);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100427 if (type == NULL)
428 return FAIL;
429 fp->uf_arg_types[i] = type;
Bram Moolenaar1d9cef72022-03-17 16:30:03 +0000430 if (i < fp->uf_args.ga_len
431 && (type->tt_type == VAR_FUNC
432 || type->tt_type == VAR_PARTIAL)
433 && var_wrong_func_name(
434 ((char_u **)fp->uf_args.ga_data)[i], TRUE))
435 return FAIL;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100436 }
437 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100438 }
Bram Moolenaar2a389082021-04-09 20:24:31 +0200439
440 if (varargs)
441 {
442 char_u *p;
443
444 // Move the last argument "...name: type" to uf_va_name and
445 // uf_va_type.
446 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data)
447 [fp->uf_args.ga_len - 1];
448 --fp->uf_args.ga_len;
449 p = ((char_u **)argtypes->ga_data)[len];
450 if (p == NULL)
451 // TODO: get type from default value
452 fp->uf_va_type = &t_list_any;
453 else
454 {
455 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE);
456 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST)
457 {
458 semsg(_(e_variable_arguments_type_must_be_list_str),
459 ((char_u **)argtypes->ga_data)[len]);
460 return FAIL;
461 }
462 }
463 if (fp->uf_va_type == NULL)
464 return FAIL;
465 }
466
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100467 return OK;
468}
469
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100470 static int
471parse_return_type(ufunc_T *fp, char_u *ret_type)
472{
473 if (ret_type == NULL)
474 fp->uf_ret_type = &t_void;
475 else
476 {
477 char_u *p = ret_type;
478
479 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE);
480 if (fp->uf_ret_type == NULL)
481 {
482 fp->uf_ret_type = &t_void;
483 return FAIL;
484 }
485 }
486 return OK;
487}
488
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +0100489/*
Bram Moolenaar58016442016-07-31 18:30:22 +0200490 * Register function "fp" as using "current_funccal" as its scope.
491 */
492 static int
493register_closure(ufunc_T *fp)
494{
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200495 if (fp->uf_scoped == current_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +0100496 // no change
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200497 return OK;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +0200498 funccal_unref(fp->uf_scoped, fp, FALSE);
Bram Moolenaar58016442016-07-31 18:30:22 +0200499 fp->uf_scoped = current_funccal;
500 current_funccal->fc_refcount++;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +0200501
Bram Moolenaarca16c602022-09-06 18:57:08 +0100502 if (ga_grow(&current_funccal->fc_ufuncs, 1) == FAIL)
Bram Moolenaar58016442016-07-31 18:30:22 +0200503 return FAIL;
Bram Moolenaarca16c602022-09-06 18:57:08 +0100504 ((ufunc_T **)current_funccal->fc_ufuncs.ga_data)
505 [current_funccal->fc_ufuncs.ga_len++] = fp;
Bram Moolenaar58016442016-07-31 18:30:22 +0200506 return OK;
507}
508
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100509 static void
510set_ufunc_name(ufunc_T *fp, char_u *name)
511{
Bram Moolenaar7b6903f2021-02-03 19:31:29 +0100512 // Add a type cast to avoid a warning for an overflow, the uf_name[] array
513 // actually extends beyond the struct.
514 STRCPY((void *)fp->uf_name, name);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100515
516 if (name[0] == K_SPECIAL)
517 {
518 fp->uf_name_exp = alloc(STRLEN(name) + 3);
519 if (fp->uf_name_exp != NULL)
520 {
521 STRCPY(fp->uf_name_exp, "<SNR>");
522 STRCAT(fp->uf_name_exp, fp->uf_name + 3);
523 }
524 }
525}
526
Bram Moolenaar58016442016-07-31 18:30:22 +0200527/*
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100528 * If "name" starts with K_SPECIAL and "buf[bufsize]" is big enough
529 * return "buf" filled with a readable function name.
530 * Otherwise just return "name", thus the return value can always be used.
531 * "name" and "buf" may be equal.
532 */
533 char_u *
534make_ufunc_name_readable(char_u *name, char_u *buf, size_t bufsize)
535{
536 size_t len;
537
538 if (name[0] != K_SPECIAL)
539 return name;
540 len = STRLEN(name);
541 if (len + 3 > bufsize)
542 return name;
543
Bram Moolenaar96e08e02022-03-31 21:40:33 +0100544 mch_memmove(buf + 5, name + 3, len - 2); // Include trailing NUL
Bram Moolenaara6c18d32022-03-31 20:02:56 +0100545 mch_memmove(buf, "<SNR>", 5);
546 return buf;
547}
548
549/*
Bram Moolenaar04b12692020-05-04 23:24:44 +0200550 * Get a name for a lambda. Returned in static memory.
551 */
552 char_u *
553get_lambda_name(void)
554{
555 static char_u name[30];
556 static int lambda_no = 0;
557
558 sprintf((char*)name, "<lambda>%d", ++lambda_no);
559 return name;
560}
561
Bram Moolenaar801ab062020-06-25 19:27:56 +0200562#if defined(FEAT_LUA) || defined(PROTO)
563/*
564 * Registers a native C callback which can be called from Vim script.
565 * Returns the name of the Vim script function.
566 */
567 char_u *
568register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state)
569{
570 char_u *name = get_lambda_name();
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200571 ufunc_T *fp;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200572
573 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
574 if (fp == NULL)
Bram Moolenaar7d2ac922020-06-29 20:20:33 +0200575 return NULL;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200576
Bram Moolenaar38ddf332020-07-31 22:05:04 +0200577 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200578 fp->uf_refcount = 1;
579 fp->uf_varargs = TRUE;
Bram Moolenaar38453522021-11-28 22:00:12 +0000580 fp->uf_flags = FC_CFUNC | FC_LAMBDA;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200581 fp->uf_calls = 0;
582 fp->uf_script_ctx = current_sctx;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200583 fp->uf_cb = cb;
584 fp->uf_cb_free = cb_free;
585 fp->uf_cb_state = state;
586
587 set_ufunc_name(fp, name);
588 hash_add(&func_hashtab, UF2HIKEY(fp));
589
590 return name;
Bram Moolenaar801ab062020-06-25 19:27:56 +0200591}
592#endif
593
Bram Moolenaar04b12692020-05-04 23:24:44 +0200594/*
Bram Moolenaar65c44152020-12-24 15:14:01 +0100595 * Skip over "->" or "=>" after the arguments of a lambda.
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100596 * If ": type" is found make "ret_type" point to "type".
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100597 * If "white_error" is not NULL check for correct use of white space and set
598 * "white_error" to TRUE if there is an error.
Bram Moolenaar65c44152020-12-24 15:14:01 +0100599 * Return NULL if no valid arrow found.
600 */
601 static char_u *
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100602skip_arrow(
603 char_u *start,
604 int equal_arrow,
605 char_u **ret_type,
606 int *white_error)
Bram Moolenaar65c44152020-12-24 15:14:01 +0100607{
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100608 char_u *s = start;
609 char_u *bef = start - 2; // "start" points to > of ->
Bram Moolenaar65c44152020-12-24 15:14:01 +0100610
611 if (equal_arrow)
612 {
613 if (*s == ':')
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100614 {
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100615 if (white_error != NULL && !VIM_ISWHITE(s[1]))
616 {
617 *white_error = TRUE;
Bram Moolenaarc3fc75d2021-02-07 15:28:09 +0100618 semsg(_(e_white_space_required_after_str_str), ":", s);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100619 return NULL;
620 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100621 s = skipwhite(s + 1);
622 *ret_type = s;
623 s = skip_type(s, TRUE);
Bram Moolenaar0346b792021-01-31 22:18:29 +0100624 if (s == *ret_type)
625 {
626 emsg(_(e_missing_return_type));
627 return NULL;
628 }
Bram Moolenaar9e68c322020-12-25 12:38:04 +0100629 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100630 bef = s;
Bram Moolenaar65c44152020-12-24 15:14:01 +0100631 s = skipwhite(s);
632 if (*s != '=')
633 return NULL;
634 ++s;
635 }
636 if (*s != '>')
637 return NULL;
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100638 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{')
639 || !IS_WHITE_OR_NUL(s[1])))
640 {
641 *white_error = TRUE;
Bram Moolenaare7a73e02021-01-01 19:17:55 +0100642 semsg(_(e_white_space_required_before_and_after_str_at_str),
643 equal_arrow ? "=>" : "->", bef);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +0100644 return NULL;
645 }
Bram Moolenaar65c44152020-12-24 15:14:01 +0100646 return skipwhite(s + 1);
647}
648
649/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100650 * Check if "*cmd" points to a function command and if so advance "*cmd" and
651 * return TRUE.
652 * Otherwise return FALSE;
653 * Do not consider "function(" to be a command.
654 */
655 static int
656is_function_cmd(char_u **cmd)
657{
658 char_u *p = *cmd;
659
660 if (checkforcmd(&p, "function", 2))
661 {
662 if (*p == '(')
663 return FALSE;
664 *cmd = p;
665 return TRUE;
666 }
667 return FALSE;
668}
669
670/*
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +0200671 * Called when defining a function: The context may be needed for script
672 * variables declared in a block that is visible now but not when the function
673 * is compiled or called later.
674 */
675 static void
676function_using_block_scopes(ufunc_T *fp, cstack_T *cstack)
677{
678 if (cstack != NULL && cstack->cs_idx >= 0)
679 {
680 int count = cstack->cs_idx + 1;
681 int i;
682
683 fp->uf_block_ids = ALLOC_MULT(int, count);
684 if (fp->uf_block_ids != NULL)
685 {
686 mch_memmove(fp->uf_block_ids, cstack->cs_block_id,
687 sizeof(int) * count);
688 fp->uf_block_depth = count;
689 }
690
691 // Set flag in each block to indicate a function was defined. This
692 // is used to keep the variable when leaving the block, see
693 // hide_script_var().
694 for (i = 0; i <= cstack->cs_idx; ++i)
695 cstack->cs_flags[i] |= CSF_FUNC_DEF;
696 }
697}
698
699/*
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100700 * Read the body of a function, put every line in "newlines".
Bram Moolenaar074f84c2021-05-18 11:47:44 +0200701 * This stops at "}", "endfunction" or "enddef".
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100702 * "newlines" must already have been initialized.
703 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block;
704 */
705 static int
706get_function_body(
707 exarg_T *eap,
708 garray_T *newlines,
709 char_u *line_arg_in,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000710 garray_T *lines_to_free)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100711{
712 linenr_T sourcing_lnum_top = SOURCING_LNUM;
713 linenr_T sourcing_lnum_off;
714 int saved_wait_return = need_wait_return;
715 char_u *line_arg = line_arg_in;
716 int vim9_function = eap->cmdidx == CMD_def
717 || eap->cmdidx == CMD_block;
718#define MAX_FUNC_NESTING 50
719 char nesting_def[MAX_FUNC_NESTING];
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200720 char nesting_inline[MAX_FUNC_NESTING];
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100721 int nesting = 0;
722 getline_opt_T getline_options;
723 int indent = 2;
724 char_u *skip_until = NULL;
725 int ret = FAIL;
726 int is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200727 int heredoc_concat_len = 0;
728 garray_T heredoc_ga;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100729 char_u *heredoc_trimmed = NULL;
730
Bram Moolenaar20677332021-06-06 17:02:53 +0200731 ga_init2(&heredoc_ga, 1, 500);
732
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100733 // Detect having skipped over comment lines to find the return
734 // type. Add NULL lines to keep the line count correct.
735 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
736 if (SOURCING_LNUM < sourcing_lnum_off)
737 {
738 sourcing_lnum_off -= SOURCING_LNUM;
739 if (ga_grow(newlines, sourcing_lnum_off) == FAIL)
740 goto theend;
741 while (sourcing_lnum_off-- > 0)
742 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
743 }
744
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200745 nesting_def[0] = vim9_function;
746 nesting_inline[0] = eap->cmdidx == CMD_block;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100747 getline_options = vim9_function
748 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
749 for (;;)
750 {
751 char_u *theline;
752 char_u *p;
753 char_u *arg;
754
755 if (KeyTyped)
756 {
757 msg_scroll = TRUE;
758 saved_wait_return = FALSE;
759 }
760 need_wait_return = FALSE;
761
762 if (line_arg != NULL)
763 {
764 // Use eap->arg, split up in parts by line breaks.
765 theline = line_arg;
766 p = vim_strchr(theline, '\n');
767 if (p == NULL)
768 line_arg += STRLEN(line_arg);
769 else
770 {
771 *p = NUL;
772 line_arg = p + 1;
773 }
774 }
775 else
776 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000777 theline = get_function_line(eap, lines_to_free, indent,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100778 getline_options);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100779 }
780 if (KeyTyped)
781 lines_left = Rows - 1;
782 if (theline == NULL)
783 {
784 // Use the start of the function for the line number.
785 SOURCING_LNUM = sourcing_lnum_top;
786 if (skip_until != NULL)
787 semsg(_(e_missing_heredoc_end_marker_str), skip_until);
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200788 else if (nesting_inline[nesting])
789 emsg(_(e_missing_end_block));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100790 else if (eap->cmdidx == CMD_def)
791 emsg(_(e_missing_enddef));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100792 else
Bram Moolenaarc553a212021-12-26 20:20:34 +0000793 emsg(_(e_missing_endfunction));
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100794 goto theend;
795 }
796
797 // Detect line continuation: SOURCING_LNUM increased more than one.
798 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie);
799 if (SOURCING_LNUM < sourcing_lnum_off)
800 sourcing_lnum_off -= SOURCING_LNUM;
801 else
802 sourcing_lnum_off = 0;
803
804 if (skip_until != NULL)
805 {
806 // Don't check for ":endfunc"/":enddef" between
807 // * ":append" and "."
808 // * ":python <<EOF" and "EOF"
809 // * ":let {var-name} =<< [trim] {marker}" and "{marker}"
810 if (heredoc_trimmed == NULL
811 || (is_heredoc && skipwhite(theline) == theline)
812 || STRNCMP(theline, heredoc_trimmed,
813 STRLEN(heredoc_trimmed)) == 0)
814 {
815 if (heredoc_trimmed == NULL)
816 p = theline;
817 else if (is_heredoc)
818 p = skipwhite(theline) == theline
819 ? theline : theline + STRLEN(heredoc_trimmed);
820 else
821 p = theline + STRLEN(heredoc_trimmed);
822 if (STRCMP(p, skip_until) == 0)
823 {
824 VIM_CLEAR(skip_until);
825 VIM_CLEAR(heredoc_trimmed);
826 getline_options = vim9_function
827 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT;
828 is_heredoc = FALSE;
Bram Moolenaar20677332021-06-06 17:02:53 +0200829
830 if (heredoc_concat_len > 0)
831 {
832 // Replace the starting line with all the concatenated
833 // lines.
834 ga_concat(&heredoc_ga, theline);
835 vim_free(((char_u **)(newlines->ga_data))[
836 heredoc_concat_len - 1]);
837 ((char_u **)(newlines->ga_data))[
838 heredoc_concat_len - 1] = heredoc_ga.ga_data;
839 ga_init(&heredoc_ga);
840 heredoc_concat_len = 0;
841 theline += STRLEN(theline); // skip the "EOF"
842 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100843 }
844 }
845 }
846 else
847 {
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200848 int c;
849 char_u *end;
Bram Moolenaarb2175222022-03-05 20:24:41 +0000850 char_u *cmd;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100851
852 // skip ':' and blanks
853 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p)
854 ;
855
856 // Check for "endfunction", "enddef" or "}".
857 // When a ":" follows it must be a dict key; "enddef: value,"
Bram Moolenaarb2175222022-03-05 20:24:41 +0000858 cmd = p;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200859 if (nesting_inline[nesting]
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100860 ? *p == '}'
861 : (checkforcmd(&p, nesting_def[nesting]
862 ? "enddef" : "endfunction", 4)
863 && *p != ':'))
864 {
Bram Moolenaarb2175222022-03-05 20:24:41 +0000865 if (!nesting_inline[nesting] && nesting_def[nesting]
866 && p < cmd + 6)
867 semsg(_(e_command_cannot_be_shortened_str), "enddef");
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100868 if (nesting-- == 0)
869 {
870 char_u *nextcmd = NULL;
871
872 if (*p == '|' || *p == '}')
873 nextcmd = p + 1;
874 else if (line_arg != NULL && *skipwhite(line_arg) != NUL)
875 nextcmd = line_arg;
876 else if (*p != NUL && *p != (vim9_function ? '#' : '"')
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100877 && (vim9_function || p_verbose > 0))
878 {
Bram Moolenaar4bba16d2021-08-15 19:28:05 +0200879 SOURCING_LNUM = sourcing_lnum_top
880 + newlines->ga_len + 1;
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100881 if (eap->cmdidx == CMD_def)
Bram Moolenaar7473a842021-12-28 17:55:26 +0000882 semsg(_(e_text_found_after_str_str), "enddef", p);
Bram Moolenaar49f1e9e2021-03-22 20:49:02 +0100883 else
884 give_warning2((char_u *)
885 _("W22: Text found after :endfunction: %s"),
886 p, TRUE);
887 }
888 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100889 {
890 // Another command follows. If the line came from "eap"
891 // we can simply point into it, otherwise we need to
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000892 // change "eap->cmdlinep" to point to the last fetched
893 // line.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100894 eap->nextcmd = nextcmd;
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000895 if (lines_to_free->ga_len > 0
896 && *eap->cmdlinep !=
897 ((char_u **)lines_to_free->ga_data)
898 [lines_to_free->ga_len - 1])
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100899 {
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000900 // *cmdlinep will be freed later, thus remove the
901 // line from lines_to_free.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100902 vim_free(*eap->cmdlinep);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +0000903 *eap->cmdlinep = ((char_u **)lines_to_free->ga_data)
904 [lines_to_free->ga_len - 1];
905 --lines_to_free->ga_len;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100906 }
907 }
908 break;
909 }
910 }
911
912 // Check for mismatched "endfunc" or "enddef".
913 // We don't check for "def" inside "func" thus we also can't check
914 // for "enddef".
915 // We continue to find the end of the function, although we might
916 // not find it.
917 else if (nesting_def[nesting])
918 {
919 if (checkforcmd(&p, "endfunction", 4) && *p != ':')
920 emsg(_(e_mismatched_endfunction));
921 }
922 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4))
923 emsg(_(e_mismatched_enddef));
924
925 // Increase indent inside "if", "while", "for" and "try", decrease
926 // at "end".
927 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0))
928 indent -= 2;
929 else if (STRNCMP(p, "if", 2) == 0
930 || STRNCMP(p, "wh", 2) == 0
931 || STRNCMP(p, "for", 3) == 0
932 || STRNCMP(p, "try", 3) == 0)
933 indent += 2;
934
935 // Check for defining a function inside this function.
936 // Only recognize "def" inside "def", not inside "function",
937 // For backwards compatibility, see Test_function_python().
938 c = *p;
939 if (is_function_cmd(&p)
940 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3)))
941 {
942 if (*p == '!')
943 p = skipwhite(p + 1);
944 p += eval_fname_script(p);
945 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL,
946 NULL, NULL));
947 if (*skipwhite(p) == '(')
948 {
949 if (nesting == MAX_FUNC_NESTING - 1)
950 emsg(_(e_function_nesting_too_deep));
951 else
952 {
953 ++nesting;
954 nesting_def[nesting] = (c == 'd');
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200955 nesting_inline[nesting] = FALSE;
956 indent += 2;
957 }
958 }
959 }
960
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200961 if (nesting_def[nesting] ? *p != '#' : *p != '"')
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200962 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200963 // Not a comment line: check for nested inline function.
964 end = p + STRLEN(p) - 1;
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200965 while (end > p && VIM_ISWHITE(*end))
966 --end;
Bram Moolenaar13212572021-08-01 22:01:30 +0200967 if (end > p + 1 && *end == '{' && VIM_ISWHITE(end[-1]))
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200968 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200969 int is_block;
970
971 // check for trailing "=> {": start of an inline function
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200972 --end;
973 while (end > p && VIM_ISWHITE(*end))
974 --end;
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200975 is_block = end > p + 2 && end[-1] == '=' && end[0] == '>';
976 if (!is_block)
Bram Moolenaar5245beb2021-07-15 22:03:50 +0200977 {
Bram Moolenaare4db17f2021-08-01 21:19:43 +0200978 char_u *s = p;
979
980 // check for line starting with "au" for :autocmd or
981 // "com" for :command, these can use a {} block
982 is_block = checkforcmd_noparen(&s, "autocmd", 2)
983 || checkforcmd_noparen(&s, "command", 3);
984 }
985
986 if (is_block)
987 {
Bram Moolenaarac2cd2b2021-07-19 21:04:23 +0200988 if (nesting == MAX_FUNC_NESTING - 1)
989 emsg(_(e_function_nesting_too_deep));
990 else
991 {
992 ++nesting;
993 nesting_def[nesting] = TRUE;
994 nesting_inline[nesting] = TRUE;
995 indent += 2;
996 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +0100997 }
998 }
999 }
1000
1001 // Check for ":append", ":change", ":insert". Not for :def.
1002 p = skip_range(p, FALSE, NULL);
1003 if (!vim9_function
1004 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p'))
1005 || (p[0] == 'c'
1006 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h'
1007 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a'
1008 && (STRNCMP(&p[3], "nge", 3) != 0
1009 || !ASCII_ISALPHA(p[6])))))))
1010 || (p[0] == 'i'
1011 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n'
1012 && (!ASCII_ISALPHA(p[2])
1013 || (p[2] == 's'
1014 && (!ASCII_ISALPHA(p[3])
1015 || p[3] == 'e'))))))))
1016 skip_until = vim_strsave((char_u *)".");
1017
1018 // Check for ":python <<EOF", ":tcl <<EOF", etc.
1019 arg = skipwhite(skiptowhite(p));
1020 if (arg[0] == '<' && arg[1] =='<'
1021 && ((p[0] == 'p' && p[1] == 'y'
1022 && (!ASCII_ISALNUM(p[2]) || p[2] == 't'
1023 || ((p[2] == '3' || p[2] == 'x')
1024 && !ASCII_ISALPHA(p[3]))))
1025 || (p[0] == 'p' && p[1] == 'e'
1026 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r'))
1027 || (p[0] == 't' && p[1] == 'c'
1028 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l'))
1029 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a'
1030 && !ASCII_ISALPHA(p[3]))
1031 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b'
1032 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y'))
1033 || (p[0] == 'm' && p[1] == 'z'
1034 && (!ASCII_ISALPHA(p[2]) || p[2] == 's'))
1035 ))
1036 {
1037 // ":python <<" continues until a dot, like ":append"
1038 p = skipwhite(arg + 2);
1039 if (STRNCMP(p, "trim", 4) == 0)
1040 {
1041 // Ignore leading white space.
1042 p = skipwhite(p + 4);
1043 heredoc_trimmed = vim_strnsave(theline,
1044 skipwhite(theline) - theline);
1045 }
1046 if (*p == NUL)
1047 skip_until = vim_strsave((char_u *)".");
1048 else
1049 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1050 getline_options = GETLINE_NONE;
1051 is_heredoc = TRUE;
Bram Moolenaard881d152022-05-13 13:50:36 +01001052 if (eap->cmdidx == CMD_def && nesting == 0)
Bram Moolenaar20677332021-06-06 17:02:53 +02001053 heredoc_concat_len = newlines->ga_len + 1;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001054 }
1055
Bram Moolenaard881d152022-05-13 13:50:36 +01001056 if (!is_heredoc)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001057 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001058 // Check for ":cmd v =<< [trim] EOF"
1059 // and ":cmd [a, b] =<< [trim] EOF"
1060 // and "lines =<< [trim] EOF" for Vim9
1061 // Where "cmd" can be "let", "var", "final" or "const".
1062 arg = skipwhite(skiptowhite(p));
1063 if (*arg == '[')
1064 arg = vim_strchr(arg, ']');
1065 if (arg != NULL)
1066 {
1067 int found = (eap->cmdidx == CMD_def && arg[0] == '='
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001068 && arg[1] == '<' && arg[2] =='<');
1069
Bram Moolenaard881d152022-05-13 13:50:36 +01001070 if (!found)
1071 // skip over the argument after "cmd"
1072 arg = skipwhite(skiptowhite(arg));
1073 if (found || (arg[0] == '=' && arg[1] == '<'
1074 && arg[2] =='<'
1075 && (checkforcmd(&p, "let", 2)
1076 || checkforcmd(&p, "var", 3)
1077 || checkforcmd(&p, "final", 5)
1078 || checkforcmd(&p, "const", 5))))
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001079 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001080 p = skipwhite(arg + 3);
1081 while (TRUE)
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001082 {
Bram Moolenaard881d152022-05-13 13:50:36 +01001083 if (STRNCMP(p, "trim", 4) == 0)
1084 {
1085 // Ignore leading white space.
1086 p = skipwhite(p + 4);
1087 heredoc_trimmed = vim_strnsave(theline,
1088 skipwhite(theline) - theline);
1089 continue;
1090 }
1091 if (STRNCMP(p, "eval", 4) == 0)
1092 {
1093 // Ignore leading white space.
1094 p = skipwhite(p + 4);
1095 continue;
1096 }
1097 break;
Yegappan Lakshmananefbfa862022-04-17 12:47:40 +01001098 }
Bram Moolenaard881d152022-05-13 13:50:36 +01001099 skip_until = vim_strnsave(p, skiptowhite(p) - p);
1100 getline_options = GETLINE_NONE;
1101 is_heredoc = TRUE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001102 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001103 }
1104 }
1105 }
1106
1107 // Add the line to the function.
Yegappan Lakshmanan7c7e19c2022-04-09 11:09:07 +01001108 if (ga_grow_id(newlines, 1 + sourcing_lnum_off, aid_get_func) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001109 goto theend;
1110
Bram Moolenaar20677332021-06-06 17:02:53 +02001111 if (heredoc_concat_len > 0)
1112 {
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00001113 // For a :def function "python << EOF" concatenates all the lines,
Bram Moolenaar20677332021-06-06 17:02:53 +02001114 // to be used for the instruction later.
1115 ga_concat(&heredoc_ga, theline);
1116 ga_concat(&heredoc_ga, (char_u *)"\n");
1117 p = vim_strsave((char_u *)"");
1118 }
1119 else
1120 {
1121 // Copy the line to newly allocated memory. get_one_sourceline()
1122 // allocates 250 bytes per line, this saves 80% on average. The
1123 // cost is an extra alloc/free.
1124 p = vim_strsave(theline);
1125 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001126 if (p == NULL)
1127 goto theend;
1128 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p;
1129
1130 // Add NULL lines for continuation lines, so that the line count is
1131 // equal to the index in the growarray.
1132 while (sourcing_lnum_off-- > 0)
1133 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL;
1134
1135 // Check for end of eap->arg.
1136 if (line_arg != NULL && *line_arg == NUL)
1137 line_arg = NULL;
1138 }
1139
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001140 // Return OK when no error was detected.
1141 if (!did_emsg)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001142 ret = OK;
1143
1144theend:
1145 vim_free(skip_until);
1146 vim_free(heredoc_trimmed);
Bram Moolenaar20677332021-06-06 17:02:53 +02001147 vim_free(heredoc_ga.ga_data);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001148 need_wait_return |= saved_wait_return;
1149 return ret;
1150}
1151
1152/*
1153 * Handle the body of a lambda. *arg points to the "{", process statements
1154 * until the matching "}".
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001155 * When not evaluating "newargs" is NULL.
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001156 * When successful "rettv" is set to a funcref.
1157 */
1158 static int
1159lambda_function_body(
1160 char_u **arg,
1161 typval_T *rettv,
1162 evalarg_T *evalarg,
1163 garray_T *newargs,
1164 garray_T *argtypes,
1165 int varargs,
1166 garray_T *default_args,
1167 char_u *ret_type)
1168{
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001169 char_u *start = *arg;
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001170 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001171 garray_T *gap = &evalarg->eval_ga;
Bram Moolenaarecb66452021-05-18 15:09:18 +02001172 garray_T *freegap = &evalarg->eval_freega;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001173 ufunc_T *ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001174 exarg_T eap;
1175 garray_T newlines;
1176 char_u *cmdline = NULL;
1177 int ret = FAIL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001178 partial_T *pt;
1179 char_u *name;
1180 int lnum_save = -1;
1181 linenr_T sourcing_lnum_top = SOURCING_LNUM;
1182
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001183 *arg = skipwhite(*arg + 1);
1184 if (**arg == '|' || !ends_excmd2(start, *arg))
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001185 {
Bram Moolenaarf5f4e852022-09-22 22:03:14 +01001186 semsg(_(e_trailing_characters_str), *arg);
Bram Moolenaare98f60a2021-03-22 18:22:30 +01001187 return FAIL;
1188 }
1189
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001190 CLEAR_FIELD(eap);
1191 eap.cmdidx = CMD_block;
1192 eap.forceit = FALSE;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001193 eap.cmdlinep = &cmdline;
1194 eap.skip = !evaluate;
1195 if (evalarg->eval_cctx != NULL)
1196 fill_exarg_from_cctx(&eap, evalarg->eval_cctx);
1197 else
1198 {
1199 eap.getline = evalarg->eval_getline;
1200 eap.cookie = evalarg->eval_cookie;
1201 }
1202
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001203 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00001204 if (get_function_body(&eap, &newlines, NULL,
1205 &evalarg->eval_tofree_ga) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001206 goto erret;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001207
1208 // When inside a lambda must add the function lines to evalarg.eval_ga.
1209 evalarg->eval_break_count += newlines.ga_len;
1210 if (gap->ga_itemsize > 0)
1211 {
1212 int idx;
1213 char_u *last;
1214 size_t plen;
1215 char_u *pnl;
1216
1217 for (idx = 0; idx < newlines.ga_len; ++idx)
1218 {
1219 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]);
1220
Bram Moolenaarecb66452021-05-18 15:09:18 +02001221 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001222 goto erret;
1223
1224 // Going to concatenate the lines after parsing. For an empty or
1225 // comment line use an empty string.
1226 // Insert NL characters at the start of each line, the string will
1227 // be split again later in .get_lambda_tv().
1228 if (*p == NUL || vim9_comment_start(p))
1229 p = (char_u *)"";
1230 plen = STRLEN(p);
1231 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1232 if (pnl != NULL)
1233 mch_memmove(pnl + 1, p, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001234 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1235 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001236 }
Bram Moolenaarecb66452021-05-18 15:09:18 +02001237 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001238 goto erret;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001239 if (eap.nextcmd != NULL)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001240 // more is following after the "}", which was skipped
1241 last = cmdline;
1242 else
1243 // nothing is following the "}"
1244 last = (char_u *)"}";
1245 plen = STRLEN(last);
1246 pnl = vim_strnsave((char_u *)"\n", plen + 1);
1247 if (pnl != NULL)
1248 mch_memmove(pnl + 1, last, plen + 1);
Bram Moolenaarecb66452021-05-18 15:09:18 +02001249 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl;
1250 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001251 }
1252
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00001253 if (eap.nextcmd != NULL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001254 {
Bram Moolenaar844fb642021-10-23 13:32:30 +01001255 garray_T *tfgap = &evalarg->eval_tofree_ga;
1256
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001257 // Something comes after the "}".
1258 *arg = eap.nextcmd;
Bram Moolenaar67da21a2021-03-21 22:12:34 +01001259
1260 // "arg" points into cmdline, need to keep the line and free it later.
Bram Moolenaar844fb642021-10-23 13:32:30 +01001261 if (ga_grow(tfgap, 1) == OK)
1262 {
1263 ((char_u **)(tfgap->ga_data))[tfgap->ga_len++] = cmdline;
1264 evalarg->eval_using_cmdline = TRUE;
1265 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001266 }
1267 else
1268 *arg = (char_u *)"";
1269
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001270 if (!evaluate)
1271 {
1272 ret = OK;
1273 goto erret;
1274 }
1275
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001276 name = get_lambda_name();
1277 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
1278 if (ufunc == NULL)
1279 goto erret;
1280 set_ufunc_name(ufunc, name);
1281 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL)
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001282 goto erret;
Bram Moolenaar38453522021-11-28 22:00:12 +00001283 ufunc->uf_flags = FC_LAMBDA;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001284 ufunc->uf_refcount = 1;
1285 ufunc->uf_args = *newargs;
1286 newargs->ga_data = NULL;
1287 ufunc->uf_def_args = *default_args;
1288 default_args->ga_data = NULL;
1289 ufunc->uf_func_type = &t_func_any;
1290
1291 // error messages are for the first function line
1292 lnum_save = SOURCING_LNUM;
1293 SOURCING_LNUM = sourcing_lnum_top;
1294
1295 // parse argument types
1296 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL)
1297 {
1298 SOURCING_LNUM = lnum_save;
1299 goto erret;
1300 }
1301
1302 // parse the return type, if any
1303 if (parse_return_type(ufunc, ret_type) == FAIL)
1304 goto erret;
1305
1306 pt = ALLOC_CLEAR_ONE(partial_T);
1307 if (pt == NULL)
1308 goto erret;
1309 pt->pt_func = ufunc;
1310 pt->pt_refcount = 1;
1311
1312 ufunc->uf_lines = newlines;
1313 newlines.ga_data = NULL;
1314 if (sandbox)
1315 ufunc->uf_flags |= FC_SANDBOX;
1316 if (!ASCII_ISUPPER(*ufunc->uf_name))
1317 ufunc->uf_flags |= FC_VIM9;
1318 ufunc->uf_script_ctx = current_sctx;
1319 ufunc->uf_script_ctx_version = current_sctx.sc_version;
1320 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top;
1321 set_function_type(ufunc);
1322
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001323 function_using_block_scopes(ufunc, evalarg->eval_cstack);
1324
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001325 rettv->vval.v_partial = pt;
1326 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001327 ufunc = NULL;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001328 ret = OK;
1329
1330erret:
1331 if (lnum_save >= 0)
1332 SOURCING_LNUM = lnum_save;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001333 ga_clear_strings(&newlines);
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001334 if (newargs != NULL)
1335 ga_clear_strings(newargs);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001336 ga_clear_strings(default_args);
Bram Moolenaar79efa2e2021-03-27 15:40:11 +01001337 if (ufunc != NULL)
1338 {
1339 func_clear(ufunc, TRUE);
1340 func_free(ufunc, TRUE);
1341 }
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001342 return ret;
1343}
1344
1345/*
1346 * Parse a lambda expression and get a Funcref from "*arg" into "rettv".
Bram Moolenaar65c44152020-12-24 15:14:01 +01001347 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr"
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001348 * When "types_optional" is TRUE optionally take argument types.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001349 * Return OK or FAIL. Returns NOTDONE for dict or {expr}.
1350 */
1351 int
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001352get_lambda_tv(
1353 char_u **arg,
1354 typval_T *rettv,
1355 int types_optional,
1356 evalarg_T *evalarg)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001357{
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001358 int evaluate = evalarg != NULL
1359 && (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001360 garray_T newargs;
1361 garray_T newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001362 garray_T *pnewargs;
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001363 garray_T argtypes;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001364 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001365 ufunc_T *fp = NULL;
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001366 partial_T *pt = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001367 int varargs;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001368 char_u *ret_type = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001369 int ret;
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001370 char_u *s;
1371 char_u *start, *end;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001372 int *old_eval_lavars = eval_lavars_used;
1373 int eval_lavars = FALSE;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001374 char_u *tofree2 = NULL;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001375 int equal_arrow = **arg == '(';
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001376 int white_error = FALSE;
Bram Moolenaar0346b792021-01-31 22:18:29 +01001377 int called_emsg_start = called_emsg;
Bram Moolenaar4525a572022-02-13 11:57:33 +00001378 int vim9script = in_vim9script();
Bram Moolenaar521bf322022-05-06 15:47:07 +01001379 long start_lnum = SOURCING_LNUM;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001380
Bram Moolenaar4525a572022-02-13 11:57:33 +00001381 if (equal_arrow && !vim9script)
Bram Moolenaar65c44152020-12-24 15:14:01 +01001382 return NOTDONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001383
1384 ga_init(&newargs);
1385 ga_init(&newlines);
1386
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001387 // First, check if this is really a lambda expression. "->" or "=>" must
1388 // be found after the arguments.
Bram Moolenaarcef12702021-01-04 14:09:43 +01001389 s = *arg + 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001390 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001391 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar14ded112021-06-26 19:25:49 +02001392 NULL, &default_args, TRUE, NULL, NULL);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001393 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001394 {
1395 if (types_optional)
1396 ga_clear_strings(&argtypes);
Bram Moolenaar0346b792021-01-31 22:18:29 +01001397 return called_emsg == called_emsg_start ? NOTDONE : FAIL;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001398 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001399
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001400 // Parse the arguments for real.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001401 if (evaluate)
1402 pnewargs = &newargs;
1403 else
1404 pnewargs = NULL;
Bram Moolenaarcef12702021-01-04 14:09:43 +01001405 *arg += 1;
Bram Moolenaar65c44152020-12-24 15:14:01 +01001406 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001407 types_optional ? &argtypes : NULL, types_optional, evalarg,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001408 &varargs, &default_args,
1409 FALSE, NULL, NULL);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001410 if (ret == FAIL
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001411 || (s = skip_arrow(*arg, equal_arrow, &ret_type,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001412 equal_arrow || vim9script ? &white_error : NULL)) == NULL)
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001413 {
1414 if (types_optional)
1415 ga_clear_strings(&argtypes);
Bram Moolenaare5730bd2020-12-25 22:30:16 +01001416 ga_clear_strings(&newargs);
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001417 return white_error ? FAIL : NOTDONE;
Bram Moolenaar6dd41b12020-12-24 16:06:00 +01001418 }
Bram Moolenaarc754b4c2020-12-25 15:24:23 +01001419 *arg = s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001420
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001421 // Skipping over linebreaks may make "ret_type" invalid, make a copy.
1422 if (ret_type != NULL)
1423 {
1424 ret_type = vim_strsave(ret_type);
1425 tofree2 = ret_type;
1426 }
1427
Bram Moolenaare38eab22019-12-05 21:50:01 +01001428 // Set up a flag for checking local variables and arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001429 if (evaluate)
1430 eval_lavars_used = &eval_lavars;
1431
Bram Moolenaar65c44152020-12-24 15:14:01 +01001432 *arg = skipwhite_and_linebreak(*arg, evalarg);
1433
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001434 // Recognize "{" as the start of a function body.
1435 if (equal_arrow && **arg == '{')
Bram Moolenaar65c44152020-12-24 15:14:01 +01001436 {
Bram Moolenaarfed9e832021-04-10 21:38:38 +02001437 if (evalarg == NULL)
1438 // cannot happen?
1439 goto theend;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001440 SOURCING_LNUM = start_lnum; // used for where lambda is defined
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001441 if (lambda_function_body(arg, rettv, evalarg, pnewargs,
1442 types_optional ? &argtypes : NULL, varargs,
1443 &default_args, ret_type) == FAIL)
1444 goto errret;
1445 goto theend;
1446 }
1447 if (default_args.ga_len > 0)
1448 {
1449 emsg(_(e_cannot_use_default_values_in_lambda));
Bram Moolenaar65c44152020-12-24 15:14:01 +01001450 goto errret;
1451 }
1452
Bram Moolenaare38eab22019-12-05 21:50:01 +01001453 // Get the start and the end of the expression.
Bram Moolenaar8e2730a2020-07-08 22:01:49 +02001454 start = *arg;
1455 ret = skip_expr_concatenate(arg, &start, &end, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001456 if (ret == FAIL)
1457 goto errret;
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001458
Bram Moolenaar65c44152020-12-24 15:14:01 +01001459 if (!equal_arrow)
Bram Moolenaaree619e52020-03-28 21:38:06 +01001460 {
Bram Moolenaar65c44152020-12-24 15:14:01 +01001461 *arg = skipwhite_and_linebreak(*arg, evalarg);
1462 if (**arg != '}')
1463 {
Bram Moolenaarb09feaa2022-01-02 20:20:45 +00001464 semsg(_(e_expected_right_curly_str), *arg);
Bram Moolenaar65c44152020-12-24 15:14:01 +01001465 goto errret;
1466 }
1467 ++*arg;
Bram Moolenaaree619e52020-03-28 21:38:06 +01001468 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001469
1470 if (evaluate)
1471 {
Bram Moolenaare40fbc22020-06-27 18:06:45 +02001472 int len;
Bram Moolenaar38453522021-11-28 22:00:12 +00001473 int flags = FC_LAMBDA;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001474 char_u *p;
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001475 char_u *line_end;
Bram Moolenaar04b12692020-05-04 23:24:44 +02001476 char_u *name = get_lambda_name();
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001477
Bram Moolenaar47ed5532019-08-08 20:49:14 +02001478 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001479 if (fp == NULL)
1480 goto errret;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02001481 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001482 pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001483 if (pt == NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001484 goto errret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001485
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001486 ga_init2(&newlines, sizeof(char_u *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001487 if (ga_grow(&newlines, 1) == FAIL)
1488 goto errret;
1489
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001490 // If there are line breaks, we need to split up the string.
1491 line_end = vim_strchr(start, '\n');
Bram Moolenaar68686342021-07-28 15:54:54 +02001492 if (line_end == NULL || line_end > end)
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001493 line_end = end;
1494
1495 // Add "return " before the expression (or the first line).
1496 len = 7 + (int)(line_end - start) + 1;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001497 p = alloc(len);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001498 if (p == NULL)
1499 goto errret;
1500 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p;
1501 STRCPY(p, "return ");
Bram Moolenaar074f84c2021-05-18 11:47:44 +02001502 vim_strncpy(p + 7, start, line_end - start);
1503
1504 if (line_end != end)
1505 {
1506 // Add more lines, split by line breaks. Thus is used when a
1507 // lambda with { cmds } is encountered.
1508 while (*line_end == '\n')
1509 {
1510 if (ga_grow(&newlines, 1) == FAIL)
1511 goto errret;
1512 start = line_end + 1;
1513 line_end = vim_strchr(start, '\n');
1514 if (line_end == NULL)
1515 line_end = end;
1516 ((char_u **)(newlines.ga_data))[newlines.ga_len++] =
1517 vim_strnsave(start, line_end - start);
1518 }
1519 }
1520
Bram Moolenaarf10806b2020-04-02 18:34:35 +02001521 if (strstr((char *)p + 7, "a:") == NULL)
1522 // No a: variables are used for sure.
1523 flags |= FC_NOARGS;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001524
1525 fp->uf_refcount = 1;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001526 set_ufunc_name(fp, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001527 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02001528 ga_init(&fp->uf_def_args);
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001529 if (types_optional)
1530 {
Bram Moolenaar2a389082021-04-09 20:24:31 +02001531 if (parse_argument_types(fp, &argtypes,
Bram Moolenaar4525a572022-02-13 11:57:33 +00001532 vim9script && varargs) == FAIL)
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001533 goto errret;
1534 if (ret_type != NULL)
1535 {
1536 fp->uf_ret_type = parse_type(&ret_type,
1537 &fp->uf_type_list, TRUE);
1538 if (fp->uf_ret_type == NULL)
1539 goto errret;
1540 }
Bram Moolenaarca2f7e72020-12-31 13:39:54 +01001541 else
Bram Moolenaara9931532021-06-12 15:58:16 +02001542 fp->uf_ret_type = &t_unknown;
Bram Moolenaar9e68c322020-12-25 12:38:04 +01001543 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001544
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001545 fp->uf_lines = newlines;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001546 if (current_funccal != NULL && eval_lavars)
1547 {
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001548 flags |= FC_CLOSURE;
Bram Moolenaar58016442016-07-31 18:30:22 +02001549 if (register_closure(fp) == FAIL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001550 goto errret;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001551 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001552
1553#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001554 if (prof_def_func())
1555 func_do_profile(fp);
1556#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02001557 if (sandbox)
1558 flags |= FC_SANDBOX;
Bram Moolenaar767034c2021-04-09 17:24:52 +02001559 // In legacy script a lambda can be called with more args than
Bram Moolenaar2a389082021-04-09 20:24:31 +02001560 // uf_args.ga_len. In Vim9 script "...name" has to be used.
Bram Moolenaar4525a572022-02-13 11:57:33 +00001561 fp->uf_varargs = !vim9script || varargs;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02001562 fp->uf_flags = flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001563 fp->uf_calls = 0;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001564 fp->uf_script_ctx = current_sctx;
Bram Moolenaar521bf322022-05-06 15:47:07 +01001565 // Use the line number of the arguments.
1566 fp->uf_script_ctx.sc_lnum += start_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001567
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001568 function_using_block_scopes(fp, evalarg->eval_cstack);
1569
Bram Moolenaar437bafe2016-08-01 15:40:54 +02001570 pt->pt_func = fp;
1571 pt->pt_refcount = 1;
1572 rettv->vval.v_partial = pt;
1573 rettv->v_type = VAR_PARTIAL;
Bram Moolenaar057e84a2021-02-28 16:55:11 +01001574
1575 hash_add(&func_hashtab, UF2HIKEY(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001576 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001577
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001578theend:
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001579 eval_lavars_used = old_eval_lavars;
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001580 vim_free(tofree2);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001581 if (types_optional)
1582 ga_clear_strings(&argtypes);
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001583
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001584 return OK;
1585
1586errret:
1587 ga_clear_strings(&newargs);
1588 ga_clear_strings(&newlines);
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01001589 ga_clear_strings(&default_args);
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001590 if (types_optional)
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001591 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01001592 ga_clear_strings(&argtypes);
Bram Moolenaar15bbb8f2021-05-24 15:45:29 +02001593 if (fp != NULL)
1594 vim_free(fp->uf_arg_types);
1595 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001596 vim_free(fp);
Bram Moolenaar445e71c2019-02-14 13:43:36 +01001597 vim_free(pt);
Bram Moolenaarf898f7c2021-01-16 18:09:52 +01001598 vim_free(tofree2);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001599 eval_lavars_used = old_eval_lavars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001600 return FAIL;
1601}
1602
1603/*
1604 * Check if "name" is a variable of type VAR_FUNC. If so, return the function
1605 * name it contains, otherwise return "name".
1606 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set
1607 * "partialp".
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001608 * If "type" is not NULL and a Vim9 script-local variable is found look up the
1609 * type of the variable.
Bram Moolenaar937610b2022-01-19 17:21:29 +00001610 * If "new_function" is TRUE the name is for a new function.
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001611 * If "found_var" is not NULL and a variable was found set it to TRUE.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001612 */
1613 char_u *
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001614deref_func_name(
1615 char_u *name,
1616 int *lenp,
1617 partial_T **partialp,
1618 type_T **type,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001619 int no_autoload,
Bram Moolenaar937610b2022-01-19 17:21:29 +00001620 int new_function,
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001621 int *found_var)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001622{
1623 dictitem_T *v;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001624 typval_T *tv = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001625 int cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001626 char_u *s = NULL;
1627 hashtab_T *ht;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001628 int did_type = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001629
1630 if (partialp != NULL)
1631 *partialp = NULL;
1632
1633 cc = name[*lenp];
1634 name[*lenp] = NUL;
Bram Moolenaar20677332021-06-06 17:02:53 +02001635
Bram Moolenaar71f21932022-01-07 18:20:55 +00001636 v = find_var_also_in_script(name, &ht, no_autoload);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001637 name[*lenp] = cc;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001638 if (v != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001639 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001640 tv = &v->di_tv;
1641 }
1642 else if (in_vim9script() || STRNCMP(name, "s:", 2) == 0)
1643 {
1644 imported_T *import;
1645 char_u *p = name;
1646 int len = *lenp;
1647
1648 if (STRNCMP(name, "s:", 2) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001649 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001650 p = name + 2;
1651 len -= 2;
1652 }
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00001653 import = find_imported(p, len, FALSE);
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001654
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001655 // imported function from another script
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001656 if (import != NULL)
1657 {
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001658 name[len] = NUL;
Bram Moolenaar937610b2022-01-19 17:21:29 +00001659 if (new_function)
1660 semsg(_(e_redefining_imported_item_str), name);
1661 else
1662 semsg(_(e_cannot_use_str_itself_it_is_imported), name);
Bram Moolenaard5f400c2022-01-06 21:10:28 +00001663 name[len] = cc;
1664 *lenp = 0;
1665 return (char_u *)""; // just in case
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001666 }
1667 }
1668
1669 if (tv != NULL)
1670 {
Bram Moolenaar2ef91562021-12-11 16:14:07 +00001671 if (found_var != NULL)
1672 *found_var = TRUE;
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001673 if (tv->v_type == VAR_FUNC)
1674 {
1675 if (tv->vval.v_string == NULL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001676 {
1677 *lenp = 0;
1678 return (char_u *)""; // just in case
1679 }
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001680 s = tv->vval.v_string;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001681 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001682 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001683
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001684 if (tv->v_type == VAR_PARTIAL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001685 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001686 partial_T *pt = tv->vval.v_partial;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001687
1688 if (pt == NULL)
1689 {
1690 *lenp = 0;
1691 return (char_u *)""; // just in case
1692 }
1693 if (partialp != NULL)
1694 *partialp = pt;
1695 s = partial_name(pt);
1696 *lenp = (int)STRLEN(s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001697 }
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001698
1699 if (s != NULL)
1700 {
Bram Moolenaar5fe07d22021-10-22 22:17:53 +01001701 if (!did_type && type != NULL && ht == get_script_local_ht())
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001702 {
Bram Moolenaar7a411a32022-04-04 14:58:06 +01001703 svar_T *sv = find_typval_in_script(tv, 0, TRUE);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01001704
1705 if (sv != NULL)
1706 *type = sv->sv_type;
1707 }
1708 return s;
1709 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001710 }
1711
1712 return name;
1713}
1714
1715/*
1716 * Give an error message with a function name. Handle <SNR> things.
1717 * "ermsg" is to be passed without translation, use N_() instead of _().
1718 */
Bram Moolenaar4c054e92019-11-10 00:13:50 +01001719 void
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001720emsg_funcname(char *ermsg, char_u *name)
1721{
Bram Moolenaar54598062022-01-13 12:05:09 +00001722 char_u *p = name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001723
Bram Moolenaar54598062022-01-13 12:05:09 +00001724 if (name[0] == K_SPECIAL && name[1] != NUL && name[2] != NUL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001725 p = concat_str((char_u *)"<SNR>", name + 3);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001726 semsg(_(ermsg), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001727 if (p != name)
1728 vim_free(p);
1729}
1730
1731/*
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001732 * Get function arguments at "*arg" and advance it.
1733 * Return them in "*argvars[MAX_FUNC_ARGS + 1]" and the count in "argcount".
Bram Moolenaar806a2732022-09-04 15:40:36 +01001734 * On failure FAIL is returned but the "argvars[argcount]" are still set.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001735 */
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001736 static int
1737get_func_arguments(
1738 char_u **arg,
1739 evalarg_T *evalarg,
1740 int partial_argc,
1741 typval_T *argvars,
1742 int *argcount)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001743{
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001744 char_u *argp = *arg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001745 int ret = OK;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001746 int vim9script = in_vim9script();
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001747 int evaluate = evalarg == NULL
1748 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001749
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001750 while (*argcount < MAX_FUNC_ARGS - partial_argc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001751 {
Bram Moolenaare6b53242020-07-01 17:28:33 +02001752 // skip the '(' or ',' and possibly line breaks
1753 argp = skipwhite_and_linebreak(argp + 1, evalarg);
1754
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001755 if (*argp == ')' || *argp == ',' || *argp == NUL)
1756 break;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001757 if (eval1(&argp, &argvars[*argcount], evalarg) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001758 {
1759 ret = FAIL;
1760 break;
1761 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001762 ++*argcount;
Bram Moolenaar9d489562020-07-30 20:08:50 +02001763 // The comma should come right after the argument, but this wasn't
1764 // checked previously, thus only enforce it in Vim9 script.
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001765 if (vim9script)
1766 {
1767 if (*argp != ',' && *skipwhite(argp) == ',')
1768 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001769 if (evaluate)
1770 semsg(_(e_no_white_space_allowed_before_str_str),
1771 ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001772 ret = FAIL;
1773 break;
1774 }
1775 }
1776 else
Bram Moolenaar9d489562020-07-30 20:08:50 +02001777 argp = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001778 if (*argp != ',')
1779 break;
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001780 if (vim9script && !IS_WHITE_OR_NUL(argp[1]))
1781 {
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001782 if (evaluate)
1783 semsg(_(e_white_space_required_after_str_str), ",", argp);
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02001784 ret = FAIL;
1785 break;
1786 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001787 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001788
Bram Moolenaare6b53242020-07-01 17:28:33 +02001789 argp = skipwhite_and_linebreak(argp, evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001790 if (*argp == ')')
1791 ++argp;
1792 else
1793 ret = FAIL;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01001794 *arg = argp;
1795 return ret;
1796}
1797
1798/*
1799 * Call a function and put the result in "rettv".
1800 * Return OK or FAIL.
1801 */
1802 int
1803get_func_tv(
1804 char_u *name, // name of the function
1805 int len, // length of "name" or -1 to use strlen()
1806 typval_T *rettv,
1807 char_u **arg, // argument, pointing to the '('
1808 evalarg_T *evalarg, // for line continuation
1809 funcexe_T *funcexe) // various values
1810{
1811 char_u *argp;
1812 int ret = OK;
1813 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
1814 int argcount = 0; // number of arguments found
1815 int vim9script = in_vim9script();
1816 int evaluate = evalarg == NULL
1817 ? FALSE : (evalarg->eval_flags & EVAL_EVALUATE);
1818
1819 argp = *arg;
1820 ret = get_func_arguments(&argp, evalarg,
1821 (funcexe->fe_partial == NULL ? 0 : funcexe->fe_partial->pt_argc),
1822 argvars, &argcount);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001823
1824 if (ret == OK)
1825 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001826 int i = 0;
1827 int did_emsg_before = did_emsg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001828
1829 if (get_vim_var_nr(VV_TESTING))
1830 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01001831 // Prepare for calling test_garbagecollect_now(), need to know
1832 // what variables are used on the call stack.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001833 if (funcargs.ga_itemsize == 0)
Bram Moolenaar04935fb2022-01-08 16:19:22 +00001834 ga_init2(&funcargs, sizeof(typval_T *), 50);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001835 for (i = 0; i < argcount; ++i)
1836 if (ga_grow(&funcargs, 1) == OK)
1837 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] =
1838 &argvars[i];
1839 }
1840
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02001841 ret = call_func(name, len, rettv, argcount, argvars, funcexe);
Bram Moolenaar4525a572022-02-13 11:57:33 +00001842 if (vim9script && did_emsg > did_emsg_before)
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001843 {
Bram Moolenaar327d3ee2021-07-28 19:34:14 +02001844 // An error in a builtin function does not return FAIL, but we do
1845 // want to abort further processing if an error was given.
1846 ret = FAIL;
Bram Moolenaar6e850a62021-07-28 22:21:23 +02001847 clear_tv(rettv);
1848 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001849
1850 funcargs.ga_len -= i;
1851 }
Bram Moolenaar5e6b9882022-01-10 18:50:52 +00001852 else if (!aborting() && evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001853 {
1854 if (argcount == MAX_FUNC_ARGS)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001855 emsg_funcname(e_too_many_arguments_for_function_str_2, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001856 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00001857 emsg_funcname(e_invalid_arguments_for_function_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001858 }
1859
1860 while (--argcount >= 0)
1861 clear_tv(&argvars[argcount]);
1862
Bram Moolenaar4525a572022-02-13 11:57:33 +00001863 if (vim9script)
Bram Moolenaar8294d492020-08-10 22:40:56 +02001864 *arg = argp;
1865 else
1866 *arg = skipwhite(argp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001867 return ret;
1868}
1869
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001870/*
1871 * Return TRUE if "p" starts with "<SID>" or "s:".
1872 * Only works if eval_fname_script() returned non-zero for "p"!
1873 */
1874 static int
1875eval_fname_sid(char_u *p)
1876{
1877 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I');
1878}
1879
1880/*
1881 * In a script change <SID>name() and s:name() to K_SNR 123_name().
1882 * Change <SNR>123_name() to K_SNR 123_name().
1883 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001884 * and set "tofree".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001885 */
Bram Moolenaar5cab73f2020-02-06 19:25:19 +01001886 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001887fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error)
1888{
1889 int llen;
1890 char_u *fname;
1891 int i;
1892
1893 llen = eval_fname_script(name);
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001894 if (llen == 0)
1895 return name; // no prefix
1896
1897 fname_buf[0] = K_SPECIAL;
1898 fname_buf[1] = KS_EXTRA;
1899 fname_buf[2] = (int)KE_SNR;
1900 i = 3;
1901 if (eval_fname_sid(name)) // "<SID>" or "s:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001902 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001903 if (current_sctx.sc_sid <= 0)
1904 *error = FCERR_SCRIPT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001905 else
1906 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001907 sprintf((char *)fname_buf + 3, "%ld_",
1908 (long)current_sctx.sc_sid);
1909 i = (int)STRLEN(fname_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001910 }
1911 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001912 if (i + STRLEN(name + llen) < FLEN_FIXED)
1913 {
1914 STRCPY(fname_buf + i, name + llen);
1915 fname = fname_buf;
1916 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001917 else
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001918 {
1919 fname = alloc(i + STRLEN(name + llen) + 1);
1920 if (fname == NULL)
1921 *error = FCERR_OTHER;
1922 else
1923 {
1924 *tofree = fname;
1925 mch_memmove(fname, fname_buf, (size_t)i);
1926 STRCPY(fname + i, name + llen);
1927 }
1928 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02001929 return fname;
1930}
1931
1932/*
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001933 * Concatenate the script ID and function name into "<SNR>99_name".
1934 * "buffer" must have size MAX_FUNC_NAME_LEN.
1935 */
1936 void
1937func_name_with_sid(char_u *name, int sid, char_u *buffer)
1938{
1939 // A script-local function is stored as "<SNR>99_name".
1940 buffer[0] = K_SPECIAL;
1941 buffer[1] = KS_EXTRA;
1942 buffer[2] = (int)KE_SNR;
1943 vim_snprintf((char *)buffer + 3, MAX_FUNC_NAME_LEN - 3, "%ld_%s",
1944 (long)sid, name);
1945}
1946
1947/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001948 * Find a function "name" in script "sid".
1949 */
1950 static ufunc_T *
1951find_func_with_sid(char_u *name, int sid)
1952{
Bram Moolenaarb8822442022-01-11 15:24:05 +00001953 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001954 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001955
Bram Moolenaarb8822442022-01-11 15:24:05 +00001956 if (!SCRIPT_ID_VALID(sid))
1957 return NULL; // not in a script
1958
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001959 func_name_with_sid(name, sid, buffer);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01001960 hi = hash_find(&func_hashtab, buffer);
1961 if (!HASHITEM_EMPTY(hi))
1962 return HI2UF(hi);
Bram Moolenaarb8822442022-01-11 15:24:05 +00001963 return NULL;
1964}
1965
1966/*
1967 * Find a function "name" in script "sid" prefixing the autoload prefix.
1968 */
1969 static ufunc_T *
1970find_func_with_prefix(char_u *name, int sid)
1971{
1972 hashitem_T *hi;
Bram Moolenaarc0ceeeb2022-03-30 21:12:27 +01001973 char_u buffer[MAX_FUNC_NAME_LEN];
Bram Moolenaarb8822442022-01-11 15:24:05 +00001974 scriptitem_T *si;
1975
Bram Moolenaar848fadd2022-01-30 15:28:30 +00001976 if (vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaarb8822442022-01-11 15:24:05 +00001977 return NULL; // already has the prefix
1978 if (!SCRIPT_ID_VALID(sid))
1979 return NULL; // not in a script
1980 si = SCRIPT_ITEM(sid);
1981 if (si->sn_autoload_prefix != NULL)
1982 {
1983 size_t len = STRLEN(si->sn_autoload_prefix) + STRLEN(name) + 1;
1984 char_u *auto_name;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00001985 char_u *namep;
1986
1987 // skip a "<SNR>99_" prefix
1988 namep = untrans_function_name(name);
1989 if (namep == NULL)
1990 namep = name;
Bram Moolenaarb8822442022-01-11 15:24:05 +00001991
1992 // An exported function in an autoload script is stored as
1993 // "dir#path#name".
1994 if (len < sizeof(buffer))
1995 auto_name = buffer;
1996 else
1997 auto_name = alloc(len);
1998 if (auto_name != NULL)
1999 {
2000 vim_snprintf((char *)auto_name, len, "%s%s",
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00002001 si->sn_autoload_prefix, namep);
Bram Moolenaarb8822442022-01-11 15:24:05 +00002002 hi = hash_find(&func_hashtab, auto_name);
2003 if (auto_name != buffer)
2004 vim_free(auto_name);
2005 if (!HASHITEM_EMPTY(hi))
2006 return HI2UF(hi);
2007 }
2008 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002009
2010 return NULL;
2011}
2012
2013/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002014 * Find a function by name, return pointer to it in ufuncs.
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002015 * When "flags" has FFED_IS_GLOBAL don't find script-local or imported
2016 * functions.
2017 * When "flags" has "FFED_NO_GLOBAL" don't find global functions.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002018 * Return NULL for unknown function.
2019 */
Bram Moolenaarce658352020-07-31 23:47:12 +02002020 ufunc_T *
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002021find_func_even_dead(char_u *name, int flags)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002022{
2023 hashitem_T *hi;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002024 ufunc_T *func;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002025
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002026 if ((flags & FFED_IS_GLOBAL) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002027 {
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002028 // Find script-local function before global one.
2029 if (in_vim9script() && eval_isnamec1(*name)
2030 && (name[1] != ':' || *name == 's'))
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002031 {
Bram Moolenaar33b968d2021-12-13 11:31:04 +00002032 func = find_func_with_sid(name[0] == 's' && name[1] == ':'
2033 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar9721fb42020-06-11 23:10:46 +02002034 if (func != NULL)
2035 return func;
2036 }
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00002037 if (in_vim9script() && STRNCMP(name, "<SNR>", 5) == 0)
2038 {
2039 char_u *p = name + 5;
2040 long sid;
2041
2042 // printable "<SNR>123_Name" form
2043 sid = getdigits(&p);
2044 if (*p == '_')
2045 {
2046 func = find_func_with_sid(p + 1, (int)sid);
2047 if (func != NULL)
2048 return func;
2049 }
2050 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002051 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002052
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002053 if ((flags & FFED_NO_GLOBAL) == 0)
2054 {
2055 hi = hash_find(&func_hashtab,
Bram Moolenaara26b9702020-04-18 19:53:28 +02002056 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name);
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002057 if (!HASHITEM_EMPTY(hi))
2058 return HI2UF(hi);
2059 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002060
Bram Moolenaarb8822442022-01-11 15:24:05 +00002061 // Find autoload function if this is an autoload script.
2062 return find_func_with_prefix(name[0] == 's' && name[1] == ':'
2063 ? name + 2 : name, current_sctx.sc_sid);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002064}
2065
2066/*
2067 * Find a function by name, return pointer to it in ufuncs.
2068 * "cctx" is passed in a :def function to find imported functions.
2069 * Return NULL for unknown or dead function.
2070 */
2071 ufunc_T *
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002072find_func(char_u *name, int is_global)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002073{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002074 ufunc_T *fp = find_func_even_dead(name, is_global ? FFED_IS_GLOBAL : 0);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002075
2076 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0)
2077 return fp;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002078 return NULL;
2079}
2080
2081/*
Bram Moolenaar0f769812020-09-12 18:32:34 +02002082 * Return TRUE if "ufunc" is a global function.
2083 */
2084 int
2085func_is_global(ufunc_T *ufunc)
2086{
2087 return ufunc->uf_name[0] != K_SPECIAL;
2088}
2089
2090/*
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002091 * Return TRUE if "ufunc" must be called with a g: prefix in Vim9 script.
2092 */
2093 int
2094func_requires_g_prefix(ufunc_T *ufunc)
2095{
2096 return ufunc->uf_name[0] != K_SPECIAL
2097 && (ufunc->uf_flags & FC_LAMBDA) == 0
Bram Moolenaarcfb4d4f2022-09-30 19:19:04 +01002098 && vim_strchr(ufunc->uf_name, AUTOLOAD_CHAR) == NULL
2099 && !isdigit(ufunc->uf_name[0]);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00002100}
2101
2102/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002103 * Copy the function name of "fp" to buffer "buf".
2104 * "buf" must be able to hold the function name plus three bytes.
2105 * Takes care of script-local function names.
2106 */
2107 static void
2108cat_func_name(char_u *buf, ufunc_T *fp)
2109{
Bram Moolenaar0f769812020-09-12 18:32:34 +02002110 if (!func_is_global(fp))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002111 {
2112 STRCPY(buf, "<SNR>");
2113 STRCAT(buf, fp->uf_name + 3);
2114 }
2115 else
2116 STRCPY(buf, fp->uf_name);
2117}
2118
2119/*
2120 * Add a number variable "name" to dict "dp" with value "nr".
2121 */
2122 static void
2123add_nr_var(
2124 dict_T *dp,
2125 dictitem_T *v,
2126 char *name,
2127 varnumber_T nr)
2128{
2129 STRCPY(v->di_key, name);
2130 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
2131 hash_add(&dp->dv_hashtab, DI2HIKEY(v));
2132 v->di_tv.v_type = VAR_NUMBER;
2133 v->di_tv.v_lock = VAR_FIXED;
2134 v->di_tv.vval.v_number = nr;
2135}
2136
2137/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002138 * Free "fc".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002139 */
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002140 static void
2141free_funccal(funccall_T *fc)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002142{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002143 int i;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002144
Bram Moolenaarca16c602022-09-06 18:57:08 +01002145 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002146 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002147 ufunc_T *fp = ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i];
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002148
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002149 // When garbage collecting a funccall_T may be freed before the
2150 // function that references it, clear its uf_scoped field.
2151 // The function may have been redefined and point to another
2152 // funccall_T, don't clear it then.
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02002153 if (fp != NULL && fp->uf_scoped == fc)
2154 fp->uf_scoped = NULL;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002155 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002156 ga_clear(&fc->fc_ufuncs);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002157
Bram Moolenaarca16c602022-09-06 18:57:08 +01002158 func_ptr_unref(fc->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002159 vim_free(fc);
2160}
2161
2162/*
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002163 * Free "fc" and what it contains.
2164 * Can be called only when "fc" is kept beyond the period of it called,
2165 * i.e. after cleanup_function_call(fc).
2166 */
2167 static void
2168free_funccal_contents(funccall_T *fc)
2169{
2170 listitem_T *li;
2171
2172 // Free all l: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002173 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002174
2175 // Free all a: variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002176 vars_clear(&fc->fc_l_avars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002177
2178 // Free the a:000 variables.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002179 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002180 clear_tv(&li->li_tv);
2181
2182 free_funccal(fc);
2183}
2184
2185/*
Bram Moolenaar6914c642017-04-01 21:21:30 +02002186 * Handle the last part of returning from a function: free the local hashtable.
2187 * Unless it is still in use by a closure.
2188 */
2189 static void
2190cleanup_function_call(funccall_T *fc)
2191{
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002192 int may_free_fc = fc->fc_refcount <= 0;
2193 int free_fc = TRUE;
2194
Bram Moolenaarca16c602022-09-06 18:57:08 +01002195 current_funccal = fc->fc_caller;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002196
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002197 // Free all l: variables if not referred.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002198 if (may_free_fc && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT)
2199 vars_clear(&fc->fc_l_vars.dv_hashtab);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002200 else
2201 free_fc = FALSE;
2202
2203 // If the a:000 list and the l: and a: dicts are not referenced and
2204 // there is no closure using it, we can free the funccall_T and what's
2205 // in it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002206 if (may_free_fc && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)
2207 vars_clear_ext(&fc->fc_l_avars.dv_hashtab, FALSE);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002208 else
2209 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002210 int todo;
2211 hashitem_T *hi;
2212 dictitem_T *di;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002213
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002214 free_fc = FALSE;
Bram Moolenaar6914c642017-04-01 21:21:30 +02002215
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002216 // Make a copy of the a: variables, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002217 todo = (int)fc->fc_l_avars.dv_hashtab.ht_used;
2218 for (hi = fc->fc_l_avars.dv_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002219 {
2220 if (!HASHITEM_EMPTY(hi))
2221 {
2222 --todo;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002223 di = HI2DI(hi);
2224 copy_tv(&di->di_tv, &di->di_tv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02002225 }
2226 }
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002227 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002228
Bram Moolenaarca16c602022-09-06 18:57:08 +01002229 if (may_free_fc && fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT)
2230 fc->fc_l_varlist.lv_first = NULL;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002231 else
2232 {
2233 listitem_T *li;
2234
2235 free_fc = FALSE;
2236
2237 // Make a copy of the a:000 items, since we didn't do that above.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002238 FOR_ALL_LIST_ITEMS(&fc->fc_l_varlist, li)
Bram Moolenaar6914c642017-04-01 21:21:30 +02002239 copy_tv(&li->li_tv, &li->li_tv);
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002240 }
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002241
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002242 if (free_fc)
2243 free_funccal(fc);
2244 else
2245 {
2246 static int made_copy = 0;
2247
2248 // "fc" is still in use. This can happen when returning "a:000",
2249 // assigning "l:" to a global variable or defining a closure.
2250 // Link "fc" in the list for garbage collection later.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002251 fc->fc_caller = previous_funccal;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002252 previous_funccal = fc;
2253
2254 if (want_garbage_collect)
2255 // If garbage collector is ready, clear count.
2256 made_copy = 0;
2257 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc)))
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002258 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002259 // We have made a lot of copies, worth 4 Mbyte. This can happen
2260 // when repetitively calling a function that creates a reference to
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002261 // itself somehow. Call the garbage collector soon to avoid using
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002262 // too much memory.
2263 made_copy = 0;
Bram Moolenaar889da2f2019-02-02 14:02:30 +01002264 want_garbage_collect = TRUE;
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002265 }
Bram Moolenaar6914c642017-04-01 21:21:30 +02002266 }
2267}
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002268
2269/*
Bram Moolenaar57bc2332021-12-15 12:06:43 +00002270 * Return TRUE if "name" is a numbered function, ignoring a "g:" prefix.
2271 */
2272 static int
2273numbered_function(char_u *name)
2274{
2275 return isdigit(*name)
2276 || (name[0] == 'g' && name[1] == ':' && isdigit(name[2]));
2277}
2278
2279/*
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002280 * There are two kinds of function names:
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002281 * 1. ordinary names, function defined with :function or :def;
2282 * can start with "<SNR>123_" literally or with K_SPECIAL.
2283 * 2. Numbered functions and lambdas: "<lambda>123"
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002284 * For the first we only count the name stored in func_hashtab as a reference,
2285 * using function() does not count as a reference, because the function is
2286 * looked up by name.
2287 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002288 int
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002289func_name_refcount(char_u *name)
2290{
Bram Moolenaarfb43cfc2022-03-11 18:54:17 +00002291 return numbered_function(name) || (name[0] == '<' && name[1] == 'l');
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002292}
2293
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002294/*
2295 * Unreference "fc": decrement the reference count and free it when it
2296 * becomes zero. "fp" is detached from "fc".
2297 * When "force" is TRUE we are exiting.
2298 */
2299 static void
2300funccal_unref(funccall_T *fc, ufunc_T *fp, int force)
2301{
2302 funccall_T **pfc;
2303 int i;
2304
2305 if (fc == NULL)
2306 return;
2307
2308 if (--fc->fc_refcount <= 0 && (force || (
Bram Moolenaarca16c602022-09-06 18:57:08 +01002309 fc->fc_l_varlist.lv_refcount == DO_NOT_FREE_CNT
2310 && fc->fc_l_vars.dv_refcount == DO_NOT_FREE_CNT
2311 && fc->fc_l_avars.dv_refcount == DO_NOT_FREE_CNT)))
2312 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->fc_caller)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002313 {
2314 if (fc == *pfc)
2315 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002316 *pfc = fc->fc_caller;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002317 free_funccal_contents(fc);
2318 return;
2319 }
2320 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002321 for (i = 0; i < fc->fc_ufuncs.ga_len; ++i)
2322 if (((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] == fp)
2323 ((ufunc_T **)(fc->fc_ufuncs.ga_data))[i] = NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002324}
2325
2326/*
2327 * Remove the function from the function hashtable. If the function was
2328 * deleted while it still has references this was already done.
2329 * Return TRUE if the entry was deleted, FALSE if it wasn't found.
2330 */
2331 static int
2332func_remove(ufunc_T *fp)
2333{
2334 hashitem_T *hi;
2335
2336 // Return if it was already virtually deleted.
2337 if (fp->uf_flags & FC_DEAD)
2338 return FALSE;
2339
2340 hi = hash_find(&func_hashtab, UF2HIKEY(fp));
2341 if (!HASHITEM_EMPTY(hi))
2342 {
2343 // When there is a def-function index do not actually remove the
2344 // function, so we can find the index when defining the function again.
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002345 // Do remove it when it's a copy.
2346 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0)
Bram Moolenaarc970e422021-03-17 15:03:04 +01002347 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002348 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01002349 return FALSE;
2350 }
2351 hash_remove(&func_hashtab, hi);
2352 fp->uf_flags |= FC_DELETED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002353 return TRUE;
2354 }
2355 return FALSE;
2356}
2357
2358 static void
2359func_clear_items(ufunc_T *fp)
2360{
2361 ga_clear_strings(&(fp->uf_args));
2362 ga_clear_strings(&(fp->uf_def_args));
2363 ga_clear_strings(&(fp->uf_lines));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002364 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02002365 VIM_CLEAR(fp->uf_block_ids);
Bram Moolenaar292b90d2020-03-18 15:23:16 +01002366 VIM_CLEAR(fp->uf_va_name);
Bram Moolenaar6110e792020-07-08 19:35:21 +02002367 clear_type_list(&fp->uf_type_list);
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002368
2369 // Increment the refcount of this function to avoid it being freed
2370 // recursively when the partial is freed.
2371 fp->uf_refcount += 3;
Bram Moolenaarf112f302020-12-20 17:47:52 +01002372 partial_unref(fp->uf_partial);
2373 fp->uf_partial = NULL;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002374 fp->uf_refcount -= 3;
Bram Moolenaar801ab062020-06-25 19:27:56 +02002375
2376#ifdef FEAT_LUA
2377 if (fp->uf_cb_free != NULL)
2378 {
2379 fp->uf_cb_free(fp->uf_cb_state);
2380 fp->uf_cb_free = NULL;
2381 }
2382
2383 fp->uf_cb_state = NULL;
2384 fp->uf_cb = NULL;
2385#endif
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002386#ifdef FEAT_PROFILE
2387 VIM_CLEAR(fp->uf_tml_count);
2388 VIM_CLEAR(fp->uf_tml_total);
2389 VIM_CLEAR(fp->uf_tml_self);
2390#endif
2391}
2392
2393/*
2394 * Free all things that a function contains. Does not free the function
2395 * itself, use func_free() for that.
2396 * When "force" is TRUE we are exiting.
2397 */
2398 static void
2399func_clear(ufunc_T *fp, int force)
2400{
2401 if (fp->uf_cleared)
2402 return;
2403 fp->uf_cleared = TRUE;
2404
2405 // clear this function
2406 func_clear_items(fp);
2407 funccal_unref(fp->uf_scoped, fp, force);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002408 unlink_def_function(fp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002409}
2410
2411/*
2412 * Free a function and remove it from the list of functions. Does not free
2413 * what a function contains, call func_clear() first.
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002414 * When "force" is TRUE we are exiting.
Bram Moolenaara05e5242020-09-19 18:19:19 +02002415 * Returns OK when the function was actually freed.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002416 */
Bram Moolenaara05e5242020-09-19 18:19:19 +02002417 static int
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002418func_free(ufunc_T *fp, int force)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002419{
2420 // Only remove it when not done already, otherwise we would remove a newer
2421 // version of the function with the same name.
2422 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0)
2423 func_remove(fp);
2424
Bram Moolenaarf7779c62020-05-03 15:38:16 +02002425 if ((fp->uf_flags & FC_DEAD) == 0 || force)
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002426 {
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002427 if (fp->uf_dfunc_idx > 0)
2428 unlink_def_function(fp);
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002429 VIM_CLEAR(fp->uf_name_exp);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002430 vim_free(fp);
Bram Moolenaara05e5242020-09-19 18:19:19 +02002431 return OK;
Bram Moolenaarc4ce36d2020-08-14 17:08:15 +02002432 }
Bram Moolenaara05e5242020-09-19 18:19:19 +02002433 return FAIL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002434}
2435
2436/*
2437 * Free all things that a function contains and free the function itself.
2438 * When "force" is TRUE we are exiting.
2439 */
Bram Moolenaar2336c372021-12-06 15:06:54 +00002440 void
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002441func_clear_free(ufunc_T *fp, int force)
2442{
2443 func_clear(fp, force);
Bram Moolenaarfdeab652020-09-19 15:16:50 +02002444 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name)
2445 || (fp->uf_flags & FC_COPY))
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002446 func_free(fp, force);
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02002447 else
2448 fp->uf_flags |= FC_DEAD;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002449}
2450
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002451/*
2452 * Copy already defined function "lambda" to a new function with name "global".
2453 * This is for when a compiled function defines a global function.
2454 */
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002455 int
Bram Moolenaar8fa745e2022-09-16 19:04:24 +01002456copy_lambda_to_global_func(
Bram Moolenaarcc341812022-09-19 15:54:34 +01002457 char_u *lambda,
2458 char_u *global,
2459 loopvarinfo_T *loopvarinfo,
2460 ectx_T *ectx)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002461{
Bram Moolenaaracc4b562022-01-24 13:54:45 +00002462 ufunc_T *ufunc = find_func_even_dead(lambda, FFED_IS_GLOBAL);
Bram Moolenaarf112f302020-12-20 17:47:52 +01002463 ufunc_T *fp = NULL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002464
2465 if (ufunc == NULL)
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002466 {
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002467 semsg(_(e_lambda_function_not_found_str), lambda);
2468 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002469 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002470
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00002471 fp = find_func(global, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002472 if (fp != NULL)
2473 {
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002474 // TODO: handle ! to overwrite
Bram Moolenaar1a992222021-12-31 17:25:48 +00002475 semsg(_(e_function_str_already_exists_add_bang_to_replace), global);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002476 return FAIL;
2477 }
2478
2479 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1);
2480 if (fp == NULL)
2481 return FAIL;
2482
2483 fp->uf_varargs = ufunc->uf_varargs;
2484 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY;
2485 fp->uf_def_status = ufunc->uf_def_status;
2486 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx;
2487 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL
2488 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args)
2489 == FAIL
2490 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL)
2491 goto failed;
2492
2493 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL
2494 : vim_strsave(ufunc->uf_name_exp);
2495 if (ufunc->uf_arg_types != NULL)
2496 {
2497 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len);
2498 if (fp->uf_arg_types == NULL)
2499 goto failed;
2500 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types,
2501 sizeof(type_T *) * fp->uf_args.ga_len);
2502 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002503 if (ufunc->uf_va_name != NULL)
2504 {
2505 fp->uf_va_name = vim_strsave(ufunc->uf_va_name);
2506 if (fp->uf_va_name == NULL)
2507 goto failed;
2508 }
2509 fp->uf_ret_type = ufunc->uf_ret_type;
2510
2511 fp->uf_refcount = 1;
2512 STRCPY(fp->uf_name, global);
2513 hash_add(&func_hashtab, UF2HIKEY(fp));
2514
2515 // the referenced dfunc_T is now used one more time
2516 link_def_function(fp);
2517
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002518 // Create a partial to store the context of the function where it was
2519 // instantiated. Only needs to be done once. Do this on the original
2520 // function, "dfunc->df_ufunc" will point to it.
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002521 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL)
2522 {
2523 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
2524
2525 if (pt == NULL)
2526 goto failed;
Bram Moolenaarcc341812022-09-19 15:54:34 +01002527 if (fill_partial_and_closure(pt, ufunc, loopvarinfo, ectx) == FAIL)
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002528 {
Bram Moolenaar6ed545e2022-05-09 20:09:23 +01002529 vim_free(pt);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002530 goto failed;
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01002531 }
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002532 ufunc->uf_partial = pt;
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002533 }
2534
2535 return OK;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002536
2537failed:
2538 func_clear_free(fp, TRUE);
Bram Moolenaarcd45ed02020-12-22 17:35:54 +01002539 return FAIL;
Bram Moolenaar38ddf332020-07-31 22:05:04 +02002540}
2541
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002542static int funcdepth = 0;
2543
2544/*
2545 * Increment the function call depth count.
2546 * Return FAIL when going over 'maxfuncdepth'.
2547 * Otherwise return OK, must call funcdepth_decrement() later!
2548 */
2549 int
2550funcdepth_increment(void)
2551{
2552 if (funcdepth >= p_mfd)
2553 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00002554 emsg(_(e_function_call_depth_is_higher_than_macfuncdepth));
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002555 return FAIL;
2556 }
2557 ++funcdepth;
2558 return OK;
2559}
2560
2561 void
2562funcdepth_decrement(void)
2563{
2564 --funcdepth;
2565}
2566
2567/*
2568 * Get the current function call depth.
2569 */
2570 int
2571funcdepth_get(void)
2572{
2573 return funcdepth;
2574}
2575
2576/*
2577 * Restore the function call depth. This is for cases where there is no
Bram Moolenaar8e7d6222020-12-18 19:49:56 +01002578 * guarantee funcdepth_decrement() can be called exactly the same number of
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002579 * times as funcdepth_increment().
2580 */
2581 void
2582funcdepth_restore(int depth)
2583{
2584 funcdepth = depth;
2585}
Bram Moolenaar6914c642017-04-01 21:21:30 +02002586
2587/*
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002588 * Allocate a funccall_T, link it in current_funccal and fill in "fp" and
2589 * "rettv".
2590 * Must be followed by one call to remove_funccal() or cleanup_function_call().
2591 * Returns NULL when allocation fails.
2592 */
2593 funccall_T *
2594create_funccal(ufunc_T *fp, typval_T *rettv)
2595{
2596 funccall_T *fc = ALLOC_CLEAR_ONE(funccall_T);
2597
2598 if (fc == NULL)
2599 return NULL;
2600 fc->fc_caller = current_funccal;
2601 current_funccal = fc;
2602 fc->fc_func = fp;
2603 func_ptr_ref(fp);
2604 fc->fc_rettv = rettv;
2605 return fc;
2606}
2607
2608/*
2609 * To be called when returning from a compiled function; restores
2610 * current_funccal.
2611 */
2612 void
2613remove_funccal()
2614{
2615 funccall_T *fc = current_funccal;
2616
2617 current_funccal = fc->fc_caller;
2618 free_funccal(fc);
2619}
2620
2621/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002622 * Call a user function.
2623 */
2624 static void
2625call_user_func(
Bram Moolenaare38eab22019-12-05 21:50:01 +01002626 ufunc_T *fp, // pointer to function
2627 int argcount, // nr of args
2628 typval_T *argvars, // arguments
2629 typval_T *rettv, // return value
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02002630 funcexe_T *funcexe, // context
Bram Moolenaare38eab22019-12-05 21:50:01 +01002631 dict_T *selfdict) // Dictionary for "self"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002632{
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002633 sctx_T save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01002634 ectx_T *save_current_ectx;
Bram Moolenaar93343722018-07-10 19:39:18 +02002635 int using_sandbox = FALSE;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002636 int save_sticky_cmdmod_flags = sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002637 funccall_T *fc;
2638 int save_did_emsg;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002639 int default_arg_err = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002640 dictitem_T *v;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002641 int fixvar_idx = 0; // index in fc_fixvar[]
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002642 int i;
2643 int ai;
2644 int islambda = FALSE;
2645 char_u numbuf[NUMBUFLEN];
2646 char_u *name;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002647 typval_T *tv_to_free[MAX_FUNC_ARGS];
2648 int tv_to_free_len = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002649#ifdef FEAT_PROFILE
Bram Moolenaarb2049902021-01-24 12:53:53 +01002650 profinfo_T profile_info;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002651#endif
Bram Moolenaare31ee862020-01-07 20:59:34 +01002652 ESTACK_CHECK_DECLARATION
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002653
Bram Moolenaarb2049902021-01-24 12:53:53 +01002654#ifdef FEAT_PROFILE
2655 CLEAR_FIELD(profile_info);
2656#endif
2657
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002658 // If depth of calling is getting too high, don't execute the function.
2659 if (funcdepth_increment() == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002660 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002661 rettv->v_type = VAR_NUMBER;
2662 rettv->vval.v_number = -1;
2663 return;
2664 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002665
Bram Moolenaare38eab22019-12-05 21:50:01 +01002666 line_breakcheck(); // check for CTRL-C hit
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002667
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002668 fc = create_funccal(fp, rettv);
Bram Moolenaar4456ab52019-01-23 23:00:30 +01002669 if (fc == NULL)
2670 return;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002671 fc->fc_level = ex_nesting_level;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002672 // Check if this function has a breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002673 fc->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0);
2674 fc->fc_dbg_tick = debug_tick;
Bram Moolenaare38eab22019-12-05 21:50:01 +01002675 // Set up fields for closure.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002676 ga_init2(&fc->fc_ufuncs, sizeof(ufunc_T *), 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002677
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02002678 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002679 {
Bram Moolenaar12d26532021-02-19 19:13:21 +01002680#ifdef FEAT_PROFILE
Bram Moolenaarca16c602022-09-06 18:57:08 +01002681 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002682#endif
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002683 // Execute the function, possibly compiling it first.
Bram Moolenaarb2049902021-01-24 12:53:53 +01002684#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002685 if (do_profiling == PROF_YES)
2686 profile_may_start_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002687#endif
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002688 sticky_cmdmod_flags = 0;
Bram Moolenaarc9c967d2022-09-07 16:48:46 +01002689 call_def_function(fp, argcount, argvars, 0, funcexe->fe_partial,
Bram Moolenaar58779852022-09-06 18:31:14 +01002690 fc, rettv);
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01002691 funcdepth_decrement();
Bram Moolenaarb2049902021-01-24 12:53:53 +01002692#ifdef FEAT_PROFILE
2693 if (do_profiling == PROF_YES && (fp->uf_profiling
Bram Moolenaar12d26532021-02-19 19:13:21 +01002694 || (caller != NULL && caller->uf_profiling)))
2695 profile_may_end_func(&profile_info, fp, caller);
Bram Moolenaarb2049902021-01-24 12:53:53 +01002696#endif
Bram Moolenaar9667b2c2022-09-07 17:28:09 +01002697 remove_funccal();
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002698 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01002699 return;
2700 }
2701
Bram Moolenaar38453522021-11-28 22:00:12 +00002702 islambda = fp->uf_flags & FC_LAMBDA;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002703
2704 /*
Bram Moolenaar98aff652022-09-06 21:02:35 +01002705 * Note about using fc->fc_fixvar[]: This is an array of FIXVAR_CNT
2706 * variables with names up to VAR_SHORT_LEN long. This avoids having to
2707 * alloc/free each argument variable and saves a lot of time.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002708 */
2709 /*
2710 * Init l: variables.
2711 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002712 init_var_dict(&fc->fc_l_vars, &fc->fc_l_vars_var, VAR_DEF_SCOPE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002713 if (selfdict != NULL)
2714 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002715 // Set l:self to "selfdict". Use "name" to avoid a warning from
2716 // some compiler that checks the destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002717 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002718 name = v->di_key;
2719 STRCPY(name, "self");
Bram Moolenaar31b81602019-02-10 22:14:27 +01002720 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002721 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002722 v->di_tv.v_type = VAR_DICT;
2723 v->di_tv.v_lock = 0;
2724 v->di_tv.vval.v_dict = selfdict;
2725 ++selfdict->dv_refcount;
2726 }
2727
2728 /*
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002729 * Init a: variables, unless none found (in lambda).
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002730 * Set a:0 to "argcount" less number of named arguments, if >= 0.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002731 * Set a:000 to a list with room for the "..." arguments.
2732 */
Bram Moolenaarca16c602022-09-06 18:57:08 +01002733 init_var_dict(&fc->fc_l_avars, &fc->fc_l_avars_var, VAR_SCOPE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002734 if ((fp->uf_flags & FC_NOARGS) == 0)
Bram Moolenaarca16c602022-09-06 18:57:08 +01002735 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var, "0",
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002736 (varnumber_T)(argcount >= fp->uf_args.ga_len
2737 ? argcount - fp->uf_args.ga_len : 0));
Bram Moolenaarca16c602022-09-06 18:57:08 +01002738 fc->fc_l_avars.dv_lock = VAR_FIXED;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002739 if ((fp->uf_flags & FC_NOARGS) == 0)
2740 {
2741 // Use "name" to avoid a warning from some compiler that checks the
2742 // destination size.
Bram Moolenaarca16c602022-09-06 18:57:08 +01002743 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002744 name = v->di_key;
2745 STRCPY(name, "000");
2746 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002747 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002748 v->di_tv.v_type = VAR_LIST;
2749 v->di_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002750 v->di_tv.vval.v_list = &fc->fc_l_varlist;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002751 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01002752 CLEAR_FIELD(fc->fc_l_varlist);
2753 fc->fc_l_varlist.lv_refcount = DO_NOT_FREE_CNT;
2754 fc->fc_l_varlist.lv_lock = VAR_FIXED;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002755
2756 /*
2757 * Set a:firstline to "firstline" and a:lastline to "lastline".
2758 * Set a:name to named arguments.
2759 * Set a:N to the "..." arguments.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002760 * Skipped when no a: variables used (in lambda).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002761 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002762 if ((fp->uf_flags & FC_NOARGS) == 0)
2763 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002764 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2765 "firstline", (varnumber_T)funcexe->fe_firstline);
2766 add_nr_var(&fc->fc_l_avars, &fc->fc_fixvar[fixvar_idx++].var,
2767 "lastline", (varnumber_T)funcexe->fe_lastline);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002768 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002769 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002770 {
2771 int addlocal = FALSE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002772 typval_T def_rettv;
2773 int isdefault = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002774
2775 ai = i - fp->uf_args.ga_len;
2776 if (ai < 0)
2777 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002778 // named argument a:name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002779 name = FUNCARG(fp, i);
2780 if (islambda)
2781 addlocal = TRUE;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002782
2783 // evaluate named argument default expression
2784 isdefault = ai + fp->uf_def_args.ga_len >= 0
2785 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL
2786 && argvars[i].vval.v_number == VVAL_NONE));
2787 if (isdefault)
2788 {
2789 char_u *default_expr = NULL;
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002790
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002791 def_rettv.v_type = VAR_NUMBER;
2792 def_rettv.vval.v_number = -1;
2793
2794 default_expr = ((char_u **)(fp->uf_def_args.ga_data))
2795 [ai + fp->uf_def_args.ga_len];
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002796 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL)
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002797 {
2798 default_arg_err = 1;
2799 break;
2800 }
2801 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002802 }
2803 else
2804 {
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002805 if ((fp->uf_flags & FC_NOARGS) != 0)
2806 // Bail out if no a: arguments used (in lambda).
2807 break;
2808
Bram Moolenaare38eab22019-12-05 21:50:01 +01002809 // "..." argument a:1, a:2, etc.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002810 sprintf((char *)numbuf, "%d", ai + 1);
2811 name = numbuf;
2812 }
2813 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN)
2814 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002815 v = &fc->fc_fixvar[fixvar_idx++].var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002816 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002817 STRCPY(v->di_key, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002818 }
2819 else
2820 {
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002821 v = dictitem_alloc(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002822 if (v == NULL)
2823 break;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002824 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002825 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002826
Bram Moolenaar6e5000d2019-06-17 21:18:41 +02002827 // Note: the values are copied directly to avoid alloc/free.
2828 // "argvars" must have VAR_FIXED for v_lock.
2829 v->di_tv = isdefault ? def_rettv : argvars[i];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002830 v->di_tv.v_lock = VAR_FIXED;
2831
Bram Moolenaarb47bed22021-04-14 17:06:43 +02002832 if (isdefault)
2833 // Need to free this later, no matter where it's stored.
2834 tv_to_free[tv_to_free_len++] = &v->di_tv;
2835
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002836 if (addlocal)
2837 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01002838 // Named arguments should be accessed without the "a:" prefix in
2839 // lambda expressions. Add to the l: dict.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002840 copy_tv(&v->di_tv, &v->di_tv);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002841 hash_add(&fc->fc_l_vars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002842 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02002843 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01002844 hash_add(&fc->fc_l_avars.dv_hashtab, DI2HIKEY(v));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002845
2846 if (ai >= 0 && ai < MAX_FUNC_ARGS)
2847 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002848 listitem_T *li = &fc->fc_l_listitems[ai];
Bram Moolenaar209b8e32019-03-14 13:43:24 +01002849
2850 li->li_tv = argvars[i];
2851 li->li_tv.v_lock = VAR_FIXED;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002852 list_append(&fc->fc_l_varlist, li);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002853 }
2854 }
2855
Bram Moolenaare38eab22019-12-05 21:50:01 +01002856 // Don't redraw while executing the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002857 ++RedrawingDisabled;
Bram Moolenaar93343722018-07-10 19:39:18 +02002858
2859 if (fp->uf_flags & FC_SANDBOX)
2860 {
2861 using_sandbox = TRUE;
2862 ++sandbox;
2863 }
2864
Bram Moolenaar25e0f582020-05-25 22:36:50 +02002865 estack_push_ufunc(fp, 1);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002866 ESTACK_CHECK_SETUP
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002867 if (p_verbose >= 12)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002868 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002869 ++no_wait_return;
2870 verbose_enter_scroll();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002871
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002872 smsg(_("calling %s"), SOURCING_NAME);
2873 if (p_verbose >= 14)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002874 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002875 char_u buf[MSG_BUF_LEN];
2876 char_u numbuf2[NUMBUFLEN];
2877 char_u *tofree;
2878 char_u *s;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002879
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002880 msg_puts("(");
2881 for (i = 0; i < argcount; ++i)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002882 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002883 if (i > 0)
2884 msg_puts(", ");
2885 if (argvars[i].v_type == VAR_NUMBER)
2886 msg_outnum((long)argvars[i].vval.v_number);
2887 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002888 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002889 // Do not want errors such as E724 here.
2890 ++emsg_off;
2891 s = tv2string(&argvars[i], &tofree, numbuf2, 0);
2892 --emsg_off;
2893 if (s != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002894 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002895 if (vim_strsize(s) > MSG_BUF_CLEN)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002896 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002897 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
2898 s = buf;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002899 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002900 msg_puts((char *)s);
2901 vim_free(tofree);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002902 }
2903 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002904 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002905 msg_puts(")");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002906 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002907 msg_puts("\n"); // don't overwrite this either
2908
2909 verbose_leave_scroll();
2910 --no_wait_return;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002911 }
2912#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002913 if (do_profiling == PROF_YES)
2914 profile_may_start_func(&profile_info, fp,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002915 fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002916#endif
2917
Bram Moolenaarcdf04852022-02-12 22:13:06 +00002918 // "legacy" does not apply to commands in the function
2919 sticky_cmdmod_flags = 0;
2920
Bram Moolenaar98aff652022-09-06 21:02:35 +01002921 // If called from a compiled :def function the execution context must be
2922 // hidden, any deferred functions need to be added to the function being
2923 // executed here.
dundargocc57b5bc2022-11-02 13:30:51 +00002924 save_current_ectx = clear_current_ectx();
Bram Moolenaar98aff652022-09-06 21:02:35 +01002925
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02002926 save_current_sctx = current_sctx;
2927 current_sctx = fp->uf_script_ctx;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002928 save_did_emsg = did_emsg;
2929 did_emsg = FALSE;
2930
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002931 if (default_arg_err && (fp->uf_flags & FC_ABORT))
2932 did_emsg = TRUE;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002933 else if (islambda)
2934 {
2935 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7;
2936
2937 // A Lambda always has the command "return {expr}". It is much faster
2938 // to evaluate {expr} directly.
2939 ++ex_nesting_level;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02002940 (void)eval1(&p, rettv, &EVALARG_EVALUATE);
Bram Moolenaarf10806b2020-04-02 18:34:35 +02002941 --ex_nesting_level;
2942 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02002943 else
2944 // call do_cmdline() to execute the lines
2945 do_cmdline(NULL, get_func_line, (void *)fc,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002946 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
2947
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002948 // Invoke functions added with ":defer".
Bram Moolenaar58779852022-09-06 18:31:14 +01002949 handle_defer_one(current_funccal);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01002950
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002951 --RedrawingDisabled;
2952
Bram Moolenaare38eab22019-12-05 21:50:01 +01002953 // when the function was aborted because of an error, return -1
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002954 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN)
2955 {
2956 clear_tv(rettv);
2957 rettv->v_type = VAR_NUMBER;
2958 rettv->vval.v_number = -1;
2959 }
2960
2961#ifdef FEAT_PROFILE
Bram Moolenaar12d26532021-02-19 19:13:21 +01002962 if (do_profiling == PROF_YES)
2963 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01002964 ufunc_T *caller = fc->fc_caller == NULL ? NULL : fc->fc_caller->fc_func;
Bram Moolenaar12d26532021-02-19 19:13:21 +01002965
2966 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling))
2967 profile_may_end_func(&profile_info, fp, caller);
2968 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002969#endif
2970
Bram Moolenaare38eab22019-12-05 21:50:01 +01002971 // when being verbose, mention the return value
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002972 if (p_verbose >= 12)
2973 {
2974 ++no_wait_return;
2975 verbose_enter_scroll();
2976
2977 if (aborting())
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002978 smsg(_("%s aborted"), SOURCING_NAME);
Bram Moolenaarca16c602022-09-06 18:57:08 +01002979 else if (fc->fc_rettv->v_type == VAR_NUMBER)
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002980 smsg(_("%s returning #%ld"), SOURCING_NAME,
Bram Moolenaarca16c602022-09-06 18:57:08 +01002981 (long)fc->fc_rettv->vval.v_number);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002982 else
2983 {
2984 char_u buf[MSG_BUF_LEN];
2985 char_u numbuf2[NUMBUFLEN];
2986 char_u *tofree;
2987 char_u *s;
2988
Bram Moolenaare38eab22019-12-05 21:50:01 +01002989 // The value may be very long. Skip the middle part, so that we
2990 // have some idea how it starts and ends. smsg() would always
2991 // truncate it at the end. Don't want errors such as E724 here.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002992 ++emsg_off;
Bram Moolenaarca16c602022-09-06 18:57:08 +01002993 s = tv2string(fc->fc_rettv, &tofree, numbuf2, 0);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02002994 --emsg_off;
2995 if (s != NULL)
2996 {
2997 if (vim_strsize(s) > MSG_BUF_CLEN)
2998 {
2999 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN);
3000 s = buf;
3001 }
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003002 smsg(_("%s returning %s"), SOURCING_NAME, s);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003003 vim_free(tofree);
3004 }
3005 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003006 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003007
3008 verbose_leave_scroll();
3009 --no_wait_return;
3010 }
3011
Bram Moolenaare31ee862020-01-07 20:59:34 +01003012 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003013 estack_pop();
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003014 current_sctx = save_current_sctx;
Bram Moolenaar98aff652022-09-06 21:02:35 +01003015 restore_current_ectx(save_current_ectx);
3016
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003017#ifdef FEAT_PROFILE
3018 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01003019 script_prof_restore(&profile_info.pi_wait_start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003020#endif
Bram Moolenaar93343722018-07-10 19:39:18 +02003021 if (using_sandbox)
3022 --sandbox;
Bram Moolenaarcdf04852022-02-12 22:13:06 +00003023 sticky_cmdmod_flags = save_sticky_cmdmod_flags;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003024
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003025 if (p_verbose >= 12 && SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003026 {
3027 ++no_wait_return;
3028 verbose_enter_scroll();
3029
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01003030 smsg(_("continuing in %s"), SOURCING_NAME);
Bram Moolenaare38eab22019-12-05 21:50:01 +01003031 msg_puts("\n"); // don't overwrite this either
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003032
3033 verbose_leave_scroll();
3034 --no_wait_return;
3035 }
3036
3037 did_emsg |= save_did_emsg;
Bram Moolenaar0ba48e82020-11-17 18:23:19 +01003038 funcdepth_decrement();
Bram Moolenaarb47bed22021-04-14 17:06:43 +02003039 for (i = 0; i < tv_to_free_len; ++i)
3040 clear_tv(tv_to_free[i]);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003041 cleanup_function_call(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003042}
3043
3044/*
Bram Moolenaar50824712020-12-20 21:10:17 +01003045 * Check the argument count for user function "fp".
3046 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise.
3047 */
3048 int
3049check_user_func_argcount(ufunc_T *fp, int argcount)
3050{
3051 int regular_args = fp->uf_args.ga_len;
3052
3053 if (argcount < regular_args - fp->uf_def_args.ga_len)
3054 return FCERR_TOOFEW;
3055 else if (!has_varargs(fp) && argcount > regular_args)
3056 return FCERR_TOOMANY;
3057 return FCERR_UNKNOWN;
3058}
3059
3060/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003061 * Call a user function after checking the arguments.
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003062 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003063 int
3064call_user_func_check(
3065 ufunc_T *fp,
3066 int argcount,
3067 typval_T *argvars,
3068 typval_T *rettv,
3069 funcexe_T *funcexe,
3070 dict_T *selfdict)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003071{
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003072 int error;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02003073
Bram Moolenaar7d149f82022-06-17 19:23:34 +01003074#ifdef FEAT_LUA
3075 if (fp->uf_flags & FC_CFUNC)
3076 {
3077 cfunc_T cb = fp->uf_cb;
3078
3079 return (*cb)(argcount, argvars, rettv, fp->uf_cb_state);
3080 }
3081#endif
3082
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003083 if (fp->uf_flags & FC_RANGE && funcexe->fe_doesrange != NULL)
3084 *funcexe->fe_doesrange = TRUE;
Bram Moolenaar50824712020-12-20 21:10:17 +01003085 error = check_user_func_argcount(fp, argcount);
3086 if (error != FCERR_UNKNOWN)
3087 return error;
3088 if ((fp->uf_flags & FC_DICT) && selfdict == NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003089 error = FCERR_DICT;
3090 else
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003091 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003092 int did_save_redo = FALSE;
3093 save_redo_T save_redo;
3094
3095 /*
3096 * Call the user function.
3097 * Save and restore search patterns, script variables and
3098 * redo buffer.
3099 */
3100 save_search_patterns();
3101 if (!ins_compl_active())
3102 {
3103 saveRedobuff(&save_redo);
3104 did_save_redo = TRUE;
3105 }
3106 ++fp->uf_calls;
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02003107 call_user_func(fp, argcount, argvars, rettv, funcexe,
3108 (fp->uf_flags & FC_DICT) ? selfdict : NULL);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003109 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0)
3110 // Function was unreferenced while being used, free it now.
3111 func_clear_free(fp, FALSE);
3112 if (did_save_redo)
3113 restoreRedobuff(&save_redo);
3114 restore_search_patterns();
3115 error = FCERR_NONE;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02003116 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003117 return error;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003118}
3119
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003120static funccal_entry_T *funccal_stack = NULL;
3121
3122/*
3123 * Save the current function call pointer, and set it to NULL.
3124 * Used when executing autocommands and for ":source".
3125 */
3126 void
3127save_funccal(funccal_entry_T *entry)
3128{
3129 entry->top_funccal = current_funccal;
3130 entry->next = funccal_stack;
3131 funccal_stack = entry;
3132 current_funccal = NULL;
3133}
3134
3135 void
3136restore_funccal(void)
3137{
3138 if (funccal_stack == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01003139 iemsg("INTERNAL: restore_funccal()");
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003140 else
3141 {
3142 current_funccal = funccal_stack->top_funccal;
3143 funccal_stack = funccal_stack->next;
3144 }
3145}
3146
Bram Moolenaarfa55cfc2019-07-13 22:59:32 +02003147 funccall_T *
3148get_current_funccal(void)
3149{
3150 return current_funccal;
3151}
3152
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003153/*
Bram Moolenaara749a422022-02-12 19:52:25 +00003154 * Return TRUE when currently at the script level:
3155 * - not in a function
3156 * - not executing an autocommand
3157 * Note that when an autocommand sources a script the result is FALSE;
3158 */
3159 int
3160at_script_level(void)
3161{
3162 return current_funccal == NULL && autocmd_match == NULL;
3163}
3164
3165/*
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003166 * Mark all functions of script "sid" as deleted.
3167 */
3168 void
3169delete_script_functions(int sid)
3170{
3171 hashitem_T *hi;
3172 ufunc_T *fp;
Bram Moolenaarce658352020-07-31 23:47:12 +02003173 long_u todo = 1;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003174 char_u buf[30];
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003175 size_t len;
3176
3177 buf[0] = K_SPECIAL;
3178 buf[1] = KS_EXTRA;
3179 buf[2] = (int)KE_SNR;
Bram Moolenaar909ed7e2020-04-27 23:16:41 +02003180 sprintf((char *)buf + 3, "%d_", sid);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003181 len = STRLEN(buf);
3182
Bram Moolenaarce658352020-07-31 23:47:12 +02003183 while (todo > 0)
3184 {
3185 todo = func_hashtab.ht_used;
3186 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3187 if (!HASHITEM_EMPTY(hi))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003188 {
Bram Moolenaarce658352020-07-31 23:47:12 +02003189 fp = HI2UF(hi);
3190 if (STRNCMP(fp->uf_name, buf, len) == 0)
3191 {
3192 int changed = func_hashtab.ht_changed;
3193
3194 fp->uf_flags |= FC_DEAD;
Bram Moolenaarc970e422021-03-17 15:03:04 +01003195
3196 if (fp->uf_calls > 0)
3197 {
3198 // Function is executing, don't free it but do remove
3199 // it from the hashtable.
3200 if (func_remove(fp))
3201 fp->uf_refcount--;
3202 }
3203 else
3204 {
3205 func_clear(fp, TRUE);
3206 // When clearing a function another function can be
3207 // cleared as a side effect. When that happens start
3208 // over.
3209 if (changed != func_hashtab.ht_changed)
3210 break;
3211 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003212 }
3213 --todo;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003214 }
Bram Moolenaarce658352020-07-31 23:47:12 +02003215 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003216}
3217
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003218#if defined(EXITFREE) || defined(PROTO)
3219 void
3220free_all_functions(void)
3221{
3222 hashitem_T *hi;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003223 ufunc_T *fp;
3224 long_u skipped = 0;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003225 long_u todo = 1;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003226 int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003227
Bram Moolenaare38eab22019-12-05 21:50:01 +01003228 // Clean up the current_funccal chain and the funccal stack.
Bram Moolenaar6914c642017-04-01 21:21:30 +02003229 while (current_funccal != NULL)
3230 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01003231 clear_tv(current_funccal->fc_rettv);
Bram Moolenaar6914c642017-04-01 21:21:30 +02003232 cleanup_function_call(current_funccal);
Bram Moolenaar27e80c82018-10-14 21:41:01 +02003233 if (current_funccal == NULL && funccal_stack != NULL)
3234 restore_funccal();
Bram Moolenaar6914c642017-04-01 21:21:30 +02003235 }
3236
Bram Moolenaare38eab22019-12-05 21:50:01 +01003237 // First clear what the functions contain. Since this may lower the
3238 // reference count of a function, it may also free a function and change
3239 // the hash table. Restart if that happens.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003240 while (todo > 0)
3241 {
3242 todo = func_hashtab.ht_used;
3243 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
3244 if (!HASHITEM_EMPTY(hi))
3245 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003246 // clear the def function index now
3247 fp = HI2UF(hi);
3248 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003249 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003250
Bram Moolenaare38eab22019-12-05 21:50:01 +01003251 // Only free functions that are not refcounted, those are
3252 // supposed to be freed when no longer referenced.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003253 if (func_name_refcount(fp->uf_name))
3254 ++skipped;
3255 else
3256 {
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003257 changed = func_hashtab.ht_changed;
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003258 func_clear(fp, TRUE);
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02003259 if (changed != func_hashtab.ht_changed)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003260 {
3261 skipped = 0;
3262 break;
3263 }
3264 }
3265 --todo;
3266 }
3267 }
3268
Bram Moolenaare38eab22019-12-05 21:50:01 +01003269 // Now actually free the functions. Need to start all over every time,
3270 // because func_free() may change the hash table.
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01003271 skipped = 0;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003272 while (func_hashtab.ht_used > skipped)
3273 {
3274 todo = func_hashtab.ht_used;
3275 for (hi = func_hashtab.ht_array; todo > 0; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003276 if (!HASHITEM_EMPTY(hi))
3277 {
Bram Moolenaarc2574872016-08-11 22:51:05 +02003278 --todo;
Bram Moolenaare38eab22019-12-05 21:50:01 +01003279 // Only free functions that are not refcounted, those are
3280 // supposed to be freed when no longer referenced.
Bram Moolenaarc2574872016-08-11 22:51:05 +02003281 fp = HI2UF(hi);
3282 if (func_name_refcount(fp->uf_name))
3283 ++skipped;
3284 else
3285 {
Bram Moolenaara05e5242020-09-19 18:19:19 +02003286 if (func_free(fp, FALSE) == OK)
3287 {
3288 skipped = 0;
3289 break;
3290 }
3291 // did not actually free it
3292 ++skipped;
Bram Moolenaarc2574872016-08-11 22:51:05 +02003293 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003294 }
Bram Moolenaarc2574872016-08-11 22:51:05 +02003295 }
3296 if (skipped == 0)
3297 hash_clear(&func_hashtab);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003298
3299 free_def_functions();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003300}
3301#endif
3302
3303/*
3304 * Return TRUE if "name" looks like a builtin function name: starts with a
Bram Moolenaar15d16352022-01-17 20:09:08 +00003305 * lower case letter, doesn't contain AUTOLOAD_CHAR or ':', no "." after the
3306 * name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003307 * "len" is the length of "name", or -1 for NUL terminated.
3308 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003309 int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003310builtin_function(char_u *name, int len)
3311{
Bram Moolenaar15d16352022-01-17 20:09:08 +00003312 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003313
Bram Moolenaara26b9702020-04-18 19:53:28 +02003314 if (!ASCII_ISLOWER(name[0]) || name[1] == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003315 return FALSE;
Bram Moolenaar15d16352022-01-17 20:09:08 +00003316 for (i = 0; name[i] != NUL && (len < 0 || i < len); ++i)
3317 {
3318 if (name[i] == AUTOLOAD_CHAR)
3319 return FALSE;
3320 if (!eval_isnamec(name[i]))
3321 {
3322 // "name.something" is not a builtin function
3323 if (name[i] == '.')
3324 return FALSE;
3325 break;
3326 }
3327 }
3328 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003329}
3330
3331 int
3332func_call(
3333 char_u *name,
3334 typval_T *args,
3335 partial_T *partial,
3336 dict_T *selfdict,
3337 typval_T *rettv)
3338{
Bram Moolenaar50985eb2020-01-27 22:09:39 +01003339 list_T *l = args->vval.v_list;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003340 listitem_T *item;
3341 typval_T argv[MAX_FUNC_ARGS + 1];
3342 int argc = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003343 int r = 0;
3344
Bram Moolenaar7e9f3512020-05-13 22:44:22 +02003345 CHECK_LIST_MATERIALIZE(l);
Bram Moolenaar00d253e2020-04-06 22:13:01 +02003346 FOR_ALL_LIST_ITEMS(l, item)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003347 {
3348 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc))
3349 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00003350 emsg(_(e_too_many_arguments));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003351 break;
3352 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003353 // Make a copy of each argument. This is needed to be able to set
3354 // v_lock to VAR_FIXED in the copy without changing the original list.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003355 copy_tv(&item->li_tv, &argv[argc++]);
3356 }
3357
3358 if (item == NULL)
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003359 {
3360 funcexe_T funcexe;
3361
Bram Moolenaara80faa82020-04-12 19:37:17 +02003362 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003363 funcexe.fe_firstline = curwin->w_cursor.lnum;
3364 funcexe.fe_lastline = curwin->w_cursor.lnum;
3365 funcexe.fe_evaluate = TRUE;
3366 funcexe.fe_partial = partial;
3367 funcexe.fe_selfdict = selfdict;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003368 r = call_func(name, -1, rettv, argc, argv, &funcexe);
3369 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003370
Bram Moolenaare38eab22019-12-05 21:50:01 +01003371 // Free the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003372 while (argc > 0)
3373 clear_tv(&argv[--argc]);
3374
3375 return r;
3376}
3377
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003378static int callback_depth = 0;
3379
3380 int
3381get_callback_depth(void)
3382{
3383 return callback_depth;
3384}
3385
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003386/*
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003387 * Invoke call_func() with a callback.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003388 * Returns FAIL if the callback could not be called.
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003389 */
3390 int
3391call_callback(
3392 callback_T *callback,
3393 int len, // length of "name" or -1 to use strlen()
3394 typval_T *rettv, // return value goes here
3395 int argcount, // number of "argvars"
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003396 typval_T *argvars) // vars for arguments, must have "argcount"
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003397 // PLUS ONE elements!
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003398{
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003399 funcexe_T funcexe;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003400 int ret;
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003401
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003402 if (callback->cb_name == NULL || *callback->cb_name == NUL)
3403 return FAIL;
Bram Moolenaara80faa82020-04-12 19:37:17 +02003404 CLEAR_FIELD(funcexe);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003405 funcexe.fe_evaluate = TRUE;
3406 funcexe.fe_partial = callback->cb_partial;
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003407 ++callback_depth;
3408 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe);
3409 --callback_depth;
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003410
3411 // When a :def function was called that uses :try an error would be turned
3412 // into an exception. Need to give the error here.
Bram Moolenaar80d60912021-12-13 19:14:52 +00003413 if (need_rethrow && current_exception != NULL && trylevel == 0)
Bram Moolenaar3b309f12021-12-13 18:19:55 +00003414 {
3415 need_rethrow = FALSE;
3416 handle_did_throw();
3417 }
3418
Bram Moolenaar0e57dd82019-09-16 22:56:03 +02003419 return ret;
Bram Moolenaar3a97bb32019-06-01 13:28:35 +02003420}
3421
3422/*
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003423 * call the 'callback' function and return the result as a number.
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003424 * Returns -2 when calling the function fails. Uses argv[0] to argv[argc - 1]
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003425 * for the function arguments. argv[argc] should have type VAR_UNKNOWN.
3426 */
3427 varnumber_T
3428call_callback_retnr(
3429 callback_T *callback,
3430 int argcount, // number of "argvars"
3431 typval_T *argvars) // vars for arguments, must have "argcount"
3432 // PLUS ONE elements!
3433{
3434 typval_T rettv;
3435 varnumber_T retval;
3436
Bram Moolenaarf0e7e632022-01-21 13:29:56 +00003437 if (call_callback(callback, -1, &rettv, argcount, argvars) == FAIL)
Yegappan Lakshmanan4dc24eb2021-12-07 12:23:57 +00003438 return -2;
Yegappan Lakshmanan8658c752021-12-03 11:09:29 +00003439
3440 retval = tv_get_number_chk(&rettv, NULL);
3441 clear_tv(&rettv);
3442 return retval;
3443}
3444
3445/*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003446 * Give an error message for the result of a function.
3447 * Nothing if "error" is FCERR_NONE.
3448 */
3449 void
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003450user_func_error(int error, char_u *name, int found_var)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003451{
3452 switch (error)
3453 {
3454 case FCERR_UNKNOWN:
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003455 if (found_var)
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003456 emsg_funcname(e_not_callable_type_str, name);
Bram Moolenaar2ef91562021-12-11 16:14:07 +00003457 else
Bram Moolenaare1242042021-12-16 20:56:57 +00003458 emsg_funcname(e_unknown_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003459 break;
3460 case FCERR_NOTMETHOD:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003461 emsg_funcname(e_cannot_use_function_as_method_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003462 break;
3463 case FCERR_DELETED:
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003464 emsg_funcname(e_function_was_deleted_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003465 break;
3466 case FCERR_TOOMANY:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003467 emsg_funcname(e_too_many_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003468 break;
3469 case FCERR_TOOFEW:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003470 emsg_funcname(e_not_enough_arguments_for_function_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003471 break;
3472 case FCERR_SCRIPT:
Bram Moolenaara6c18d32022-03-31 20:02:56 +01003473 emsg_funcname(e_using_sid_not_in_script_context_str, name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003474 break;
3475 case FCERR_DICT:
Bram Moolenaara6f79292022-01-04 21:30:47 +00003476 emsg_funcname(e_calling_dict_function_without_dictionary_str,
3477 name);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003478 break;
3479 }
3480}
3481
3482/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003483 * Call a function with its resolved parameters
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003484 *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003485 * Return FAIL when the function can't be called, OK otherwise.
3486 * Also returns OK when an error was encountered while executing the function.
3487 */
3488 int
3489call_func(
Bram Moolenaar6ed88192019-05-11 18:37:44 +02003490 char_u *funcname, // name of the function
3491 int len, // length of "name" or -1 to use strlen()
3492 typval_T *rettv, // return value goes here
3493 int argcount_in, // number of "argvars"
3494 typval_T *argvars_in, // vars for arguments, must have "argcount"
3495 // PLUS ONE elements!
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003496 funcexe_T *funcexe) // more arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003497{
3498 int ret = FAIL;
Bram Moolenaaref140542019-12-31 21:27:13 +01003499 int error = FCERR_NONE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003500 int i;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003501 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003502 char_u fname_buf[FLEN_FIXED + 1];
3503 char_u *tofree = NULL;
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003504 char_u *fname = NULL;
3505 char_u *name = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003506 int argcount = argcount_in;
3507 typval_T *argvars = argvars_in;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003508 dict_T *selfdict = funcexe->fe_selfdict;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003509 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003510 // "funcexe->fe_basetv" is not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003511 int argv_clear = 0;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003512 int argv_base = 0;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003513 partial_T *partial = funcexe->fe_partial;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003514 type_T check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003515 type_T *check_type_args[MAX_FUNC_ARGS];
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003516
Bram Moolenaarc507a2d2019-08-29 21:32:55 +02003517 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv)
3518 // even when call_func() returns FAIL.
3519 rettv->v_type = VAR_UNKNOWN;
3520
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003521 if (partial != NULL)
3522 fp = partial->pt_func;
3523 if (fp == NULL)
3524 {
3525 // Make a copy of the name, if it comes from a funcref variable it
3526 // could be changed or deleted in the called function.
3527 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname);
3528 if (name == NULL)
3529 return ret;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003530
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003531 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3532 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003533
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003534 if (funcexe->fe_doesrange != NULL)
3535 *funcexe->fe_doesrange = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003536
3537 if (partial != NULL)
3538 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003539 // When the function has a partial with a dict and there is a dict
3540 // argument, use the dict argument. That is backwards compatible.
3541 // When the dict was bound explicitly use the one from the partial.
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02003542 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003543 selfdict = partial->pt_dict;
Bram Moolenaaref140542019-12-31 21:27:13 +01003544 if (error == FCERR_NONE && partial->pt_argc > 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003545 {
3546 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear)
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003547 {
3548 if (argv_clear + argcount_in >= MAX_FUNC_ARGS)
3549 {
Bram Moolenaaref140542019-12-31 21:27:13 +01003550 error = FCERR_TOOMANY;
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003551 goto theend;
3552 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003553 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]);
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003554 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003555 for (i = 0; i < argcount_in; ++i)
3556 argv[i + argv_clear] = argvars_in[i];
3557 argvars = argv;
3558 argcount = partial->pt_argc + argcount_in;
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003559
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003560 if (funcexe->fe_check_type != NULL
3561 && funcexe->fe_check_type->tt_argcount != -1)
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003562 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003563 // Now funcexe->fe_check_type is missing the added arguments,
3564 // make a copy of the type with the correction.
3565 check_type = *funcexe->fe_check_type;
3566 funcexe->fe_check_type = &check_type;
Bram Moolenaar13789bf2021-12-30 13:29:00 +00003567 check_type.tt_args = check_type_args;
3568 CLEAR_FIELD(check_type_args);
3569 for (i = 0; i < check_type.tt_argcount; ++i)
3570 check_type_args[i + partial->pt_argc] =
3571 check_type.tt_args[i];
Bram Moolenaar97f227d2021-07-04 20:20:52 +02003572 check_type.tt_argcount += partial->pt_argc;
3573 check_type.tt_min_argcount += partial->pt_argc;
3574 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003575 }
3576 }
3577
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003578 if (error == FCERR_NONE && funcexe->fe_check_type != NULL
3579 && funcexe->fe_evaluate)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003580 {
3581 // Check that the argument types are OK for the types of the funcref.
Bram Moolenaarc84287d2022-01-16 18:06:21 +00003582 if (check_argument_types(funcexe->fe_check_type,
3583 argvars, argcount, funcexe->fe_basetv,
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01003584 (name != NULL) ? name : funcname) == FAIL)
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003585 error = FCERR_OTHER;
3586 }
3587
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003588 if (error == FCERR_NONE && funcexe->fe_evaluate)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003589 {
3590 char_u *rfname = fname;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003591 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003592
Bram Moolenaar333894b2020-08-01 18:53:07 +02003593 // Skip "g:" before a function name.
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003594 if (fp == NULL && fname[0] == 'g' && fname[1] == ':')
Bram Moolenaar333894b2020-08-01 18:53:07 +02003595 {
3596 is_global = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003597 rfname = fname + 2;
Bram Moolenaar333894b2020-08-01 18:53:07 +02003598 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003599
Bram Moolenaare38eab22019-12-05 21:50:01 +01003600 rettv->v_type = VAR_NUMBER; // default rettv is number zero
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003601 rettv->vval.v_number = 0;
Bram Moolenaaref140542019-12-31 21:27:13 +01003602 error = FCERR_UNKNOWN;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003603
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003604 if (fp != NULL || !builtin_function(rfname, -1))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003605 {
3606 /*
3607 * User defined function.
3608 */
Bram Moolenaarf10806b2020-04-02 18:34:35 +02003609 if (fp == NULL)
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003610 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003611 fp = find_func(rfname, is_global);
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003612 if (fp != NULL && !is_global && in_vim9script()
3613 && func_requires_g_prefix(fp))
3614 // In Vim9 script g: is required to find a global
3615 // non-autoload function.
3616 fp = NULL;
3617 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003618
Bram Moolenaare38eab22019-12-05 21:50:01 +01003619 // Trigger FuncUndefined event, may load the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003620 if (fp == NULL
3621 && apply_autocmds(EVENT_FUNCUNDEFINED,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003622 rfname, rfname, TRUE, NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003623 && !aborting())
3624 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003625 // executed an autocommand, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003626 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003627 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01003628 // Try loading a package.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003629 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting())
3630 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01003631 // loaded a package, search for the function again
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003632 fp = find_func(rfname, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003633 }
Bram Moolenaara26b9702020-04-18 19:53:28 +02003634 if (fp == NULL)
3635 {
3636 char_u *p = untrans_function_name(rfname);
3637
3638 // If using Vim9 script try not local to the script.
Bram Moolenaar035d6e92020-08-11 22:30:42 +02003639 // Don't do this if the name starts with "s:".
3640 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':'))
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00003641 fp = find_func(p, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02003642 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003643
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003644 if (fp != NULL && (fp->uf_flags & FC_DELETED))
Bram Moolenaaref140542019-12-31 21:27:13 +01003645 error = FCERR_DELETED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003646 else if (fp != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003647 {
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003648 if (funcexe->fe_argv_func != NULL)
Bram Moolenaarb0745b22019-11-09 22:28:11 +01003649 // postponed filling in the arguments, do it now
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003650 argcount = funcexe->fe_argv_func(argcount, argvars,
zeertzjq48db5da2022-09-16 12:10:03 +01003651 argv_clear, fp);
Bram Moolenaardf48fb42016-07-22 21:50:18 +02003652
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003653 if (funcexe->fe_basetv != NULL)
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003654 {
3655 // Method call: base->Method()
3656 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount);
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003657 argv[0] = *funcexe->fe_basetv;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003658 argcount++;
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003659 argvars = argv;
3660 argv_base = 1;
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003661 }
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003662
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003663 error = call_user_func_check(fp, argcount, argvars, rettv,
3664 funcexe, selfdict);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003665 }
3666 }
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003667 else if (funcexe->fe_basetv != NULL)
Bram Moolenaarac92e252019-08-03 21:58:38 +02003668 {
3669 /*
Bram Moolenaarfcfe1a92019-08-04 23:04:39 +02003670 * expr->method(): Find the method name in the table, call its
3671 * implementation with the base as one of the arguments.
Bram Moolenaarac92e252019-08-03 21:58:38 +02003672 */
3673 error = call_internal_method(fname, argcount, argvars, rettv,
Bram Moolenaar851f86b2021-12-13 14:26:44 +00003674 funcexe->fe_basetv);
Bram Moolenaarac92e252019-08-03 21:58:38 +02003675 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003676 else
3677 {
3678 /*
3679 * Find the function name in the table, call its implementation.
3680 */
3681 error = call_internal_func(fname, argcount, argvars, rettv);
3682 }
Bram Moolenaar333894b2020-08-01 18:53:07 +02003683
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003684 /*
3685 * The function call (or "FuncUndefined" autocommand sequence) might
3686 * have been aborted by an error, an interrupt, or an explicitly thrown
3687 * exception that has not been caught so far. This situation can be
3688 * tested for by calling aborting(). For an error in an internal
3689 * function or for the "E132" error in call_user_func(), however, the
3690 * throw point at which the "force_abort" flag (temporarily reset by
3691 * emsg()) is normally updated has not been reached yet. We need to
3692 * update that flag first to make aborting() reliable.
3693 */
3694 update_force_abort();
3695 }
Bram Moolenaaref140542019-12-31 21:27:13 +01003696 if (error == FCERR_NONE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003697 ret = OK;
3698
Bram Moolenaar4c054e92019-11-10 00:13:50 +01003699theend:
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003700 /*
3701 * Report an error unless the argument evaluation or function call has been
3702 * cancelled due to an aborting error, an interrupt, or an exception.
3703 */
3704 if (!aborting())
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003705 user_func_error(error, (name != NULL) ? name : funcname,
3706 funcexe->fe_found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003707
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003708 // clear the copies made from the partial
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003709 while (argv_clear > 0)
Bram Moolenaar761fdf02019-08-05 23:10:16 +02003710 clear_tv(&argv[--argv_clear + argv_base]);
3711
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003712 vim_free(tofree);
3713 vim_free(name);
3714
3715 return ret;
3716}
3717
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01003718/*
3719 * Call a function without arguments, partial or dict.
3720 * This is like call_func() when the call is only "FuncName()".
3721 * To be used by "expr" options.
3722 * Returns NOTDONE when the function could not be found.
3723 */
3724 int
3725call_simple_func(
3726 char_u *funcname, // name of the function
3727 int len, // length of "name" or -1 to use strlen()
3728 typval_T *rettv) // return value goes here
3729{
3730 int ret = FAIL;
3731 int error = FCERR_NONE;
3732 char_u fname_buf[FLEN_FIXED + 1];
3733 char_u *tofree = NULL;
3734 char_u *name;
3735 char_u *fname;
3736 char_u *rfname;
3737 int is_global = FALSE;
3738 ufunc_T *fp;
3739
3740 rettv->v_type = VAR_NUMBER; // default rettv is number zero
3741 rettv->vval.v_number = 0;
3742
3743 // Make a copy of the name, an option can be changed in the function.
3744 name = vim_strnsave(funcname, len);
3745 if (name == NULL)
3746 return ret;
3747
3748 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
3749
3750 // Skip "g:" before a function name.
3751 if (fname[0] == 'g' && fname[1] == ':')
3752 {
3753 is_global = TRUE;
3754 rfname = fname + 2;
3755 }
3756 else
3757 rfname = fname;
3758 fp = find_func(rfname, is_global);
3759 if (fp != NULL && !is_global && in_vim9script()
3760 && func_requires_g_prefix(fp))
3761 // In Vim9 script g: is required to find a global non-autoload
3762 // function.
3763 fp = NULL;
3764 if (fp == NULL)
3765 ret = NOTDONE;
3766 else if (fp != NULL && (fp->uf_flags & FC_DELETED))
3767 error = FCERR_DELETED;
3768 else if (fp != NULL)
3769 {
3770 typval_T argvars[1];
3771 funcexe_T funcexe;
3772
3773 argvars[0].v_type = VAR_UNKNOWN;
3774 CLEAR_FIELD(funcexe);
3775 funcexe.fe_evaluate = TRUE;
3776
3777 error = call_user_func_check(fp, 0, argvars, rettv, &funcexe, NULL);
3778 if (error == FCERR_NONE)
3779 ret = OK;
3780 }
3781
3782 user_func_error(error, name, FALSE);
3783 vim_free(tofree);
3784 vim_free(name);
3785
3786 return ret;
3787}
3788
Bram Moolenaar682d0a12020-07-19 20:48:59 +02003789 char_u *
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003790printable_func_name(ufunc_T *fp)
3791{
3792 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name;
3793}
3794
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003795/*
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003796 * When "prev_ht_changed" does not equal "ht_changed" give an error and return
3797 * TRUE. Otherwise return FALSE.
3798 */
3799 static int
3800function_list_modified(int prev_ht_changed)
3801{
3802 if (prev_ht_changed != func_hashtab.ht_changed)
3803 {
3804 emsg(_(e_function_list_was_modified));
3805 return TRUE;
3806 }
3807 return FALSE;
3808}
3809
3810/*
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003811 * List the head of the function: "function name(arg1, arg2)".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003812 */
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003813 static int
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003814list_func_head(ufunc_T *fp, int indent)
3815{
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003816 int prev_ht_changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003817 int j;
3818
3819 msg_start();
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003820
3821 // a timer at the more prompt may have deleted the function
3822 if (function_list_modified(prev_ht_changed))
3823 return FAIL;
3824
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003825 if (indent)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003826 msg_puts(" ");
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003827 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003828 msg_puts("def ");
3829 else
3830 msg_puts("function ");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003831 msg_puts((char *)printable_func_name(fp));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003832 msg_putchar('(');
3833 for (j = 0; j < fp->uf_args.ga_len; ++j)
3834 {
3835 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003836 msg_puts(", ");
3837 msg_puts((char *)FUNCARG(fp, j));
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003838 if (fp->uf_arg_types != NULL)
3839 {
3840 char *tofree;
3841
3842 msg_puts(": ");
3843 msg_puts(type_name(fp->uf_arg_types[j], &tofree));
3844 vim_free(tofree);
3845 }
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02003846 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len)
3847 {
3848 msg_puts(" = ");
3849 msg_puts(((char **)(fp->uf_def_args.ga_data))
3850 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]);
3851 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003852 }
3853 if (fp->uf_varargs)
3854 {
3855 if (j)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003856 msg_puts(", ");
3857 msg_puts("...");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003858 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003859 if (fp->uf_va_name != NULL)
3860 {
Bram Moolenaar521bf322022-05-06 15:47:07 +01003861 if (!fp->uf_varargs)
3862 {
3863 if (j)
3864 msg_puts(", ");
3865 msg_puts("...");
3866 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003867 msg_puts((char *)fp->uf_va_name);
Bram Moolenaar2a389082021-04-09 20:24:31 +02003868 if (fp->uf_va_type != NULL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003869 {
3870 char *tofree;
3871
3872 msg_puts(": ");
3873 msg_puts(type_name(fp->uf_va_type, &tofree));
3874 vim_free(tofree);
3875 }
3876 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003877 msg_putchar(')');
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003878
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02003879 if (fp->uf_def_status != UF_NOT_COMPILED)
Bram Moolenaar61a6d4e2020-03-01 23:32:25 +01003880 {
3881 if (fp->uf_ret_type != &t_void)
3882 {
3883 char *tofree;
3884
3885 msg_puts(": ");
3886 msg_puts(type_name(fp->uf_ret_type, &tofree));
3887 vim_free(tofree);
3888 }
3889 }
3890 else if (fp->uf_flags & FC_ABORT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003891 msg_puts(" abort");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003892 if (fp->uf_flags & FC_RANGE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003893 msg_puts(" range");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003894 if (fp->uf_flags & FC_DICT)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003895 msg_puts(" dict");
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02003896 if (fp->uf_flags & FC_CLOSURE)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003897 msg_puts(" closure");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003898 msg_clr_eos();
3899 if (p_verbose > 0)
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02003900 last_set_msg(fp->uf_script_ctx);
Bram Moolenaar398a26f2022-11-13 22:13:33 +00003901
3902 return OK;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003903}
3904
3905/*
3906 * Get a function name, translating "<SID>" and "<SNR>".
3907 * Also handles a Funcref in a List or Dictionary.
3908 * Returns the function name in allocated memory, or NULL for failure.
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003909 * Set "*is_global" to TRUE when the function must be global, unless
3910 * "is_global" is NULL.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003911 * flags:
3912 * TFN_INT: internal function name OK
3913 * TFN_QUIET: be quiet
3914 * TFN_NO_AUTOLOAD: do not use script autoloading
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02003915 * TFN_NO_DEREF: do not dereference a Funcref
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003916 * Advances "pp" to just after the function name (if no error).
3917 */
Bram Moolenaar437bafe2016-08-01 15:40:54 +02003918 char_u *
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003919trans_function_name(
3920 char_u **pp,
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02003921 int *is_global,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003922 int skip, // only find the end, don't evaluate
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003923 int flags,
Bram Moolenaare38eab22019-12-05 21:50:01 +01003924 funcdict_T *fdp, // return: info about dictionary used
Bram Moolenaar32b3f822021-01-06 21:59:39 +01003925 partial_T **partial, // return: partial of a FuncRef
3926 type_T **type) // return: type of funcref if not NULL
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003927{
3928 char_u *name = NULL;
3929 char_u *start;
3930 char_u *end;
3931 int lead;
3932 char_u sid_buf[20];
3933 int len;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01003934 int extra = 0;
Bram Moolenaar848fadd2022-01-30 15:28:30 +00003935 int prefix_g = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003936 lval_T lv;
Bram Moolenaar4525a572022-02-13 11:57:33 +00003937 int vim9script = in_vim9script();
3938 int vim9_local;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003939
3940 if (fdp != NULL)
Bram Moolenaara80faa82020-04-12 19:37:17 +02003941 CLEAR_POINTER(fdp);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003942 start = *pp;
3943
Bram Moolenaare38eab22019-12-05 21:50:01 +01003944 // Check for hard coded <SNR>: already translated function ID (from a user
3945 // command).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003946 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA
3947 && (*pp)[2] == (int)KE_SNR)
3948 {
3949 *pp += 3;
3950 len = get_id_len(pp) + 3;
3951 return vim_strnsave(start, len);
3952 }
3953
Bram Moolenaare38eab22019-12-05 21:50:01 +01003954 // A name starting with "<SID>" or "<SNR>" is local to a script. But
3955 // don't skip over "s:", get_lval() needs it for "s:dict.func".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003956 lead = eval_fname_script(start);
3957 if (lead > 2)
3958 start += lead;
3959
Bram Moolenaare38eab22019-12-05 21:50:01 +01003960 // Note that TFN_ flags use the same values as GLV_ flags.
Bram Moolenaar6e65d592017-12-07 22:11:27 +01003961 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY,
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003962 lead > 2 ? 0 : FNE_CHECK_START);
Bram Moolenaar4525a572022-02-13 11:57:33 +00003963 if (end == start || (vim9script && end != NULL
Bram Moolenaare6a42002022-01-21 10:32:58 +00003964 && end[-1] == AUTOLOAD_CHAR && *end == '('))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003965 {
3966 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00003967 emsg(_(e_function_name_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003968 goto theend;
3969 }
3970 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range)))
3971 {
3972 /*
3973 * Report an invalid expression in braces, unless the expression
3974 * evaluation has been cancelled due to an aborting error, an
3975 * interrupt, or an exception.
3976 */
3977 if (!aborting())
3978 {
3979 if (end != NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00003980 semsg(_(e_invalid_argument_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02003981 }
3982 else
3983 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR);
3984 goto theend;
3985 }
3986
3987 if (lv.ll_tv != NULL)
3988 {
3989 if (fdp != NULL)
3990 {
3991 fdp->fd_dict = lv.ll_dict;
3992 fdp->fd_newkey = lv.ll_newkey;
3993 lv.ll_newkey = NULL;
3994 fdp->fd_di = lv.ll_di;
3995 }
3996 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL)
3997 {
3998 name = vim_strsave(lv.ll_tv->vval.v_string);
3999 *pp = end;
4000 }
4001 else if (lv.ll_tv->v_type == VAR_PARTIAL
4002 && lv.ll_tv->vval.v_partial != NULL)
4003 {
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004004 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004005 *pp = end;
4006 if (partial != NULL)
4007 *partial = lv.ll_tv->vval.v_partial;
4008 }
4009 else
4010 {
4011 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL
4012 || lv.ll_dict == NULL || fdp->fd_newkey == NULL))
Bram Moolenaara6f79292022-01-04 21:30:47 +00004013 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004014 else
4015 *pp = end;
4016 name = NULL;
4017 }
4018 goto theend;
4019 }
4020
4021 if (lv.ll_name == NULL)
4022 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004023 // Error found, but continue after the function name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004024 *pp = end;
4025 goto theend;
4026 }
4027
Bram Moolenaare38eab22019-12-05 21:50:01 +01004028 // Check if the name is a Funcref. If so, use the value.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004029 if (lv.ll_exp_name != NULL)
4030 {
4031 len = (int)STRLEN(lv.ll_exp_name);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004032 name = deref_func_name(lv.ll_exp_name, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004033 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004034 if (name == lv.ll_exp_name)
4035 name = NULL;
4036 }
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004037 else if (lv.ll_sid > 0)
4038 {
4039 scriptitem_T *si = SCRIPT_ITEM(lv.ll_sid);
4040 int cc = *lv.ll_name_end;
4041
4042 // function in another script. Prefix <SNR>99_ or the autoload prefix.
4043 *lv.ll_name_end = NUL;
4044 if (si->sn_autoload_prefix != NULL)
4045 {
4046 name = concat_str(si->sn_autoload_prefix, lv.ll_name);
4047 }
4048 else
4049 {
4050 sid_buf[0] = K_SPECIAL;
4051 sid_buf[1] = KS_EXTRA;
4052 sid_buf[2] = (int)KE_SNR;
4053 vim_snprintf((char *)sid_buf + 3, sizeof(sid_buf) - 3,
Bram Moolenaar62aec932022-01-29 21:45:34 +00004054 "%ld_", (long)lv.ll_sid);
Bram Moolenaarf111cdf2022-01-12 12:48:17 +00004055 name = concat_str(sid_buf, lv.ll_name);
4056 }
4057 *lv.ll_name_end = cc;
4058 *pp = end;
4059 goto theend;
4060 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004061 else if (!(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004062 {
4063 len = (int)(end - *pp);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004064 name = deref_func_name(*pp, &len, partial, type,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004065 flags & TFN_NO_AUTOLOAD, flags & TFN_NEW_FUNC, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004066 if (name == *pp)
4067 name = NULL;
4068 }
4069 if (name != NULL)
4070 {
4071 name = vim_strsave(name);
4072 *pp = end;
4073 if (STRNCMP(name, "<SNR>", 5) == 0)
4074 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004075 // Change "<SNR>" to the byte sequence.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004076 name[0] = K_SPECIAL;
4077 name[1] = KS_EXTRA;
4078 name[2] = (int)KE_SNR;
4079 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1);
4080 }
4081 goto theend;
4082 }
4083
4084 if (lv.ll_exp_name != NULL)
4085 {
4086 len = (int)STRLEN(lv.ll_exp_name);
4087 if (lead <= 2 && lv.ll_name == lv.ll_exp_name
4088 && STRNCMP(lv.ll_name, "s:", 2) == 0)
4089 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004090 // When there was "s:" already or the name expanded to get a
4091 // leading "s:" then remove it.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004092 lv.ll_name += 2;
4093 len -= 2;
4094 lead = 2;
4095 }
4096 }
4097 else
4098 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004099 // skip over "s:" and "g:"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004100 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':'))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004101 {
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004102 if (lv.ll_name[0] == 'g')
4103 {
4104 if (is_global != NULL)
4105 {
4106 *is_global = TRUE;
4107 }
4108 else
4109 {
4110 // dropping "g:" without setting "is_global" won't work in
4111 // Vim9script, put it back later
4112 prefix_g = TRUE;
4113 extra = 2;
4114 }
4115 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004116 lv.ll_name += 2;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004117 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004118 len = (int)(end - lv.ll_name);
4119 }
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004120 if (len <= 0)
4121 {
4122 if (!skip)
Bram Moolenaarc553a212021-12-26 20:20:34 +00004123 emsg(_(e_function_name_required));
Bram Moolenaar7b5d5442020-10-04 13:42:34 +02004124 goto theend;
4125 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004126
Bram Moolenaar17f700a2020-12-19 21:23:42 +01004127 // In Vim9 script a user function is script-local by default, unless it
4128 // starts with a lower case character: dict.func().
Bram Moolenaar4525a572022-02-13 11:57:33 +00004129 vim9_local = ASCII_ISUPPER(*start) && vim9script;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004130
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004131 /*
4132 * Copy the function name to allocated memory.
4133 * Accept <SID>name() inside a script, translate into <SNR>123_name().
4134 * Accept <SNR>123_name() outside a script.
4135 */
4136 if (skip)
Bram Moolenaare38eab22019-12-05 21:50:01 +01004137 lead = 0; // do nothing
Bram Moolenaar4525a572022-02-13 11:57:33 +00004138 else if (lead > 0 || vim9_local)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004139 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004140 if (!vim9_local)
Bram Moolenaar3787f262022-02-07 21:54:01 +00004141 {
Kota Kato948a3892022-08-16 16:09:59 +01004142 if (vim9script && lead == 2 && !ASCII_ISUPPER(*lv.ll_name)
4143 && current_script_is_vim9())
Bram Moolenaar3787f262022-02-07 21:54:01 +00004144 {
Bram Moolenaar72981ac2022-07-29 19:50:41 +01004145 semsg(_(e_function_name_must_start_with_capital_str), start);
Bram Moolenaar3787f262022-02-07 21:54:01 +00004146 goto theend;
4147 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004148 lead = 3;
Bram Moolenaar3787f262022-02-07 21:54:01 +00004149 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00004150 if (vim9_local || (lv.ll_exp_name != NULL
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004151 && eval_fname_sid(lv.ll_exp_name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004152 || eval_fname_sid(*pp))
4153 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004154 // It's script-local, "s:" or "<SID>"
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004155 if (current_sctx.sc_sid <= 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004156 {
Bram Moolenaar40bcec12021-12-05 22:19:27 +00004157 emsg(_(e_using_sid_not_in_script_context));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004158 goto theend;
4159 }
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02004160 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004161 if (vim9_local)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004162 extra = 3 + (int)STRLEN(sid_buf);
4163 else
4164 lead += (int)STRLEN(sid_buf);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004165 }
4166 }
Bram Moolenaar22f17a22021-06-21 20:48:58 +02004167 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len)
Bram Moolenaar4525a572022-02-13 11:57:33 +00004168 || (vim9script && *lv.ll_name == '_')))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004169 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004170 semsg(_(vim9script ? e_function_name_must_start_with_capital_str
Bram Moolenaar3787f262022-02-07 21:54:01 +00004171 : e_function_name_must_start_with_capital_or_s_str),
4172 start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004173 goto theend;
4174 }
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02004175 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004176 {
4177 char_u *cp = vim_strchr(lv.ll_name, ':');
4178
4179 if (cp != NULL && cp < end)
4180 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00004181 semsg(_(e_function_name_cannot_contain_colon_str), start);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004182 goto theend;
4183 }
4184 }
4185
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004186 name = alloc(len + lead + extra + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004187 if (name != NULL)
4188 {
Bram Moolenaar4525a572022-02-13 11:57:33 +00004189 if (!skip && (lead > 0 || vim9_local))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004190 {
4191 name[0] = K_SPECIAL;
4192 name[1] = KS_EXTRA;
4193 name[2] = (int)KE_SNR;
Bram Moolenaar4525a572022-02-13 11:57:33 +00004194 if (vim9_local || lead > 3) // If it's "<SID>"
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004195 STRCPY(name + 3, sid_buf);
4196 }
Bram Moolenaar848fadd2022-01-30 15:28:30 +00004197 else if (prefix_g)
4198 {
4199 name[0] = 'g';
4200 name[1] = ':';
4201 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004202 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len);
4203 name[lead + extra + len] = NUL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004204 }
4205 *pp = end;
4206
4207theend:
4208 clear_lval(&lv);
4209 return name;
4210}
4211
4212/*
Bram Moolenaara26b9702020-04-18 19:53:28 +02004213 * Assuming "name" is the result of trans_function_name() and it was prefixed
4214 * to use the script-local name, return the unmodified name (points into
4215 * "name"). Otherwise return NULL.
4216 * This can be used to first search for a script-local function and fall back
4217 * to the global function if not found.
4218 */
Yegappan Lakshmananee47eac2022-06-29 12:55:36 +01004219 static char_u *
Bram Moolenaara26b9702020-04-18 19:53:28 +02004220untrans_function_name(char_u *name)
4221{
4222 char_u *p;
4223
Bram Moolenaareb6880b2020-07-12 17:07:05 +02004224 if (*name == K_SPECIAL && in_vim9script())
Bram Moolenaara26b9702020-04-18 19:53:28 +02004225 {
4226 p = vim_strchr(name, '_');
4227 if (p != NULL)
4228 return p + 1;
4229 }
4230 return NULL;
4231}
4232
4233/*
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004234 * If the 'funcname' starts with "s:" or "<SID>", then expands it to the
4235 * current script ID and returns the expanded function name. The caller should
4236 * free the returned name. If not called from a script context or the function
4237 * name doesn't start with these prefixes, then returns NULL.
4238 * This doesn't check whether the script-local function exists or not.
4239 */
4240 char_u *
4241get_scriptlocal_funcname(char_u *funcname)
4242{
4243 char sid_buf[25];
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004244 int off;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004245 char_u *newname;
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004246 char_u *p = funcname;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004247
4248 if (funcname == NULL)
4249 return NULL;
4250
4251 if (STRNCMP(funcname, "s:", 2) != 0
4252 && STRNCMP(funcname, "<SID>", 5) != 0)
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004253 {
4254 ufunc_T *ufunc;
4255
4256 // The function name does not have a script-local prefix. Try finding
4257 // it when in a Vim9 script and there is no "g:" prefix.
4258 if (!in_vim9script() || STRNCMP(funcname, "g:", 2) == 0)
4259 return NULL;
4260 ufunc = find_func(funcname, FALSE);
4261 if (ufunc == NULL || func_is_global(ufunc)
4262 || (p = vim_strchr(ufunc->uf_name, '_')) == NULL)
4263 return NULL;
4264 ++p;
4265 off = 0;
4266 }
Bram Moolenaare89bfd22022-02-18 18:34:45 +00004267 else
4268 off = *funcname == 's' ? 2 : 5;
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004269
4270 if (!SCRIPT_ID_VALID(current_sctx.sc_sid))
4271 {
4272 emsg(_(e_using_sid_not_in_script_context));
4273 return NULL;
4274 }
4275 // Expand s: prefix into <SNR>nr_<name>
4276 vim_snprintf(sid_buf, sizeof(sid_buf), "<SNR>%ld_",
4277 (long)current_sctx.sc_sid);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004278 newname = alloc(STRLEN(sid_buf) + STRLEN(p + off) + 1);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004279 if (newname == NULL)
4280 return NULL;
4281 STRCPY(newname, sid_buf);
Bram Moolenaar1fca5f32022-02-18 17:50:47 +00004282 STRCAT(newname, p + off);
Yegappan Lakshmanane7f4abd2021-12-24 20:47:38 +00004283
4284 return newname;
4285}
4286
4287/*
Bram Moolenaarc2f17f72022-02-21 13:13:50 +00004288 * Return script-local "fname" with the 3-byte sequence replaced by
4289 * printable <SNR> in allocated memory.
4290 */
4291 char_u *
4292alloc_printable_func_name(char_u *fname)
4293{
4294 char_u *n = alloc(STRLEN(fname + 3) + 6);
4295
4296 if (n != NULL)
4297 {
4298 STRCPY(n, "<SNR>");
4299 STRCPY(n + 5, fname + 3);
4300 }
4301 return n;
4302}
4303
4304/*
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004305 * Call trans_function_name(), except that a lambda is returned as-is.
4306 * Returns the name in allocated memory.
4307 */
4308 char_u *
4309save_function_name(
4310 char_u **name,
4311 int *is_global,
4312 int skip,
4313 int flags,
4314 funcdict_T *fudi)
4315{
4316 char_u *p = *name;
4317 char_u *saved;
4318
4319 if (STRNCMP(p, "<lambda>", 8) == 0)
4320 {
4321 p += 8;
4322 (void)getdigits(&p);
4323 saved = vim_strnsave(*name, p - *name);
4324 if (fudi != NULL)
4325 CLEAR_POINTER(fudi);
4326 }
4327 else
4328 saved = trans_function_name(&p, is_global, skip,
4329 flags, fudi, NULL, NULL);
4330 *name = p;
4331 return saved;
4332}
4333
4334/*
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004335 * List functions. When "regmatch" is NULL all of then.
4336 * Otherwise functions matching "regmatch".
4337 */
Bram Moolenaar6abdcf82020-11-22 18:15:44 +01004338 void
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004339list_functions(regmatch_T *regmatch)
4340{
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004341 int prev_ht_changed = func_hashtab.ht_changed;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004342 long_u todo = func_hashtab.ht_used;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004343 hashitem_T *hi;
4344
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02004345 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004346 {
4347 if (!HASHITEM_EMPTY(hi))
4348 {
4349 ufunc_T *fp = HI2UF(hi);
4350
4351 --todo;
4352 if ((fp->uf_flags & FC_DEAD) == 0
4353 && (regmatch == NULL
4354 ? !message_filtered(fp->uf_name)
4355 && !func_name_refcount(fp->uf_name)
4356 : !isdigit(*fp->uf_name)
4357 && vim_regexec(regmatch, fp->uf_name, 0)))
4358 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004359 if (list_func_head(fp, FALSE) == FAIL)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004360 return;
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004361 if (function_list_modified(prev_ht_changed))
4362 return;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004363 }
4364 }
4365 }
4366}
4367
4368/*
Bram Moolenaar04b12692020-05-04 23:24:44 +02004369 * ":function" also supporting nested ":def".
Bram Moolenaar38ddf332020-07-31 22:05:04 +02004370 * When "name_arg" is not NULL this is a nested function, using "name_arg" for
4371 * the function name.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004372 * "lines_to_free" is a list of strings to be freed later.
Bram Moolenaar04b12692020-05-04 23:24:44 +02004373 * Returns a pointer to the function or NULL if no function defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004374 */
Bram Moolenaar04b12692020-05-04 23:24:44 +02004375 ufunc_T *
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004376define_function(exarg_T *eap, char_u *name_arg, garray_T *lines_to_free)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004377{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004378 int j;
4379 int c;
Bram Moolenaar57033102022-01-30 19:37:52 +00004380 int saved_did_emsg = FALSE;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004381 char_u *name = name_arg;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02004382 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004383 char_u *p;
4384 char_u *arg;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004385 char_u *whitep;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004386 char_u *line_arg = NULL;
4387 garray_T newargs;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004388 garray_T argtypes;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02004389 garray_T default_args;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004390 garray_T newlines;
4391 int varargs = FALSE;
4392 int flags = 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004393 char_u *ret_type = NULL;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004394 ufunc_T *fp = NULL;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004395 int fp_allocated = FALSE;
4396 int free_fp = FALSE;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004397 int overwrite = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004398 dictitem_T *v;
4399 funcdict_T fudi;
Bram Moolenaare38eab22019-12-05 21:50:01 +01004400 static int func_nr = 0; // number for nameless function
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004401 int paren;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004402 hashitem_T *hi;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004403 linenr_T sourcing_lnum_top;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004404 int vim9script = in_vim9script();
Bram Moolenaareef21022020-08-01 22:16:43 +02004405 imported_T *import = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004406
4407 /*
4408 * ":function" without argument: list functions.
4409 */
Bram Moolenaara72cfb82020-04-23 17:07:30 +02004410 if (ends_excmd2(eap->cmd, eap->arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004411 {
4412 if (!eap->skip)
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004413 list_functions(NULL);
Bram Moolenaar63b91732021-08-05 20:40:03 +02004414 set_nextcmd(eap, eap->arg);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004415 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004416 }
4417
4418 /*
4419 * ":function /pat": list functions matching pattern.
4420 */
4421 if (*eap->arg == '/')
4422 {
Bram Moolenaare8c4abb2020-04-02 21:13:25 +02004423 p = skip_regexp(eap->arg + 1, '/', TRUE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004424 if (!eap->skip)
4425 {
4426 regmatch_T regmatch;
4427
4428 c = *p;
4429 *p = NUL;
4430 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC);
4431 *p = c;
4432 if (regmatch.regprog != NULL)
4433 {
4434 regmatch.rm_ic = p_ic;
Bram Moolenaar3fffa972020-06-05 21:06:10 +02004435 list_functions(&regmatch);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004436 vim_regfree(regmatch.regprog);
4437 }
4438 }
4439 if (*p == '/')
4440 ++p;
Bram Moolenaar63b91732021-08-05 20:40:03 +02004441 set_nextcmd(eap, p);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004442 return NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004443 }
4444
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004445 ga_init(&newargs);
4446 ga_init(&argtypes);
4447 ga_init(&default_args);
4448
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004449 /*
4450 * Get the function name. There are these situations:
4451 * func normal function name
4452 * "name" == func, "fudi.fd_dict" == NULL
4453 * dict.func new dictionary entry
4454 * "name" == NULL, "fudi.fd_dict" set,
4455 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func
4456 * dict.func existing dict entry with a Funcref
4457 * "name" == func, "fudi.fd_dict" set,
4458 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4459 * dict.func existing dict entry that's not a Funcref
4460 * "name" == NULL, "fudi.fd_dict" set,
4461 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL
4462 * s:func script-local function name
4463 * g:func global function name, same as "func"
4464 */
4465 p = eap->arg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02004466 if (name_arg != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004467 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004468 // nested function, argument is (args).
4469 paren = TRUE;
4470 CLEAR_FIELD(fudi);
4471 }
4472 else
4473 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004474 if (vim9script)
Bram Moolenaara749a422022-02-12 19:52:25 +00004475 {
Bram Moolenaardea5ab02022-02-23 22:12:02 +00004476 if (p[0] == 's' && p[1] == ':')
4477 {
4478 semsg(_(e_cannot_use_s_colon_in_vim9_script_str), p);
4479 return NULL;
4480 }
4481 p = to_name_end(p, TRUE);
4482 if (*skipwhite(p) == '.' && vim_strchr(p, '(') != NULL)
4483 {
4484 semsg(_(e_cannot_define_dict_func_in_vim9_script_str),
4485 eap->arg);
4486 return NULL;
4487 }
4488 p = eap->arg;
Bram Moolenaara749a422022-02-12 19:52:25 +00004489 }
4490
Bram Moolenaareba3b7f2021-11-30 18:25:08 +00004491 name = save_function_name(&p, &is_global, eap->skip,
Bram Moolenaar937610b2022-01-19 17:21:29 +00004492 TFN_NO_AUTOLOAD | TFN_NEW_FUNC, &fudi);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004493 paren = (vim_strchr(p, '(') != NULL);
4494 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004495 {
Bram Moolenaar04b12692020-05-04 23:24:44 +02004496 /*
4497 * Return on an invalid expression in braces, unless the expression
4498 * evaluation has been cancelled due to an aborting error, an
4499 * interrupt, or an exception.
4500 */
4501 if (!aborting())
4502 {
4503 if (!eap->skip && fudi.fd_newkey != NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004504 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02004505 vim_free(fudi.fd_newkey);
4506 return NULL;
4507 }
4508 else
4509 eap->skip = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004510 }
Bram Moolenaardc4451d2022-01-09 21:36:37 +00004511
Bram Moolenaarfe2ef0b2022-01-10 18:08:00 +00004512 // For "export def FuncName()" in an autoload script the function name
4513 // is stored with the legacy autoload name "dir#script#FuncName" so
4514 // that it can also be found in legacy script.
Bram Moolenaar78a70532022-01-13 13:24:34 +00004515 if (is_export && name != NULL)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004516 {
4517 char_u *prefixed = may_prefix_autoload(name);
4518
4519 if (prefixed != NULL && prefixed != name)
4520 {
4521 vim_free(name);
4522 name = prefixed;
4523 }
4524 }
Bram Moolenaar8164f6e2022-02-06 13:08:41 +00004525 else if (paren && vim9script && name != NULL
Bram Moolenaar48a60482022-01-31 11:44:48 +00004526 && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
Bram Moolenaard8fe6d32022-01-30 18:40:44 +00004527 {
4528 emsg(_(e_cannot_use_name_with_hash_in_vim9_script_use_export_instead));
4529 goto ret_free;
4530 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004531 }
4532
Bram Moolenaare38eab22019-12-05 21:50:01 +01004533 // An error in a function call during evaluation of an expression in magic
4534 // braces should not cause the function not to be defined.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004535 saved_did_emsg = did_emsg;
4536 did_emsg = FALSE;
4537
4538 /*
4539 * ":function func" with only function name: list function.
4540 */
4541 if (!paren)
4542 {
4543 if (!ends_excmd(*skipwhite(p)))
4544 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00004545 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004546 goto ret_free;
4547 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02004548 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004549 if (eap->nextcmd != NULL)
4550 *p = NUL;
4551 if (!eap->skip && !got_int)
4552 {
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004553 fp = find_func(name, is_global);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004554 if (fp == NULL && ASCII_ISUPPER(*eap->arg))
4555 {
4556 char_u *up = untrans_function_name(name);
4557
4558 // With Vim9 script the name was made script-local, if not
4559 // found try again with the original name.
Bram Moolenaarec9749f2020-04-18 20:51:40 +02004560 if (up != NULL)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004561 fp = find_func(up, FALSE);
Bram Moolenaara26b9702020-04-18 19:53:28 +02004562 }
4563
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004564 if (fp != NULL)
4565 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004566 // Check no function was added or removed from a timer, e.g. at
4567 // the more prompt. "fp" may then be invalid.
4568 int prev_ht_changed = func_hashtab.ht_changed;
4569
4570 if (list_func_head(fp, TRUE) == OK)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004571 {
Bram Moolenaar398a26f2022-11-13 22:13:33 +00004572 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j)
4573 {
4574 if (FUNCLINE(fp, j) == NULL)
4575 continue;
4576 msg_putchar('\n');
4577 msg_outnum((long)(j + 1));
4578 if (j < 9)
4579 msg_putchar(' ');
4580 if (j < 99)
4581 msg_putchar(' ');
4582 if (function_list_modified(prev_ht_changed))
4583 break;
4584 msg_prt_line(FUNCLINE(fp, j), FALSE);
4585 out_flush(); // show a line at a time
4586 ui_breakcheck();
4587 }
4588 if (!got_int)
4589 {
4590 msg_putchar('\n');
4591 if (!function_list_modified(prev_ht_changed))
4592 {
4593 if (fp->uf_def_status != UF_NOT_COMPILED)
4594 msg_puts(" enddef");
4595 else
4596 msg_puts(" endfunction");
4597 }
4598 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004599 }
4600 }
4601 else
Bram Moolenaarc553a212021-12-26 20:20:34 +00004602 emsg_funcname(e_undefined_function_str, eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004603 }
4604 goto ret_free;
4605 }
4606
4607 /*
4608 * ":function name(arg1, arg2)" Define function.
4609 */
4610 p = skipwhite(p);
4611 if (*p != '(')
4612 {
4613 if (!eap->skip)
4614 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00004615 semsg(_(e_missing_paren_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004616 goto ret_free;
4617 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004618 // attempt to continue by skipping some text
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004619 if (vim_strchr(p, '(') != NULL)
4620 p = vim_strchr(p, '(');
4621 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004622
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004623 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1]))
4624 {
Bram Moolenaarba98fb52021-02-07 18:06:29 +01004625 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1);
Bram Moolenaar4efd9942021-01-24 21:14:20 +01004626 goto ret_free;
4627 }
4628
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004629 // In Vim9 script only global functions can be redefined.
4630 if (vim9script && eap->forceit && !is_global)
4631 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00004632 emsg(_(e_no_bang_allowed));
Bram Moolenaar925e9fd2020-07-25 15:41:11 +02004633 goto ret_free;
4634 }
4635
Bram Moolenaar04935fb2022-01-08 16:19:22 +00004636 ga_init2(&newlines, sizeof(char_u *), 10);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004637
Bram Moolenaar04b12692020-05-04 23:24:44 +02004638 if (!eap->skip && name_arg == NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004639 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004640 // Check the name of the function. Unless it's a dictionary function
4641 // (that we are overwriting).
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004642 if (name != NULL)
4643 arg = name;
4644 else
4645 arg = fudi.fd_newkey;
4646 if (arg != NULL && (fudi.fd_di == NULL
4647 || (fudi.fd_di->di_tv.v_type != VAR_FUNC
4648 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL)))
4649 {
Bram Moolenaar052ff292021-12-11 13:54:46 +00004650 char_u *name_base = arg;
4651 int i;
4652
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004653 if (*arg == K_SPECIAL)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004654 {
4655 name_base = vim_strchr(arg, '_');
4656 if (name_base == NULL)
4657 name_base = arg + 3;
4658 else
4659 ++name_base;
4660 }
4661 for (i = 0; name_base[i] != NUL && (i == 0
4662 ? eval_isnamec1(name_base[i])
4663 : eval_isnamec(name_base[i])); ++i)
4664 ;
4665 if (name_base[i] != NUL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004666 emsg_funcname(e_invalid_argument_str, arg);
Bram Moolenaar052ff292021-12-11 13:54:46 +00004667
4668 // In Vim9 script a function cannot have the same name as a
4669 // variable.
4670 if (vim9script && *arg == K_SPECIAL
Bram Moolenaard5f400c2022-01-06 21:10:28 +00004671 && eval_variable(name_base, (int)STRLEN(name_base), 0, NULL,
4672 NULL, EVAL_VAR_NOAUTOLOAD + EVAL_VAR_IMPORT
Bram Moolenaar052ff292021-12-11 13:54:46 +00004673 + EVAL_VAR_NO_FUNC) == OK)
4674 {
4675 semsg(_(e_redefining_script_item_str), name_base);
4676 goto ret_free;
4677 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004678 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004679 // Disallow using the g: dict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004680 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE)
Bram Moolenaar052ff292021-12-11 13:54:46 +00004681 {
Bram Moolenaar9d00e4a2022-01-05 17:49:15 +00004682 emsg(_(e_cannot_use_g_here));
Bram Moolenaar052ff292021-12-11 13:54:46 +00004683 goto ret_free;
4684 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004685 }
4686
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004687 // This may get more lines and make the pointers into the first line
4688 // invalid.
Bram Moolenaarcef12702021-01-04 14:09:43 +01004689 ++p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004690 if (get_function_args(&p, ')', &newargs,
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01004691 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE,
Bram Moolenaar057e84a2021-02-28 16:55:11 +01004692 NULL, &varargs, &default_args, eap->skip,
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004693 eap, lines_to_free) == FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004694 goto errret_2;
Bram Moolenaarcef12702021-01-04 14:09:43 +01004695 whitep = p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004696
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004697 if (eap->cmdidx == CMD_def)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004698 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004699 // find the return type: :def Func(): type
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004700 if (*skipwhite(p) == ':')
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004701 {
Bram Moolenaar33ea9fd2021-08-08 19:07:37 +02004702 if (*p != ':')
4703 {
4704 semsg(_(e_no_white_space_allowed_before_colon_str), p);
4705 p = skipwhite(p);
4706 }
4707 else if (!IS_WHITE_OR_NUL(p[1]))
4708 semsg(_(e_white_space_required_after_str_str), ":", p);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004709 ret_type = skipwhite(p + 1);
Bram Moolenaar4fc224c2020-07-26 17:56:25 +02004710 p = skip_type(ret_type, FALSE);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004711 if (p > ret_type)
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004712 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +02004713 ret_type = vim_strnsave(ret_type, p - ret_type);
Bram Moolenaarcef12702021-01-04 14:09:43 +01004714 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004715 p = skipwhite(p);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004716 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004717 else
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004718 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02004719 semsg(_(e_expected_type_str), ret_type);
Bram Moolenaarb8ce6b02020-04-23 22:23:14 +02004720 ret_type = NULL;
Bram Moolenaar5e774c72020-04-12 21:53:00 +02004721 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004722 }
Bram Moolenaare7e48382020-07-22 18:17:08 +02004723 p = skipwhite(p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004724 }
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004725 else
4726 // find extra arguments "range", "dict", "abort" and "closure"
4727 for (;;)
4728 {
Bram Moolenaarcef12702021-01-04 14:09:43 +01004729 whitep = p;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004730 p = skipwhite(p);
4731 if (STRNCMP(p, "range", 5) == 0)
4732 {
4733 flags |= FC_RANGE;
4734 p += 5;
4735 }
4736 else if (STRNCMP(p, "dict", 4) == 0)
4737 {
4738 flags |= FC_DICT;
4739 p += 4;
4740 }
4741 else if (STRNCMP(p, "abort", 5) == 0)
4742 {
4743 flags |= FC_ABORT;
4744 p += 5;
4745 }
4746 else if (STRNCMP(p, "closure", 7) == 0)
4747 {
4748 flags |= FC_CLOSURE;
4749 p += 7;
4750 if (current_funccal == NULL)
4751 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004752 emsg_funcname(e_closure_function_should_not_be_at_top_level,
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004753 name == NULL ? (char_u *)"" : name);
4754 goto erret;
4755 }
4756 }
4757 else
4758 break;
4759 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004760
Bram Moolenaare38eab22019-12-05 21:50:01 +01004761 // When there is a line break use what follows for the function body.
4762 // Makes 'exe "func Test()\n...\nendfunc"' work.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004763 if (*p == '\n')
4764 line_arg = p + 1;
Bram Moolenaare7e48382020-07-22 18:17:08 +02004765 else if (*p != NUL
Bram Moolenaar98981072020-07-29 14:40:25 +02004766 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function)
4767 && eap->cmdidx != CMD_def)
Bram Moolenaarcef12702021-01-04 14:09:43 +01004768 && !(VIM_ISWHITE(*whitep) && *p == '#'
4769 && (vim9script || eap->cmdidx == CMD_def))
Bram Moolenaare7e48382020-07-22 18:17:08 +02004770 && !eap->skip
4771 && !did_emsg)
Bram Moolenaar74409f62022-01-01 15:58:22 +00004772 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004773
4774 /*
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004775 * Read the body of the function, until "}", ":endfunction" or ":enddef" is
4776 * found.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004777 */
4778 if (KeyTyped)
4779 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004780 // Check if the function already exists, don't let the user type the
4781 // whole function before telling him it doesn't work! For a script we
4782 // need to skip the body to be able to find what follows.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004783 if (!eap->skip && !eap->forceit)
4784 {
4785 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL)
Bram Moolenaara6f79292022-01-04 21:30:47 +00004786 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00004787 else if (name != NULL && find_func(name, is_global) != NULL)
Bram Moolenaar1a992222021-12-31 17:25:48 +00004788 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004789 }
4790
4791 if (!eap->skip && did_emsg)
4792 goto erret;
4793
Bram Moolenaare38eab22019-12-05 21:50:01 +01004794 msg_putchar('\n'); // don't overwrite the function name
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004795 cmdline_row = msg_row;
4796 }
4797
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004798 // Save the starting line number.
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004799 sourcing_lnum_top = SOURCING_LNUM;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02004800
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004801 // Do not define the function when getting the body fails and when
4802 // skipping.
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00004803 if (get_function_body(eap, &newlines, line_arg, lines_to_free) == FAIL
Bram Moolenaard87c21a2021-05-18 13:40:33 +02004804 || eap->skip)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004805 goto erret;
4806
4807 /*
4808 * If there are no errors, add the function
4809 */
4810 if (fudi.fd_dict == NULL)
4811 {
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004812 hashtab_T *ht;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004813 char_u *find_name = name;
4814 int var_conflict = FALSE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004815 int ffed_flags = is_global ? FFED_IS_GLOBAL : 0;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004816
Bram Moolenaar32b3f822021-01-06 21:59:39 +01004817 v = find_var(name, &ht, TRUE);
Bram Moolenaar4525a572022-02-13 11:57:33 +00004818 if (v != NULL && (vim9script || v->di_tv.v_type == VAR_FUNC))
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004819 var_conflict = TRUE;
4820
4821 if (SCRIPT_ID_VALID(current_sctx.sc_sid))
4822 {
4823 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
4824
4825 if (si->sn_autoload_prefix != NULL)
4826 {
4827 if (is_export)
4828 {
4829 find_name = name + STRLEN(si->sn_autoload_prefix);
4830 v = find_var(find_name, &ht, TRUE);
4831 if (v != NULL)
4832 var_conflict = TRUE;
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004833 // Only check if the function already exists in the script,
4834 // global functions can be shadowed.
4835 ffed_flags |= FFED_NO_GLOBAL;
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004836 }
4837 else
4838 {
4839 char_u *prefixed = may_prefix_autoload(name);
4840
Bram Moolenaar9383a3a2022-02-25 21:35:17 +00004841 if (prefixed != NULL && prefixed != name)
Bram Moolenaar9c7cae62022-01-20 19:10:25 +00004842 {
4843 v = find_var(prefixed, &ht, TRUE);
4844 if (v != NULL)
4845 var_conflict = TRUE;
4846 vim_free(prefixed);
4847 }
4848 }
4849 }
4850 }
4851 if (var_conflict)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004852 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004853 emsg_funcname(e_function_name_conflicts_with_variable_str, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004854 goto erret;
4855 }
4856
Bram Moolenaaracc4b562022-01-24 13:54:45 +00004857 fp = find_func_even_dead(find_name, ffed_flags);
Bram Moolenaareef21022020-08-01 22:16:43 +02004858 if (vim9script)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004859 {
Bram Moolenaareef21022020-08-01 22:16:43 +02004860 char_u *uname = untrans_function_name(name);
4861
Bram Moolenaar4b1d9632022-02-13 21:51:08 +00004862 import = find_imported(uname == NULL ? name : uname, 0, FALSE);
Bram Moolenaareef21022020-08-01 22:16:43 +02004863 }
4864
4865 if (fp != NULL || import != NULL)
4866 {
4867 int dead = fp != NULL && (fp->uf_flags & FC_DEAD);
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004868
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004869 // Function can be replaced with "function!" and when sourcing the
4870 // same script again, but only once.
Bram Moolenaareef21022020-08-01 22:16:43 +02004871 // A name that is used by an import can not be overruled.
4872 if (import != NULL
4873 || (!dead && !eap->forceit
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004874 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid
Bram Moolenaareef21022020-08-01 22:16:43 +02004875 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004876 {
Bram Moolenaard604d782021-11-20 21:46:20 +00004877 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaareef21022020-08-01 22:16:43 +02004878 if (vim9script)
Bram Moolenaar7cb6fc22020-08-21 22:36:47 +02004879 emsg_funcname(e_name_already_defined_str, name);
Bram Moolenaareef21022020-08-01 22:16:43 +02004880 else
Bram Moolenaar1a992222021-12-31 17:25:48 +00004881 emsg_funcname(e_function_str_already_exists_add_bang_to_replace, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004882 goto erret;
4883 }
4884 if (fp->uf_calls > 0)
4885 {
Bram Moolenaarded5f1b2018-11-10 17:33:29 +01004886 emsg_funcname(
Bram Moolenaarc553a212021-12-26 20:20:34 +00004887 e_cannot_redefine_function_str_it_is_in_use, name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004888 goto erret;
4889 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004890 if (fp->uf_refcount > 1)
4891 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004892 // This function is referenced somewhere, don't redefine it but
4893 // create a new one.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004894 --fp->uf_refcount;
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02004895 fp->uf_flags |= FC_REMOVED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004896 fp = NULL;
4897 overwrite = TRUE;
4898 }
4899 else
4900 {
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004901 char_u *exp_name = fp->uf_name_exp;
4902
4903 // redefine existing function, keep the expanded name
Bram Moolenaard23a8232018-02-10 18:45:26 +01004904 VIM_CLEAR(name);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004905 fp->uf_name_exp = NULL;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004906 func_clear_items(fp);
Bram Moolenaarb9adef72020-01-02 14:31:22 +01004907 fp->uf_name_exp = exp_name;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01004908 fp->uf_flags &= ~FC_DEAD;
Bram Moolenaar79c2ad52018-07-29 17:40:43 +02004909#ifdef FEAT_PROFILE
4910 fp->uf_profiling = FALSE;
4911 fp->uf_prof_initialized = FALSE;
4912#endif
Bram Moolenaarcdc40c42020-12-26 17:43:08 +01004913 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02004914 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004915 }
4916 }
4917 else
4918 {
4919 char numbuf[20];
4920
4921 fp = NULL;
4922 if (fudi.fd_newkey == NULL && !eap->forceit)
4923 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00004924 emsg(_(e_dictionary_entry_already_exists));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004925 goto erret;
4926 }
4927 if (fudi.fd_di == NULL)
4928 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004929 // Can't add a function to a locked dictionary
Bram Moolenaara187c432020-09-16 21:08:28 +02004930 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004931 goto erret;
4932 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01004933 // Can't change an existing function if it is locked
Bram Moolenaara187c432020-09-16 21:08:28 +02004934 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004935 goto erret;
4936
Bram Moolenaare38eab22019-12-05 21:50:01 +01004937 // Give the function a sequential number. Can only be used with a
4938 // Funcref!
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004939 vim_free(name);
4940 sprintf(numbuf, "%d", ++func_nr);
4941 name = vim_strsave((char_u *)numbuf);
4942 if (name == NULL)
4943 goto erret;
4944 }
4945
4946 if (fp == NULL)
4947 {
4948 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL)
4949 {
4950 int slen, plen;
4951 char_u *scriptname;
4952
Bram Moolenaare38eab22019-12-05 21:50:01 +01004953 // Check that the autoload name matches the script name.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004954 j = FAIL;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004955 if (SOURCING_NAME != NULL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004956 {
4957 scriptname = autoload_name(name);
4958 if (scriptname != NULL)
4959 {
4960 p = vim_strchr(scriptname, '/');
4961 plen = (int)STRLEN(p);
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004962 slen = (int)STRLEN(SOURCING_NAME);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004963 if (slen > plen && fnamecmp(p,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01004964 SOURCING_NAME + slen - plen) == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004965 j = OK;
4966 vim_free(scriptname);
4967 }
4968 }
4969 if (j == FAIL)
4970 {
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004971 linenr_T save_lnum = SOURCING_LNUM;
4972
4973 SOURCING_LNUM = sourcing_lnum_top;
Bram Moolenaar677658a2022-01-05 16:09:06 +00004974 semsg(_(e_function_name_does_not_match_script_file_name_str),
4975 name);
Bram Moolenaarf48b2fa2021-04-12 22:02:36 +02004976 SOURCING_LNUM = save_lnum;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004977 goto erret;
4978 }
4979 }
4980
Bram Moolenaar47ed5532019-08-08 20:49:14 +02004981 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004982 if (fp == NULL)
4983 goto erret;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00004984 fp_allocated = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004985
4986 if (fudi.fd_dict != NULL)
4987 {
4988 if (fudi.fd_di == NULL)
4989 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01004990 // add new dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004991 fudi.fd_di = dictitem_alloc(fudi.fd_newkey);
4992 if (fudi.fd_di == NULL)
4993 {
4994 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02004995 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02004996 goto erret;
4997 }
4998 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL)
4999 {
5000 vim_free(fudi.fd_di);
5001 vim_free(fp);
Bram Moolenaara14e6972020-05-25 23:29:28 +02005002 fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005003 goto erret;
5004 }
5005 }
5006 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01005007 // overwrite existing dict entry
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005008 clear_tv(&fudi.fd_di->di_tv);
5009 fudi.fd_di->di_tv.v_type = VAR_FUNC;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005010 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005011
Bram Moolenaare38eab22019-12-05 21:50:01 +01005012 // behave like "dict" was used
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005013 flags |= FC_DICT;
5014 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005015 }
5016 fp->uf_args = newargs;
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005017 fp->uf_def_args = default_args;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005018 fp->uf_ret_type = &t_any;
Bram Moolenaar5deeb3f2020-04-05 17:08:17 +02005019 fp->uf_func_type = &t_func_any;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005020
5021 if (eap->cmdidx == CMD_def)
5022 {
Bram Moolenaar39ca4122020-10-20 14:25:07 +02005023 int lnum_save = SOURCING_LNUM;
5024 cstack_T *cstack = eap->cstack;
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005025
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005026 fp->uf_def_status = UF_TO_BE_COMPILED;
Bram Moolenaar822ba242020-05-24 23:00:18 +02005027
Bram Moolenaarbfe12042020-02-04 21:54:07 +01005028 // error messages are for the first function line
5029 SOURCING_LNUM = sourcing_lnum_top;
5030
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02005031 // The function may use script variables from the context.
5032 function_using_block_scopes(fp, cstack);
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02005033
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005034 if (parse_argument_types(fp, &argtypes, varargs) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005035 {
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005036 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005037 free_fp = fp_allocated;
5038 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005039 }
Bram Moolenaarb4d16cb2020-11-05 18:45:46 +01005040 varargs = FALSE;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005041
5042 // parse the return type, if any
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005043 if (parse_return_type(fp, ret_type) == FAIL)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005044 {
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005045 SOURCING_LNUM = lnum_save;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005046 free_fp = fp_allocated;
Bram Moolenaar7a6eaa02021-03-21 20:53:29 +01005047 goto erret;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005048 }
Bram Moolenaar09689a02020-05-09 22:50:08 +02005049 SOURCING_LNUM = lnum_save;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005050 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005051 else
Bram Moolenaar0cb5bcf2020-06-20 18:19:09 +02005052 fp->uf_def_status = UF_NOT_COMPILED;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005053
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005054 if (fp_allocated)
5055 {
5056 // insert the new function in the function list
5057 set_ufunc_name(fp, name);
5058 if (overwrite)
5059 {
5060 hi = hash_find(&func_hashtab, name);
5061 hi->hi_key = UF2HIKEY(fp);
5062 }
5063 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL)
5064 {
5065 free_fp = TRUE;
5066 goto erret;
5067 }
5068 fp->uf_refcount = 1;
5069 }
5070
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005071 fp->uf_lines = newlines;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005072 newlines.ga_data = NULL;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005073 if ((flags & FC_CLOSURE) != 0)
5074 {
Bram Moolenaar58016442016-07-31 18:30:22 +02005075 if (register_closure(fp) == FAIL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005076 goto erret;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02005077 }
5078 else
5079 fp->uf_scoped = NULL;
5080
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005081#ifdef FEAT_PROFILE
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005082 if (prof_def_func())
5083 func_do_profile(fp);
5084#endif
5085 fp->uf_varargs = varargs;
Bram Moolenaar93343722018-07-10 19:39:18 +02005086 if (sandbox)
5087 flags |= FC_SANDBOX;
Bram Moolenaare7e48382020-07-22 18:17:08 +02005088 if (vim9script && !ASCII_ISUPPER(*fp->uf_name))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005089 flags |= FC_VIM9;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005090 fp->uf_flags = flags;
5091 fp->uf_calls = 0;
Bram Moolenaar63ce4842020-02-19 15:46:48 +01005092 fp->uf_cleared = FALSE;
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02005093 fp->uf_script_ctx = current_sctx;
Bram Moolenaarf9b2b492020-08-05 14:34:14 +02005094 fp->uf_script_ctx_version = current_sctx.sc_version;
Bram Moolenaarbc2cfe42019-07-04 14:57:12 +02005095 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005096 if (is_export)
5097 {
5098 fp->uf_flags |= FC_EXPORT;
dundargocc57b5bc2022-11-02 13:30:51 +00005099 // let do_one_cmd() know the export worked.
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005100 is_export = FALSE;
5101 }
5102
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005103 if (eap->cmdidx == CMD_def)
5104 set_function_type(fp);
Bram Moolenaar67979662020-06-20 22:50:47 +02005105 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9)
5106 // :func does not use Vim9 script syntax, even in a Vim9 script file
5107 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX;
Bram Moolenaar6ff71d82020-05-24 23:45:24 +02005108
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005109 goto ret_free;
5110
5111erret:
5112 ga_clear_strings(&newargs);
Bram Moolenaar42ae78c2019-05-09 21:08:58 +02005113 ga_clear_strings(&default_args);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005114 if (fp != NULL)
5115 {
5116 ga_init(&fp->uf_args);
5117 ga_init(&fp->uf_def_args);
5118 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005119errret_2:
5120 ga_clear_strings(&newlines);
Bram Moolenaar31842cd2021-02-12 22:10:21 +01005121 if (fp != NULL)
5122 VIM_CLEAR(fp->uf_arg_types);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005123 if (free_fp)
5124 {
5125 vim_free(fp);
5126 fp = NULL;
5127 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005128ret_free:
Bram Moolenaar292b90d2020-03-18 15:23:16 +01005129 ga_clear_strings(&argtypes);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005130 vim_free(fudi.fd_newkey);
Bram Moolenaar04b12692020-05-04 23:24:44 +02005131 if (name != name_arg)
5132 vim_free(name);
Bram Moolenaar5e774c72020-04-12 21:53:00 +02005133 vim_free(ret_type);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005134 did_emsg |= saved_did_emsg;
Bram Moolenaar04b12692020-05-04 23:24:44 +02005135
5136 return fp;
5137}
5138
5139/*
5140 * ":function"
5141 */
5142 void
5143ex_function(exarg_T *eap)
5144{
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005145 garray_T lines_to_free;
Bram Moolenaar9c23f9b2021-12-26 14:23:22 +00005146
Bram Moolenaar9f1a39a2022-01-08 15:39:39 +00005147 ga_init2(&lines_to_free, sizeof(char_u *), 50);
5148 (void)define_function(eap, NULL, &lines_to_free);
5149 ga_clear_strings(&lines_to_free);
Bram Moolenaar822ba242020-05-24 23:00:18 +02005150}
5151
5152/*
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005153 * Find a function by name, including "<lambda>123".
5154 * Check for "profile" and "debug" arguments and set"compile_type".
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005155 * Caller should initialize "compile_type" to CT_NONE.
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005156 * Return NULL if not found.
5157 */
5158 ufunc_T *
5159find_func_by_name(char_u *name, compiletype_T *compile_type)
5160{
5161 char_u *arg = name;
5162 char_u *fname;
5163 ufunc_T *ufunc;
5164 int is_global = FALSE;
5165
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005166 if (STRNCMP(arg, "profile", 7) == 0 && VIM_ISWHITE(arg[7]))
5167 {
5168 *compile_type = CT_PROFILE;
5169 arg = skipwhite(arg + 7);
5170 }
5171 else if (STRNCMP(arg, "debug", 5) == 0 && VIM_ISWHITE(arg[5]))
5172 {
5173 *compile_type = CT_DEBUG;
5174 arg = skipwhite(arg + 5);
5175 }
5176
5177 if (STRNCMP(arg, "<lambda>", 8) == 0)
5178 {
5179 arg += 8;
5180 (void)getdigits(&arg);
5181 fname = vim_strnsave(name, arg - name);
5182 }
5183 else
5184 fname = trans_function_name(&arg, &is_global, FALSE,
5185 TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD, NULL, NULL, NULL);
5186 if (fname == NULL)
5187 {
5188 semsg(_(e_invalid_argument_str), name);
5189 return NULL;
5190 }
5191 if (!ends_excmd2(name, arg))
5192 {
Bram Moolenaar1a56ea82022-05-21 16:28:42 +01005193 vim_free(fname);
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005194 emsg(ex_errmsg(e_trailing_characters_str, arg));
5195 return NULL;
5196 }
5197
5198 ufunc = find_func(fname, is_global);
5199 if (ufunc == NULL)
5200 {
5201 char_u *p = untrans_function_name(fname);
5202
5203 if (p != NULL)
5204 // Try again without making it script-local.
5205 ufunc = find_func(p, FALSE);
5206 }
5207 vim_free(fname);
5208 if (ufunc == NULL)
5209 semsg(_(e_cannot_find_function_str), name);
5210 return ufunc;
5211}
5212
5213/*
Bram Moolenaar96f8f492020-09-09 17:08:51 +02005214 * :defcompile - compile all :def functions in the current script that need to
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005215 * be compiled or the one specified by the argument.
5216 * Skips dead functions. Doesn't do profiling.
Bram Moolenaar822ba242020-05-24 23:00:18 +02005217 */
5218 void
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005219ex_defcompile(exarg_T *eap)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005220{
Bram Moolenaar822ba242020-05-24 23:00:18 +02005221 ufunc_T *ufunc;
5222
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005223 if (*eap->arg != NUL)
Bram Moolenaar822ba242020-05-24 23:00:18 +02005224 {
Bram Moolenaar5a01caa2022-05-21 18:56:58 +01005225 compiletype_T compile_type = CT_NONE;
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005226
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005227 ufunc = find_func_by_name(eap->arg, &compile_type);
5228 if (ufunc != NULL)
5229 {
5230 if (func_needs_compiling(ufunc, compile_type))
5231 (void)compile_def_function(ufunc, FALSE, compile_type, NULL);
5232 else
5233 smsg(_("Function %s does not need compiling"), eap->arg);
5234 }
5235 }
5236 else
5237 {
5238 long todo = (long)func_hashtab.ht_used;
5239 int changed = func_hashtab.ht_changed;
5240 hashitem_T *hi;
5241
5242 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
5243 {
5244 if (!HASHITEM_EMPTY(hi))
5245 {
5246 --todo;
5247 ufunc = HI2UF(hi);
5248 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid
5249 && ufunc->uf_def_status == UF_TO_BE_COMPILED
5250 && (ufunc->uf_flags & FC_DEAD) == 0)
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005251 {
Bram Moolenaarf79d9dd2022-05-21 15:39:02 +01005252 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL);
5253
5254 if (func_hashtab.ht_changed != changed)
5255 {
5256 // a function has been added or removed, need to start
5257 // over
5258 todo = (long)func_hashtab.ht_used;
5259 changed = func_hashtab.ht_changed;
5260 hi = func_hashtab.ht_array;
5261 --hi;
5262 }
Bram Moolenaarebc3de62020-05-26 11:08:28 +02005263 }
5264 }
Bram Moolenaar822ba242020-05-24 23:00:18 +02005265 }
5266 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005267}
5268
5269/*
5270 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case).
5271 * Return 2 if "p" starts with "s:".
5272 * Return 0 otherwise.
5273 */
5274 int
5275eval_fname_script(char_u *p)
5276{
Bram Moolenaare38eab22019-12-05 21:50:01 +01005277 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with
5278 // the standard library function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005279 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0
5280 || MB_STRNICMP(p + 1, "SNR>", 4) == 0))
5281 return 5;
5282 if (p[0] == 's' && p[1] == ':')
5283 return 2;
5284 return 0;
5285}
5286
5287 int
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005288translated_function_exists(char_u *name, int is_global)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005289{
5290 if (builtin_function(name, -1))
Bram Moolenaarac92e252019-08-03 21:58:38 +02005291 return has_internal_func(name);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005292 return find_func(name, is_global) != NULL;
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005293}
5294
5295/*
5296 * Return TRUE when "ufunc" has old-style "..." varargs
5297 * or named varargs "...name: type".
5298 */
5299 int
5300has_varargs(ufunc_T *ufunc)
5301{
5302 return ufunc->uf_varargs || ufunc->uf_va_name != NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005303}
5304
5305/*
5306 * Return TRUE if a function "name" exists.
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005307 * If "no_defef" is TRUE, do not dereference a Funcref.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005308 */
5309 int
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005310function_exists(char_u *name, int no_deref)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005311{
5312 char_u *nm = name;
5313 char_u *p;
5314 int n = FALSE;
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005315 int flag;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005316 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005317
Bram Moolenaarb54c3ff2016-07-31 14:11:58 +02005318 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD;
5319 if (no_deref)
5320 flag |= TFN_NO_DEREF;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005321 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005322 nm = skipwhite(nm);
5323
Bram Moolenaare38eab22019-12-05 21:50:01 +01005324 // Only accept "funcname", "funcname ", "funcname (..." and
5325 // "funcname(...", not "funcname!...".
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005326 if (p != NULL && (*nm == NUL || *nm == '('))
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005327 n = translated_function_exists(p, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005328 vim_free(p);
5329 return n;
5330}
5331
Bram Moolenaar113e1072019-01-20 15:30:40 +01005332#if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005333 char_u *
5334get_expanded_name(char_u *name, int check)
5335{
5336 char_u *nm = name;
5337 char_u *p;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005338 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005339
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005340 p = trans_function_name(&nm, &is_global, FALSE,
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005341 TFN_INT|TFN_QUIET, NULL, NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005342
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005343 if (p != NULL && *nm == NUL
5344 && (!check || translated_function_exists(p, is_global)))
5345 return p;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005346
5347 vim_free(p);
5348 return NULL;
5349}
Bram Moolenaar113e1072019-01-20 15:30:40 +01005350#endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005351
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005352/*
5353 * Function given to ExpandGeneric() to obtain the list of user defined
5354 * function names.
5355 */
5356 char_u *
5357get_user_func_name(expand_T *xp, int idx)
5358{
5359 static long_u done;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005360 static int changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005361 static hashitem_T *hi;
5362 ufunc_T *fp;
5363
5364 if (idx == 0)
5365 {
5366 done = 0;
5367 hi = func_hashtab.ht_array;
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005368 changed = func_hashtab.ht_changed;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005369 }
Bram Moolenaar1f22cc52020-07-14 21:08:49 +02005370 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005371 {
5372 if (done++ > 0)
5373 ++hi;
5374 while (HASHITEM_EMPTY(hi))
5375 ++hi;
5376 fp = HI2UF(hi);
5377
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005378 // don't show dead, dict and lambda functions
5379 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT)
Bram Moolenaarb49edc12016-07-23 15:47:34 +02005380 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0)
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005381 return (char_u *)"";
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005382
5383 if (STRLEN(fp->uf_name) + 4 >= IOSIZE)
Bram Moolenaare38eab22019-12-05 21:50:01 +01005384 return fp->uf_name; // prevents overflow
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005385
5386 cat_func_name(IObuff, fp);
naohiro ono9aecf792021-08-28 15:56:06 +02005387 if (xp->xp_context != EXPAND_USER_FUNC
5388 && xp->xp_context != EXPAND_DISASSEMBLE)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005389 {
5390 STRCAT(IObuff, "(");
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01005391 if (!has_varargs(fp) && fp->uf_args.ga_len == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005392 STRCAT(IObuff, ")");
5393 }
5394 return IObuff;
5395 }
5396 return NULL;
5397}
5398
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005399/*
5400 * ":delfunction {name}"
5401 */
5402 void
5403ex_delfunction(exarg_T *eap)
5404{
5405 ufunc_T *fp = NULL;
5406 char_u *p;
5407 char_u *name;
5408 funcdict_T fudi;
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005409 int is_global = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005410
5411 p = eap->arg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005412 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi,
5413 NULL, NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005414 vim_free(fudi.fd_newkey);
5415 if (name == NULL)
5416 {
5417 if (fudi.fd_dict != NULL && !eap->skip)
Bram Moolenaara6f79292022-01-04 21:30:47 +00005418 emsg(_(e_funcref_required));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005419 return;
5420 }
5421 if (!ends_excmd(*skipwhite(p)))
5422 {
5423 vim_free(name);
Bram Moolenaar74409f62022-01-01 15:58:22 +00005424 semsg(_(e_trailing_characters_str), p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005425 return;
5426 }
Bram Moolenaar63b91732021-08-05 20:40:03 +02005427 set_nextcmd(eap, p);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005428 if (eap->nextcmd != NULL)
5429 *p = NUL;
5430
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005431 if (numbered_function(name) && fudi.fd_dict == NULL)
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005432 {
5433 if (!eap->skip)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00005434 semsg(_(e_invalid_argument_str), eap->arg);
Bram Moolenaarddfc0512021-09-06 20:56:56 +02005435 vim_free(name);
5436 return;
5437 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005438 if (!eap->skip)
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005439 fp = find_func(name, is_global);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005440 vim_free(name);
5441
5442 if (!eap->skip)
5443 {
5444 if (fp == NULL)
5445 {
Bram Moolenaard6abcd12017-06-22 19:15:24 +02005446 if (!eap->forceit)
Bram Moolenaarc553a212021-12-26 20:20:34 +00005447 semsg(_(e_unknown_function_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005448 return;
5449 }
5450 if (fp->uf_calls > 0)
5451 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005452 semsg(_(e_cannot_delete_function_str_it_is_in_use), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005453 return;
5454 }
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005455 if (fp->uf_flags & FC_VIM9)
5456 {
Bram Moolenaar451c2e32020-08-15 16:33:28 +02005457 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg);
Bram Moolenaar4c17ad92020-04-27 22:47:51 +02005458 return;
5459 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005460
5461 if (fudi.fd_dict != NULL)
5462 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005463 // Delete the dict item that refers to the function, it will
5464 // invoke func_unref() and possibly delete the function.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005465 dictitem_remove(fudi.fd_dict, fudi.fd_di);
5466 }
5467 else
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005468 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005469 // A normal function (not a numbered function or lambda) has a
5470 // refcount of 1 for the entry in the hashtable. When deleting
5471 // it and the refcount is more than one, it should be kept.
5472 // A numbered function and lambda should be kept if the refcount is
5473 // one or more.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005474 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1))
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005475 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005476 // Function is still referenced somewhere. Don't free it but
5477 // do remove it from the hashtable.
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005478 if (func_remove(fp))
5479 fp->uf_refcount--;
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005480 }
5481 else
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005482 func_clear_free(fp, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005483 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005484 }
5485}
5486
5487/*
5488 * Unreference a Function: decrement the reference count and free it when it
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005489 * becomes zero.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005490 */
5491 void
5492func_unref(char_u *name)
5493{
Bram Moolenaar97baee82016-07-26 20:46:08 +02005494 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005495
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005496 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005497 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005498 fp = find_func(name, FALSE);
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005499 if (fp == NULL && numbered_function(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005500 {
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005501#ifdef EXITFREE
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005502 if (!entered_free_all_mem)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005503#endif
Bram Moolenaar95f09602016-11-10 20:01:45 +01005504 internal_error("func_unref()");
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005505 }
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005506 func_ptr_unref(fp);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005507}
5508
5509/*
5510 * Unreference a Function: decrement the reference count and free it when it
5511 * becomes zero.
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005512 * Also when it becomes one and uf_partial points to the function.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005513 */
5514 void
5515func_ptr_unref(ufunc_T *fp)
5516{
Bram Moolenaar0d3de8c2021-01-22 20:46:27 +01005517 if (fp != NULL && (--fp->uf_refcount <= 0
5518 || (fp->uf_refcount == 1 && fp->uf_partial != NULL
5519 && fp->uf_partial->pt_refcount <= 1
5520 && fp->uf_partial->pt_func == fp)))
Bram Moolenaar97baee82016-07-26 20:46:08 +02005521 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005522 // Only delete it when it's not being used. Otherwise it's done
5523 // when "uf_calls" becomes zero.
Bram Moolenaar97baee82016-07-26 20:46:08 +02005524 if (fp->uf_calls == 0)
Bram Moolenaar03ff9bc2017-02-02 22:59:27 +01005525 func_clear_free(fp, FALSE);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005526 }
5527}
5528
5529/*
5530 * Count a reference to a Function.
5531 */
5532 void
5533func_ref(char_u *name)
5534{
5535 ufunc_T *fp;
5536
Bram Moolenaar8dd3a432016-08-01 20:46:25 +02005537 if (name == NULL || !func_name_refcount(name))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005538 return;
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00005539 fp = find_func(name, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005540 if (fp != NULL)
5541 ++fp->uf_refcount;
Bram Moolenaar57bc2332021-12-15 12:06:43 +00005542 else if (numbered_function(name))
Bram Moolenaare38eab22019-12-05 21:50:01 +01005543 // Only give an error for a numbered function.
5544 // Fail silently, when named or lambda function isn't found.
Bram Moolenaar95f09602016-11-10 20:01:45 +01005545 internal_error("func_ref()");
Bram Moolenaar437bafe2016-08-01 15:40:54 +02005546}
5547
5548/*
5549 * Count a reference to a Function.
5550 */
5551 void
5552func_ptr_ref(ufunc_T *fp)
5553{
5554 if (fp != NULL)
5555 ++fp->uf_refcount;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005556}
5557
5558/*
5559 * Return TRUE if items in "fc" do not have "copyID". That means they are not
5560 * referenced from anywhere that is in use.
5561 */
5562 static int
5563can_free_funccal(funccall_T *fc, int copyID)
5564{
Bram Moolenaarca16c602022-09-06 18:57:08 +01005565 return (fc->fc_l_varlist.lv_copyID != copyID
5566 && fc->fc_l_vars.dv_copyID != copyID
5567 && fc->fc_l_avars.dv_copyID != copyID
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02005568 && fc->fc_copyID != copyID);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005569}
5570
5571/*
5572 * ":return [expr]"
5573 */
5574 void
5575ex_return(exarg_T *eap)
5576{
5577 char_u *arg = eap->arg;
5578 typval_T rettv;
5579 int returning = FALSE;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005580 evalarg_T evalarg;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005581
5582 if (current_funccal == NULL)
5583 {
Bram Moolenaarc553a212021-12-26 20:20:34 +00005584 emsg(_(e_return_not_inside_function));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005585 return;
5586 }
5587
Bram Moolenaar844fb642021-10-23 13:32:30 +01005588 init_evalarg(&evalarg);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +02005589 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE;
5590
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005591 if (eap->skip)
5592 ++emsg_skip;
5593
5594 eap->nextcmd = NULL;
5595 if ((*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02005596 && eval0(arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005597 {
5598 if (!eap->skip)
5599 returning = do_return(eap, FALSE, TRUE, &rettv);
5600 else
5601 clear_tv(&rettv);
5602 }
Bram Moolenaare38eab22019-12-05 21:50:01 +01005603 // It's safer to return also on error.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005604 else if (!eap->skip)
5605 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005606 // In return statement, cause_abort should be force_abort.
Bram Moolenaarfabaf752017-12-23 17:26:11 +01005607 update_force_abort();
5608
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005609 /*
5610 * Return unless the expression evaluation has been cancelled due to an
5611 * aborting error, an interrupt, or an exception.
5612 */
5613 if (!aborting())
5614 returning = do_return(eap, FALSE, TRUE, NULL);
5615 }
5616
Bram Moolenaare38eab22019-12-05 21:50:01 +01005617 // When skipping or the return gets pending, advance to the next command
5618 // in this line (!returning). Otherwise, ignore the rest of the line.
5619 // Following lines will be ignored by get_func_line().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005620 if (returning)
5621 eap->nextcmd = NULL;
Bram Moolenaare38eab22019-12-05 21:50:01 +01005622 else if (eap->nextcmd == NULL) // no argument
Bram Moolenaar63b91732021-08-05 20:40:03 +02005623 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005624
5625 if (eap->skip)
5626 --emsg_skip;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02005627 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005628}
5629
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005630 static int
5631ex_call_inner(
5632 exarg_T *eap,
5633 char_u *name,
5634 char_u **arg,
5635 char_u *startarg,
5636 funcexe_T *funcexe_init,
5637 evalarg_T *evalarg)
5638{
5639 linenr_T lnum;
5640 int doesrange;
5641 typval_T rettv;
5642 int failed = FALSE;
5643
5644 /*
5645 * When skipping, evaluate the function once, to find the end of the
5646 * arguments.
5647 * When the function takes a range, this is discovered after the first
5648 * call, and the loop is broken.
5649 */
5650 if (eap->skip)
5651 {
5652 ++emsg_skip;
5653 lnum = eap->line2; // do it once, also with an invalid range
5654 }
5655 else
5656 lnum = eap->line1;
5657 for ( ; lnum <= eap->line2; ++lnum)
5658 {
5659 funcexe_T funcexe;
5660
5661 if (!eap->skip && eap->addr_count > 0)
5662 {
5663 if (lnum > curbuf->b_ml.ml_line_count)
5664 {
5665 // If the function deleted lines or switched to another buffer
5666 // the line number may become invalid.
5667 emsg(_(e_invalid_range));
5668 break;
5669 }
5670 curwin->w_cursor.lnum = lnum;
5671 curwin->w_cursor.col = 0;
5672 curwin->w_cursor.coladd = 0;
5673 }
5674 *arg = startarg;
5675
5676 funcexe = *funcexe_init;
5677 funcexe.fe_doesrange = &doesrange;
5678 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5679 if (get_func_tv(name, -1, &rettv, arg, evalarg, &funcexe) == FAIL)
5680 {
5681 failed = TRUE;
5682 break;
5683 }
5684 if (has_watchexpr())
5685 dbg_check_breakpoint(eap);
5686
5687 // Handle a function returning a Funcref, Dictionary or List.
5688 if (handle_subscript(arg, NULL, &rettv,
5689 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL)
5690 {
5691 failed = TRUE;
5692 break;
5693 }
5694
5695 clear_tv(&rettv);
5696 if (doesrange || eap->skip)
5697 break;
5698
5699 // Stop when immediately aborting on error, or when an interrupt
5700 // occurred or an exception was thrown but not caught.
5701 // get_func_tv() returned OK, so that the check for trailing
5702 // characters below is executed.
5703 if (aborting())
5704 break;
5705 }
5706 if (eap->skip)
5707 --emsg_skip;
5708 return failed;
5709}
5710
5711/*
5712 * Core part of ":defer func(arg)". "arg" points to the "(" and is advanced.
5713 * Returns FAIL or OK.
5714 */
5715 static int
Bram Moolenaar86d87252022-09-05 21:21:25 +01005716ex_defer_inner(
5717 char_u *name,
5718 char_u **arg,
Bram Moolenaar16900322022-09-08 19:51:45 +01005719 type_T *type,
Bram Moolenaar86d87252022-09-05 21:21:25 +01005720 partial_T *partial,
5721 evalarg_T *evalarg)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005722{
5723 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments
Bram Moolenaar86d87252022-09-05 21:21:25 +01005724 int partial_argc = 0; // number of partial arguments
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005725 int argcount = 0; // number of arguments found
Bram Moolenaar86d87252022-09-05 21:21:25 +01005726 int r;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005727
5728 if (current_funccal == NULL)
5729 {
5730 semsg(_(e_str_not_inside_function), "defer");
5731 return FAIL;
5732 }
Bram Moolenaar86d87252022-09-05 21:21:25 +01005733 if (partial != NULL)
5734 {
5735 if (partial->pt_dict != NULL)
5736 {
5737 emsg(_(e_cannot_use_partial_with_dictionary_for_defer));
5738 return FAIL;
5739 }
5740 if (partial->pt_argc > 0)
5741 {
5742 int i;
5743
5744 partial_argc = partial->pt_argc;
5745 for (i = 0; i < partial_argc; ++i)
5746 copy_tv(&partial->pt_argv[i], &argvars[i]);
5747 }
5748 }
5749 r = get_func_arguments(arg, evalarg, FALSE,
5750 argvars + partial_argc, &argcount);
5751 argcount += partial_argc;
Bram Moolenaar16900322022-09-08 19:51:45 +01005752
5753 if (r == OK)
5754 {
5755 if (type != NULL)
5756 {
5757 // Check that the arguments are OK for the types of the funcref.
5758 r = check_argument_types(type, argvars, argcount, NULL, name);
5759 }
5760 else if (builtin_function(name, -1))
5761 {
5762 int idx = find_internal_func(name);
5763
5764 if (idx < 0)
5765 {
5766 emsg_funcname(e_unknown_function_str, name);
5767 r = FAIL;
5768 }
5769 else if (check_internal_func(idx, argcount) == -1)
5770 r = FAIL;
5771 }
5772 else
5773 {
5774 ufunc_T *ufunc = find_func(name, FALSE);
5775
5776 // we tolerate an unknown function here, it might be defined later
5777 if (ufunc != NULL)
5778 {
5779 int error = check_user_func_argcount(ufunc, argcount);
5780
5781 if (error != FCERR_UNKNOWN)
5782 {
Bram Moolenaar87b4e5c2022-10-01 15:32:46 +01005783 user_func_error(error, name, FALSE);
Bram Moolenaar16900322022-09-08 19:51:45 +01005784 r = FAIL;
5785 }
5786 }
5787 }
5788 }
5789
Bram Moolenaar86d87252022-09-05 21:21:25 +01005790 if (r == FAIL)
Bram Moolenaar806a2732022-09-04 15:40:36 +01005791 {
5792 while (--argcount >= 0)
5793 clear_tv(&argvars[argcount]);
5794 return FAIL;
5795 }
5796 return add_defer(name, argcount, argvars);
5797}
5798
5799/*
Bram Moolenaar6f14da12022-09-07 21:30:44 +01005800 * Return TRUE if currently inside a function call.
5801 * Give an error message and return FALSE when not.
5802 */
5803 int
5804can_add_defer(void)
5805{
5806 if (!in_def_function() && get_current_funccal() == NULL)
5807 {
5808 semsg(_(e_str_not_inside_function), "defer");
5809 return FALSE;
5810 }
5811 return TRUE;
5812}
5813
5814/*
Bram Moolenaar806a2732022-09-04 15:40:36 +01005815 * Add a deferred call for "name" with arguments "argvars[argcount]".
5816 * Consumes "argvars[]".
5817 * Caller must check that in_def_function() returns TRUE or current_funccal is
5818 * not NULL.
5819 * Returns OK or FAIL.
5820 */
5821 int
5822add_defer(char_u *name, int argcount_arg, typval_T *argvars)
5823{
5824 char_u *saved_name = vim_strsave(name);
5825 int argcount = argcount_arg;
5826 defer_T *dr;
5827 int ret = FAIL;
5828
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005829 if (saved_name == NULL)
5830 goto theend;
Bram Moolenaar806a2732022-09-04 15:40:36 +01005831 if (in_def_function())
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005832 {
Bram Moolenaar806a2732022-09-04 15:40:36 +01005833 if (add_defer_function(saved_name, argcount, argvars) == OK)
5834 argcount = 0;
5835 }
5836 else
5837 {
5838 if (current_funccal->fc_defer.ga_itemsize == 0)
5839 ga_init2(&current_funccal->fc_defer, sizeof(defer_T), 10);
5840 if (ga_grow(&current_funccal->fc_defer, 1) == FAIL)
5841 goto theend;
5842 dr = ((defer_T *)current_funccal->fc_defer.ga_data)
5843 + current_funccal->fc_defer.ga_len++;
5844 dr->dr_name = saved_name;
5845 dr->dr_argcount = argcount;
5846 while (argcount > 0)
5847 {
5848 --argcount;
5849 dr->dr_argvars[argcount] = argvars[argcount];
5850 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005851 }
5852 ret = OK;
5853
5854theend:
5855 while (--argcount >= 0)
5856 clear_tv(&argvars[argcount]);
5857 return ret;
5858}
5859
5860/*
5861 * Invoked after a functions has finished: invoke ":defer" functions.
5862 */
Bram Moolenaar58779852022-09-06 18:31:14 +01005863 static void
5864handle_defer_one(funccall_T *funccal)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005865{
5866 int idx;
5867
Bram Moolenaar58779852022-09-06 18:31:14 +01005868 for (idx = funccal->fc_defer.ga_len - 1; idx >= 0; --idx)
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005869 {
5870 funcexe_T funcexe;
5871 typval_T rettv;
Bram Moolenaar58779852022-09-06 18:31:14 +01005872 defer_T *dr = ((defer_T *)funccal->fc_defer.ga_data) + idx;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005873 int i;
5874
5875 CLEAR_FIELD(funcexe);
5876 funcexe.fe_evaluate = TRUE;
5877
5878 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this
5879 call_func(dr->dr_name, -1, &rettv,
5880 dr->dr_argcount, dr->dr_argvars, &funcexe);
5881 clear_tv(&rettv);
5882 vim_free(dr->dr_name);
5883 for (i = dr->dr_argcount - 1; i >= 0; --i)
5884 clear_tv(&dr->dr_argvars[i]);
5885 }
Bram Moolenaar58779852022-09-06 18:31:14 +01005886 ga_clear(&funccal->fc_defer);
5887}
5888
5889/*
5890 * Called when exiting: call all defer functions.
5891 */
5892 void
5893invoke_all_defer(void)
5894{
5895 funccall_T *funccal;
5896
Bram Moolenaarca16c602022-09-06 18:57:08 +01005897 for (funccal = current_funccal; funccal != NULL;
5898 funccal = funccal->fc_caller)
Bram Moolenaar58779852022-09-06 18:31:14 +01005899 if (funccal->fc_ectx != NULL)
5900 {
5901 // :def function
5902 unwind_def_callstack(funccal->fc_ectx);
5903 may_invoke_defer_funcs(funccal->fc_ectx);
5904 }
5905 else
5906 {
5907 // legacy function
5908 handle_defer_one(funccal);
5909 }
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005910}
5911
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005912/*
5913 * ":1,25call func(arg1, arg2)" function call.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005914 * ":defer func(arg1, arg2)" deferred function call.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005915 */
5916 void
5917ex_call(exarg_T *eap)
5918{
5919 char_u *arg = eap->arg;
5920 char_u *startarg;
5921 char_u *name;
5922 char_u *tofree;
5923 int len;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005924 int failed = FALSE;
5925 funcdict_T fudi;
5926 partial_T *partial = NULL;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005927 evalarg_T evalarg;
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005928 type_T *type = NULL;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00005929 int found_var = FALSE;
Bram Moolenaar4525a572022-02-13 11:57:33 +00005930 int vim9script = in_vim9script();
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005931
Bram Moolenaare6b53242020-07-01 17:28:33 +02005932 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005933 if (eap->skip)
5934 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005935 typval_T rettv;
5936
Bram Moolenaare38eab22019-12-05 21:50:01 +01005937 // trans_function_name() doesn't work well when skipping, use eval0()
5938 // instead to skip to any following command, e.g. for:
5939 // :if 0 | call dict.foo().bar() | endif
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005940 ++emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005941 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005942 clear_tv(&rettv);
5943 --emsg_skip;
Bram Moolenaare6b53242020-07-01 17:28:33 +02005944 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005945 return;
5946 }
5947
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005948 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005949 &fudi, &partial, vim9script ? &type : NULL);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005950 if (fudi.fd_newkey != NULL)
5951 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01005952 // Still need to give an error message for missing key.
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005953 semsg(_(e_key_not_present_in_dictionary), fudi.fd_newkey);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005954 vim_free(fudi.fd_newkey);
5955 }
5956 if (tofree == NULL)
5957 return;
5958
Bram Moolenaare38eab22019-12-05 21:50:01 +01005959 // Increase refcount on dictionary, it could get deleted when evaluating
5960 // the arguments.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005961 if (fudi.fd_dict != NULL)
5962 ++fudi.fd_dict->dv_refcount;
5963
Bram Moolenaare38eab22019-12-05 21:50:01 +01005964 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its
5965 // contents. For VAR_PARTIAL get its partial, unless we already have one
5966 // from trans_function_name().
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005967 len = (int)STRLEN(tofree);
Bram Moolenaar32b3f822021-01-06 21:59:39 +01005968 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial,
Bram Moolenaar4525a572022-02-13 11:57:33 +00005969 vim9script && type == NULL ? &type : NULL,
Bram Moolenaar937610b2022-01-19 17:21:29 +00005970 FALSE, FALSE, &found_var);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005971
Bram Moolenaare38eab22019-12-05 21:50:01 +01005972 // Skip white space to allow ":call func ()". Not good, but required for
5973 // backward compatibility.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005974 startarg = skipwhite(arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005975 if (*startarg != '(')
5976 {
Bram Moolenaare1242042021-12-16 20:56:57 +00005977 semsg(_(e_missing_parenthesis_str), eap->arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005978 goto end;
5979 }
Bram Moolenaar4525a572022-02-13 11:57:33 +00005980 if (vim9script && startarg > arg)
Bram Moolenaar01dd6c32021-09-05 16:36:23 +02005981 {
5982 semsg(_(e_no_white_space_allowed_before_str_str), "(", eap->arg);
5983 goto end;
5984 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005985
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005986 if (eap->cmdidx == CMD_defer)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005987 {
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005988 arg = startarg;
Bram Moolenaar16900322022-09-08 19:51:45 +01005989 failed = ex_defer_inner(name, &arg, type, partial, &evalarg) == FAIL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005990 }
5991 else
Bram Moolenaara9b579f2016-07-17 18:29:19 +02005992 {
Bram Moolenaarc6538bc2019-08-03 18:17:11 +02005993 funcexe_T funcexe;
5994
Bram Moolenaara80faa82020-04-12 19:37:17 +02005995 CLEAR_FIELD(funcexe);
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005996 funcexe.fe_check_type = type;
Bram Moolenaar851f86b2021-12-13 14:26:44 +00005997 funcexe.fe_partial = partial;
5998 funcexe.fe_selfdict = fudi.fd_dict;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01005999 funcexe.fe_firstline = eap->line1;
6000 funcexe.fe_lastline = eap->line2;
Bram Moolenaar2ef91562021-12-11 16:14:07 +00006001 funcexe.fe_found_var = found_var;
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006002 funcexe.fe_evaluate = !eap->skip;
6003 failed = ex_call_inner(eap, name, &arg, startarg, &funcexe, &evalarg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006004 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006005
Bram Moolenaar1d341892021-09-18 15:25:52 +02006006 // When inside :try we need to check for following "| catch" or "| endtry".
6007 // Not when there was an error, but do check if an exception was thrown.
Bram Moolenaar1d84f762022-09-03 21:35:53 +01006008 if ((!aborting() || did_throw) && (!failed || eap->cstack->cs_trylevel > 0))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006009 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006010 // Check for trailing illegal characters and a following command.
Bram Moolenaar8294d492020-08-10 22:40:56 +02006011 arg = skipwhite(arg);
Bram Moolenaara72cfb82020-04-23 17:07:30 +02006012 if (!ends_excmd2(eap->arg, arg))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006013 {
Bram Moolenaar1d341892021-09-18 15:25:52 +02006014 if (!failed && !aborting())
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006015 {
6016 emsg_severe = TRUE;
Bram Moolenaar74409f62022-01-01 15:58:22 +00006017 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar40d9da22020-02-17 10:01:24 +01006018 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006019 }
6020 else
Bram Moolenaar63b91732021-08-05 20:40:03 +02006021 set_nextcmd(eap, arg);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006022 }
Bram Moolenaara929c922022-04-18 15:21:17 +01006023 // Must be after using "arg", it may point into memory cleared here.
6024 clear_evalarg(&evalarg, eap);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006025
6026end:
6027 dict_unref(fudi.fd_dict);
6028 vim_free(tofree);
6029}
6030
6031/*
6032 * Return from a function. Possibly makes the return pending. Also called
6033 * for a pending return at the ":endtry" or after returning from an extra
6034 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set
6035 * when called due to a ":return" command. "rettv" may point to a typval_T
6036 * with the return rettv. Returns TRUE when the return can be carried out,
6037 * FALSE when the return gets pending.
6038 */
6039 int
6040do_return(
6041 exarg_T *eap,
6042 int reanimate,
6043 int is_cmd,
6044 void *rettv)
6045{
6046 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01006047 cstack_T *cstack = eap->cstack;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006048
6049 if (reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006050 // Undo the return.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006051 current_funccal->fc_returned = FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006052
6053 /*
6054 * Cleanup (and inactivate) conditionals, but stop when a try conditional
6055 * not in its finally clause (which then is to be executed next) is found.
6056 * In this case, make the ":return" pending for execution at the ":endtry".
6057 * Otherwise, return normally.
6058 */
6059 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
6060 if (idx >= 0)
6061 {
6062 cstack->cs_pending[idx] = CSTP_RETURN;
6063
6064 if (!is_cmd && !reanimate)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006065 // A pending return again gets pending. "rettv" points to an
6066 // allocated variable with the rettv of the original ":return"'s
6067 // argument if present or is NULL else.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006068 cstack->cs_rettv[idx] = rettv;
6069 else
6070 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006071 // When undoing a return in order to make it pending, get the stored
6072 // return rettv.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006073 if (reanimate)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006074 rettv = current_funccal->fc_rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006075
6076 if (rettv != NULL)
6077 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006078 // Store the value of the pending return.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006079 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL)
6080 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv;
6081 else
Bram Moolenaare29a27f2021-07-20 21:07:36 +02006082 emsg(_(e_out_of_memory));
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006083 }
6084 else
6085 cstack->cs_rettv[idx] = NULL;
6086
6087 if (reanimate)
6088 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006089 // The pending return value could be overwritten by a ":return"
6090 // without argument in a finally clause; reset the default
6091 // return value.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006092 current_funccal->fc_rettv->v_type = VAR_NUMBER;
6093 current_funccal->fc_rettv->vval.v_number = 0;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006094 }
6095 }
6096 report_make_pending(CSTP_RETURN, rettv);
6097 }
6098 else
6099 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006100 current_funccal->fc_returned = TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006101
Bram Moolenaare38eab22019-12-05 21:50:01 +01006102 // If the return is carried out now, store the return value. For
6103 // a return immediately after reanimation, the value is already
6104 // there.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006105 if (!reanimate && rettv != NULL)
6106 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006107 clear_tv(current_funccal->fc_rettv);
6108 *current_funccal->fc_rettv = *(typval_T *)rettv;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006109 if (!is_cmd)
6110 vim_free(rettv);
6111 }
6112 }
6113
6114 return idx < 0;
6115}
6116
6117/*
6118 * Free the variable with a pending return value.
6119 */
6120 void
6121discard_pending_return(void *rettv)
6122{
6123 free_tv((typval_T *)rettv);
6124}
6125
6126/*
6127 * Generate a return command for producing the value of "rettv". The result
6128 * is an allocated string. Used by report_pending() for verbose messages.
6129 */
6130 char_u *
6131get_return_cmd(void *rettv)
6132{
6133 char_u *s = NULL;
6134 char_u *tofree = NULL;
6135 char_u numbuf[NUMBUFLEN];
6136
6137 if (rettv != NULL)
6138 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0);
6139 if (s == NULL)
6140 s = (char_u *)"";
6141
6142 STRCPY(IObuff, ":return ");
6143 STRNCPY(IObuff + 8, s, IOSIZE - 8);
6144 if (STRLEN(s) + 8 >= IOSIZE)
6145 STRCPY(IObuff + IOSIZE - 4, "...");
6146 vim_free(tofree);
6147 return vim_strsave(IObuff);
6148}
6149
6150/*
6151 * Get next function line.
6152 * Called by do_cmdline() to get the next line.
6153 * Returns allocated string, or NULL for end of function.
6154 */
6155 char_u *
6156get_func_line(
6157 int c UNUSED,
6158 void *cookie,
Bram Moolenaare96a2492019-06-25 04:12:16 +02006159 int indent UNUSED,
Bram Moolenaar66250c92020-08-20 15:02:42 +02006160 getline_opt_T options UNUSED)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006161{
6162 funccall_T *fcp = (funccall_T *)cookie;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006163 ufunc_T *fp = fcp->fc_func;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006164 char_u *retval;
Bram Moolenaare38eab22019-12-05 21:50:01 +01006165 garray_T *gap; // growarray with function lines
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006166
Bram Moolenaare38eab22019-12-05 21:50:01 +01006167 // If breakpoints have been added/deleted need to check for it.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006168 if (fcp->fc_dbg_tick != debug_tick)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006169 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006170 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006171 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006172 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006173 }
6174#ifdef FEAT_PROFILE
6175 if (do_profiling == PROF_YES)
6176 func_line_end(cookie);
6177#endif
6178
6179 gap = &fp->uf_lines;
6180 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try())
Bram Moolenaarca16c602022-09-06 18:57:08 +01006181 || fcp->fc_returned)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006182 retval = NULL;
6183 else
6184 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006185 // Skip NULL lines (continuation lines).
Bram Moolenaarca16c602022-09-06 18:57:08 +01006186 while (fcp->fc_linenr < gap->ga_len
6187 && ((char_u **)(gap->ga_data))[fcp->fc_linenr] == NULL)
6188 ++fcp->fc_linenr;
6189 if (fcp->fc_linenr >= gap->ga_len)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006190 retval = NULL;
6191 else
6192 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006193 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->fc_linenr++]);
6194 SOURCING_LNUM = fcp->fc_linenr;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006195#ifdef FEAT_PROFILE
6196 if (do_profiling == PROF_YES)
Bram Moolenaarb2049902021-01-24 12:53:53 +01006197 func_line_start(cookie, SOURCING_LNUM);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006198#endif
6199 }
6200 }
6201
Bram Moolenaare38eab22019-12-05 21:50:01 +01006202 // Did we encounter a breakpoint?
Bram Moolenaarca16c602022-09-06 18:57:08 +01006203 if (fcp->fc_breakpoint != 0 && fcp->fc_breakpoint <= SOURCING_LNUM)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006204 {
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006205 dbg_breakpoint(fp->uf_name, SOURCING_LNUM);
Bram Moolenaare38eab22019-12-05 21:50:01 +01006206 // Find next breakpoint.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006207 fcp->fc_breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name,
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01006208 SOURCING_LNUM);
Bram Moolenaarca16c602022-09-06 18:57:08 +01006209 fcp->fc_dbg_tick = debug_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006210 }
6211
6212 return retval;
6213}
6214
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006215/*
6216 * Return TRUE if the currently active function should be ended, because a
6217 * return was encountered or an error occurred. Used inside a ":while".
6218 */
6219 int
6220func_has_ended(void *cookie)
6221{
6222 funccall_T *fcp = (funccall_T *)cookie;
6223
Bram Moolenaare38eab22019-12-05 21:50:01 +01006224 // Ignore the "abort" flag if the abortion behavior has been changed due to
6225 // an error inside a try conditional.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006226 return (((fcp->fc_func->uf_flags & FC_ABORT)
6227 && did_emsg && !aborted_in_try())
6228 || fcp->fc_returned);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006229}
6230
6231/*
6232 * return TRUE if cookie indicates a function which "abort"s on errors.
6233 */
6234 int
6235func_has_abort(
6236 void *cookie)
6237{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006238 return ((funccall_T *)cookie)->fc_func->uf_flags & FC_ABORT;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006239}
6240
6241
6242/*
6243 * Turn "dict.Func" into a partial for "Func" bound to "dict".
6244 * Don't do this when "Func" is already a partial that was bound
6245 * explicitly (pt_auto is FALSE).
6246 * Changes "rettv" in-place.
6247 * Returns the updated "selfdict_in".
6248 */
6249 dict_T *
6250make_partial(dict_T *selfdict_in, typval_T *rettv)
6251{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006252 char_u *fname;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006253 ufunc_T *fp = NULL;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006254 char_u fname_buf[FLEN_FIXED + 1];
6255 int error;
6256 dict_T *selfdict = selfdict_in;
6257
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006258 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial != NULL
6259 && rettv->vval.v_partial->pt_func != NULL)
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006260 fp = rettv->vval.v_partial->pt_func;
6261 else
6262 {
6263 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006264 : rettv->vval.v_partial == NULL ? NULL
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006265 : rettv->vval.v_partial->pt_name;
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006266 if (fname == NULL)
6267 {
6268 // There is no point binding a dict to a NULL function, just create
6269 // a function reference.
6270 rettv->v_type = VAR_FUNC;
6271 rettv->vval.v_string = NULL;
6272 }
6273 else
Bram Moolenaar673bcb12022-03-08 16:52:24 +00006274 {
6275 char_u *tofree = NULL;
6276
6277 // Translate "s:func" to the stored function name.
6278 fname = fname_trans_sid(fname, fname_buf, &tofree, &error);
6279 fp = find_func(fname, FALSE);
6280 vim_free(tofree);
6281 }
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006282 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006283
Bram Moolenaared0c62e2022-03-08 19:43:55 +00006284 if (fp != NULL && (fp->uf_flags & FC_DICT))
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006285 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006286 partial_T *pt = ALLOC_CLEAR_ONE(partial_T);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006287
6288 if (pt != NULL)
6289 {
6290 pt->pt_refcount = 1;
6291 pt->pt_dict = selfdict;
6292 pt->pt_auto = TRUE;
6293 selfdict = NULL;
6294 if (rettv->v_type == VAR_FUNC)
6295 {
Bram Moolenaare38eab22019-12-05 21:50:01 +01006296 // Just a function: Take over the function name and use
6297 // selfdict.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006298 pt->pt_name = rettv->vval.v_string;
6299 }
6300 else
6301 {
6302 partial_T *ret_pt = rettv->vval.v_partial;
6303 int i;
6304
Bram Moolenaare38eab22019-12-05 21:50:01 +01006305 // Partial: copy the function name, use selfdict and copy
6306 // args. Can't take over name or args, the partial might
6307 // be referenced elsewhere.
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006308 if (ret_pt->pt_name != NULL)
6309 {
6310 pt->pt_name = vim_strsave(ret_pt->pt_name);
6311 func_ref(pt->pt_name);
6312 }
6313 else
6314 {
6315 pt->pt_func = ret_pt->pt_func;
6316 func_ptr_ref(pt->pt_func);
6317 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006318 if (ret_pt->pt_argc > 0)
6319 {
Bram Moolenaarc799fe22019-05-28 23:08:19 +02006320 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006321 if (pt->pt_argv == NULL)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006322 // out of memory: drop the arguments
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006323 pt->pt_argc = 0;
6324 else
6325 {
6326 pt->pt_argc = ret_pt->pt_argc;
6327 for (i = 0; i < pt->pt_argc; i++)
6328 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]);
6329 }
6330 }
6331 partial_unref(ret_pt);
6332 }
6333 rettv->v_type = VAR_PARTIAL;
6334 rettv->vval.v_partial = pt;
6335 }
6336 }
6337 return selfdict;
6338}
6339
6340/*
6341 * Return the name of the executed function.
6342 */
6343 char_u *
6344func_name(void *cookie)
6345{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006346 return ((funccall_T *)cookie)->fc_func->uf_name;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006347}
6348
6349/*
6350 * Return the address holding the next breakpoint line for a funccall cookie.
6351 */
6352 linenr_T *
6353func_breakpoint(void *cookie)
6354{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006355 return &((funccall_T *)cookie)->fc_breakpoint;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006356}
6357
6358/*
6359 * Return the address holding the debug tick for a funccall cookie.
6360 */
6361 int *
6362func_dbg_tick(void *cookie)
6363{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006364 return &((funccall_T *)cookie)->fc_dbg_tick;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006365}
6366
6367/*
6368 * Return the nesting level for a funccall cookie.
6369 */
6370 int
6371func_level(void *cookie)
6372{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006373 return ((funccall_T *)cookie)->fc_level;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006374}
6375
6376/*
6377 * Return TRUE when a function was ended by a ":return" command.
6378 */
6379 int
6380current_func_returned(void)
6381{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006382 return current_funccal->fc_returned;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006383}
6384
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006385 int
6386free_unref_funccal(int copyID, int testing)
6387{
6388 int did_free = FALSE;
6389 int did_free_funccal = FALSE;
6390 funccall_T *fc, **pfc;
6391
6392 for (pfc = &previous_funccal; *pfc != NULL; )
6393 {
6394 if (can_free_funccal(*pfc, copyID))
6395 {
6396 fc = *pfc;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006397 *pfc = fc->fc_caller;
Bram Moolenaar209b8e32019-03-14 13:43:24 +01006398 free_funccal_contents(fc);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006399 did_free = TRUE;
6400 did_free_funccal = TRUE;
6401 }
6402 else
Bram Moolenaarca16c602022-09-06 18:57:08 +01006403 pfc = &(*pfc)->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006404 }
6405 if (did_free_funccal)
Bram Moolenaare38eab22019-12-05 21:50:01 +01006406 // When a funccal was freed some more items might be garbage
6407 // collected, so run again.
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006408 (void)garbage_collect(testing);
6409
6410 return did_free;
6411}
6412
6413/*
Bram Moolenaarba209902016-08-24 22:06:38 +02006414 * Get function call environment based on backtrace debug level
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006415 */
6416 static funccall_T *
6417get_funccal(void)
6418{
6419 int i;
6420 funccall_T *funccal;
6421 funccall_T *temp_funccal;
6422
6423 funccal = current_funccal;
6424 if (debug_backtrace_level > 0)
6425 {
6426 for (i = 0; i < debug_backtrace_level; i++)
6427 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006428 temp_funccal = funccal->fc_caller;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006429 if (temp_funccal)
6430 funccal = temp_funccal;
6431 else
Bram Moolenaare38eab22019-12-05 21:50:01 +01006432 // backtrace level overflow. reset to max
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006433 debug_backtrace_level = i;
6434 }
6435 }
6436 return funccal;
6437}
6438
6439/*
6440 * Return the hashtable used for local variables in the current funccal.
6441 * Return NULL if there is no current funccal.
6442 */
6443 hashtab_T *
6444get_funccal_local_ht()
6445{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006446 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006447 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006448 return &get_funccal()->fc_l_vars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006449}
6450
6451/*
6452 * Return the l: scope variable.
6453 * Return NULL if there is no current funccal.
6454 */
6455 dictitem_T *
6456get_funccal_local_var()
6457{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006458 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006459 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006460 return &get_funccal()->fc_l_vars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006461}
6462
6463/*
6464 * Return the hashtable used for argument in the current funccal.
6465 * Return NULL if there is no current funccal.
6466 */
6467 hashtab_T *
6468get_funccal_args_ht()
6469{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006470 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006471 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006472 return &get_funccal()->fc_l_avars.dv_hashtab;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006473}
6474
6475/*
6476 * Return the a: scope variable.
6477 * Return NULL if there is no current funccal.
6478 */
6479 dictitem_T *
6480get_funccal_args_var()
6481{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006482 if (current_funccal == NULL || current_funccal->fc_l_vars.dv_refcount == 0)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006483 return NULL;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006484 return &get_funccal()->fc_l_avars_var;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006485}
6486
6487/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006488 * List function variables, if there is a function.
6489 */
6490 void
6491list_func_vars(int *first)
6492{
Bram Moolenaarca16c602022-09-06 18:57:08 +01006493 if (current_funccal != NULL && current_funccal->fc_l_vars.dv_refcount > 0)
6494 list_hashtable_vars(&current_funccal->fc_l_vars.dv_hashtab,
Bram Moolenaar32526b32019-01-19 17:43:09 +01006495 "l:", FALSE, first);
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006496}
6497
6498/*
6499 * If "ht" is the hashtable for local variables in the current funccal, return
6500 * the dict that contains it.
6501 * Otherwise return NULL.
6502 */
6503 dict_T *
6504get_current_funccal_dict(hashtab_T *ht)
6505{
6506 if (current_funccal != NULL
Bram Moolenaarca16c602022-09-06 18:57:08 +01006507 && ht == &current_funccal->fc_l_vars.dv_hashtab)
6508 return &current_funccal->fc_l_vars;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006509 return NULL;
6510}
6511
6512/*
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006513 * Search hashitem in parent scope.
6514 */
6515 hashitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006516find_hi_in_scoped_ht(char_u *name, hashtab_T **pht)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006517{
6518 funccall_T *old_current_funccal = current_funccal;
6519 hashtab_T *ht;
6520 hashitem_T *hi = NULL;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006521 char_u *varname;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006522
Bram Moolenaarca16c602022-09-06 18:57:08 +01006523 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006524 return NULL;
6525
Bram Moolenaar6f5b6df2020-05-16 21:20:12 +02006526 // Search in parent scope, which can be referenced from a lambda.
Bram Moolenaarca16c602022-09-06 18:57:08 +01006527 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar58016442016-07-31 18:30:22 +02006528 while (current_funccal != NULL)
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006529 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006530 ht = find_var_ht(name, &varname);
6531 if (ht != NULL && *varname != NUL)
Bram Moolenaar58016442016-07-31 18:30:22 +02006532 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006533 hi = hash_find(ht, varname);
Bram Moolenaar58016442016-07-31 18:30:22 +02006534 if (!HASHITEM_EMPTY(hi))
6535 {
6536 *pht = ht;
6537 break;
6538 }
6539 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006540 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar58016442016-07-31 18:30:22 +02006541 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006542 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar10ce39a2016-07-29 22:37:06 +02006543 }
6544 current_funccal = old_current_funccal;
6545
6546 return hi;
6547}
6548
6549/*
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006550 * Search variable in parent scope.
6551 */
6552 dictitem_T *
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006553find_var_in_scoped_ht(char_u *name, int no_autoload)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006554{
6555 dictitem_T *v = NULL;
6556 funccall_T *old_current_funccal = current_funccal;
6557 hashtab_T *ht;
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006558 char_u *varname;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006559
Bram Moolenaarca16c602022-09-06 18:57:08 +01006560 if (current_funccal == NULL || current_funccal->fc_func->uf_scoped == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006561 return NULL;
6562
Bram Moolenaare38eab22019-12-05 21:50:01 +01006563 // Search in parent scope which is possible to reference from lambda
Bram Moolenaarca16c602022-09-06 18:57:08 +01006564 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006565 while (current_funccal)
6566 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006567 ht = find_var_ht(name, &varname);
6568 if (ht != NULL && *varname != NUL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006569 {
Bram Moolenaarba96e9a2016-08-01 17:10:20 +02006570 v = find_var_in_ht(ht, *name, varname, no_autoload);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006571 if (v != NULL)
6572 break;
6573 }
Bram Moolenaarca16c602022-09-06 18:57:08 +01006574 if (current_funccal == current_funccal->fc_func->uf_scoped)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006575 break;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006576 current_funccal = current_funccal->fc_func->uf_scoped;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006577 }
6578 current_funccal = old_current_funccal;
6579
6580 return v;
6581}
6582
6583/*
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006584 * Set "copyID + 1" in previous_funccal and callers.
6585 */
6586 int
6587set_ref_in_previous_funccal(int copyID)
6588{
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006589 funccall_T *fc;
6590
Bram Moolenaarca16c602022-09-06 18:57:08 +01006591 for (fc = previous_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006592 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006593 fc->fc_copyID = copyID + 1;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006594 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID + 1, NULL)
6595 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID + 1, NULL)
6596 || set_ref_in_list_items(&fc->fc_l_varlist, copyID + 1, NULL))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006597 return TRUE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006598 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006599 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006600}
6601
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006602 static int
6603set_ref_in_funccal(funccall_T *fc, int copyID)
6604{
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006605 if (fc->fc_copyID != copyID)
6606 {
6607 fc->fc_copyID = copyID;
Bram Moolenaarca16c602022-09-06 18:57:08 +01006608 if (set_ref_in_ht(&fc->fc_l_vars.dv_hashtab, copyID, NULL)
6609 || set_ref_in_ht(&fc->fc_l_avars.dv_hashtab, copyID, NULL)
6610 || set_ref_in_list_items(&fc->fc_l_varlist, copyID, NULL)
6611 || set_ref_in_func(NULL, fc->fc_func, copyID))
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006612 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006613 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006614 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006615}
6616
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006617/*
6618 * Set "copyID" in all local vars and arguments in the call stack.
6619 */
6620 int
6621set_ref_in_call_stack(int copyID)
6622{
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006623 funccall_T *fc;
6624 funccal_entry_T *entry;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006625
Bram Moolenaarca16c602022-09-06 18:57:08 +01006626 for (fc = current_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006627 if (set_ref_in_funccal(fc, copyID))
6628 return TRUE;
Bram Moolenaarc07f67a2019-06-06 19:03:17 +02006629
6630 // Also go through the funccal_stack.
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006631 for (entry = funccal_stack; entry != NULL; entry = entry->next)
Bram Moolenaarca16c602022-09-06 18:57:08 +01006632 for (fc = entry->top_funccal; fc != NULL; fc = fc->fc_caller)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006633 if (set_ref_in_funccal(fc, copyID))
6634 return TRUE;
6635 return FALSE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006636}
6637
6638/*
6639 * Set "copyID" in all functions available by name.
6640 */
6641 int
6642set_ref_in_functions(int copyID)
6643{
6644 int todo;
6645 hashitem_T *hi = NULL;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006646 ufunc_T *fp;
6647
6648 todo = (int)func_hashtab.ht_used;
6649 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi)
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006650 {
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006651 if (!HASHITEM_EMPTY(hi))
6652 {
6653 --todo;
6654 fp = HI2UF(hi);
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006655 if (!func_name_refcount(fp->uf_name)
6656 && set_ref_in_func(NULL, fp, copyID))
6657 return TRUE;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006658 }
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006659 }
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006660 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006661}
6662
6663/*
6664 * Set "copyID" in all function arguments.
6665 */
6666 int
6667set_ref_in_func_args(int copyID)
6668{
6669 int i;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006670
6671 for (i = 0; i < funcargs.ga_len; ++i)
Bram Moolenaar20cc5282021-07-03 16:33:16 +02006672 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i],
6673 copyID, NULL, NULL))
6674 return TRUE;
6675 return FALSE;
Bram Moolenaara9b579f2016-07-17 18:29:19 +02006676}
6677
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006678/*
6679 * Mark all lists and dicts referenced through function "name" with "copyID".
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006680 * Returns TRUE if setting references failed somehow.
6681 */
6682 int
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006683set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006684{
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006685 ufunc_T *fp = fp_in;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006686 funccall_T *fc;
Bram Moolenaaref140542019-12-31 21:27:13 +01006687 int error = FCERR_NONE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006688 char_u fname_buf[FLEN_FIXED + 1];
6689 char_u *tofree = NULL;
6690 char_u *fname;
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006691 int abort = FALSE;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006692
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006693 if (name == NULL && fp_in == NULL)
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006694 return FALSE;
6695
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006696 if (fp_in == NULL)
6697 {
6698 fname = fname_trans_sid(name, fname_buf, &tofree, &error);
Bram Moolenaard9d2fd02022-01-13 21:15:21 +00006699 fp = find_func(fname, FALSE);
Bram Moolenaar437bafe2016-08-01 15:40:54 +02006700 }
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006701 if (fp != NULL)
6702 {
Bram Moolenaarca16c602022-09-06 18:57:08 +01006703 for (fc = fp->uf_scoped; fc != NULL; fc = fc->fc_func->uf_scoped)
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006704 abort = abort || set_ref_in_funccal(fc, copyID);
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006705 }
Bram Moolenaar5adc55c2020-05-02 23:12:58 +02006706
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006707 vim_free(tofree);
Bram Moolenaarbc7ce672016-08-01 22:49:22 +02006708 return abort;
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02006709}
6710
Bram Moolenaare38eab22019-12-05 21:50:01 +01006711#endif // FEAT_EVAL