1 /* vi:set ts=8 sts=4 sw=4 noet: 2 * 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 /* 11 * userfunc.c: User defined function support 12 */ 13 14 #include "vim.h" 15 16 #if defined(FEAT_EVAL) || defined(PROTO) 17 /* 18 * All user-defined functions are found in this hashtable. 19 */ 20 static hashtab_T func_hashtab; 21 22 // Used by get_func_tv() 23 static garray_T funcargs = GA_EMPTY; 24 25 // pointer to funccal for currently active function 26 static funccall_T *current_funccal = NULL; 27 28 // Pointer to list of previously used funccal, still around because some 29 // item in it is still being used. 30 static funccall_T *previous_funccal = NULL; 31 32 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it"); 33 static char *e_funcdict = N_("E717: Dictionary entry already exists"); 34 static char *e_funcref = N_("E718: Funcref required"); 35 static char *e_nofunc = N_("E130: Unknown function: %s"); 36 37 static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force); 38 static void func_clear(ufunc_T *fp, int force); 39 static int func_free(ufunc_T *fp, int force); 40 41 void 42 func_init() 43 { 44 hash_init(&func_hashtab); 45 } 46 47 /* 48 * Return the function hash table 49 */ 50 hashtab_T * 51 func_tbl_get(void) 52 { 53 return &func_hashtab; 54 } 55 56 /* 57 * Get one function argument. 58 * If "argtypes" is not NULL also get the type: "arg: type" (:def function). 59 * If "types_optional" is TRUE a missing type is OK, use "any". 60 * If "evalarg" is not NULL use it to check for an already declared name. 61 * Return a pointer to after the type. 62 * When something is wrong return "arg". 63 */ 64 static char_u * 65 one_function_arg( 66 char_u *arg, 67 garray_T *newargs, 68 garray_T *argtypes, 69 int types_optional, 70 evalarg_T *evalarg, 71 int is_vararg, 72 int skip) 73 { 74 char_u *p = arg; 75 char_u *arg_copy = NULL; 76 int is_underscore = FALSE; 77 78 while (ASCII_ISALNUM(*p) || *p == '_') 79 ++p; 80 if (arg == p || isdigit(*arg) 81 || (argtypes == NULL 82 && ((p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0) 83 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0)))) 84 { 85 if (!skip) 86 semsg(_("E125: Illegal argument: %s"), arg); 87 return arg; 88 } 89 90 // Vim9 script: cannot use script var name for argument. In function: also 91 // check local vars and arguments. 92 if (!skip && argtypes != NULL && check_defined(arg, p - arg, 93 evalarg == NULL ? NULL : evalarg->eval_cctx, TRUE) == FAIL) 94 return arg; 95 96 if (newargs != NULL && ga_grow(newargs, 1) == FAIL) 97 return arg; 98 if (newargs != NULL) 99 { 100 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 } 111 is_underscore = arg_copy[0] == '_' && arg_copy[1] == NUL; 112 if (argtypes == NULL || !is_underscore) 113 // 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 { 117 semsg(_("E853: Duplicate argument name: %s"), arg_copy); 118 vim_free(arg_copy); 119 return arg; 120 } 121 ((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" 128 if (argtypes != NULL && (skip || ga_grow(argtypes, 1) == OK)) 129 { 130 char_u *type = NULL; 131 132 if (VIM_ISWHITE(*p) && *skipwhite(p) == ':') 133 { 134 semsg(_(e_no_white_space_allowed_before_colon_str), 135 arg_copy == NULL ? arg : arg_copy); 136 p = skipwhite(p); 137 } 138 if (*p == ':') 139 { 140 ++p; 141 if (!skip && !VIM_ISWHITE(*p)) 142 { 143 semsg(_(e_white_space_required_after_str_str), ":", p - 1); 144 return arg; 145 } 146 type = skipwhite(p); 147 p = skip_type(type, TRUE); 148 if (!skip) 149 type = vim_strnsave(type, p - type); 150 } 151 else if (*skipwhite(p) != '=' && !types_optional && !is_underscore) 152 { 153 semsg(_(e_missing_argument_type_for_str), 154 arg_copy == NULL ? arg : arg_copy); 155 return arg; 156 } 157 if (!skip) 158 { 159 if (type == NULL && types_optional) 160 // lambda arguments default to "any" type 161 type = vim_strsave((char_u *) 162 (is_vararg ? "list<any>" : "any")); 163 ((char_u **)argtypes->ga_data)[argtypes->ga_len++] = type; 164 } 165 } 166 167 return p; 168 } 169 170 /* 171 * Get function arguments. 172 * "argp" should point to just after the "(", possibly to white space. 173 * "argp" is advanced just after "endchar". 174 */ 175 static int 176 get_function_args( 177 char_u **argp, 178 char_u endchar, 179 garray_T *newargs, 180 garray_T *argtypes, // NULL unless using :def 181 int types_optional, // types optional if "argtypes" is not NULL 182 evalarg_T *evalarg, // context or NULL 183 int *varargs, 184 garray_T *default_args, 185 int skip, 186 exarg_T *eap, 187 char_u **line_to_free) 188 { 189 int mustend = FALSE; 190 char_u *arg; 191 char_u *p; 192 int c; 193 int any_default = FALSE; 194 char_u *expr; 195 char_u *whitep = *argp; 196 197 if (newargs != NULL) 198 ga_init2(newargs, (int)sizeof(char_u *), 3); 199 if (argtypes != NULL) 200 ga_init2(argtypes, (int)sizeof(char_u *), 3); 201 if (!skip && default_args != NULL) 202 ga_init2(default_args, (int)sizeof(char_u *), 3); 203 204 if (varargs != NULL) 205 *varargs = FALSE; 206 207 /* 208 * Isolate the arguments: "arg1, arg2, ...)" 209 */ 210 arg = skipwhite(*argp); 211 p = arg; 212 while (*p != endchar) 213 { 214 while (eap != NULL && eap->getline != NULL 215 && (*p == NUL || (VIM_ISWHITE(*whitep) && *p == '#'))) 216 { 217 char_u *theline; 218 219 // End of the line, get the next one. 220 theline = eap->getline(':', eap->cookie, 0, TRUE); 221 if (theline == NULL) 222 break; 223 vim_free(*line_to_free); 224 *line_to_free = theline; 225 whitep = (char_u *)" "; 226 p = skipwhite(theline); 227 } 228 229 if (mustend && *p != endchar) 230 { 231 if (!skip) 232 semsg(_(e_invarg2), *argp); 233 goto err_ret; 234 } 235 if (*p == endchar) 236 break; 237 238 if (p[0] == '.' && p[1] == '.' && p[2] == '.') 239 { 240 if (varargs != NULL) 241 *varargs = TRUE; 242 p += 3; 243 mustend = TRUE; 244 245 if (argtypes != NULL) 246 { 247 // ...name: list<type> 248 if (!eval_isnamec1(*p)) 249 { 250 if (!skip) 251 emsg(_(e_missing_name_after_dots)); 252 goto err_ret; 253 } 254 255 arg = p; 256 p = one_function_arg(p, newargs, argtypes, types_optional, 257 evalarg, TRUE, skip); 258 if (p == arg) 259 break; 260 if (*skipwhite(p) == '=') 261 { 262 emsg(_(e_cannot_use_default_for_variable_arguments)); 263 break; 264 } 265 } 266 } 267 else 268 { 269 char_u *np; 270 271 arg = p; 272 p = one_function_arg(p, newargs, argtypes, types_optional, 273 evalarg, FALSE, skip); 274 if (p == arg) 275 break; 276 277 // Recognize " = expr" but not " == expr". A lambda can have 278 // "(a = expr" but "(a == expr" and "(a =~ expr" are not a lambda. 279 np = skipwhite(p); 280 if (*np == '=' && np[1] != '=' && np[1] != '~' 281 && default_args != NULL) 282 { 283 typval_T rettv; 284 285 // find the end of the expression (doesn't evaluate it) 286 any_default = TRUE; 287 p = skipwhite(p) + 1; 288 whitep = p; 289 p = skipwhite(p); 290 expr = p; 291 if (eval1(&p, &rettv, NULL) != FAIL) 292 { 293 if (!skip) 294 { 295 if (ga_grow(default_args, 1) == FAIL) 296 goto err_ret; 297 298 // trim trailing whitespace 299 while (p > expr && VIM_ISWHITE(p[-1])) 300 p--; 301 c = *p; 302 *p = NUL; 303 expr = vim_strsave(expr); 304 if (expr == NULL) 305 { 306 *p = c; 307 goto err_ret; 308 } 309 ((char_u **)(default_args->ga_data)) 310 [default_args->ga_len] = expr; 311 default_args->ga_len++; 312 *p = c; 313 } 314 } 315 else 316 mustend = TRUE; 317 } 318 else if (any_default) 319 { 320 emsg(_("E989: Non-default argument follows default argument")); 321 goto err_ret; 322 } 323 324 if (VIM_ISWHITE(*p) && *skipwhite(p) == ',') 325 { 326 // Be tolerant when skipping 327 if (!skip) 328 { 329 semsg(_(e_no_white_space_allowed_before_str_str), ",", p); 330 goto err_ret; 331 } 332 p = skipwhite(p); 333 } 334 if (*p == ',') 335 { 336 ++p; 337 // Don't give this error when skipping, it makes the "->" not 338 // found in "{k,v -> x}" and give a confusing error. 339 // Allow missing space after comma in legacy functions. 340 if (!skip && argtypes != NULL 341 && !IS_WHITE_OR_NUL(*p) && *p != endchar) 342 { 343 semsg(_(e_white_space_required_after_str_str), ",", p - 1); 344 goto err_ret; 345 } 346 } 347 else 348 mustend = TRUE; 349 } 350 whitep = p; 351 p = skipwhite(p); 352 } 353 354 if (*p != endchar) 355 goto err_ret; 356 ++p; // skip "endchar" 357 358 *argp = p; 359 return OK; 360 361 err_ret: 362 if (newargs != NULL) 363 ga_clear_strings(newargs); 364 if (!skip && default_args != NULL) 365 ga_clear_strings(default_args); 366 return FAIL; 367 } 368 369 /* 370 * Parse the argument types, filling "fp->uf_arg_types". 371 * Return OK or FAIL. 372 */ 373 static int 374 parse_argument_types(ufunc_T *fp, garray_T *argtypes, int varargs) 375 { 376 int len = 0; 377 378 ga_init2(&fp->uf_type_list, sizeof(type_T *), 10); 379 if (argtypes->ga_len > 0) 380 { 381 // When "varargs" is set the last name/type goes into uf_va_name 382 // and uf_va_type. 383 len = argtypes->ga_len - (varargs ? 1 : 0); 384 385 if (len > 0) 386 fp->uf_arg_types = ALLOC_CLEAR_MULT(type_T *, len); 387 if (fp->uf_arg_types != NULL) 388 { 389 int i; 390 type_T *type; 391 392 for (i = 0; i < len; ++ i) 393 { 394 char_u *p = ((char_u **)argtypes->ga_data)[i]; 395 396 if (p == NULL) 397 // will get the type from the default value 398 type = &t_unknown; 399 else 400 type = parse_type(&p, &fp->uf_type_list, TRUE); 401 if (type == NULL) 402 return FAIL; 403 fp->uf_arg_types[i] = type; 404 } 405 } 406 } 407 408 if (varargs) 409 { 410 char_u *p; 411 412 // Move the last argument "...name: type" to uf_va_name and 413 // uf_va_type. 414 fp->uf_va_name = ((char_u **)fp->uf_args.ga_data) 415 [fp->uf_args.ga_len - 1]; 416 --fp->uf_args.ga_len; 417 p = ((char_u **)argtypes->ga_data)[len]; 418 if (p == NULL) 419 // TODO: get type from default value 420 fp->uf_va_type = &t_list_any; 421 else 422 { 423 fp->uf_va_type = parse_type(&p, &fp->uf_type_list, TRUE); 424 if (fp->uf_va_type != NULL && fp->uf_va_type->tt_type != VAR_LIST) 425 { 426 semsg(_(e_variable_arguments_type_must_be_list_str), 427 ((char_u **)argtypes->ga_data)[len]); 428 return FAIL; 429 } 430 } 431 if (fp->uf_va_type == NULL) 432 return FAIL; 433 } 434 435 return OK; 436 } 437 438 static int 439 parse_return_type(ufunc_T *fp, char_u *ret_type) 440 { 441 if (ret_type == NULL) 442 fp->uf_ret_type = &t_void; 443 else 444 { 445 char_u *p = ret_type; 446 447 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list, TRUE); 448 if (fp->uf_ret_type == NULL) 449 { 450 fp->uf_ret_type = &t_void; 451 return FAIL; 452 } 453 } 454 return OK; 455 } 456 457 /* 458 * Register function "fp" as using "current_funccal" as its scope. 459 */ 460 static int 461 register_closure(ufunc_T *fp) 462 { 463 if (fp->uf_scoped == current_funccal) 464 // no change 465 return OK; 466 funccal_unref(fp->uf_scoped, fp, FALSE); 467 fp->uf_scoped = current_funccal; 468 current_funccal->fc_refcount++; 469 470 if (ga_grow(¤t_funccal->fc_funcs, 1) == FAIL) 471 return FAIL; 472 ((ufunc_T **)current_funccal->fc_funcs.ga_data) 473 [current_funccal->fc_funcs.ga_len++] = fp; 474 return OK; 475 } 476 477 static void 478 set_ufunc_name(ufunc_T *fp, char_u *name) 479 { 480 // Add a type cast to avoid a warning for an overflow, the uf_name[] array 481 // actually extends beyond the struct. 482 STRCPY((void *)fp->uf_name, name); 483 484 if (name[0] == K_SPECIAL) 485 { 486 fp->uf_name_exp = alloc(STRLEN(name) + 3); 487 if (fp->uf_name_exp != NULL) 488 { 489 STRCPY(fp->uf_name_exp, "<SNR>"); 490 STRCAT(fp->uf_name_exp, fp->uf_name + 3); 491 } 492 } 493 } 494 495 /* 496 * Get a name for a lambda. Returned in static memory. 497 */ 498 char_u * 499 get_lambda_name(void) 500 { 501 static char_u name[30]; 502 static int lambda_no = 0; 503 504 sprintf((char*)name, "<lambda>%d", ++lambda_no); 505 return name; 506 } 507 508 #if defined(FEAT_LUA) || defined(PROTO) 509 /* 510 * Registers a native C callback which can be called from Vim script. 511 * Returns the name of the Vim script function. 512 */ 513 char_u * 514 register_cfunc(cfunc_T cb, cfunc_free_T cb_free, void *state) 515 { 516 char_u *name = get_lambda_name(); 517 ufunc_T *fp; 518 519 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 520 if (fp == NULL) 521 return NULL; 522 523 fp->uf_def_status = UF_NOT_COMPILED; 524 fp->uf_refcount = 1; 525 fp->uf_varargs = TRUE; 526 fp->uf_flags = FC_CFUNC; 527 fp->uf_calls = 0; 528 fp->uf_script_ctx = current_sctx; 529 fp->uf_cb = cb; 530 fp->uf_cb_free = cb_free; 531 fp->uf_cb_state = state; 532 533 set_ufunc_name(fp, name); 534 hash_add(&func_hashtab, UF2HIKEY(fp)); 535 536 return name; 537 } 538 #endif 539 540 /* 541 * Skip over "->" or "=>" after the arguments of a lambda. 542 * If ": type" is found make "ret_type" point to "type". 543 * If "white_error" is not NULL check for correct use of white space and set 544 * "white_error" to TRUE if there is an error. 545 * Return NULL if no valid arrow found. 546 */ 547 static char_u * 548 skip_arrow( 549 char_u *start, 550 int equal_arrow, 551 char_u **ret_type, 552 int *white_error) 553 { 554 char_u *s = start; 555 char_u *bef = start - 2; // "start" points to > of -> 556 557 if (equal_arrow) 558 { 559 if (*s == ':') 560 { 561 if (white_error != NULL && !VIM_ISWHITE(s[1])) 562 { 563 *white_error = TRUE; 564 semsg(_(e_white_space_required_after_str_str), ":", s); 565 return NULL; 566 } 567 s = skipwhite(s + 1); 568 *ret_type = s; 569 s = skip_type(s, TRUE); 570 if (s == *ret_type) 571 { 572 emsg(_(e_missing_return_type)); 573 return NULL; 574 } 575 } 576 bef = s; 577 s = skipwhite(s); 578 if (*s != '=') 579 return NULL; 580 ++s; 581 } 582 if (*s != '>') 583 return NULL; 584 if (white_error != NULL && ((!VIM_ISWHITE(*bef) && *bef != '{') 585 || !IS_WHITE_OR_NUL(s[1]))) 586 { 587 *white_error = TRUE; 588 semsg(_(e_white_space_required_before_and_after_str_at_str), 589 equal_arrow ? "=>" : "->", bef); 590 return NULL; 591 } 592 return skipwhite(s + 1); 593 } 594 595 /* 596 * Check if "*cmd" points to a function command and if so advance "*cmd" and 597 * return TRUE. 598 * Otherwise return FALSE; 599 * Do not consider "function(" to be a command. 600 */ 601 static int 602 is_function_cmd(char_u **cmd) 603 { 604 char_u *p = *cmd; 605 606 if (checkforcmd(&p, "function", 2)) 607 { 608 if (*p == '(') 609 return FALSE; 610 *cmd = p; 611 return TRUE; 612 } 613 return FALSE; 614 } 615 616 /* 617 * Read the body of a function, put every line in "newlines". 618 * This stops at "}", "endfunction" or "enddef". 619 * "newlines" must already have been initialized. 620 * "eap->cmdidx" is CMD_function, CMD_def or CMD_block; 621 */ 622 static int 623 get_function_body( 624 exarg_T *eap, 625 garray_T *newlines, 626 char_u *line_arg_in, 627 char_u **line_to_free) 628 { 629 linenr_T sourcing_lnum_top = SOURCING_LNUM; 630 linenr_T sourcing_lnum_off; 631 int saved_wait_return = need_wait_return; 632 char_u *line_arg = line_arg_in; 633 int vim9_function = eap->cmdidx == CMD_def 634 || eap->cmdidx == CMD_block; 635 #define MAX_FUNC_NESTING 50 636 char nesting_def[MAX_FUNC_NESTING]; 637 int nesting = 0; 638 getline_opt_T getline_options; 639 int indent = 2; 640 char_u *skip_until = NULL; 641 int ret = FAIL; 642 int is_heredoc = FALSE; 643 int heredoc_concat_len = 0; 644 garray_T heredoc_ga; 645 char_u *heredoc_trimmed = NULL; 646 647 ga_init2(&heredoc_ga, 1, 500); 648 649 // Detect having skipped over comment lines to find the return 650 // type. Add NULL lines to keep the line count correct. 651 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie); 652 if (SOURCING_LNUM < sourcing_lnum_off) 653 { 654 sourcing_lnum_off -= SOURCING_LNUM; 655 if (ga_grow(newlines, sourcing_lnum_off) == FAIL) 656 goto theend; 657 while (sourcing_lnum_off-- > 0) 658 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL; 659 } 660 661 nesting_def[nesting] = vim9_function; 662 getline_options = vim9_function 663 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT; 664 for (;;) 665 { 666 char_u *theline; 667 char_u *p; 668 char_u *arg; 669 670 if (KeyTyped) 671 { 672 msg_scroll = TRUE; 673 saved_wait_return = FALSE; 674 } 675 need_wait_return = FALSE; 676 677 if (line_arg != NULL) 678 { 679 // Use eap->arg, split up in parts by line breaks. 680 theline = line_arg; 681 p = vim_strchr(theline, '\n'); 682 if (p == NULL) 683 line_arg += STRLEN(line_arg); 684 else 685 { 686 *p = NUL; 687 line_arg = p + 1; 688 } 689 } 690 else 691 { 692 vim_free(*line_to_free); 693 if (eap->getline == NULL) 694 theline = getcmdline(':', 0L, indent, getline_options); 695 else 696 theline = eap->getline(':', eap->cookie, indent, 697 getline_options); 698 *line_to_free = theline; 699 } 700 if (KeyTyped) 701 lines_left = Rows - 1; 702 if (theline == NULL) 703 { 704 // Use the start of the function for the line number. 705 SOURCING_LNUM = sourcing_lnum_top; 706 if (skip_until != NULL) 707 semsg(_(e_missing_heredoc_end_marker_str), skip_until); 708 else if (eap->cmdidx == CMD_def) 709 emsg(_(e_missing_enddef)); 710 else if (eap->cmdidx == CMD_block) 711 emsg(_(e_missing_end_block)); 712 else 713 emsg(_("E126: Missing :endfunction")); 714 goto theend; 715 } 716 717 // Detect line continuation: SOURCING_LNUM increased more than one. 718 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie); 719 if (SOURCING_LNUM < sourcing_lnum_off) 720 sourcing_lnum_off -= SOURCING_LNUM; 721 else 722 sourcing_lnum_off = 0; 723 724 if (skip_until != NULL) 725 { 726 // Don't check for ":endfunc"/":enddef" between 727 // * ":append" and "." 728 // * ":python <<EOF" and "EOF" 729 // * ":let {var-name} =<< [trim] {marker}" and "{marker}" 730 if (heredoc_trimmed == NULL 731 || (is_heredoc && skipwhite(theline) == theline) 732 || STRNCMP(theline, heredoc_trimmed, 733 STRLEN(heredoc_trimmed)) == 0) 734 { 735 if (heredoc_trimmed == NULL) 736 p = theline; 737 else if (is_heredoc) 738 p = skipwhite(theline) == theline 739 ? theline : theline + STRLEN(heredoc_trimmed); 740 else 741 p = theline + STRLEN(heredoc_trimmed); 742 if (STRCMP(p, skip_until) == 0) 743 { 744 VIM_CLEAR(skip_until); 745 VIM_CLEAR(heredoc_trimmed); 746 getline_options = vim9_function 747 ? GETLINE_CONCAT_CONTBAR : GETLINE_CONCAT_CONT; 748 is_heredoc = FALSE; 749 750 if (heredoc_concat_len > 0) 751 { 752 // Replace the starting line with all the concatenated 753 // lines. 754 ga_concat(&heredoc_ga, theline); 755 vim_free(((char_u **)(newlines->ga_data))[ 756 heredoc_concat_len - 1]); 757 ((char_u **)(newlines->ga_data))[ 758 heredoc_concat_len - 1] = heredoc_ga.ga_data; 759 ga_init(&heredoc_ga); 760 heredoc_concat_len = 0; 761 theline += STRLEN(theline); // skip the "EOF" 762 } 763 } 764 } 765 } 766 else 767 { 768 int c; 769 770 // skip ':' and blanks 771 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p) 772 ; 773 774 // Check for "endfunction", "enddef" or "}". 775 // When a ":" follows it must be a dict key; "enddef: value," 776 if ((nesting == 0 && eap->cmdidx == CMD_block) 777 ? *p == '}' 778 : (checkforcmd(&p, nesting_def[nesting] 779 ? "enddef" : "endfunction", 4) 780 && *p != ':')) 781 { 782 if (nesting-- == 0) 783 { 784 char_u *nextcmd = NULL; 785 786 if (*p == '|' || *p == '}') 787 nextcmd = p + 1; 788 else if (line_arg != NULL && *skipwhite(line_arg) != NUL) 789 nextcmd = line_arg; 790 else if (*p != NUL && *p != (vim9_function ? '#' : '"') 791 && (vim9_function || p_verbose > 0)) 792 { 793 if (eap->cmdidx == CMD_def) 794 semsg(_(e_text_found_after_enddef_str), p); 795 else 796 give_warning2((char_u *) 797 _("W22: Text found after :endfunction: %s"), 798 p, TRUE); 799 } 800 if (nextcmd != NULL && *skipwhite(nextcmd) != NUL) 801 { 802 // Another command follows. If the line came from "eap" 803 // we can simply point into it, otherwise we need to 804 // change "eap->cmdlinep". 805 eap->nextcmd = nextcmd; 806 if (*line_to_free != NULL) 807 { 808 vim_free(*eap->cmdlinep); 809 *eap->cmdlinep = *line_to_free; 810 *line_to_free = NULL; 811 } 812 } 813 break; 814 } 815 } 816 817 // Check for mismatched "endfunc" or "enddef". 818 // We don't check for "def" inside "func" thus we also can't check 819 // for "enddef". 820 // We continue to find the end of the function, although we might 821 // not find it. 822 else if (nesting_def[nesting]) 823 { 824 if (checkforcmd(&p, "endfunction", 4) && *p != ':') 825 emsg(_(e_mismatched_endfunction)); 826 } 827 else if (eap->cmdidx == CMD_def && checkforcmd(&p, "enddef", 4)) 828 emsg(_(e_mismatched_enddef)); 829 830 // Increase indent inside "if", "while", "for" and "try", decrease 831 // at "end". 832 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0)) 833 indent -= 2; 834 else if (STRNCMP(p, "if", 2) == 0 835 || STRNCMP(p, "wh", 2) == 0 836 || STRNCMP(p, "for", 3) == 0 837 || STRNCMP(p, "try", 3) == 0) 838 indent += 2; 839 840 // Check for defining a function inside this function. 841 // Only recognize "def" inside "def", not inside "function", 842 // For backwards compatibility, see Test_function_python(). 843 c = *p; 844 if (is_function_cmd(&p) 845 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3))) 846 { 847 if (*p == '!') 848 p = skipwhite(p + 1); 849 p += eval_fname_script(p); 850 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, 851 NULL, NULL)); 852 if (*skipwhite(p) == '(') 853 { 854 if (nesting == MAX_FUNC_NESTING - 1) 855 emsg(_(e_function_nesting_too_deep)); 856 else 857 { 858 ++nesting; 859 nesting_def[nesting] = (c == 'd'); 860 indent += 2; 861 } 862 } 863 } 864 865 // Check for ":append", ":change", ":insert". Not for :def. 866 p = skip_range(p, FALSE, NULL); 867 if (!vim9_function 868 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p')) 869 || (p[0] == 'c' 870 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h' 871 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a' 872 && (STRNCMP(&p[3], "nge", 3) != 0 873 || !ASCII_ISALPHA(p[6]))))))) 874 || (p[0] == 'i' 875 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n' 876 && (!ASCII_ISALPHA(p[2]) 877 || (p[2] == 's' 878 && (!ASCII_ISALPHA(p[3]) 879 || p[3] == 'e')))))))) 880 skip_until = vim_strsave((char_u *)"."); 881 882 // Check for ":python <<EOF", ":tcl <<EOF", etc. 883 arg = skipwhite(skiptowhite(p)); 884 if (arg[0] == '<' && arg[1] =='<' 885 && ((p[0] == 'p' && p[1] == 'y' 886 && (!ASCII_ISALNUM(p[2]) || p[2] == 't' 887 || ((p[2] == '3' || p[2] == 'x') 888 && !ASCII_ISALPHA(p[3])))) 889 || (p[0] == 'p' && p[1] == 'e' 890 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r')) 891 || (p[0] == 't' && p[1] == 'c' 892 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l')) 893 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a' 894 && !ASCII_ISALPHA(p[3])) 895 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b' 896 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y')) 897 || (p[0] == 'm' && p[1] == 'z' 898 && (!ASCII_ISALPHA(p[2]) || p[2] == 's')) 899 )) 900 { 901 // ":python <<" continues until a dot, like ":append" 902 p = skipwhite(arg + 2); 903 if (STRNCMP(p, "trim", 4) == 0) 904 { 905 // Ignore leading white space. 906 p = skipwhite(p + 4); 907 heredoc_trimmed = vim_strnsave(theline, 908 skipwhite(theline) - theline); 909 } 910 if (*p == NUL) 911 skip_until = vim_strsave((char_u *)"."); 912 else 913 skip_until = vim_strnsave(p, skiptowhite(p) - p); 914 getline_options = GETLINE_NONE; 915 is_heredoc = TRUE; 916 if (eap->cmdidx == CMD_def) 917 heredoc_concat_len = newlines->ga_len + 1; 918 } 919 920 // Check for ":cmd v =<< [trim] EOF" 921 // and ":cmd [a, b] =<< [trim] EOF" 922 // and "lines =<< [trim] EOF" for Vim9 923 // Where "cmd" can be "let", "var", "final" or "const". 924 arg = skipwhite(skiptowhite(p)); 925 if (*arg == '[') 926 arg = vim_strchr(arg, ']'); 927 if (arg != NULL) 928 { 929 int found = (eap->cmdidx == CMD_def && arg[0] == '=' 930 && arg[1] == '<' && arg[2] =='<'); 931 932 if (!found) 933 // skip over the argument after "cmd" 934 arg = skipwhite(skiptowhite(arg)); 935 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<' 936 && (checkforcmd(&p, "let", 2) 937 || checkforcmd(&p, "var", 3) 938 || checkforcmd(&p, "final", 5) 939 || checkforcmd(&p, "const", 5)))) 940 { 941 p = skipwhite(arg + 3); 942 if (STRNCMP(p, "trim", 4) == 0) 943 { 944 // Ignore leading white space. 945 p = skipwhite(p + 4); 946 heredoc_trimmed = vim_strnsave(theline, 947 skipwhite(theline) - theline); 948 } 949 skip_until = vim_strnsave(p, skiptowhite(p) - p); 950 getline_options = GETLINE_NONE; 951 is_heredoc = TRUE; 952 } 953 } 954 } 955 956 // Add the line to the function. 957 if (ga_grow(newlines, 1 + sourcing_lnum_off) == FAIL) 958 goto theend; 959 960 if (heredoc_concat_len > 0) 961 { 962 // For a :def function "python << EOF" concatenats all the lines, 963 // to be used for the instruction later. 964 ga_concat(&heredoc_ga, theline); 965 ga_concat(&heredoc_ga, (char_u *)"\n"); 966 p = vim_strsave((char_u *)""); 967 } 968 else 969 { 970 // Copy the line to newly allocated memory. get_one_sourceline() 971 // allocates 250 bytes per line, this saves 80% on average. The 972 // cost is an extra alloc/free. 973 p = vim_strsave(theline); 974 } 975 if (p == NULL) 976 goto theend; 977 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = p; 978 979 // Add NULL lines for continuation lines, so that the line count is 980 // equal to the index in the growarray. 981 while (sourcing_lnum_off-- > 0) 982 ((char_u **)(newlines->ga_data))[newlines->ga_len++] = NULL; 983 984 // Check for end of eap->arg. 985 if (line_arg != NULL && *line_arg == NUL) 986 line_arg = NULL; 987 } 988 989 // Return OK when no error was detected. 990 if (!did_emsg) 991 ret = OK; 992 993 theend: 994 vim_free(skip_until); 995 vim_free(heredoc_trimmed); 996 vim_free(heredoc_ga.ga_data); 997 need_wait_return |= saved_wait_return; 998 return ret; 999 } 1000 1001 /* 1002 * Handle the body of a lambda. *arg points to the "{", process statements 1003 * until the matching "}". 1004 * When not evaluating "newargs" is NULL. 1005 * When successful "rettv" is set to a funcref. 1006 */ 1007 static int 1008 lambda_function_body( 1009 char_u **arg, 1010 typval_T *rettv, 1011 evalarg_T *evalarg, 1012 garray_T *newargs, 1013 garray_T *argtypes, 1014 int varargs, 1015 garray_T *default_args, 1016 char_u *ret_type) 1017 { 1018 int evaluate = (evalarg->eval_flags & EVAL_EVALUATE); 1019 garray_T *gap = &evalarg->eval_ga; 1020 garray_T *freegap = &evalarg->eval_freega; 1021 ufunc_T *ufunc = NULL; 1022 exarg_T eap; 1023 garray_T newlines; 1024 char_u *cmdline = NULL; 1025 int ret = FAIL; 1026 char_u *line_to_free = NULL; 1027 partial_T *pt; 1028 char_u *name; 1029 int lnum_save = -1; 1030 linenr_T sourcing_lnum_top = SOURCING_LNUM; 1031 1032 if (!ends_excmd2(*arg, skipwhite(*arg + 1))) 1033 { 1034 semsg(_(e_trailing_arg), *arg + 1); 1035 return FAIL; 1036 } 1037 1038 CLEAR_FIELD(eap); 1039 eap.cmdidx = CMD_block; 1040 eap.forceit = FALSE; 1041 eap.cmdlinep = &cmdline; 1042 eap.skip = !evaluate; 1043 if (evalarg->eval_cctx != NULL) 1044 fill_exarg_from_cctx(&eap, evalarg->eval_cctx); 1045 else 1046 { 1047 eap.getline = evalarg->eval_getline; 1048 eap.cookie = evalarg->eval_cookie; 1049 } 1050 1051 ga_init2(&newlines, (int)sizeof(char_u *), 10); 1052 if (get_function_body(&eap, &newlines, NULL, &line_to_free) == FAIL) 1053 { 1054 vim_free(cmdline); 1055 goto erret; 1056 } 1057 1058 // When inside a lambda must add the function lines to evalarg.eval_ga. 1059 evalarg->eval_break_count += newlines.ga_len; 1060 if (gap->ga_itemsize > 0) 1061 { 1062 int idx; 1063 char_u *last; 1064 size_t plen; 1065 char_u *pnl; 1066 1067 for (idx = 0; idx < newlines.ga_len; ++idx) 1068 { 1069 char_u *p = skipwhite(((char_u **)newlines.ga_data)[idx]); 1070 1071 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL) 1072 goto erret; 1073 1074 // Going to concatenate the lines after parsing. For an empty or 1075 // comment line use an empty string. 1076 // Insert NL characters at the start of each line, the string will 1077 // be split again later in .get_lambda_tv(). 1078 if (*p == NUL || vim9_comment_start(p)) 1079 p = (char_u *)""; 1080 plen = STRLEN(p); 1081 pnl = vim_strnsave((char_u *)"\n", plen + 1); 1082 if (pnl != NULL) 1083 mch_memmove(pnl + 1, p, plen + 1); 1084 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl; 1085 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl; 1086 } 1087 if (ga_grow(gap, 1) == FAIL || ga_grow(freegap, 1) == FAIL) 1088 goto erret; 1089 if (cmdline != NULL) 1090 // more is following after the "}", which was skipped 1091 last = cmdline; 1092 else 1093 // nothing is following the "}" 1094 last = (char_u *)"}"; 1095 plen = STRLEN(last); 1096 pnl = vim_strnsave((char_u *)"\n", plen + 1); 1097 if (pnl != NULL) 1098 mch_memmove(pnl + 1, last, plen + 1); 1099 ((char_u **)gap->ga_data)[gap->ga_len++] = pnl; 1100 ((char_u **)freegap->ga_data)[freegap->ga_len++] = pnl; 1101 } 1102 1103 if (cmdline != NULL) 1104 { 1105 // Something comes after the "}". 1106 *arg = eap.nextcmd; 1107 1108 // "arg" points into cmdline, need to keep the line and free it later. 1109 vim_free(evalarg->eval_tofree_cmdline); 1110 evalarg->eval_tofree_cmdline = cmdline; 1111 } 1112 else 1113 *arg = (char_u *)""; 1114 1115 if (!evaluate) 1116 { 1117 ret = OK; 1118 goto erret; 1119 } 1120 1121 name = get_lambda_name(); 1122 ufunc = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 1123 if (ufunc == NULL) 1124 goto erret; 1125 set_ufunc_name(ufunc, name); 1126 if (hash_add(&func_hashtab, UF2HIKEY(ufunc)) == FAIL) 1127 goto erret; 1128 ufunc->uf_refcount = 1; 1129 ufunc->uf_args = *newargs; 1130 newargs->ga_data = NULL; 1131 ufunc->uf_def_args = *default_args; 1132 default_args->ga_data = NULL; 1133 ufunc->uf_func_type = &t_func_any; 1134 1135 // error messages are for the first function line 1136 lnum_save = SOURCING_LNUM; 1137 SOURCING_LNUM = sourcing_lnum_top; 1138 1139 // parse argument types 1140 if (parse_argument_types(ufunc, argtypes, varargs) == FAIL) 1141 { 1142 SOURCING_LNUM = lnum_save; 1143 goto erret; 1144 } 1145 1146 // parse the return type, if any 1147 if (parse_return_type(ufunc, ret_type) == FAIL) 1148 goto erret; 1149 1150 pt = ALLOC_CLEAR_ONE(partial_T); 1151 if (pt == NULL) 1152 goto erret; 1153 pt->pt_func = ufunc; 1154 pt->pt_refcount = 1; 1155 1156 ufunc->uf_lines = newlines; 1157 newlines.ga_data = NULL; 1158 if (sandbox) 1159 ufunc->uf_flags |= FC_SANDBOX; 1160 if (!ASCII_ISUPPER(*ufunc->uf_name)) 1161 ufunc->uf_flags |= FC_VIM9; 1162 ufunc->uf_script_ctx = current_sctx; 1163 ufunc->uf_script_ctx_version = current_sctx.sc_version; 1164 ufunc->uf_script_ctx.sc_lnum += sourcing_lnum_top; 1165 set_function_type(ufunc); 1166 1167 rettv->vval.v_partial = pt; 1168 rettv->v_type = VAR_PARTIAL; 1169 ufunc = NULL; 1170 ret = OK; 1171 1172 erret: 1173 if (lnum_save >= 0) 1174 SOURCING_LNUM = lnum_save; 1175 vim_free(line_to_free); 1176 ga_clear_strings(&newlines); 1177 if (newargs != NULL) 1178 ga_clear_strings(newargs); 1179 ga_clear_strings(default_args); 1180 if (ufunc != NULL) 1181 { 1182 func_clear(ufunc, TRUE); 1183 func_free(ufunc, TRUE); 1184 } 1185 return ret; 1186 } 1187 1188 /* 1189 * Parse a lambda expression and get a Funcref from "*arg" into "rettv". 1190 * "arg" points to the { in "{arg -> expr}" or the ( in "(arg) => expr" 1191 * When "types_optional" is TRUE optionally take argument types. 1192 * Return OK or FAIL. Returns NOTDONE for dict or {expr}. 1193 */ 1194 int 1195 get_lambda_tv( 1196 char_u **arg, 1197 typval_T *rettv, 1198 int types_optional, 1199 evalarg_T *evalarg) 1200 { 1201 int evaluate = evalarg != NULL 1202 && (evalarg->eval_flags & EVAL_EVALUATE); 1203 garray_T newargs; 1204 garray_T newlines; 1205 garray_T *pnewargs; 1206 garray_T argtypes; 1207 garray_T default_args; 1208 ufunc_T *fp = NULL; 1209 partial_T *pt = NULL; 1210 int varargs; 1211 char_u *ret_type = NULL; 1212 int ret; 1213 char_u *s; 1214 char_u *start, *end; 1215 int *old_eval_lavars = eval_lavars_used; 1216 int eval_lavars = FALSE; 1217 char_u *tofree1 = NULL; 1218 char_u *tofree2 = NULL; 1219 int equal_arrow = **arg == '('; 1220 int white_error = FALSE; 1221 int called_emsg_start = called_emsg; 1222 1223 if (equal_arrow && !in_vim9script()) 1224 return NOTDONE; 1225 1226 ga_init(&newargs); 1227 ga_init(&newlines); 1228 1229 // First, check if this is really a lambda expression. "->" or "=>" must 1230 // be found after the arguments. 1231 s = *arg + 1; 1232 ret = get_function_args(&s, equal_arrow ? ')' : '-', NULL, 1233 types_optional ? &argtypes : NULL, types_optional, evalarg, 1234 NULL, &default_args, TRUE, NULL, NULL); 1235 if (ret == FAIL || skip_arrow(s, equal_arrow, &ret_type, NULL) == NULL) 1236 { 1237 if (types_optional) 1238 ga_clear_strings(&argtypes); 1239 return called_emsg == called_emsg_start ? NOTDONE : FAIL; 1240 } 1241 1242 // Parse the arguments for real. 1243 if (evaluate) 1244 pnewargs = &newargs; 1245 else 1246 pnewargs = NULL; 1247 *arg += 1; 1248 ret = get_function_args(arg, equal_arrow ? ')' : '-', pnewargs, 1249 types_optional ? &argtypes : NULL, types_optional, evalarg, 1250 &varargs, &default_args, 1251 FALSE, NULL, NULL); 1252 if (ret == FAIL 1253 || (s = skip_arrow(*arg, equal_arrow, &ret_type, 1254 equal_arrow || in_vim9script() ? &white_error : NULL)) == NULL) 1255 { 1256 if (types_optional) 1257 ga_clear_strings(&argtypes); 1258 ga_clear_strings(&newargs); 1259 return white_error ? FAIL : NOTDONE; 1260 } 1261 *arg = s; 1262 1263 // Skipping over linebreaks may make "ret_type" invalid, make a copy. 1264 if (ret_type != NULL) 1265 { 1266 ret_type = vim_strsave(ret_type); 1267 tofree2 = ret_type; 1268 } 1269 1270 // Set up a flag for checking local variables and arguments. 1271 if (evaluate) 1272 eval_lavars_used = &eval_lavars; 1273 1274 *arg = skipwhite_and_linebreak(*arg, evalarg); 1275 1276 // Recognize "{" as the start of a function body. 1277 if (equal_arrow && **arg == '{') 1278 { 1279 if (evalarg == NULL) 1280 // cannot happen? 1281 goto theend; 1282 if (lambda_function_body(arg, rettv, evalarg, pnewargs, 1283 types_optional ? &argtypes : NULL, varargs, 1284 &default_args, ret_type) == FAIL) 1285 goto errret; 1286 goto theend; 1287 } 1288 if (default_args.ga_len > 0) 1289 { 1290 emsg(_(e_cannot_use_default_values_in_lambda)); 1291 goto errret; 1292 } 1293 1294 // Get the start and the end of the expression. 1295 start = *arg; 1296 ret = skip_expr_concatenate(arg, &start, &end, evalarg); 1297 if (ret == FAIL) 1298 goto errret; 1299 if (evalarg != NULL) 1300 { 1301 // avoid that the expression gets freed when another line break follows 1302 tofree1 = evalarg->eval_tofree; 1303 evalarg->eval_tofree = NULL; 1304 } 1305 1306 if (!equal_arrow) 1307 { 1308 *arg = skipwhite_and_linebreak(*arg, evalarg); 1309 if (**arg != '}') 1310 { 1311 semsg(_("E451: Expected }: %s"), *arg); 1312 goto errret; 1313 } 1314 ++*arg; 1315 } 1316 1317 if (evaluate) 1318 { 1319 int len; 1320 int flags = 0; 1321 char_u *p; 1322 char_u *line_end; 1323 char_u *name = get_lambda_name(); 1324 1325 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 1326 if (fp == NULL) 1327 goto errret; 1328 fp->uf_def_status = UF_NOT_COMPILED; 1329 pt = ALLOC_CLEAR_ONE(partial_T); 1330 if (pt == NULL) 1331 goto errret; 1332 1333 ga_init2(&newlines, (int)sizeof(char_u *), 1); 1334 if (ga_grow(&newlines, 1) == FAIL) 1335 goto errret; 1336 1337 // If there are line breaks, we need to split up the string. 1338 line_end = vim_strchr(start, '\n'); 1339 if (line_end == NULL) 1340 line_end = end; 1341 1342 // Add "return " before the expression (or the first line). 1343 len = 7 + (int)(line_end - start) + 1; 1344 p = alloc(len); 1345 if (p == NULL) 1346 goto errret; 1347 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p; 1348 STRCPY(p, "return "); 1349 vim_strncpy(p + 7, start, line_end - start); 1350 1351 if (line_end != end) 1352 { 1353 // Add more lines, split by line breaks. Thus is used when a 1354 // lambda with { cmds } is encountered. 1355 while (*line_end == '\n') 1356 { 1357 if (ga_grow(&newlines, 1) == FAIL) 1358 goto errret; 1359 start = line_end + 1; 1360 line_end = vim_strchr(start, '\n'); 1361 if (line_end == NULL) 1362 line_end = end; 1363 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = 1364 vim_strnsave(start, line_end - start); 1365 } 1366 } 1367 1368 if (strstr((char *)p + 7, "a:") == NULL) 1369 // No a: variables are used for sure. 1370 flags |= FC_NOARGS; 1371 1372 fp->uf_refcount = 1; 1373 set_ufunc_name(fp, name); 1374 fp->uf_args = newargs; 1375 ga_init(&fp->uf_def_args); 1376 if (types_optional) 1377 { 1378 if (parse_argument_types(fp, &argtypes, 1379 in_vim9script() && varargs) == FAIL) 1380 goto errret; 1381 if (ret_type != NULL) 1382 { 1383 fp->uf_ret_type = parse_type(&ret_type, 1384 &fp->uf_type_list, TRUE); 1385 if (fp->uf_ret_type == NULL) 1386 goto errret; 1387 } 1388 else 1389 fp->uf_ret_type = &t_unknown; 1390 } 1391 1392 fp->uf_lines = newlines; 1393 if (current_funccal != NULL && eval_lavars) 1394 { 1395 flags |= FC_CLOSURE; 1396 if (register_closure(fp) == FAIL) 1397 goto errret; 1398 } 1399 1400 #ifdef FEAT_PROFILE 1401 if (prof_def_func()) 1402 func_do_profile(fp); 1403 #endif 1404 if (sandbox) 1405 flags |= FC_SANDBOX; 1406 // In legacy script a lambda can be called with more args than 1407 // uf_args.ga_len. In Vim9 script "...name" has to be used. 1408 fp->uf_varargs = !in_vim9script() || varargs; 1409 fp->uf_flags = flags; 1410 fp->uf_calls = 0; 1411 fp->uf_script_ctx = current_sctx; 1412 fp->uf_script_ctx.sc_lnum += SOURCING_LNUM - newlines.ga_len; 1413 1414 pt->pt_func = fp; 1415 pt->pt_refcount = 1; 1416 rettv->vval.v_partial = pt; 1417 rettv->v_type = VAR_PARTIAL; 1418 1419 hash_add(&func_hashtab, UF2HIKEY(fp)); 1420 } 1421 1422 theend: 1423 eval_lavars_used = old_eval_lavars; 1424 if (evalarg != NULL && evalarg->eval_tofree == NULL) 1425 evalarg->eval_tofree = tofree1; 1426 else 1427 vim_free(tofree1); 1428 vim_free(tofree2); 1429 if (types_optional) 1430 ga_clear_strings(&argtypes); 1431 return OK; 1432 1433 errret: 1434 ga_clear_strings(&newargs); 1435 ga_clear_strings(&newlines); 1436 ga_clear_strings(&default_args); 1437 if (types_optional) 1438 { 1439 ga_clear_strings(&argtypes); 1440 if (fp != NULL) 1441 vim_free(fp->uf_arg_types); 1442 } 1443 vim_free(fp); 1444 vim_free(pt); 1445 if (evalarg != NULL && evalarg->eval_tofree == NULL) 1446 evalarg->eval_tofree = tofree1; 1447 else 1448 vim_free(tofree1); 1449 vim_free(tofree2); 1450 eval_lavars_used = old_eval_lavars; 1451 return FAIL; 1452 } 1453 1454 /* 1455 * Check if "name" is a variable of type VAR_FUNC. If so, return the function 1456 * name it contains, otherwise return "name". 1457 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set 1458 * "partialp". 1459 * If "type" is not NULL and a Vim9 script-local variable is found look up the 1460 * type of the variable. 1461 */ 1462 char_u * 1463 deref_func_name( 1464 char_u *name, 1465 int *lenp, 1466 partial_T **partialp, 1467 type_T **type, 1468 int no_autoload) 1469 { 1470 dictitem_T *v; 1471 int cc; 1472 char_u *s = NULL; 1473 hashtab_T *ht; 1474 1475 if (partialp != NULL) 1476 *partialp = NULL; 1477 1478 cc = name[*lenp]; 1479 name[*lenp] = NUL; 1480 1481 v = find_var(name, &ht, no_autoload); 1482 name[*lenp] = cc; 1483 if (v != NULL) 1484 { 1485 if (v->di_tv.v_type == VAR_FUNC) 1486 { 1487 if (v->di_tv.vval.v_string == NULL) 1488 { 1489 *lenp = 0; 1490 return (char_u *)""; // just in case 1491 } 1492 s = v->di_tv.vval.v_string; 1493 *lenp = (int)STRLEN(s); 1494 } 1495 1496 if (v->di_tv.v_type == VAR_PARTIAL) 1497 { 1498 partial_T *pt = v->di_tv.vval.v_partial; 1499 1500 if (pt == NULL) 1501 { 1502 *lenp = 0; 1503 return (char_u *)""; // just in case 1504 } 1505 if (partialp != NULL) 1506 *partialp = pt; 1507 s = partial_name(pt); 1508 *lenp = (int)STRLEN(s); 1509 } 1510 1511 if (s != NULL) 1512 { 1513 if (type != NULL && ht == get_script_local_ht()) 1514 { 1515 svar_T *sv = find_typval_in_script(&v->di_tv); 1516 1517 if (sv != NULL) 1518 *type = sv->sv_type; 1519 } 1520 return s; 1521 } 1522 } 1523 1524 return name; 1525 } 1526 1527 /* 1528 * Give an error message with a function name. Handle <SNR> things. 1529 * "ermsg" is to be passed without translation, use N_() instead of _(). 1530 */ 1531 void 1532 emsg_funcname(char *ermsg, char_u *name) 1533 { 1534 char_u *p; 1535 1536 if (*name == K_SPECIAL) 1537 p = concat_str((char_u *)"<SNR>", name + 3); 1538 else 1539 p = name; 1540 semsg(_(ermsg), p); 1541 if (p != name) 1542 vim_free(p); 1543 } 1544 1545 /* 1546 * Allocate a variable for the result of a function. 1547 * Return OK or FAIL. 1548 */ 1549 int 1550 get_func_tv( 1551 char_u *name, // name of the function 1552 int len, // length of "name" or -1 to use strlen() 1553 typval_T *rettv, 1554 char_u **arg, // argument, pointing to the '(' 1555 evalarg_T *evalarg, // for line continuation 1556 funcexe_T *funcexe) // various values 1557 { 1558 char_u *argp; 1559 int ret = OK; 1560 typval_T argvars[MAX_FUNC_ARGS + 1]; // vars for arguments 1561 int argcount = 0; // number of arguments found 1562 int vim9script = in_vim9script(); 1563 1564 /* 1565 * Get the arguments. 1566 */ 1567 argp = *arg; 1568 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0 1569 : funcexe->partial->pt_argc)) 1570 { 1571 // skip the '(' or ',' and possibly line breaks 1572 argp = skipwhite_and_linebreak(argp + 1, evalarg); 1573 1574 if (*argp == ')' || *argp == ',' || *argp == NUL) 1575 break; 1576 if (eval1(&argp, &argvars[argcount], evalarg) == FAIL) 1577 { 1578 ret = FAIL; 1579 break; 1580 } 1581 ++argcount; 1582 // The comma should come right after the argument, but this wasn't 1583 // checked previously, thus only enforce it in Vim9 script. 1584 if (vim9script) 1585 { 1586 if (*argp != ',' && *skipwhite(argp) == ',') 1587 { 1588 semsg(_(e_no_white_space_allowed_before_str_str), ",", argp); 1589 ret = FAIL; 1590 break; 1591 } 1592 } 1593 else 1594 argp = skipwhite(argp); 1595 if (*argp != ',') 1596 break; 1597 if (vim9script && !IS_WHITE_OR_NUL(argp[1])) 1598 { 1599 semsg(_(e_white_space_required_after_str_str), ",", argp); 1600 ret = FAIL; 1601 break; 1602 } 1603 } 1604 argp = skipwhite_and_linebreak(argp, evalarg); 1605 if (*argp == ')') 1606 ++argp; 1607 else 1608 ret = FAIL; 1609 1610 if (ret == OK) 1611 { 1612 int i = 0; 1613 1614 if (get_vim_var_nr(VV_TESTING)) 1615 { 1616 // Prepare for calling test_garbagecollect_now(), need to know 1617 // what variables are used on the call stack. 1618 if (funcargs.ga_itemsize == 0) 1619 ga_init2(&funcargs, (int)sizeof(typval_T *), 50); 1620 for (i = 0; i < argcount; ++i) 1621 if (ga_grow(&funcargs, 1) == OK) 1622 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] = 1623 &argvars[i]; 1624 } 1625 1626 ret = call_func(name, len, rettv, argcount, argvars, funcexe); 1627 1628 funcargs.ga_len -= i; 1629 } 1630 else if (!aborting()) 1631 { 1632 if (argcount == MAX_FUNC_ARGS) 1633 emsg_funcname(N_("E740: Too many arguments for function %s"), name); 1634 else 1635 emsg_funcname(N_("E116: Invalid arguments for function %s"), name); 1636 } 1637 1638 while (--argcount >= 0) 1639 clear_tv(&argvars[argcount]); 1640 1641 if (in_vim9script()) 1642 *arg = argp; 1643 else 1644 *arg = skipwhite(argp); 1645 return ret; 1646 } 1647 1648 /* 1649 * Return TRUE if "p" starts with "<SID>" or "s:". 1650 * Only works if eval_fname_script() returned non-zero for "p"! 1651 */ 1652 static int 1653 eval_fname_sid(char_u *p) 1654 { 1655 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I'); 1656 } 1657 1658 /* 1659 * In a script change <SID>name() and s:name() to K_SNR 123_name(). 1660 * Change <SNR>123_name() to K_SNR 123_name(). 1661 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory 1662 * (slow). 1663 */ 1664 char_u * 1665 fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error) 1666 { 1667 int llen; 1668 char_u *fname; 1669 int i; 1670 1671 llen = eval_fname_script(name); 1672 if (llen > 0) 1673 { 1674 fname_buf[0] = K_SPECIAL; 1675 fname_buf[1] = KS_EXTRA; 1676 fname_buf[2] = (int)KE_SNR; 1677 i = 3; 1678 if (eval_fname_sid(name)) // "<SID>" or "s:" 1679 { 1680 if (current_sctx.sc_sid <= 0) 1681 *error = FCERR_SCRIPT; 1682 else 1683 { 1684 sprintf((char *)fname_buf + 3, "%ld_", 1685 (long)current_sctx.sc_sid); 1686 i = (int)STRLEN(fname_buf); 1687 } 1688 } 1689 if (i + STRLEN(name + llen) < FLEN_FIXED) 1690 { 1691 STRCPY(fname_buf + i, name + llen); 1692 fname = fname_buf; 1693 } 1694 else 1695 { 1696 fname = alloc(i + STRLEN(name + llen) + 1); 1697 if (fname == NULL) 1698 *error = FCERR_OTHER; 1699 else 1700 { 1701 *tofree = fname; 1702 mch_memmove(fname, fname_buf, (size_t)i); 1703 STRCPY(fname + i, name + llen); 1704 } 1705 } 1706 } 1707 else 1708 fname = name; 1709 return fname; 1710 } 1711 1712 /* 1713 * Find a function "name" in script "sid". 1714 */ 1715 static ufunc_T * 1716 find_func_with_sid(char_u *name, int sid) 1717 { 1718 hashitem_T *hi; 1719 char_u buffer[200]; 1720 1721 buffer[0] = K_SPECIAL; 1722 buffer[1] = KS_EXTRA; 1723 buffer[2] = (int)KE_SNR; 1724 vim_snprintf((char *)buffer + 3, sizeof(buffer) - 3, "%ld_%s", 1725 (long)sid, name); 1726 hi = hash_find(&func_hashtab, buffer); 1727 if (!HASHITEM_EMPTY(hi)) 1728 return HI2UF(hi); 1729 1730 return NULL; 1731 } 1732 1733 /* 1734 * Find a function by name, return pointer to it in ufuncs. 1735 * When "is_global" is true don't find script-local or imported functions. 1736 * Return NULL for unknown function. 1737 */ 1738 ufunc_T * 1739 find_func_even_dead(char_u *name, int is_global, cctx_T *cctx) 1740 { 1741 hashitem_T *hi; 1742 ufunc_T *func; 1743 imported_T *imported; 1744 1745 if (!is_global) 1746 { 1747 char_u *after_script = NULL; 1748 long sid = 0; 1749 int find_script_local = in_vim9script() 1750 && eval_isnamec1(*name) && name[1] != ':'; 1751 1752 if (find_script_local) 1753 { 1754 // Find script-local function before global one. 1755 func = find_func_with_sid(name, current_sctx.sc_sid); 1756 if (func != NULL) 1757 return func; 1758 } 1759 1760 if (name[0] == K_SPECIAL 1761 && name[1] == KS_EXTRA 1762 && name[2] == KE_SNR) 1763 { 1764 // Caller changes s: to <SNR>99_name. 1765 1766 after_script = name + 3; 1767 sid = getdigits(&after_script); 1768 if (*after_script == '_') 1769 ++after_script; 1770 else 1771 after_script = NULL; 1772 } 1773 if (find_script_local || after_script != NULL) 1774 { 1775 // Find imported function before global one. 1776 if (after_script != NULL && sid != current_sctx.sc_sid) 1777 imported = find_imported_in_script(after_script, 0, sid); 1778 else 1779 imported = find_imported(after_script == NULL 1780 ? name : after_script, 0, cctx); 1781 if (imported != NULL && imported->imp_funcname != NULL) 1782 { 1783 hi = hash_find(&func_hashtab, imported->imp_funcname); 1784 if (!HASHITEM_EMPTY(hi)) 1785 return HI2UF(hi); 1786 } 1787 } 1788 } 1789 1790 hi = hash_find(&func_hashtab, 1791 STRNCMP(name, "g:", 2) == 0 ? name + 2 : name); 1792 if (!HASHITEM_EMPTY(hi)) 1793 return HI2UF(hi); 1794 1795 return NULL; 1796 } 1797 1798 /* 1799 * Find a function by name, return pointer to it in ufuncs. 1800 * "cctx" is passed in a :def function to find imported functions. 1801 * Return NULL for unknown or dead function. 1802 */ 1803 ufunc_T * 1804 find_func(char_u *name, int is_global, cctx_T *cctx) 1805 { 1806 ufunc_T *fp = find_func_even_dead(name, is_global, cctx); 1807 1808 if (fp != NULL && (fp->uf_flags & FC_DEAD) == 0) 1809 return fp; 1810 return NULL; 1811 } 1812 1813 /* 1814 * Return TRUE if "ufunc" is a global function. 1815 */ 1816 int 1817 func_is_global(ufunc_T *ufunc) 1818 { 1819 return ufunc->uf_name[0] != K_SPECIAL; 1820 } 1821 1822 /* 1823 * Copy the function name of "fp" to buffer "buf". 1824 * "buf" must be able to hold the function name plus three bytes. 1825 * Takes care of script-local function names. 1826 */ 1827 static void 1828 cat_func_name(char_u *buf, ufunc_T *fp) 1829 { 1830 if (!func_is_global(fp)) 1831 { 1832 STRCPY(buf, "<SNR>"); 1833 STRCAT(buf, fp->uf_name + 3); 1834 } 1835 else 1836 STRCPY(buf, fp->uf_name); 1837 } 1838 1839 /* 1840 * Add a number variable "name" to dict "dp" with value "nr". 1841 */ 1842 static void 1843 add_nr_var( 1844 dict_T *dp, 1845 dictitem_T *v, 1846 char *name, 1847 varnumber_T nr) 1848 { 1849 STRCPY(v->di_key, name); 1850 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 1851 hash_add(&dp->dv_hashtab, DI2HIKEY(v)); 1852 v->di_tv.v_type = VAR_NUMBER; 1853 v->di_tv.v_lock = VAR_FIXED; 1854 v->di_tv.vval.v_number = nr; 1855 } 1856 1857 /* 1858 * Free "fc". 1859 */ 1860 static void 1861 free_funccal(funccall_T *fc) 1862 { 1863 int i; 1864 1865 for (i = 0; i < fc->fc_funcs.ga_len; ++i) 1866 { 1867 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i]; 1868 1869 // When garbage collecting a funccall_T may be freed before the 1870 // function that references it, clear its uf_scoped field. 1871 // The function may have been redefined and point to another 1872 // funccall_T, don't clear it then. 1873 if (fp != NULL && fp->uf_scoped == fc) 1874 fp->uf_scoped = NULL; 1875 } 1876 ga_clear(&fc->fc_funcs); 1877 1878 func_ptr_unref(fc->func); 1879 vim_free(fc); 1880 } 1881 1882 /* 1883 * Free "fc" and what it contains. 1884 * Can be called only when "fc" is kept beyond the period of it called, 1885 * i.e. after cleanup_function_call(fc). 1886 */ 1887 static void 1888 free_funccal_contents(funccall_T *fc) 1889 { 1890 listitem_T *li; 1891 1892 // Free all l: variables. 1893 vars_clear(&fc->l_vars.dv_hashtab); 1894 1895 // Free all a: variables. 1896 vars_clear(&fc->l_avars.dv_hashtab); 1897 1898 // Free the a:000 variables. 1899 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li) 1900 clear_tv(&li->li_tv); 1901 1902 free_funccal(fc); 1903 } 1904 1905 /* 1906 * Handle the last part of returning from a function: free the local hashtable. 1907 * Unless it is still in use by a closure. 1908 */ 1909 static void 1910 cleanup_function_call(funccall_T *fc) 1911 { 1912 int may_free_fc = fc->fc_refcount <= 0; 1913 int free_fc = TRUE; 1914 1915 current_funccal = fc->caller; 1916 1917 // Free all l: variables if not referred. 1918 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT) 1919 vars_clear(&fc->l_vars.dv_hashtab); 1920 else 1921 free_fc = FALSE; 1922 1923 // If the a:000 list and the l: and a: dicts are not referenced and 1924 // there is no closure using it, we can free the funccall_T and what's 1925 // in it. 1926 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT) 1927 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE); 1928 else 1929 { 1930 int todo; 1931 hashitem_T *hi; 1932 dictitem_T *di; 1933 1934 free_fc = FALSE; 1935 1936 // Make a copy of the a: variables, since we didn't do that above. 1937 todo = (int)fc->l_avars.dv_hashtab.ht_used; 1938 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi) 1939 { 1940 if (!HASHITEM_EMPTY(hi)) 1941 { 1942 --todo; 1943 di = HI2DI(hi); 1944 copy_tv(&di->di_tv, &di->di_tv); 1945 } 1946 } 1947 } 1948 1949 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT) 1950 fc->l_varlist.lv_first = NULL; 1951 else 1952 { 1953 listitem_T *li; 1954 1955 free_fc = FALSE; 1956 1957 // Make a copy of the a:000 items, since we didn't do that above. 1958 FOR_ALL_LIST_ITEMS(&fc->l_varlist, li) 1959 copy_tv(&li->li_tv, &li->li_tv); 1960 } 1961 1962 if (free_fc) 1963 free_funccal(fc); 1964 else 1965 { 1966 static int made_copy = 0; 1967 1968 // "fc" is still in use. This can happen when returning "a:000", 1969 // assigning "l:" to a global variable or defining a closure. 1970 // Link "fc" in the list for garbage collection later. 1971 fc->caller = previous_funccal; 1972 previous_funccal = fc; 1973 1974 if (want_garbage_collect) 1975 // If garbage collector is ready, clear count. 1976 made_copy = 0; 1977 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc))) 1978 { 1979 // We have made a lot of copies, worth 4 Mbyte. This can happen 1980 // when repetitively calling a function that creates a reference to 1981 // itself somehow. Call the garbage collector soon to avoid using 1982 // too much memory. 1983 made_copy = 0; 1984 want_garbage_collect = TRUE; 1985 } 1986 } 1987 } 1988 1989 /* 1990 * There are two kinds of function names: 1991 * 1. ordinary names, function defined with :function or :def 1992 * 2. numbered functions and lambdas 1993 * For the first we only count the name stored in func_hashtab as a reference, 1994 * using function() does not count as a reference, because the function is 1995 * looked up by name. 1996 */ 1997 int 1998 func_name_refcount(char_u *name) 1999 { 2000 return isdigit(*name) || *name == '<'; 2001 } 2002 2003 /* 2004 * Unreference "fc": decrement the reference count and free it when it 2005 * becomes zero. "fp" is detached from "fc". 2006 * When "force" is TRUE we are exiting. 2007 */ 2008 static void 2009 funccal_unref(funccall_T *fc, ufunc_T *fp, int force) 2010 { 2011 funccall_T **pfc; 2012 int i; 2013 2014 if (fc == NULL) 2015 return; 2016 2017 if (--fc->fc_refcount <= 0 && (force || ( 2018 fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT 2019 && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT 2020 && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT))) 2021 for (pfc = &previous_funccal; *pfc != NULL; pfc = &(*pfc)->caller) 2022 { 2023 if (fc == *pfc) 2024 { 2025 *pfc = fc->caller; 2026 free_funccal_contents(fc); 2027 return; 2028 } 2029 } 2030 for (i = 0; i < fc->fc_funcs.ga_len; ++i) 2031 if (((ufunc_T **)(fc->fc_funcs.ga_data))[i] == fp) 2032 ((ufunc_T **)(fc->fc_funcs.ga_data))[i] = NULL; 2033 } 2034 2035 /* 2036 * Remove the function from the function hashtable. If the function was 2037 * deleted while it still has references this was already done. 2038 * Return TRUE if the entry was deleted, FALSE if it wasn't found. 2039 */ 2040 static int 2041 func_remove(ufunc_T *fp) 2042 { 2043 hashitem_T *hi; 2044 2045 // Return if it was already virtually deleted. 2046 if (fp->uf_flags & FC_DEAD) 2047 return FALSE; 2048 2049 hi = hash_find(&func_hashtab, UF2HIKEY(fp)); 2050 if (!HASHITEM_EMPTY(hi)) 2051 { 2052 // When there is a def-function index do not actually remove the 2053 // function, so we can find the index when defining the function again. 2054 // Do remove it when it's a copy. 2055 if (fp->uf_def_status == UF_COMPILED && (fp->uf_flags & FC_COPY) == 0) 2056 { 2057 fp->uf_flags |= FC_DEAD; 2058 return FALSE; 2059 } 2060 hash_remove(&func_hashtab, hi); 2061 fp->uf_flags |= FC_DELETED; 2062 return TRUE; 2063 } 2064 return FALSE; 2065 } 2066 2067 static void 2068 func_clear_items(ufunc_T *fp) 2069 { 2070 ga_clear_strings(&(fp->uf_args)); 2071 ga_clear_strings(&(fp->uf_def_args)); 2072 ga_clear_strings(&(fp->uf_lines)); 2073 VIM_CLEAR(fp->uf_arg_types); 2074 VIM_CLEAR(fp->uf_block_ids); 2075 VIM_CLEAR(fp->uf_va_name); 2076 clear_type_list(&fp->uf_type_list); 2077 2078 // Increment the refcount of this function to avoid it being freed 2079 // recursively when the partial is freed. 2080 fp->uf_refcount += 3; 2081 partial_unref(fp->uf_partial); 2082 fp->uf_partial = NULL; 2083 fp->uf_refcount -= 3; 2084 2085 #ifdef FEAT_LUA 2086 if (fp->uf_cb_free != NULL) 2087 { 2088 fp->uf_cb_free(fp->uf_cb_state); 2089 fp->uf_cb_free = NULL; 2090 } 2091 2092 fp->uf_cb_state = NULL; 2093 fp->uf_cb = NULL; 2094 #endif 2095 #ifdef FEAT_PROFILE 2096 VIM_CLEAR(fp->uf_tml_count); 2097 VIM_CLEAR(fp->uf_tml_total); 2098 VIM_CLEAR(fp->uf_tml_self); 2099 #endif 2100 } 2101 2102 /* 2103 * Free all things that a function contains. Does not free the function 2104 * itself, use func_free() for that. 2105 * When "force" is TRUE we are exiting. 2106 */ 2107 static void 2108 func_clear(ufunc_T *fp, int force) 2109 { 2110 if (fp->uf_cleared) 2111 return; 2112 fp->uf_cleared = TRUE; 2113 2114 // clear this function 2115 func_clear_items(fp); 2116 funccal_unref(fp->uf_scoped, fp, force); 2117 unlink_def_function(fp); 2118 } 2119 2120 /* 2121 * Free a function and remove it from the list of functions. Does not free 2122 * what a function contains, call func_clear() first. 2123 * When "force" is TRUE we are exiting. 2124 * Returns OK when the function was actually freed. 2125 */ 2126 static int 2127 func_free(ufunc_T *fp, int force) 2128 { 2129 // Only remove it when not done already, otherwise we would remove a newer 2130 // version of the function with the same name. 2131 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0) 2132 func_remove(fp); 2133 2134 if ((fp->uf_flags & FC_DEAD) == 0 || force) 2135 { 2136 if (fp->uf_dfunc_idx > 0) 2137 unlink_def_function(fp); 2138 VIM_CLEAR(fp->uf_name_exp); 2139 vim_free(fp); 2140 return OK; 2141 } 2142 return FAIL; 2143 } 2144 2145 /* 2146 * Free all things that a function contains and free the function itself. 2147 * When "force" is TRUE we are exiting. 2148 */ 2149 static void 2150 func_clear_free(ufunc_T *fp, int force) 2151 { 2152 func_clear(fp, force); 2153 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name) 2154 || (fp->uf_flags & FC_COPY)) 2155 func_free(fp, force); 2156 else 2157 fp->uf_flags |= FC_DEAD; 2158 } 2159 2160 /* 2161 * Copy already defined function "lambda" to a new function with name "global". 2162 * This is for when a compiled function defines a global function. 2163 */ 2164 int 2165 copy_func(char_u *lambda, char_u *global, ectx_T *ectx) 2166 { 2167 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL); 2168 ufunc_T *fp = NULL; 2169 2170 if (ufunc == NULL) 2171 { 2172 semsg(_(e_lambda_function_not_found_str), lambda); 2173 return FAIL; 2174 } 2175 2176 fp = find_func(global, TRUE, NULL); 2177 if (fp != NULL) 2178 { 2179 // TODO: handle ! to overwrite 2180 semsg(_(e_funcexts), global); 2181 return FAIL; 2182 } 2183 2184 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1); 2185 if (fp == NULL) 2186 return FAIL; 2187 2188 fp->uf_varargs = ufunc->uf_varargs; 2189 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY; 2190 fp->uf_def_status = ufunc->uf_def_status; 2191 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx; 2192 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL 2193 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args) 2194 == FAIL 2195 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL) 2196 goto failed; 2197 2198 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL 2199 : vim_strsave(ufunc->uf_name_exp); 2200 if (ufunc->uf_arg_types != NULL) 2201 { 2202 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len); 2203 if (fp->uf_arg_types == NULL) 2204 goto failed; 2205 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types, 2206 sizeof(type_T *) * fp->uf_args.ga_len); 2207 } 2208 if (ufunc->uf_va_name != NULL) 2209 { 2210 fp->uf_va_name = vim_strsave(ufunc->uf_va_name); 2211 if (fp->uf_va_name == NULL) 2212 goto failed; 2213 } 2214 fp->uf_ret_type = ufunc->uf_ret_type; 2215 2216 fp->uf_refcount = 1; 2217 STRCPY(fp->uf_name, global); 2218 hash_add(&func_hashtab, UF2HIKEY(fp)); 2219 2220 // the referenced dfunc_T is now used one more time 2221 link_def_function(fp); 2222 2223 // Create a partial to store the context of the function where it was 2224 // instantiated. Only needs to be done once. Do this on the original 2225 // function, "dfunc->df_ufunc" will point to it. 2226 if ((ufunc->uf_flags & FC_CLOSURE) && ufunc->uf_partial == NULL) 2227 { 2228 partial_T *pt = ALLOC_CLEAR_ONE(partial_T); 2229 2230 if (pt == NULL) 2231 goto failed; 2232 if (fill_partial_and_closure(pt, ufunc, ectx) == FAIL) 2233 { 2234 vim_free(pt); 2235 goto failed; 2236 } 2237 ufunc->uf_partial = pt; 2238 --pt->pt_refcount; // not actually referenced here 2239 } 2240 2241 return OK; 2242 2243 failed: 2244 func_clear_free(fp, TRUE); 2245 return FAIL; 2246 } 2247 2248 static int funcdepth = 0; 2249 2250 /* 2251 * Increment the function call depth count. 2252 * Return FAIL when going over 'maxfuncdepth'. 2253 * Otherwise return OK, must call funcdepth_decrement() later! 2254 */ 2255 int 2256 funcdepth_increment(void) 2257 { 2258 if (funcdepth >= p_mfd) 2259 { 2260 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'")); 2261 return FAIL; 2262 } 2263 ++funcdepth; 2264 return OK; 2265 } 2266 2267 void 2268 funcdepth_decrement(void) 2269 { 2270 --funcdepth; 2271 } 2272 2273 /* 2274 * Get the current function call depth. 2275 */ 2276 int 2277 funcdepth_get(void) 2278 { 2279 return funcdepth; 2280 } 2281 2282 /* 2283 * Restore the function call depth. This is for cases where there is no 2284 * guarantee funcdepth_decrement() can be called exactly the same number of 2285 * times as funcdepth_increment(). 2286 */ 2287 void 2288 funcdepth_restore(int depth) 2289 { 2290 funcdepth = depth; 2291 } 2292 2293 /* 2294 * Call a user function. 2295 */ 2296 static void 2297 call_user_func( 2298 ufunc_T *fp, // pointer to function 2299 int argcount, // nr of args 2300 typval_T *argvars, // arguments 2301 typval_T *rettv, // return value 2302 funcexe_T *funcexe, // context 2303 dict_T *selfdict) // Dictionary for "self" 2304 { 2305 sctx_T save_current_sctx; 2306 int using_sandbox = FALSE; 2307 funccall_T *fc; 2308 int save_did_emsg; 2309 int default_arg_err = FALSE; 2310 dictitem_T *v; 2311 int fixvar_idx = 0; // index in fixvar[] 2312 int i; 2313 int ai; 2314 int islambda = FALSE; 2315 char_u numbuf[NUMBUFLEN]; 2316 char_u *name; 2317 typval_T *tv_to_free[MAX_FUNC_ARGS]; 2318 int tv_to_free_len = 0; 2319 #ifdef FEAT_PROFILE 2320 profinfo_T profile_info; 2321 #endif 2322 ESTACK_CHECK_DECLARATION 2323 2324 #ifdef FEAT_PROFILE 2325 CLEAR_FIELD(profile_info); 2326 #endif 2327 2328 // If depth of calling is getting too high, don't execute the function. 2329 if (funcdepth_increment() == FAIL) 2330 { 2331 rettv->v_type = VAR_NUMBER; 2332 rettv->vval.v_number = -1; 2333 return; 2334 } 2335 2336 line_breakcheck(); // check for CTRL-C hit 2337 2338 fc = ALLOC_CLEAR_ONE(funccall_T); 2339 if (fc == NULL) 2340 return; 2341 fc->caller = current_funccal; 2342 current_funccal = fc; 2343 fc->func = fp; 2344 fc->rettv = rettv; 2345 fc->level = ex_nesting_level; 2346 // Check if this function has a breakpoint. 2347 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0); 2348 fc->dbg_tick = debug_tick; 2349 // Set up fields for closure. 2350 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1); 2351 func_ptr_ref(fp); 2352 2353 if (fp->uf_def_status != UF_NOT_COMPILED) 2354 { 2355 #ifdef FEAT_PROFILE 2356 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func; 2357 #endif 2358 // Execute the function, possibly compiling it first. 2359 #ifdef FEAT_PROFILE 2360 if (do_profiling == PROF_YES) 2361 profile_may_start_func(&profile_info, fp, caller); 2362 #endif 2363 call_def_function(fp, argcount, argvars, funcexe->partial, rettv); 2364 funcdepth_decrement(); 2365 #ifdef FEAT_PROFILE 2366 if (do_profiling == PROF_YES && (fp->uf_profiling 2367 || (caller != NULL && caller->uf_profiling))) 2368 profile_may_end_func(&profile_info, fp, caller); 2369 #endif 2370 current_funccal = fc->caller; 2371 free_funccal(fc); 2372 return; 2373 } 2374 2375 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 2376 islambda = TRUE; 2377 2378 /* 2379 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables 2380 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free 2381 * each argument variable and saves a lot of time. 2382 */ 2383 /* 2384 * Init l: variables. 2385 */ 2386 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE); 2387 if (selfdict != NULL) 2388 { 2389 // Set l:self to "selfdict". Use "name" to avoid a warning from 2390 // some compiler that checks the destination size. 2391 v = &fc->fixvar[fixvar_idx++].var; 2392 name = v->di_key; 2393 STRCPY(name, "self"); 2394 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 2395 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 2396 v->di_tv.v_type = VAR_DICT; 2397 v->di_tv.v_lock = 0; 2398 v->di_tv.vval.v_dict = selfdict; 2399 ++selfdict->dv_refcount; 2400 } 2401 2402 /* 2403 * Init a: variables, unless none found (in lambda). 2404 * Set a:0 to "argcount" less number of named arguments, if >= 0. 2405 * Set a:000 to a list with room for the "..." arguments. 2406 */ 2407 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE); 2408 if ((fp->uf_flags & FC_NOARGS) == 0) 2409 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0", 2410 (varnumber_T)(argcount >= fp->uf_args.ga_len 2411 ? argcount - fp->uf_args.ga_len : 0)); 2412 fc->l_avars.dv_lock = VAR_FIXED; 2413 if ((fp->uf_flags & FC_NOARGS) == 0) 2414 { 2415 // Use "name" to avoid a warning from some compiler that checks the 2416 // destination size. 2417 v = &fc->fixvar[fixvar_idx++].var; 2418 name = v->di_key; 2419 STRCPY(name, "000"); 2420 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 2421 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 2422 v->di_tv.v_type = VAR_LIST; 2423 v->di_tv.v_lock = VAR_FIXED; 2424 v->di_tv.vval.v_list = &fc->l_varlist; 2425 } 2426 CLEAR_FIELD(fc->l_varlist); 2427 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT; 2428 fc->l_varlist.lv_lock = VAR_FIXED; 2429 2430 /* 2431 * Set a:firstline to "firstline" and a:lastline to "lastline". 2432 * Set a:name to named arguments. 2433 * Set a:N to the "..." arguments. 2434 * Skipped when no a: variables used (in lambda). 2435 */ 2436 if ((fp->uf_flags & FC_NOARGS) == 0) 2437 { 2438 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline", 2439 (varnumber_T)funcexe->firstline); 2440 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline", 2441 (varnumber_T)funcexe->lastline); 2442 } 2443 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i) 2444 { 2445 int addlocal = FALSE; 2446 typval_T def_rettv; 2447 int isdefault = FALSE; 2448 2449 ai = i - fp->uf_args.ga_len; 2450 if (ai < 0) 2451 { 2452 // named argument a:name 2453 name = FUNCARG(fp, i); 2454 if (islambda) 2455 addlocal = TRUE; 2456 2457 // evaluate named argument default expression 2458 isdefault = ai + fp->uf_def_args.ga_len >= 0 2459 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL 2460 && argvars[i].vval.v_number == VVAL_NONE)); 2461 if (isdefault) 2462 { 2463 char_u *default_expr = NULL; 2464 2465 def_rettv.v_type = VAR_NUMBER; 2466 def_rettv.vval.v_number = -1; 2467 2468 default_expr = ((char_u **)(fp->uf_def_args.ga_data)) 2469 [ai + fp->uf_def_args.ga_len]; 2470 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL) 2471 { 2472 default_arg_err = 1; 2473 break; 2474 } 2475 } 2476 } 2477 else 2478 { 2479 if ((fp->uf_flags & FC_NOARGS) != 0) 2480 // Bail out if no a: arguments used (in lambda). 2481 break; 2482 2483 // "..." argument a:1, a:2, etc. 2484 sprintf((char *)numbuf, "%d", ai + 1); 2485 name = numbuf; 2486 } 2487 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN) 2488 { 2489 v = &fc->fixvar[fixvar_idx++].var; 2490 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 2491 STRCPY(v->di_key, name); 2492 } 2493 else 2494 { 2495 v = dictitem_alloc(name); 2496 if (v == NULL) 2497 break; 2498 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX; 2499 } 2500 2501 // Note: the values are copied directly to avoid alloc/free. 2502 // "argvars" must have VAR_FIXED for v_lock. 2503 v->di_tv = isdefault ? def_rettv : argvars[i]; 2504 v->di_tv.v_lock = VAR_FIXED; 2505 2506 if (isdefault) 2507 // Need to free this later, no matter where it's stored. 2508 tv_to_free[tv_to_free_len++] = &v->di_tv; 2509 2510 if (addlocal) 2511 { 2512 // Named arguments should be accessed without the "a:" prefix in 2513 // lambda expressions. Add to the l: dict. 2514 copy_tv(&v->di_tv, &v->di_tv); 2515 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 2516 } 2517 else 2518 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 2519 2520 if (ai >= 0 && ai < MAX_FUNC_ARGS) 2521 { 2522 listitem_T *li = &fc->l_listitems[ai]; 2523 2524 li->li_tv = argvars[i]; 2525 li->li_tv.v_lock = VAR_FIXED; 2526 list_append(&fc->l_varlist, li); 2527 } 2528 } 2529 2530 // Don't redraw while executing the function. 2531 ++RedrawingDisabled; 2532 2533 if (fp->uf_flags & FC_SANDBOX) 2534 { 2535 using_sandbox = TRUE; 2536 ++sandbox; 2537 } 2538 2539 estack_push_ufunc(fp, 1); 2540 ESTACK_CHECK_SETUP 2541 if (p_verbose >= 12) 2542 { 2543 ++no_wait_return; 2544 verbose_enter_scroll(); 2545 2546 smsg(_("calling %s"), SOURCING_NAME); 2547 if (p_verbose >= 14) 2548 { 2549 char_u buf[MSG_BUF_LEN]; 2550 char_u numbuf2[NUMBUFLEN]; 2551 char_u *tofree; 2552 char_u *s; 2553 2554 msg_puts("("); 2555 for (i = 0; i < argcount; ++i) 2556 { 2557 if (i > 0) 2558 msg_puts(", "); 2559 if (argvars[i].v_type == VAR_NUMBER) 2560 msg_outnum((long)argvars[i].vval.v_number); 2561 else 2562 { 2563 // Do not want errors such as E724 here. 2564 ++emsg_off; 2565 s = tv2string(&argvars[i], &tofree, numbuf2, 0); 2566 --emsg_off; 2567 if (s != NULL) 2568 { 2569 if (vim_strsize(s) > MSG_BUF_CLEN) 2570 { 2571 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 2572 s = buf; 2573 } 2574 msg_puts((char *)s); 2575 vim_free(tofree); 2576 } 2577 } 2578 } 2579 msg_puts(")"); 2580 } 2581 msg_puts("\n"); // don't overwrite this either 2582 2583 verbose_leave_scroll(); 2584 --no_wait_return; 2585 } 2586 #ifdef FEAT_PROFILE 2587 if (do_profiling == PROF_YES) 2588 profile_may_start_func(&profile_info, fp, 2589 fc->caller == NULL ? NULL : fc->caller->func); 2590 #endif 2591 2592 save_current_sctx = current_sctx; 2593 current_sctx = fp->uf_script_ctx; 2594 save_did_emsg = did_emsg; 2595 did_emsg = FALSE; 2596 2597 if (default_arg_err && (fp->uf_flags & FC_ABORT)) 2598 did_emsg = TRUE; 2599 else if (islambda) 2600 { 2601 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7; 2602 2603 // A Lambda always has the command "return {expr}". It is much faster 2604 // to evaluate {expr} directly. 2605 ++ex_nesting_level; 2606 (void)eval1(&p, rettv, &EVALARG_EVALUATE); 2607 --ex_nesting_level; 2608 } 2609 else 2610 // call do_cmdline() to execute the lines 2611 do_cmdline(NULL, get_func_line, (void *)fc, 2612 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT); 2613 2614 --RedrawingDisabled; 2615 2616 // when the function was aborted because of an error, return -1 2617 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN) 2618 { 2619 clear_tv(rettv); 2620 rettv->v_type = VAR_NUMBER; 2621 rettv->vval.v_number = -1; 2622 } 2623 2624 #ifdef FEAT_PROFILE 2625 if (do_profiling == PROF_YES) 2626 { 2627 ufunc_T *caller = fc->caller == NULL ? NULL : fc->caller->func; 2628 2629 if (fp->uf_profiling || (caller != NULL && caller->uf_profiling)) 2630 profile_may_end_func(&profile_info, fp, caller); 2631 } 2632 #endif 2633 2634 // when being verbose, mention the return value 2635 if (p_verbose >= 12) 2636 { 2637 ++no_wait_return; 2638 verbose_enter_scroll(); 2639 2640 if (aborting()) 2641 smsg(_("%s aborted"), SOURCING_NAME); 2642 else if (fc->rettv->v_type == VAR_NUMBER) 2643 smsg(_("%s returning #%ld"), SOURCING_NAME, 2644 (long)fc->rettv->vval.v_number); 2645 else 2646 { 2647 char_u buf[MSG_BUF_LEN]; 2648 char_u numbuf2[NUMBUFLEN]; 2649 char_u *tofree; 2650 char_u *s; 2651 2652 // The value may be very long. Skip the middle part, so that we 2653 // have some idea how it starts and ends. smsg() would always 2654 // truncate it at the end. Don't want errors such as E724 here. 2655 ++emsg_off; 2656 s = tv2string(fc->rettv, &tofree, numbuf2, 0); 2657 --emsg_off; 2658 if (s != NULL) 2659 { 2660 if (vim_strsize(s) > MSG_BUF_CLEN) 2661 { 2662 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 2663 s = buf; 2664 } 2665 smsg(_("%s returning %s"), SOURCING_NAME, s); 2666 vim_free(tofree); 2667 } 2668 } 2669 msg_puts("\n"); // don't overwrite this either 2670 2671 verbose_leave_scroll(); 2672 --no_wait_return; 2673 } 2674 2675 ESTACK_CHECK_NOW 2676 estack_pop(); 2677 current_sctx = save_current_sctx; 2678 #ifdef FEAT_PROFILE 2679 if (do_profiling == PROF_YES) 2680 script_prof_restore(&profile_info.pi_wait_start); 2681 #endif 2682 if (using_sandbox) 2683 --sandbox; 2684 2685 if (p_verbose >= 12 && SOURCING_NAME != NULL) 2686 { 2687 ++no_wait_return; 2688 verbose_enter_scroll(); 2689 2690 smsg(_("continuing in %s"), SOURCING_NAME); 2691 msg_puts("\n"); // don't overwrite this either 2692 2693 verbose_leave_scroll(); 2694 --no_wait_return; 2695 } 2696 2697 did_emsg |= save_did_emsg; 2698 funcdepth_decrement(); 2699 for (i = 0; i < tv_to_free_len; ++i) 2700 clear_tv(tv_to_free[i]); 2701 cleanup_function_call(fc); 2702 } 2703 2704 /* 2705 * Check the argument count for user function "fp". 2706 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise. 2707 */ 2708 int 2709 check_user_func_argcount(ufunc_T *fp, int argcount) 2710 { 2711 int regular_args = fp->uf_args.ga_len; 2712 2713 if (argcount < regular_args - fp->uf_def_args.ga_len) 2714 return FCERR_TOOFEW; 2715 else if (!has_varargs(fp) && argcount > regular_args) 2716 return FCERR_TOOMANY; 2717 return FCERR_UNKNOWN; 2718 } 2719 2720 /* 2721 * Call a user function after checking the arguments. 2722 */ 2723 int 2724 call_user_func_check( 2725 ufunc_T *fp, 2726 int argcount, 2727 typval_T *argvars, 2728 typval_T *rettv, 2729 funcexe_T *funcexe, 2730 dict_T *selfdict) 2731 { 2732 int error; 2733 2734 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL) 2735 *funcexe->doesrange = TRUE; 2736 error = check_user_func_argcount(fp, argcount); 2737 if (error != FCERR_UNKNOWN) 2738 return error; 2739 if ((fp->uf_flags & FC_DICT) && selfdict == NULL) 2740 error = FCERR_DICT; 2741 else 2742 { 2743 int did_save_redo = FALSE; 2744 save_redo_T save_redo; 2745 2746 /* 2747 * Call the user function. 2748 * Save and restore search patterns, script variables and 2749 * redo buffer. 2750 */ 2751 save_search_patterns(); 2752 if (!ins_compl_active()) 2753 { 2754 saveRedobuff(&save_redo); 2755 did_save_redo = TRUE; 2756 } 2757 ++fp->uf_calls; 2758 call_user_func(fp, argcount, argvars, rettv, funcexe, 2759 (fp->uf_flags & FC_DICT) ? selfdict : NULL); 2760 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0) 2761 // Function was unreferenced while being used, free it now. 2762 func_clear_free(fp, FALSE); 2763 if (did_save_redo) 2764 restoreRedobuff(&save_redo); 2765 restore_search_patterns(); 2766 error = FCERR_NONE; 2767 } 2768 return error; 2769 } 2770 2771 static funccal_entry_T *funccal_stack = NULL; 2772 2773 /* 2774 * Save the current function call pointer, and set it to NULL. 2775 * Used when executing autocommands and for ":source". 2776 */ 2777 void 2778 save_funccal(funccal_entry_T *entry) 2779 { 2780 entry->top_funccal = current_funccal; 2781 entry->next = funccal_stack; 2782 funccal_stack = entry; 2783 current_funccal = NULL; 2784 } 2785 2786 void 2787 restore_funccal(void) 2788 { 2789 if (funccal_stack == NULL) 2790 iemsg("INTERNAL: restore_funccal()"); 2791 else 2792 { 2793 current_funccal = funccal_stack->top_funccal; 2794 funccal_stack = funccal_stack->next; 2795 } 2796 } 2797 2798 funccall_T * 2799 get_current_funccal(void) 2800 { 2801 return current_funccal; 2802 } 2803 2804 /* 2805 * Mark all functions of script "sid" as deleted. 2806 */ 2807 void 2808 delete_script_functions(int sid) 2809 { 2810 hashitem_T *hi; 2811 ufunc_T *fp; 2812 long_u todo = 1; 2813 char_u buf[30]; 2814 size_t len; 2815 2816 buf[0] = K_SPECIAL; 2817 buf[1] = KS_EXTRA; 2818 buf[2] = (int)KE_SNR; 2819 sprintf((char *)buf + 3, "%d_", sid); 2820 len = STRLEN(buf); 2821 2822 while (todo > 0) 2823 { 2824 todo = func_hashtab.ht_used; 2825 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2826 if (!HASHITEM_EMPTY(hi)) 2827 { 2828 fp = HI2UF(hi); 2829 if (STRNCMP(fp->uf_name, buf, len) == 0) 2830 { 2831 int changed = func_hashtab.ht_changed; 2832 2833 fp->uf_flags |= FC_DEAD; 2834 2835 if (fp->uf_calls > 0) 2836 { 2837 // Function is executing, don't free it but do remove 2838 // it from the hashtable. 2839 if (func_remove(fp)) 2840 fp->uf_refcount--; 2841 } 2842 else 2843 { 2844 func_clear(fp, TRUE); 2845 // When clearing a function another function can be 2846 // cleared as a side effect. When that happens start 2847 // over. 2848 if (changed != func_hashtab.ht_changed) 2849 break; 2850 } 2851 } 2852 --todo; 2853 } 2854 } 2855 } 2856 2857 #if defined(EXITFREE) || defined(PROTO) 2858 void 2859 free_all_functions(void) 2860 { 2861 hashitem_T *hi; 2862 ufunc_T *fp; 2863 long_u skipped = 0; 2864 long_u todo = 1; 2865 int changed; 2866 2867 // Clean up the current_funccal chain and the funccal stack. 2868 while (current_funccal != NULL) 2869 { 2870 clear_tv(current_funccal->rettv); 2871 cleanup_function_call(current_funccal); 2872 if (current_funccal == NULL && funccal_stack != NULL) 2873 restore_funccal(); 2874 } 2875 2876 // First clear what the functions contain. Since this may lower the 2877 // reference count of a function, it may also free a function and change 2878 // the hash table. Restart if that happens. 2879 while (todo > 0) 2880 { 2881 todo = func_hashtab.ht_used; 2882 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2883 if (!HASHITEM_EMPTY(hi)) 2884 { 2885 // clear the def function index now 2886 fp = HI2UF(hi); 2887 fp->uf_flags &= ~FC_DEAD; 2888 fp->uf_def_status = UF_NOT_COMPILED; 2889 2890 // Only free functions that are not refcounted, those are 2891 // supposed to be freed when no longer referenced. 2892 if (func_name_refcount(fp->uf_name)) 2893 ++skipped; 2894 else 2895 { 2896 changed = func_hashtab.ht_changed; 2897 func_clear(fp, TRUE); 2898 if (changed != func_hashtab.ht_changed) 2899 { 2900 skipped = 0; 2901 break; 2902 } 2903 } 2904 --todo; 2905 } 2906 } 2907 2908 // Now actually free the functions. Need to start all over every time, 2909 // because func_free() may change the hash table. 2910 skipped = 0; 2911 while (func_hashtab.ht_used > skipped) 2912 { 2913 todo = func_hashtab.ht_used; 2914 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2915 if (!HASHITEM_EMPTY(hi)) 2916 { 2917 --todo; 2918 // Only free functions that are not refcounted, those are 2919 // supposed to be freed when no longer referenced. 2920 fp = HI2UF(hi); 2921 if (func_name_refcount(fp->uf_name)) 2922 ++skipped; 2923 else 2924 { 2925 if (func_free(fp, FALSE) == OK) 2926 { 2927 skipped = 0; 2928 break; 2929 } 2930 // did not actually free it 2931 ++skipped; 2932 } 2933 } 2934 } 2935 if (skipped == 0) 2936 hash_clear(&func_hashtab); 2937 2938 free_def_functions(); 2939 } 2940 #endif 2941 2942 /* 2943 * Return TRUE if "name" looks like a builtin function name: starts with a 2944 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'. 2945 * "len" is the length of "name", or -1 for NUL terminated. 2946 */ 2947 int 2948 builtin_function(char_u *name, int len) 2949 { 2950 char_u *p; 2951 2952 if (!ASCII_ISLOWER(name[0]) || name[1] == ':') 2953 return FALSE; 2954 p = vim_strchr(name, AUTOLOAD_CHAR); 2955 return p == NULL || (len > 0 && p > name + len); 2956 } 2957 2958 int 2959 func_call( 2960 char_u *name, 2961 typval_T *args, 2962 partial_T *partial, 2963 dict_T *selfdict, 2964 typval_T *rettv) 2965 { 2966 list_T *l = args->vval.v_list; 2967 listitem_T *item; 2968 typval_T argv[MAX_FUNC_ARGS + 1]; 2969 int argc = 0; 2970 int r = 0; 2971 2972 CHECK_LIST_MATERIALIZE(l); 2973 FOR_ALL_LIST_ITEMS(l, item) 2974 { 2975 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc)) 2976 { 2977 emsg(_("E699: Too many arguments")); 2978 break; 2979 } 2980 // Make a copy of each argument. This is needed to be able to set 2981 // v_lock to VAR_FIXED in the copy without changing the original list. 2982 copy_tv(&item->li_tv, &argv[argc++]); 2983 } 2984 2985 if (item == NULL) 2986 { 2987 funcexe_T funcexe; 2988 2989 CLEAR_FIELD(funcexe); 2990 funcexe.firstline = curwin->w_cursor.lnum; 2991 funcexe.lastline = curwin->w_cursor.lnum; 2992 funcexe.evaluate = TRUE; 2993 funcexe.partial = partial; 2994 funcexe.selfdict = selfdict; 2995 r = call_func(name, -1, rettv, argc, argv, &funcexe); 2996 } 2997 2998 // Free the arguments. 2999 while (argc > 0) 3000 clear_tv(&argv[--argc]); 3001 3002 return r; 3003 } 3004 3005 static int callback_depth = 0; 3006 3007 int 3008 get_callback_depth(void) 3009 { 3010 return callback_depth; 3011 } 3012 3013 /* 3014 * Invoke call_func() with a callback. 3015 */ 3016 int 3017 call_callback( 3018 callback_T *callback, 3019 int len, // length of "name" or -1 to use strlen() 3020 typval_T *rettv, // return value goes here 3021 int argcount, // number of "argvars" 3022 typval_T *argvars) // vars for arguments, must have "argcount" 3023 // PLUS ONE elements! 3024 { 3025 funcexe_T funcexe; 3026 int ret; 3027 3028 CLEAR_FIELD(funcexe); 3029 funcexe.evaluate = TRUE; 3030 funcexe.partial = callback->cb_partial; 3031 ++callback_depth; 3032 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe); 3033 --callback_depth; 3034 return ret; 3035 } 3036 3037 /* 3038 * Give an error message for the result of a function. 3039 * Nothing if "error" is FCERR_NONE. 3040 */ 3041 void 3042 user_func_error(int error, char_u *name) 3043 { 3044 switch (error) 3045 { 3046 case FCERR_UNKNOWN: 3047 emsg_funcname(e_unknownfunc, name); 3048 break; 3049 case FCERR_NOTMETHOD: 3050 emsg_funcname( 3051 N_("E276: Cannot use function as a method: %s"), name); 3052 break; 3053 case FCERR_DELETED: 3054 emsg_funcname(N_(e_func_deleted), name); 3055 break; 3056 case FCERR_TOOMANY: 3057 emsg_funcname((char *)e_toomanyarg, name); 3058 break; 3059 case FCERR_TOOFEW: 3060 emsg_funcname((char *)e_toofewarg, name); 3061 break; 3062 case FCERR_SCRIPT: 3063 emsg_funcname( 3064 N_("E120: Using <SID> not in a script context: %s"), name); 3065 break; 3066 case FCERR_DICT: 3067 emsg_funcname( 3068 N_("E725: Calling dict function without Dictionary: %s"), 3069 name); 3070 break; 3071 } 3072 } 3073 3074 /* 3075 * Call a function with its resolved parameters 3076 * 3077 * Return FAIL when the function can't be called, OK otherwise. 3078 * Also returns OK when an error was encountered while executing the function. 3079 */ 3080 int 3081 call_func( 3082 char_u *funcname, // name of the function 3083 int len, // length of "name" or -1 to use strlen() 3084 typval_T *rettv, // return value goes here 3085 int argcount_in, // number of "argvars" 3086 typval_T *argvars_in, // vars for arguments, must have "argcount" 3087 // PLUS ONE elements! 3088 funcexe_T *funcexe) // more arguments 3089 { 3090 int ret = FAIL; 3091 int error = FCERR_NONE; 3092 int i; 3093 ufunc_T *fp = NULL; 3094 char_u fname_buf[FLEN_FIXED + 1]; 3095 char_u *tofree = NULL; 3096 char_u *fname = NULL; 3097 char_u *name = NULL; 3098 int argcount = argcount_in; 3099 typval_T *argvars = argvars_in; 3100 dict_T *selfdict = funcexe->selfdict; 3101 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or 3102 // "funcexe->basetv" is not NULL 3103 int argv_clear = 0; 3104 int argv_base = 0; 3105 partial_T *partial = funcexe->partial; 3106 type_T check_type; 3107 3108 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv) 3109 // even when call_func() returns FAIL. 3110 rettv->v_type = VAR_UNKNOWN; 3111 3112 if (partial != NULL) 3113 fp = partial->pt_func; 3114 if (fp == NULL) 3115 { 3116 // Make a copy of the name, if it comes from a funcref variable it 3117 // could be changed or deleted in the called function. 3118 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname); 3119 if (name == NULL) 3120 return ret; 3121 3122 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 3123 } 3124 3125 if (funcexe->doesrange != NULL) 3126 *funcexe->doesrange = FALSE; 3127 3128 if (partial != NULL) 3129 { 3130 // When the function has a partial with a dict and there is a dict 3131 // argument, use the dict argument. That is backwards compatible. 3132 // When the dict was bound explicitly use the one from the partial. 3133 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto)) 3134 selfdict = partial->pt_dict; 3135 if (error == FCERR_NONE && partial->pt_argc > 0) 3136 { 3137 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear) 3138 { 3139 if (argv_clear + argcount_in >= MAX_FUNC_ARGS) 3140 { 3141 error = FCERR_TOOMANY; 3142 goto theend; 3143 } 3144 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]); 3145 } 3146 for (i = 0; i < argcount_in; ++i) 3147 argv[i + argv_clear] = argvars_in[i]; 3148 argvars = argv; 3149 argcount = partial->pt_argc + argcount_in; 3150 3151 if (funcexe->check_type != NULL 3152 && funcexe->check_type->tt_argcount != -1) 3153 { 3154 // Now funcexe->check_type is missing the added arguments, make 3155 // a copy of the type with the correction. 3156 check_type = *funcexe->check_type; 3157 funcexe->check_type = &check_type; 3158 check_type.tt_argcount += partial->pt_argc; 3159 check_type.tt_min_argcount += partial->pt_argc; 3160 } 3161 } 3162 } 3163 3164 if (error == FCERR_NONE && funcexe->check_type != NULL && funcexe->evaluate) 3165 { 3166 // Check that the argument types are OK for the types of the funcref. 3167 if (check_argument_types(funcexe->check_type, argvars, argcount, 3168 (name != NULL) ? name : funcname) == FAIL) 3169 error = FCERR_OTHER; 3170 } 3171 3172 if (error == FCERR_NONE && funcexe->evaluate) 3173 { 3174 char_u *rfname = fname; 3175 int is_global = FALSE; 3176 3177 // Skip "g:" before a function name. 3178 if (fp == NULL && fname[0] == 'g' && fname[1] == ':') 3179 { 3180 is_global = TRUE; 3181 rfname = fname + 2; 3182 } 3183 3184 rettv->v_type = VAR_NUMBER; // default rettv is number zero 3185 rettv->vval.v_number = 0; 3186 error = FCERR_UNKNOWN; 3187 3188 if (fp != NULL || !builtin_function(rfname, -1)) 3189 { 3190 /* 3191 * User defined function. 3192 */ 3193 if (fp == NULL) 3194 fp = find_func(rfname, is_global, NULL); 3195 3196 // Trigger FuncUndefined event, may load the function. 3197 if (fp == NULL 3198 && apply_autocmds(EVENT_FUNCUNDEFINED, 3199 rfname, rfname, TRUE, NULL) 3200 && !aborting()) 3201 { 3202 // executed an autocommand, search for the function again 3203 fp = find_func(rfname, is_global, NULL); 3204 } 3205 // Try loading a package. 3206 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting()) 3207 { 3208 // loaded a package, search for the function again 3209 fp = find_func(rfname, is_global, NULL); 3210 } 3211 if (fp == NULL) 3212 { 3213 char_u *p = untrans_function_name(rfname); 3214 3215 // If using Vim9 script try not local to the script. 3216 // Don't do this if the name starts with "s:". 3217 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':')) 3218 fp = find_func(p, is_global, NULL); 3219 } 3220 3221 if (fp != NULL && (fp->uf_flags & FC_DELETED)) 3222 error = FCERR_DELETED; 3223 #ifdef FEAT_LUA 3224 else if (fp != NULL && (fp->uf_flags & FC_CFUNC)) 3225 { 3226 cfunc_T cb = fp->uf_cb; 3227 3228 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state); 3229 } 3230 #endif 3231 else if (fp != NULL) 3232 { 3233 if (funcexe->argv_func != NULL) 3234 // postponed filling in the arguments, do it now 3235 argcount = funcexe->argv_func(argcount, argvars, argv_clear, 3236 fp->uf_args.ga_len); 3237 3238 if (funcexe->basetv != NULL) 3239 { 3240 // Method call: base->Method() 3241 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount); 3242 argv[0] = *funcexe->basetv; 3243 argcount++; 3244 argvars = argv; 3245 argv_base = 1; 3246 } 3247 3248 error = call_user_func_check(fp, argcount, argvars, rettv, 3249 funcexe, selfdict); 3250 } 3251 } 3252 else if (funcexe->basetv != NULL) 3253 { 3254 /* 3255 * expr->method(): Find the method name in the table, call its 3256 * implementation with the base as one of the arguments. 3257 */ 3258 error = call_internal_method(fname, argcount, argvars, rettv, 3259 funcexe->basetv); 3260 } 3261 else 3262 { 3263 /* 3264 * Find the function name in the table, call its implementation. 3265 */ 3266 error = call_internal_func(fname, argcount, argvars, rettv); 3267 } 3268 3269 /* 3270 * The function call (or "FuncUndefined" autocommand sequence) might 3271 * have been aborted by an error, an interrupt, or an explicitly thrown 3272 * exception that has not been caught so far. This situation can be 3273 * tested for by calling aborting(). For an error in an internal 3274 * function or for the "E132" error in call_user_func(), however, the 3275 * throw point at which the "force_abort" flag (temporarily reset by 3276 * emsg()) is normally updated has not been reached yet. We need to 3277 * update that flag first to make aborting() reliable. 3278 */ 3279 update_force_abort(); 3280 } 3281 if (error == FCERR_NONE) 3282 ret = OK; 3283 3284 theend: 3285 /* 3286 * Report an error unless the argument evaluation or function call has been 3287 * cancelled due to an aborting error, an interrupt, or an exception. 3288 */ 3289 if (!aborting()) 3290 { 3291 user_func_error(error, (name != NULL) ? name : funcname); 3292 } 3293 3294 // clear the copies made from the partial 3295 while (argv_clear > 0) 3296 clear_tv(&argv[--argv_clear + argv_base]); 3297 3298 vim_free(tofree); 3299 vim_free(name); 3300 3301 return ret; 3302 } 3303 3304 char_u * 3305 printable_func_name(ufunc_T *fp) 3306 { 3307 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name; 3308 } 3309 3310 /* 3311 * List the head of the function: "function name(arg1, arg2)". 3312 */ 3313 static void 3314 list_func_head(ufunc_T *fp, int indent) 3315 { 3316 int j; 3317 3318 msg_start(); 3319 if (indent) 3320 msg_puts(" "); 3321 if (fp->uf_def_status != UF_NOT_COMPILED) 3322 msg_puts("def "); 3323 else 3324 msg_puts("function "); 3325 msg_puts((char *)printable_func_name(fp)); 3326 msg_putchar('('); 3327 for (j = 0; j < fp->uf_args.ga_len; ++j) 3328 { 3329 if (j) 3330 msg_puts(", "); 3331 msg_puts((char *)FUNCARG(fp, j)); 3332 if (fp->uf_arg_types != NULL) 3333 { 3334 char *tofree; 3335 3336 msg_puts(": "); 3337 msg_puts(type_name(fp->uf_arg_types[j], &tofree)); 3338 vim_free(tofree); 3339 } 3340 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len) 3341 { 3342 msg_puts(" = "); 3343 msg_puts(((char **)(fp->uf_def_args.ga_data)) 3344 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]); 3345 } 3346 } 3347 if (fp->uf_varargs) 3348 { 3349 if (j) 3350 msg_puts(", "); 3351 msg_puts("..."); 3352 } 3353 if (fp->uf_va_name != NULL) 3354 { 3355 if (j) 3356 msg_puts(", "); 3357 msg_puts("..."); 3358 msg_puts((char *)fp->uf_va_name); 3359 if (fp->uf_va_type != NULL) 3360 { 3361 char *tofree; 3362 3363 msg_puts(": "); 3364 msg_puts(type_name(fp->uf_va_type, &tofree)); 3365 vim_free(tofree); 3366 } 3367 } 3368 msg_putchar(')'); 3369 3370 if (fp->uf_def_status != UF_NOT_COMPILED) 3371 { 3372 if (fp->uf_ret_type != &t_void) 3373 { 3374 char *tofree; 3375 3376 msg_puts(": "); 3377 msg_puts(type_name(fp->uf_ret_type, &tofree)); 3378 vim_free(tofree); 3379 } 3380 } 3381 else if (fp->uf_flags & FC_ABORT) 3382 msg_puts(" abort"); 3383 if (fp->uf_flags & FC_RANGE) 3384 msg_puts(" range"); 3385 if (fp->uf_flags & FC_DICT) 3386 msg_puts(" dict"); 3387 if (fp->uf_flags & FC_CLOSURE) 3388 msg_puts(" closure"); 3389 msg_clr_eos(); 3390 if (p_verbose > 0) 3391 last_set_msg(fp->uf_script_ctx); 3392 } 3393 3394 /* 3395 * Get a function name, translating "<SID>" and "<SNR>". 3396 * Also handles a Funcref in a List or Dictionary. 3397 * Returns the function name in allocated memory, or NULL for failure. 3398 * Set "*is_global" to TRUE when the function must be global, unless 3399 * "is_global" is NULL. 3400 * flags: 3401 * TFN_INT: internal function name OK 3402 * TFN_QUIET: be quiet 3403 * TFN_NO_AUTOLOAD: do not use script autoloading 3404 * TFN_NO_DEREF: do not dereference a Funcref 3405 * Advances "pp" to just after the function name (if no error). 3406 */ 3407 char_u * 3408 trans_function_name( 3409 char_u **pp, 3410 int *is_global, 3411 int skip, // only find the end, don't evaluate 3412 int flags, 3413 funcdict_T *fdp, // return: info about dictionary used 3414 partial_T **partial, // return: partial of a FuncRef 3415 type_T **type) // return: type of funcref if not NULL 3416 { 3417 char_u *name = NULL; 3418 char_u *start; 3419 char_u *end; 3420 int lead; 3421 char_u sid_buf[20]; 3422 int len; 3423 int extra = 0; 3424 lval_T lv; 3425 int vim9script; 3426 static char *e_function_name = N_("E129: Function name required"); 3427 3428 if (fdp != NULL) 3429 CLEAR_POINTER(fdp); 3430 start = *pp; 3431 3432 // Check for hard coded <SNR>: already translated function ID (from a user 3433 // command). 3434 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA 3435 && (*pp)[2] == (int)KE_SNR) 3436 { 3437 *pp += 3; 3438 len = get_id_len(pp) + 3; 3439 return vim_strnsave(start, len); 3440 } 3441 3442 // A name starting with "<SID>" or "<SNR>" is local to a script. But 3443 // don't skip over "s:", get_lval() needs it for "s:dict.func". 3444 lead = eval_fname_script(start); 3445 if (lead > 2) 3446 start += lead; 3447 3448 // Note that TFN_ flags use the same values as GLV_ flags. 3449 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY, 3450 lead > 2 ? 0 : FNE_CHECK_START); 3451 if (end == start) 3452 { 3453 if (!skip) 3454 emsg(_(e_function_name)); 3455 goto theend; 3456 } 3457 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range))) 3458 { 3459 /* 3460 * Report an invalid expression in braces, unless the expression 3461 * evaluation has been cancelled due to an aborting error, an 3462 * interrupt, or an exception. 3463 */ 3464 if (!aborting()) 3465 { 3466 if (end != NULL) 3467 semsg(_(e_invarg2), start); 3468 } 3469 else 3470 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR); 3471 goto theend; 3472 } 3473 3474 if (lv.ll_tv != NULL) 3475 { 3476 if (fdp != NULL) 3477 { 3478 fdp->fd_dict = lv.ll_dict; 3479 fdp->fd_newkey = lv.ll_newkey; 3480 lv.ll_newkey = NULL; 3481 fdp->fd_di = lv.ll_di; 3482 } 3483 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL) 3484 { 3485 name = vim_strsave(lv.ll_tv->vval.v_string); 3486 *pp = end; 3487 } 3488 else if (lv.ll_tv->v_type == VAR_PARTIAL 3489 && lv.ll_tv->vval.v_partial != NULL) 3490 { 3491 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial)); 3492 *pp = end; 3493 if (partial != NULL) 3494 *partial = lv.ll_tv->vval.v_partial; 3495 } 3496 else 3497 { 3498 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL 3499 || lv.ll_dict == NULL || fdp->fd_newkey == NULL)) 3500 emsg(_(e_funcref)); 3501 else 3502 *pp = end; 3503 name = NULL; 3504 } 3505 goto theend; 3506 } 3507 3508 if (lv.ll_name == NULL) 3509 { 3510 // Error found, but continue after the function name. 3511 *pp = end; 3512 goto theend; 3513 } 3514 3515 // Check if the name is a Funcref. If so, use the value. 3516 if (lv.ll_exp_name != NULL) 3517 { 3518 len = (int)STRLEN(lv.ll_exp_name); 3519 name = deref_func_name(lv.ll_exp_name, &len, partial, type, 3520 flags & TFN_NO_AUTOLOAD); 3521 if (name == lv.ll_exp_name) 3522 name = NULL; 3523 } 3524 else if (!(flags & TFN_NO_DEREF)) 3525 { 3526 len = (int)(end - *pp); 3527 name = deref_func_name(*pp, &len, partial, type, 3528 flags & TFN_NO_AUTOLOAD); 3529 if (name == *pp) 3530 name = NULL; 3531 } 3532 if (name != NULL) 3533 { 3534 name = vim_strsave(name); 3535 *pp = end; 3536 if (STRNCMP(name, "<SNR>", 5) == 0) 3537 { 3538 // Change "<SNR>" to the byte sequence. 3539 name[0] = K_SPECIAL; 3540 name[1] = KS_EXTRA; 3541 name[2] = (int)KE_SNR; 3542 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1); 3543 } 3544 goto theend; 3545 } 3546 3547 if (lv.ll_exp_name != NULL) 3548 { 3549 len = (int)STRLEN(lv.ll_exp_name); 3550 if (lead <= 2 && lv.ll_name == lv.ll_exp_name 3551 && STRNCMP(lv.ll_name, "s:", 2) == 0) 3552 { 3553 // When there was "s:" already or the name expanded to get a 3554 // leading "s:" then remove it. 3555 lv.ll_name += 2; 3556 len -= 2; 3557 lead = 2; 3558 } 3559 } 3560 else 3561 { 3562 // skip over "s:" and "g:" 3563 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':')) 3564 { 3565 if (is_global != NULL && lv.ll_name[0] == 'g') 3566 *is_global = TRUE; 3567 lv.ll_name += 2; 3568 } 3569 len = (int)(end - lv.ll_name); 3570 } 3571 if (len <= 0) 3572 { 3573 if (!skip) 3574 emsg(_(e_function_name)); 3575 goto theend; 3576 } 3577 3578 // In Vim9 script a user function is script-local by default, unless it 3579 // starts with a lower case character: dict.func(). 3580 vim9script = ASCII_ISUPPER(*start) && in_vim9script(); 3581 if (vim9script) 3582 { 3583 char_u *p; 3584 3585 // SomeScript#func() is a global function. 3586 for (p = start; *p != NUL && *p != '('; ++p) 3587 if (*p == AUTOLOAD_CHAR) 3588 vim9script = FALSE; 3589 } 3590 3591 /* 3592 * Copy the function name to allocated memory. 3593 * Accept <SID>name() inside a script, translate into <SNR>123_name(). 3594 * Accept <SNR>123_name() outside a script. 3595 */ 3596 if (skip) 3597 lead = 0; // do nothing 3598 else if (lead > 0 || vim9script) 3599 { 3600 if (!vim9script) 3601 lead = 3; 3602 if (vim9script || (lv.ll_exp_name != NULL 3603 && eval_fname_sid(lv.ll_exp_name)) 3604 || eval_fname_sid(*pp)) 3605 { 3606 // It's script-local, "s:" or "<SID>" 3607 if (current_sctx.sc_sid <= 0) 3608 { 3609 emsg(_(e_usingsid)); 3610 goto theend; 3611 } 3612 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid); 3613 if (vim9script) 3614 extra = 3 + (int)STRLEN(sid_buf); 3615 else 3616 lead += (int)STRLEN(sid_buf); 3617 } 3618 } 3619 else if (!(flags & TFN_INT) && (builtin_function(lv.ll_name, len) 3620 || (in_vim9script() && *lv.ll_name == '_'))) 3621 { 3622 semsg(_("E128: Function name must start with a capital or \"s:\": %s"), 3623 start); 3624 goto theend; 3625 } 3626 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF)) 3627 { 3628 char_u *cp = vim_strchr(lv.ll_name, ':'); 3629 3630 if (cp != NULL && cp < end) 3631 { 3632 semsg(_("E884: Function name cannot contain a colon: %s"), start); 3633 goto theend; 3634 } 3635 } 3636 3637 name = alloc(len + lead + extra + 1); 3638 if (name != NULL) 3639 { 3640 if (!skip && (lead > 0 || vim9script)) 3641 { 3642 name[0] = K_SPECIAL; 3643 name[1] = KS_EXTRA; 3644 name[2] = (int)KE_SNR; 3645 if (vim9script || lead > 3) // If it's "<SID>" 3646 STRCPY(name + 3, sid_buf); 3647 } 3648 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len); 3649 name[lead + extra + len] = NUL; 3650 } 3651 *pp = end; 3652 3653 theend: 3654 clear_lval(&lv); 3655 return name; 3656 } 3657 3658 /* 3659 * Assuming "name" is the result of trans_function_name() and it was prefixed 3660 * to use the script-local name, return the unmodified name (points into 3661 * "name"). Otherwise return NULL. 3662 * This can be used to first search for a script-local function and fall back 3663 * to the global function if not found. 3664 */ 3665 char_u * 3666 untrans_function_name(char_u *name) 3667 { 3668 char_u *p; 3669 3670 if (*name == K_SPECIAL && in_vim9script()) 3671 { 3672 p = vim_strchr(name, '_'); 3673 if (p != NULL) 3674 return p + 1; 3675 } 3676 return NULL; 3677 } 3678 3679 /* 3680 * List functions. When "regmatch" is NULL all of then. 3681 * Otherwise functions matching "regmatch". 3682 */ 3683 void 3684 list_functions(regmatch_T *regmatch) 3685 { 3686 int changed = func_hashtab.ht_changed; 3687 long_u todo = func_hashtab.ht_used; 3688 hashitem_T *hi; 3689 3690 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 3691 { 3692 if (!HASHITEM_EMPTY(hi)) 3693 { 3694 ufunc_T *fp = HI2UF(hi); 3695 3696 --todo; 3697 if ((fp->uf_flags & FC_DEAD) == 0 3698 && (regmatch == NULL 3699 ? !message_filtered(fp->uf_name) 3700 && !func_name_refcount(fp->uf_name) 3701 : !isdigit(*fp->uf_name) 3702 && vim_regexec(regmatch, fp->uf_name, 0))) 3703 { 3704 list_func_head(fp, FALSE); 3705 if (changed != func_hashtab.ht_changed) 3706 { 3707 emsg(_("E454: function list was modified")); 3708 return; 3709 } 3710 } 3711 } 3712 } 3713 } 3714 3715 /* 3716 * ":function" also supporting nested ":def". 3717 * When "name_arg" is not NULL this is a nested function, using "name_arg" for 3718 * the function name. 3719 * Returns a pointer to the function or NULL if no function defined. 3720 */ 3721 ufunc_T * 3722 define_function(exarg_T *eap, char_u *name_arg) 3723 { 3724 char_u *line_to_free = NULL; 3725 int j; 3726 int c; 3727 int saved_did_emsg; 3728 char_u *name = name_arg; 3729 int is_global = FALSE; 3730 char_u *p; 3731 char_u *arg; 3732 char_u *whitep; 3733 char_u *line_arg = NULL; 3734 garray_T newargs; 3735 garray_T argtypes; 3736 garray_T default_args; 3737 garray_T newlines; 3738 int varargs = FALSE; 3739 int flags = 0; 3740 char_u *ret_type = NULL; 3741 ufunc_T *fp = NULL; 3742 int overwrite = FALSE; 3743 dictitem_T *v; 3744 funcdict_T fudi; 3745 static int func_nr = 0; // number for nameless function 3746 int paren; 3747 hashitem_T *hi; 3748 linenr_T sourcing_lnum_top; 3749 int vim9script = in_vim9script(); 3750 imported_T *import = NULL; 3751 3752 /* 3753 * ":function" without argument: list functions. 3754 */ 3755 if (ends_excmd2(eap->cmd, eap->arg)) 3756 { 3757 if (!eap->skip) 3758 list_functions(NULL); 3759 eap->nextcmd = check_nextcmd(eap->arg); 3760 return NULL; 3761 } 3762 3763 /* 3764 * ":function /pat": list functions matching pattern. 3765 */ 3766 if (*eap->arg == '/') 3767 { 3768 p = skip_regexp(eap->arg + 1, '/', TRUE); 3769 if (!eap->skip) 3770 { 3771 regmatch_T regmatch; 3772 3773 c = *p; 3774 *p = NUL; 3775 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC); 3776 *p = c; 3777 if (regmatch.regprog != NULL) 3778 { 3779 regmatch.rm_ic = p_ic; 3780 list_functions(®match); 3781 vim_regfree(regmatch.regprog); 3782 } 3783 } 3784 if (*p == '/') 3785 ++p; 3786 eap->nextcmd = check_nextcmd(p); 3787 return NULL; 3788 } 3789 3790 ga_init(&newargs); 3791 ga_init(&argtypes); 3792 ga_init(&default_args); 3793 3794 /* 3795 * Get the function name. There are these situations: 3796 * func normal function name 3797 * "name" == func, "fudi.fd_dict" == NULL 3798 * dict.func new dictionary entry 3799 * "name" == NULL, "fudi.fd_dict" set, 3800 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func 3801 * dict.func existing dict entry with a Funcref 3802 * "name" == func, "fudi.fd_dict" set, 3803 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 3804 * dict.func existing dict entry that's not a Funcref 3805 * "name" == NULL, "fudi.fd_dict" set, 3806 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 3807 * s:func script-local function name 3808 * g:func global function name, same as "func" 3809 */ 3810 p = eap->arg; 3811 if (name_arg != NULL) 3812 { 3813 // nested function, argument is (args). 3814 paren = TRUE; 3815 CLEAR_FIELD(fudi); 3816 } 3817 else 3818 { 3819 if (STRNCMP(p, "<lambda>", 8) == 0) 3820 { 3821 p += 8; 3822 (void)getdigits(&p); 3823 name = vim_strnsave(eap->arg, p - eap->arg); 3824 CLEAR_FIELD(fudi); 3825 } 3826 else 3827 name = trans_function_name(&p, &is_global, eap->skip, 3828 TFN_NO_AUTOLOAD, &fudi, NULL, NULL); 3829 paren = (vim_strchr(p, '(') != NULL); 3830 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip) 3831 { 3832 /* 3833 * Return on an invalid expression in braces, unless the expression 3834 * evaluation has been cancelled due to an aborting error, an 3835 * interrupt, or an exception. 3836 */ 3837 if (!aborting()) 3838 { 3839 if (!eap->skip && fudi.fd_newkey != NULL) 3840 semsg(_(e_dictkey), fudi.fd_newkey); 3841 vim_free(fudi.fd_newkey); 3842 return NULL; 3843 } 3844 else 3845 eap->skip = TRUE; 3846 } 3847 } 3848 3849 // An error in a function call during evaluation of an expression in magic 3850 // braces should not cause the function not to be defined. 3851 saved_did_emsg = did_emsg; 3852 did_emsg = FALSE; 3853 3854 /* 3855 * ":function func" with only function name: list function. 3856 */ 3857 if (!paren) 3858 { 3859 if (!ends_excmd(*skipwhite(p))) 3860 { 3861 semsg(_(e_trailing_arg), p); 3862 goto ret_free; 3863 } 3864 eap->nextcmd = check_nextcmd(p); 3865 if (eap->nextcmd != NULL) 3866 *p = NUL; 3867 if (!eap->skip && !got_int) 3868 { 3869 fp = find_func(name, is_global, NULL); 3870 if (fp == NULL && ASCII_ISUPPER(*eap->arg)) 3871 { 3872 char_u *up = untrans_function_name(name); 3873 3874 // With Vim9 script the name was made script-local, if not 3875 // found try again with the original name. 3876 if (up != NULL) 3877 fp = find_func(up, FALSE, NULL); 3878 } 3879 3880 if (fp != NULL) 3881 { 3882 list_func_head(fp, TRUE); 3883 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j) 3884 { 3885 if (FUNCLINE(fp, j) == NULL) 3886 continue; 3887 msg_putchar('\n'); 3888 msg_outnum((long)(j + 1)); 3889 if (j < 9) 3890 msg_putchar(' '); 3891 if (j < 99) 3892 msg_putchar(' '); 3893 msg_prt_line(FUNCLINE(fp, j), FALSE); 3894 out_flush(); // show a line at a time 3895 ui_breakcheck(); 3896 } 3897 if (!got_int) 3898 { 3899 msg_putchar('\n'); 3900 if (fp->uf_def_status != UF_NOT_COMPILED) 3901 msg_puts(" enddef"); 3902 else 3903 msg_puts(" endfunction"); 3904 } 3905 } 3906 else 3907 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg); 3908 } 3909 goto ret_free; 3910 } 3911 3912 /* 3913 * ":function name(arg1, arg2)" Define function. 3914 */ 3915 p = skipwhite(p); 3916 if (*p != '(') 3917 { 3918 if (!eap->skip) 3919 { 3920 semsg(_("E124: Missing '(': %s"), eap->arg); 3921 goto ret_free; 3922 } 3923 // attempt to continue by skipping some text 3924 if (vim_strchr(p, '(') != NULL) 3925 p = vim_strchr(p, '('); 3926 } 3927 3928 if ((vim9script || eap->cmdidx == CMD_def) && VIM_ISWHITE(p[-1])) 3929 { 3930 semsg(_(e_no_white_space_allowed_before_str_str), "(", p - 1); 3931 goto ret_free; 3932 } 3933 3934 // In Vim9 script only global functions can be redefined. 3935 if (vim9script && eap->forceit && !is_global) 3936 { 3937 emsg(_(e_nobang)); 3938 goto ret_free; 3939 } 3940 3941 ga_init2(&newlines, (int)sizeof(char_u *), 10); 3942 3943 if (!eap->skip && name_arg == NULL) 3944 { 3945 // Check the name of the function. Unless it's a dictionary function 3946 // (that we are overwriting). 3947 if (name != NULL) 3948 arg = name; 3949 else 3950 arg = fudi.fd_newkey; 3951 if (arg != NULL && (fudi.fd_di == NULL 3952 || (fudi.fd_di->di_tv.v_type != VAR_FUNC 3953 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL))) 3954 { 3955 if (*arg == K_SPECIAL) 3956 j = 3; 3957 else 3958 j = 0; 3959 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j]) 3960 : eval_isnamec(arg[j]))) 3961 ++j; 3962 if (arg[j] != NUL) 3963 emsg_funcname((char *)e_invarg2, arg); 3964 } 3965 // Disallow using the g: dict. 3966 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE) 3967 emsg(_("E862: Cannot use g: here")); 3968 } 3969 3970 // This may get more lines and make the pointers into the first line 3971 // invalid. 3972 ++p; 3973 if (get_function_args(&p, ')', &newargs, 3974 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE, 3975 NULL, &varargs, &default_args, eap->skip, 3976 eap, &line_to_free) == FAIL) 3977 goto errret_2; 3978 whitep = p; 3979 3980 if (eap->cmdidx == CMD_def) 3981 { 3982 // find the return type: :def Func(): type 3983 if (*p == ':') 3984 { 3985 ret_type = skipwhite(p + 1); 3986 p = skip_type(ret_type, FALSE); 3987 if (p > ret_type) 3988 { 3989 ret_type = vim_strnsave(ret_type, p - ret_type); 3990 whitep = p; 3991 p = skipwhite(p); 3992 } 3993 else 3994 { 3995 semsg(_(e_expected_type_str), ret_type); 3996 ret_type = NULL; 3997 } 3998 } 3999 p = skipwhite(p); 4000 } 4001 else 4002 // find extra arguments "range", "dict", "abort" and "closure" 4003 for (;;) 4004 { 4005 whitep = p; 4006 p = skipwhite(p); 4007 if (STRNCMP(p, "range", 5) == 0) 4008 { 4009 flags |= FC_RANGE; 4010 p += 5; 4011 } 4012 else if (STRNCMP(p, "dict", 4) == 0) 4013 { 4014 flags |= FC_DICT; 4015 p += 4; 4016 } 4017 else if (STRNCMP(p, "abort", 5) == 0) 4018 { 4019 flags |= FC_ABORT; 4020 p += 5; 4021 } 4022 else if (STRNCMP(p, "closure", 7) == 0) 4023 { 4024 flags |= FC_CLOSURE; 4025 p += 7; 4026 if (current_funccal == NULL) 4027 { 4028 emsg_funcname(N_("E932: Closure function should not be at top level: %s"), 4029 name == NULL ? (char_u *)"" : name); 4030 goto erret; 4031 } 4032 } 4033 else 4034 break; 4035 } 4036 4037 // When there is a line break use what follows for the function body. 4038 // Makes 'exe "func Test()\n...\nendfunc"' work. 4039 if (*p == '\n') 4040 line_arg = p + 1; 4041 else if (*p != NUL 4042 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function) 4043 && eap->cmdidx != CMD_def) 4044 && !(VIM_ISWHITE(*whitep) && *p == '#' 4045 && (vim9script || eap->cmdidx == CMD_def)) 4046 && !eap->skip 4047 && !did_emsg) 4048 semsg(_(e_trailing_arg), p); 4049 4050 /* 4051 * Read the body of the function, until "}", ":endfunction" or ":enddef" is 4052 * found. 4053 */ 4054 if (KeyTyped) 4055 { 4056 // Check if the function already exists, don't let the user type the 4057 // whole function before telling him it doesn't work! For a script we 4058 // need to skip the body to be able to find what follows. 4059 if (!eap->skip && !eap->forceit) 4060 { 4061 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL) 4062 emsg(_(e_funcdict)); 4063 else if (name != NULL && find_func(name, is_global, NULL) != NULL) 4064 emsg_funcname(e_funcexts, name); 4065 } 4066 4067 if (!eap->skip && did_emsg) 4068 goto erret; 4069 4070 msg_putchar('\n'); // don't overwrite the function name 4071 cmdline_row = msg_row; 4072 } 4073 4074 // Save the starting line number. 4075 sourcing_lnum_top = SOURCING_LNUM; 4076 4077 // Do not define the function when getting the body fails and when 4078 // skipping. 4079 if (get_function_body(eap, &newlines, line_arg, &line_to_free) == FAIL 4080 || eap->skip) 4081 goto erret; 4082 4083 /* 4084 * If there are no errors, add the function 4085 */ 4086 if (fudi.fd_dict == NULL) 4087 { 4088 hashtab_T *ht; 4089 4090 v = find_var(name, &ht, TRUE); 4091 if (v != NULL && v->di_tv.v_type == VAR_FUNC) 4092 { 4093 emsg_funcname(N_("E707: Function name conflicts with variable: %s"), 4094 name); 4095 goto erret; 4096 } 4097 4098 fp = find_func_even_dead(name, is_global, NULL); 4099 if (vim9script) 4100 { 4101 char_u *uname = untrans_function_name(name); 4102 4103 import = find_imported(uname == NULL ? name : uname, 0, NULL); 4104 } 4105 4106 if (fp != NULL || import != NULL) 4107 { 4108 int dead = fp != NULL && (fp->uf_flags & FC_DEAD); 4109 4110 // Function can be replaced with "function!" and when sourcing the 4111 // same script again, but only once. 4112 // A name that is used by an import can not be overruled. 4113 if (import != NULL 4114 || (!dead && !eap->forceit 4115 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid 4116 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))) 4117 { 4118 if (vim9script) 4119 emsg_funcname(e_name_already_defined_str, name); 4120 else 4121 emsg_funcname(e_funcexts, name); 4122 goto erret; 4123 } 4124 if (fp->uf_calls > 0) 4125 { 4126 emsg_funcname( 4127 N_("E127: Cannot redefine function %s: It is in use"), 4128 name); 4129 goto erret; 4130 } 4131 if (fp->uf_refcount > 1) 4132 { 4133 // This function is referenced somewhere, don't redefine it but 4134 // create a new one. 4135 --fp->uf_refcount; 4136 fp->uf_flags |= FC_REMOVED; 4137 fp = NULL; 4138 overwrite = TRUE; 4139 } 4140 else 4141 { 4142 char_u *exp_name = fp->uf_name_exp; 4143 4144 // redefine existing function, keep the expanded name 4145 VIM_CLEAR(name); 4146 fp->uf_name_exp = NULL; 4147 func_clear_items(fp); 4148 fp->uf_name_exp = exp_name; 4149 fp->uf_flags &= ~FC_DEAD; 4150 #ifdef FEAT_PROFILE 4151 fp->uf_profiling = FALSE; 4152 fp->uf_prof_initialized = FALSE; 4153 #endif 4154 fp->uf_def_status = UF_NOT_COMPILED; 4155 } 4156 } 4157 } 4158 else 4159 { 4160 char numbuf[20]; 4161 4162 fp = NULL; 4163 if (fudi.fd_newkey == NULL && !eap->forceit) 4164 { 4165 emsg(_(e_funcdict)); 4166 goto erret; 4167 } 4168 if (fudi.fd_di == NULL) 4169 { 4170 // Can't add a function to a locked dictionary 4171 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE)) 4172 goto erret; 4173 } 4174 // Can't change an existing function if it is locked 4175 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE)) 4176 goto erret; 4177 4178 // Give the function a sequential number. Can only be used with a 4179 // Funcref! 4180 vim_free(name); 4181 sprintf(numbuf, "%d", ++func_nr); 4182 name = vim_strsave((char_u *)numbuf); 4183 if (name == NULL) 4184 goto erret; 4185 } 4186 4187 if (fp == NULL) 4188 { 4189 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL) 4190 { 4191 int slen, plen; 4192 char_u *scriptname; 4193 4194 // Check that the autoload name matches the script name. 4195 j = FAIL; 4196 if (SOURCING_NAME != NULL) 4197 { 4198 scriptname = autoload_name(name); 4199 if (scriptname != NULL) 4200 { 4201 p = vim_strchr(scriptname, '/'); 4202 plen = (int)STRLEN(p); 4203 slen = (int)STRLEN(SOURCING_NAME); 4204 if (slen > plen && fnamecmp(p, 4205 SOURCING_NAME + slen - plen) == 0) 4206 j = OK; 4207 vim_free(scriptname); 4208 } 4209 } 4210 if (j == FAIL) 4211 { 4212 linenr_T save_lnum = SOURCING_LNUM; 4213 4214 SOURCING_LNUM = sourcing_lnum_top; 4215 semsg(_("E746: Function name does not match script file name: %s"), name); 4216 SOURCING_LNUM = save_lnum; 4217 goto erret; 4218 } 4219 } 4220 4221 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 4222 if (fp == NULL) 4223 goto erret; 4224 4225 if (fudi.fd_dict != NULL) 4226 { 4227 if (fudi.fd_di == NULL) 4228 { 4229 // add new dict entry 4230 fudi.fd_di = dictitem_alloc(fudi.fd_newkey); 4231 if (fudi.fd_di == NULL) 4232 { 4233 vim_free(fp); 4234 fp = NULL; 4235 goto erret; 4236 } 4237 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL) 4238 { 4239 vim_free(fudi.fd_di); 4240 vim_free(fp); 4241 fp = NULL; 4242 goto erret; 4243 } 4244 } 4245 else 4246 // overwrite existing dict entry 4247 clear_tv(&fudi.fd_di->di_tv); 4248 fudi.fd_di->di_tv.v_type = VAR_FUNC; 4249 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name); 4250 4251 // behave like "dict" was used 4252 flags |= FC_DICT; 4253 } 4254 4255 // insert the new function in the function list 4256 set_ufunc_name(fp, name); 4257 if (overwrite) 4258 { 4259 hi = hash_find(&func_hashtab, name); 4260 hi->hi_key = UF2HIKEY(fp); 4261 } 4262 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL) 4263 { 4264 vim_free(fp); 4265 fp = NULL; 4266 goto erret; 4267 } 4268 fp->uf_refcount = 1; 4269 } 4270 fp->uf_args = newargs; 4271 fp->uf_def_args = default_args; 4272 fp->uf_ret_type = &t_any; 4273 fp->uf_func_type = &t_func_any; 4274 4275 if (eap->cmdidx == CMD_def) 4276 { 4277 int lnum_save = SOURCING_LNUM; 4278 cstack_T *cstack = eap->cstack; 4279 4280 fp->uf_def_status = UF_TO_BE_COMPILED; 4281 4282 // error messages are for the first function line 4283 SOURCING_LNUM = sourcing_lnum_top; 4284 4285 if (cstack != NULL && cstack->cs_idx >= 0) 4286 { 4287 int count = cstack->cs_idx + 1; 4288 int i; 4289 4290 // The block context may be needed for script variables declared in 4291 // a block that is visible now but not when the function is called 4292 // later. 4293 fp->uf_block_ids = ALLOC_MULT(int, count); 4294 if (fp->uf_block_ids != NULL) 4295 { 4296 mch_memmove(fp->uf_block_ids, cstack->cs_block_id, 4297 sizeof(int) * count); 4298 fp->uf_block_depth = count; 4299 } 4300 4301 // Set flag in each block to indicate a function was defined. This 4302 // is used to keep the variable when leaving the block, see 4303 // hide_script_var(). 4304 for (i = 0; i <= cstack->cs_idx; ++i) 4305 cstack->cs_flags[i] |= CSF_FUNC_DEF; 4306 } 4307 4308 if (parse_argument_types(fp, &argtypes, varargs) == FAIL) 4309 { 4310 SOURCING_LNUM = lnum_save; 4311 goto errret_2; 4312 } 4313 varargs = FALSE; 4314 4315 // parse the return type, if any 4316 if (parse_return_type(fp, ret_type) == FAIL) 4317 { 4318 SOURCING_LNUM = lnum_save; 4319 goto erret; 4320 } 4321 SOURCING_LNUM = lnum_save; 4322 } 4323 else 4324 fp->uf_def_status = UF_NOT_COMPILED; 4325 4326 fp->uf_lines = newlines; 4327 if ((flags & FC_CLOSURE) != 0) 4328 { 4329 if (register_closure(fp) == FAIL) 4330 goto erret; 4331 } 4332 else 4333 fp->uf_scoped = NULL; 4334 4335 #ifdef FEAT_PROFILE 4336 if (prof_def_func()) 4337 func_do_profile(fp); 4338 #endif 4339 fp->uf_varargs = varargs; 4340 if (sandbox) 4341 flags |= FC_SANDBOX; 4342 if (vim9script && !ASCII_ISUPPER(*fp->uf_name)) 4343 flags |= FC_VIM9; 4344 fp->uf_flags = flags; 4345 fp->uf_calls = 0; 4346 fp->uf_cleared = FALSE; 4347 fp->uf_script_ctx = current_sctx; 4348 fp->uf_script_ctx_version = current_sctx.sc_version; 4349 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top; 4350 if (is_export) 4351 { 4352 fp->uf_flags |= FC_EXPORT; 4353 // let ex_export() know the export worked. 4354 is_export = FALSE; 4355 } 4356 4357 if (eap->cmdidx == CMD_def) 4358 set_function_type(fp); 4359 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9) 4360 // :func does not use Vim9 script syntax, even in a Vim9 script file 4361 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX; 4362 4363 goto ret_free; 4364 4365 erret: 4366 ga_clear_strings(&newargs); 4367 ga_clear_strings(&default_args); 4368 if (fp != NULL) 4369 { 4370 ga_init(&fp->uf_args); 4371 ga_init(&fp->uf_def_args); 4372 } 4373 errret_2: 4374 ga_clear_strings(&newlines); 4375 if (fp != NULL) 4376 VIM_CLEAR(fp->uf_arg_types); 4377 ret_free: 4378 ga_clear_strings(&argtypes); 4379 vim_free(line_to_free); 4380 vim_free(fudi.fd_newkey); 4381 if (name != name_arg) 4382 vim_free(name); 4383 vim_free(ret_type); 4384 did_emsg |= saved_did_emsg; 4385 4386 return fp; 4387 } 4388 4389 /* 4390 * ":function" 4391 */ 4392 void 4393 ex_function(exarg_T *eap) 4394 { 4395 (void)define_function(eap, NULL); 4396 } 4397 4398 /* 4399 * :defcompile - compile all :def functions in the current script that need to 4400 * be compiled. Except dead functions. Doesn't do profiling. 4401 */ 4402 void 4403 ex_defcompile(exarg_T *eap UNUSED) 4404 { 4405 long todo = (long)func_hashtab.ht_used; 4406 int changed = func_hashtab.ht_changed; 4407 hashitem_T *hi; 4408 ufunc_T *ufunc; 4409 4410 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 4411 { 4412 if (!HASHITEM_EMPTY(hi)) 4413 { 4414 --todo; 4415 ufunc = HI2UF(hi); 4416 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid 4417 && ufunc->uf_def_status == UF_TO_BE_COMPILED 4418 && (ufunc->uf_flags & FC_DEAD) == 0) 4419 { 4420 (void)compile_def_function(ufunc, FALSE, CT_NONE, NULL); 4421 4422 if (func_hashtab.ht_changed != changed) 4423 { 4424 // a function has been added or removed, need to start over 4425 todo = (long)func_hashtab.ht_used; 4426 changed = func_hashtab.ht_changed; 4427 hi = func_hashtab.ht_array; 4428 --hi; 4429 } 4430 } 4431 } 4432 } 4433 } 4434 4435 /* 4436 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case). 4437 * Return 2 if "p" starts with "s:". 4438 * Return 0 otherwise. 4439 */ 4440 int 4441 eval_fname_script(char_u *p) 4442 { 4443 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with 4444 // the standard library function. 4445 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0 4446 || MB_STRNICMP(p + 1, "SNR>", 4) == 0)) 4447 return 5; 4448 if (p[0] == 's' && p[1] == ':') 4449 return 2; 4450 return 0; 4451 } 4452 4453 int 4454 translated_function_exists(char_u *name, int is_global) 4455 { 4456 if (builtin_function(name, -1)) 4457 return has_internal_func(name); 4458 return find_func(name, is_global, NULL) != NULL; 4459 } 4460 4461 /* 4462 * Return TRUE when "ufunc" has old-style "..." varargs 4463 * or named varargs "...name: type". 4464 */ 4465 int 4466 has_varargs(ufunc_T *ufunc) 4467 { 4468 return ufunc->uf_varargs || ufunc->uf_va_name != NULL; 4469 } 4470 4471 /* 4472 * Return TRUE if a function "name" exists. 4473 * If "no_defef" is TRUE, do not dereference a Funcref. 4474 */ 4475 int 4476 function_exists(char_u *name, int no_deref) 4477 { 4478 char_u *nm = name; 4479 char_u *p; 4480 int n = FALSE; 4481 int flag; 4482 int is_global = FALSE; 4483 4484 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD; 4485 if (no_deref) 4486 flag |= TFN_NO_DEREF; 4487 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL, NULL); 4488 nm = skipwhite(nm); 4489 4490 // Only accept "funcname", "funcname ", "funcname (..." and 4491 // "funcname(...", not "funcname!...". 4492 if (p != NULL && (*nm == NUL || *nm == '(')) 4493 n = translated_function_exists(p, is_global); 4494 vim_free(p); 4495 return n; 4496 } 4497 4498 #if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO) 4499 char_u * 4500 get_expanded_name(char_u *name, int check) 4501 { 4502 char_u *nm = name; 4503 char_u *p; 4504 int is_global = FALSE; 4505 4506 p = trans_function_name(&nm, &is_global, FALSE, 4507 TFN_INT|TFN_QUIET, NULL, NULL, NULL); 4508 4509 if (p != NULL && *nm == NUL 4510 && (!check || translated_function_exists(p, is_global))) 4511 return p; 4512 4513 vim_free(p); 4514 return NULL; 4515 } 4516 #endif 4517 4518 /* 4519 * Function given to ExpandGeneric() to obtain the list of user defined 4520 * function names. 4521 */ 4522 char_u * 4523 get_user_func_name(expand_T *xp, int idx) 4524 { 4525 static long_u done; 4526 static int changed; 4527 static hashitem_T *hi; 4528 ufunc_T *fp; 4529 4530 if (idx == 0) 4531 { 4532 done = 0; 4533 hi = func_hashtab.ht_array; 4534 changed = func_hashtab.ht_changed; 4535 } 4536 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used) 4537 { 4538 if (done++ > 0) 4539 ++hi; 4540 while (HASHITEM_EMPTY(hi)) 4541 ++hi; 4542 fp = HI2UF(hi); 4543 4544 // don't show dead, dict and lambda functions 4545 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT) 4546 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 4547 return (char_u *)""; 4548 4549 if (STRLEN(fp->uf_name) + 4 >= IOSIZE) 4550 return fp->uf_name; // prevents overflow 4551 4552 cat_func_name(IObuff, fp); 4553 if (xp->xp_context != EXPAND_USER_FUNC) 4554 { 4555 STRCAT(IObuff, "("); 4556 if (!has_varargs(fp) && fp->uf_args.ga_len == 0) 4557 STRCAT(IObuff, ")"); 4558 } 4559 return IObuff; 4560 } 4561 return NULL; 4562 } 4563 4564 /* 4565 * ":delfunction {name}" 4566 */ 4567 void 4568 ex_delfunction(exarg_T *eap) 4569 { 4570 ufunc_T *fp = NULL; 4571 char_u *p; 4572 char_u *name; 4573 funcdict_T fudi; 4574 int is_global = FALSE; 4575 4576 p = eap->arg; 4577 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, 4578 NULL, NULL); 4579 vim_free(fudi.fd_newkey); 4580 if (name == NULL) 4581 { 4582 if (fudi.fd_dict != NULL && !eap->skip) 4583 emsg(_(e_funcref)); 4584 return; 4585 } 4586 if (!ends_excmd(*skipwhite(p))) 4587 { 4588 vim_free(name); 4589 semsg(_(e_trailing_arg), p); 4590 return; 4591 } 4592 eap->nextcmd = check_nextcmd(p); 4593 if (eap->nextcmd != NULL) 4594 *p = NUL; 4595 4596 if (!eap->skip) 4597 fp = find_func(name, is_global, NULL); 4598 vim_free(name); 4599 4600 if (!eap->skip) 4601 { 4602 if (fp == NULL) 4603 { 4604 if (!eap->forceit) 4605 semsg(_(e_nofunc), eap->arg); 4606 return; 4607 } 4608 if (fp->uf_calls > 0) 4609 { 4610 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg); 4611 return; 4612 } 4613 if (fp->uf_flags & FC_VIM9) 4614 { 4615 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg); 4616 return; 4617 } 4618 4619 if (fudi.fd_dict != NULL) 4620 { 4621 // Delete the dict item that refers to the function, it will 4622 // invoke func_unref() and possibly delete the function. 4623 dictitem_remove(fudi.fd_dict, fudi.fd_di); 4624 } 4625 else 4626 { 4627 // A normal function (not a numbered function or lambda) has a 4628 // refcount of 1 for the entry in the hashtable. When deleting 4629 // it and the refcount is more than one, it should be kept. 4630 // A numbered function and lambda should be kept if the refcount is 4631 // one or more. 4632 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1)) 4633 { 4634 // Function is still referenced somewhere. Don't free it but 4635 // do remove it from the hashtable. 4636 if (func_remove(fp)) 4637 fp->uf_refcount--; 4638 } 4639 else 4640 func_clear_free(fp, FALSE); 4641 } 4642 } 4643 } 4644 4645 /* 4646 * Unreference a Function: decrement the reference count and free it when it 4647 * becomes zero. 4648 */ 4649 void 4650 func_unref(char_u *name) 4651 { 4652 ufunc_T *fp = NULL; 4653 4654 if (name == NULL || !func_name_refcount(name)) 4655 return; 4656 fp = find_func(name, FALSE, NULL); 4657 if (fp == NULL && isdigit(*name)) 4658 { 4659 #ifdef EXITFREE 4660 if (!entered_free_all_mem) 4661 #endif 4662 internal_error("func_unref()"); 4663 } 4664 func_ptr_unref(fp); 4665 } 4666 4667 /* 4668 * Unreference a Function: decrement the reference count and free it when it 4669 * becomes zero. 4670 * Also when it becomes one and uf_partial points to the function. 4671 */ 4672 void 4673 func_ptr_unref(ufunc_T *fp) 4674 { 4675 if (fp != NULL && (--fp->uf_refcount <= 0 4676 || (fp->uf_refcount == 1 && fp->uf_partial != NULL 4677 && fp->uf_partial->pt_refcount <= 1 4678 && fp->uf_partial->pt_func == fp))) 4679 { 4680 // Only delete it when it's not being used. Otherwise it's done 4681 // when "uf_calls" becomes zero. 4682 if (fp->uf_calls == 0) 4683 func_clear_free(fp, FALSE); 4684 } 4685 } 4686 4687 /* 4688 * Count a reference to a Function. 4689 */ 4690 void 4691 func_ref(char_u *name) 4692 { 4693 ufunc_T *fp; 4694 4695 if (name == NULL || !func_name_refcount(name)) 4696 return; 4697 fp = find_func(name, FALSE, NULL); 4698 if (fp != NULL) 4699 ++fp->uf_refcount; 4700 else if (isdigit(*name)) 4701 // Only give an error for a numbered function. 4702 // Fail silently, when named or lambda function isn't found. 4703 internal_error("func_ref()"); 4704 } 4705 4706 /* 4707 * Count a reference to a Function. 4708 */ 4709 void 4710 func_ptr_ref(ufunc_T *fp) 4711 { 4712 if (fp != NULL) 4713 ++fp->uf_refcount; 4714 } 4715 4716 /* 4717 * Return TRUE if items in "fc" do not have "copyID". That means they are not 4718 * referenced from anywhere that is in use. 4719 */ 4720 static int 4721 can_free_funccal(funccall_T *fc, int copyID) 4722 { 4723 return (fc->l_varlist.lv_copyID != copyID 4724 && fc->l_vars.dv_copyID != copyID 4725 && fc->l_avars.dv_copyID != copyID 4726 && fc->fc_copyID != copyID); 4727 } 4728 4729 /* 4730 * ":return [expr]" 4731 */ 4732 void 4733 ex_return(exarg_T *eap) 4734 { 4735 char_u *arg = eap->arg; 4736 typval_T rettv; 4737 int returning = FALSE; 4738 evalarg_T evalarg; 4739 4740 if (current_funccal == NULL) 4741 { 4742 emsg(_("E133: :return not inside a function")); 4743 return; 4744 } 4745 4746 CLEAR_FIELD(evalarg); 4747 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE; 4748 4749 if (eap->skip) 4750 ++emsg_skip; 4751 4752 eap->nextcmd = NULL; 4753 if ((*arg != NUL && *arg != '|' && *arg != '\n') 4754 && eval0(arg, &rettv, eap, &evalarg) != FAIL) 4755 { 4756 if (!eap->skip) 4757 returning = do_return(eap, FALSE, TRUE, &rettv); 4758 else 4759 clear_tv(&rettv); 4760 } 4761 // It's safer to return also on error. 4762 else if (!eap->skip) 4763 { 4764 // In return statement, cause_abort should be force_abort. 4765 update_force_abort(); 4766 4767 /* 4768 * Return unless the expression evaluation has been cancelled due to an 4769 * aborting error, an interrupt, or an exception. 4770 */ 4771 if (!aborting()) 4772 returning = do_return(eap, FALSE, TRUE, NULL); 4773 } 4774 4775 // When skipping or the return gets pending, advance to the next command 4776 // in this line (!returning). Otherwise, ignore the rest of the line. 4777 // Following lines will be ignored by get_func_line(). 4778 if (returning) 4779 eap->nextcmd = NULL; 4780 else if (eap->nextcmd == NULL) // no argument 4781 eap->nextcmd = check_nextcmd(arg); 4782 4783 if (eap->skip) 4784 --emsg_skip; 4785 clear_evalarg(&evalarg, eap); 4786 } 4787 4788 /* 4789 * ":1,25call func(arg1, arg2)" function call. 4790 */ 4791 void 4792 ex_call(exarg_T *eap) 4793 { 4794 char_u *arg = eap->arg; 4795 char_u *startarg; 4796 char_u *name; 4797 char_u *tofree; 4798 int len; 4799 typval_T rettv; 4800 linenr_T lnum; 4801 int doesrange; 4802 int failed = FALSE; 4803 funcdict_T fudi; 4804 partial_T *partial = NULL; 4805 evalarg_T evalarg; 4806 type_T *type = NULL; 4807 4808 fill_evalarg_from_eap(&evalarg, eap, eap->skip); 4809 if (eap->skip) 4810 { 4811 // trans_function_name() doesn't work well when skipping, use eval0() 4812 // instead to skip to any following command, e.g. for: 4813 // :if 0 | call dict.foo().bar() | endif 4814 ++emsg_skip; 4815 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL) 4816 clear_tv(&rettv); 4817 --emsg_skip; 4818 clear_evalarg(&evalarg, eap); 4819 return; 4820 } 4821 4822 tofree = trans_function_name(&arg, NULL, eap->skip, TFN_INT, 4823 &fudi, &partial, in_vim9script() ? &type : NULL); 4824 if (fudi.fd_newkey != NULL) 4825 { 4826 // Still need to give an error message for missing key. 4827 semsg(_(e_dictkey), fudi.fd_newkey); 4828 vim_free(fudi.fd_newkey); 4829 } 4830 if (tofree == NULL) 4831 return; 4832 4833 // Increase refcount on dictionary, it could get deleted when evaluating 4834 // the arguments. 4835 if (fudi.fd_dict != NULL) 4836 ++fudi.fd_dict->dv_refcount; 4837 4838 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its 4839 // contents. For VAR_PARTIAL get its partial, unless we already have one 4840 // from trans_function_name(). 4841 len = (int)STRLEN(tofree); 4842 name = deref_func_name(tofree, &len, partial != NULL ? NULL : &partial, 4843 in_vim9script() && type == NULL ? &type : NULL, FALSE); 4844 4845 // Skip white space to allow ":call func ()". Not good, but required for 4846 // backward compatibility. 4847 startarg = skipwhite(arg); 4848 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this 4849 4850 if (*startarg != '(') 4851 { 4852 semsg(_(e_missing_paren), eap->arg); 4853 goto end; 4854 } 4855 4856 /* 4857 * When skipping, evaluate the function once, to find the end of the 4858 * arguments. 4859 * When the function takes a range, this is discovered after the first 4860 * call, and the loop is broken. 4861 */ 4862 if (eap->skip) 4863 { 4864 ++emsg_skip; 4865 lnum = eap->line2; // do it once, also with an invalid range 4866 } 4867 else 4868 lnum = eap->line1; 4869 for ( ; lnum <= eap->line2; ++lnum) 4870 { 4871 funcexe_T funcexe; 4872 4873 if (!eap->skip && eap->addr_count > 0) 4874 { 4875 if (lnum > curbuf->b_ml.ml_line_count) 4876 { 4877 // If the function deleted lines or switched to another buffer 4878 // the line number may become invalid. 4879 emsg(_(e_invalid_range)); 4880 break; 4881 } 4882 curwin->w_cursor.lnum = lnum; 4883 curwin->w_cursor.col = 0; 4884 curwin->w_cursor.coladd = 0; 4885 } 4886 arg = startarg; 4887 4888 CLEAR_FIELD(funcexe); 4889 funcexe.firstline = eap->line1; 4890 funcexe.lastline = eap->line2; 4891 funcexe.doesrange = &doesrange; 4892 funcexe.evaluate = !eap->skip; 4893 funcexe.partial = partial; 4894 funcexe.selfdict = fudi.fd_dict; 4895 funcexe.check_type = type; 4896 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL) 4897 { 4898 failed = TRUE; 4899 break; 4900 } 4901 if (has_watchexpr()) 4902 dbg_check_breakpoint(eap); 4903 4904 // Handle a function returning a Funcref, Dictionary or List. 4905 if (handle_subscript(&arg, &rettv, 4906 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL) 4907 { 4908 failed = TRUE; 4909 break; 4910 } 4911 4912 clear_tv(&rettv); 4913 if (doesrange || eap->skip) 4914 break; 4915 4916 // Stop when immediately aborting on error, or when an interrupt 4917 // occurred or an exception was thrown but not caught. 4918 // get_func_tv() returned OK, so that the check for trailing 4919 // characters below is executed. 4920 if (aborting()) 4921 break; 4922 } 4923 if (eap->skip) 4924 --emsg_skip; 4925 clear_evalarg(&evalarg, eap); 4926 4927 // When inside :try we need to check for following "| catch". 4928 if (!failed || eap->cstack->cs_trylevel > 0) 4929 { 4930 // Check for trailing illegal characters and a following command. 4931 arg = skipwhite(arg); 4932 if (!ends_excmd2(eap->arg, arg)) 4933 { 4934 if (!failed) 4935 { 4936 emsg_severe = TRUE; 4937 semsg(_(e_trailing_arg), arg); 4938 } 4939 } 4940 else 4941 eap->nextcmd = check_nextcmd(arg); 4942 } 4943 4944 end: 4945 dict_unref(fudi.fd_dict); 4946 vim_free(tofree); 4947 } 4948 4949 /* 4950 * Return from a function. Possibly makes the return pending. Also called 4951 * for a pending return at the ":endtry" or after returning from an extra 4952 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set 4953 * when called due to a ":return" command. "rettv" may point to a typval_T 4954 * with the return rettv. Returns TRUE when the return can be carried out, 4955 * FALSE when the return gets pending. 4956 */ 4957 int 4958 do_return( 4959 exarg_T *eap, 4960 int reanimate, 4961 int is_cmd, 4962 void *rettv) 4963 { 4964 int idx; 4965 cstack_T *cstack = eap->cstack; 4966 4967 if (reanimate) 4968 // Undo the return. 4969 current_funccal->returned = FALSE; 4970 4971 /* 4972 * Cleanup (and inactivate) conditionals, but stop when a try conditional 4973 * not in its finally clause (which then is to be executed next) is found. 4974 * In this case, make the ":return" pending for execution at the ":endtry". 4975 * Otherwise, return normally. 4976 */ 4977 idx = cleanup_conditionals(eap->cstack, 0, TRUE); 4978 if (idx >= 0) 4979 { 4980 cstack->cs_pending[idx] = CSTP_RETURN; 4981 4982 if (!is_cmd && !reanimate) 4983 // A pending return again gets pending. "rettv" points to an 4984 // allocated variable with the rettv of the original ":return"'s 4985 // argument if present or is NULL else. 4986 cstack->cs_rettv[idx] = rettv; 4987 else 4988 { 4989 // When undoing a return in order to make it pending, get the stored 4990 // return rettv. 4991 if (reanimate) 4992 rettv = current_funccal->rettv; 4993 4994 if (rettv != NULL) 4995 { 4996 // Store the value of the pending return. 4997 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL) 4998 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv; 4999 else 5000 emsg(_(e_outofmem)); 5001 } 5002 else 5003 cstack->cs_rettv[idx] = NULL; 5004 5005 if (reanimate) 5006 { 5007 // The pending return value could be overwritten by a ":return" 5008 // without argument in a finally clause; reset the default 5009 // return value. 5010 current_funccal->rettv->v_type = VAR_NUMBER; 5011 current_funccal->rettv->vval.v_number = 0; 5012 } 5013 } 5014 report_make_pending(CSTP_RETURN, rettv); 5015 } 5016 else 5017 { 5018 current_funccal->returned = TRUE; 5019 5020 // If the return is carried out now, store the return value. For 5021 // a return immediately after reanimation, the value is already 5022 // there. 5023 if (!reanimate && rettv != NULL) 5024 { 5025 clear_tv(current_funccal->rettv); 5026 *current_funccal->rettv = *(typval_T *)rettv; 5027 if (!is_cmd) 5028 vim_free(rettv); 5029 } 5030 } 5031 5032 return idx < 0; 5033 } 5034 5035 /* 5036 * Free the variable with a pending return value. 5037 */ 5038 void 5039 discard_pending_return(void *rettv) 5040 { 5041 free_tv((typval_T *)rettv); 5042 } 5043 5044 /* 5045 * Generate a return command for producing the value of "rettv". The result 5046 * is an allocated string. Used by report_pending() for verbose messages. 5047 */ 5048 char_u * 5049 get_return_cmd(void *rettv) 5050 { 5051 char_u *s = NULL; 5052 char_u *tofree = NULL; 5053 char_u numbuf[NUMBUFLEN]; 5054 5055 if (rettv != NULL) 5056 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0); 5057 if (s == NULL) 5058 s = (char_u *)""; 5059 5060 STRCPY(IObuff, ":return "); 5061 STRNCPY(IObuff + 8, s, IOSIZE - 8); 5062 if (STRLEN(s) + 8 >= IOSIZE) 5063 STRCPY(IObuff + IOSIZE - 4, "..."); 5064 vim_free(tofree); 5065 return vim_strsave(IObuff); 5066 } 5067 5068 /* 5069 * Get next function line. 5070 * Called by do_cmdline() to get the next line. 5071 * Returns allocated string, or NULL for end of function. 5072 */ 5073 char_u * 5074 get_func_line( 5075 int c UNUSED, 5076 void *cookie, 5077 int indent UNUSED, 5078 getline_opt_T options UNUSED) 5079 { 5080 funccall_T *fcp = (funccall_T *)cookie; 5081 ufunc_T *fp = fcp->func; 5082 char_u *retval; 5083 garray_T *gap; // growarray with function lines 5084 5085 // If breakpoints have been added/deleted need to check for it. 5086 if (fcp->dbg_tick != debug_tick) 5087 { 5088 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 5089 SOURCING_LNUM); 5090 fcp->dbg_tick = debug_tick; 5091 } 5092 #ifdef FEAT_PROFILE 5093 if (do_profiling == PROF_YES) 5094 func_line_end(cookie); 5095 #endif 5096 5097 gap = &fp->uf_lines; 5098 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 5099 || fcp->returned) 5100 retval = NULL; 5101 else 5102 { 5103 // Skip NULL lines (continuation lines). 5104 while (fcp->linenr < gap->ga_len 5105 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL) 5106 ++fcp->linenr; 5107 if (fcp->linenr >= gap->ga_len) 5108 retval = NULL; 5109 else 5110 { 5111 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]); 5112 SOURCING_LNUM = fcp->linenr; 5113 #ifdef FEAT_PROFILE 5114 if (do_profiling == PROF_YES) 5115 func_line_start(cookie, SOURCING_LNUM); 5116 #endif 5117 } 5118 } 5119 5120 // Did we encounter a breakpoint? 5121 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM) 5122 { 5123 dbg_breakpoint(fp->uf_name, SOURCING_LNUM); 5124 // Find next breakpoint. 5125 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 5126 SOURCING_LNUM); 5127 fcp->dbg_tick = debug_tick; 5128 } 5129 5130 return retval; 5131 } 5132 5133 /* 5134 * Return TRUE if the currently active function should be ended, because a 5135 * return was encountered or an error occurred. Used inside a ":while". 5136 */ 5137 int 5138 func_has_ended(void *cookie) 5139 { 5140 funccall_T *fcp = (funccall_T *)cookie; 5141 5142 // Ignore the "abort" flag if the abortion behavior has been changed due to 5143 // an error inside a try conditional. 5144 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 5145 || fcp->returned); 5146 } 5147 5148 /* 5149 * return TRUE if cookie indicates a function which "abort"s on errors. 5150 */ 5151 int 5152 func_has_abort( 5153 void *cookie) 5154 { 5155 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT; 5156 } 5157 5158 5159 /* 5160 * Turn "dict.Func" into a partial for "Func" bound to "dict". 5161 * Don't do this when "Func" is already a partial that was bound 5162 * explicitly (pt_auto is FALSE). 5163 * Changes "rettv" in-place. 5164 * Returns the updated "selfdict_in". 5165 */ 5166 dict_T * 5167 make_partial(dict_T *selfdict_in, typval_T *rettv) 5168 { 5169 char_u *fname; 5170 char_u *tofree = NULL; 5171 ufunc_T *fp; 5172 char_u fname_buf[FLEN_FIXED + 1]; 5173 int error; 5174 dict_T *selfdict = selfdict_in; 5175 5176 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL) 5177 fp = rettv->vval.v_partial->pt_func; 5178 else 5179 { 5180 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string 5181 : rettv->vval.v_partial->pt_name; 5182 // Translate "s:func" to the stored function name. 5183 fname = fname_trans_sid(fname, fname_buf, &tofree, &error); 5184 fp = find_func(fname, FALSE, NULL); 5185 vim_free(tofree); 5186 } 5187 5188 if (fp != NULL && (fp->uf_flags & FC_DICT)) 5189 { 5190 partial_T *pt = ALLOC_CLEAR_ONE(partial_T); 5191 5192 if (pt != NULL) 5193 { 5194 pt->pt_refcount = 1; 5195 pt->pt_dict = selfdict; 5196 pt->pt_auto = TRUE; 5197 selfdict = NULL; 5198 if (rettv->v_type == VAR_FUNC) 5199 { 5200 // Just a function: Take over the function name and use 5201 // selfdict. 5202 pt->pt_name = rettv->vval.v_string; 5203 } 5204 else 5205 { 5206 partial_T *ret_pt = rettv->vval.v_partial; 5207 int i; 5208 5209 // Partial: copy the function name, use selfdict and copy 5210 // args. Can't take over name or args, the partial might 5211 // be referenced elsewhere. 5212 if (ret_pt->pt_name != NULL) 5213 { 5214 pt->pt_name = vim_strsave(ret_pt->pt_name); 5215 func_ref(pt->pt_name); 5216 } 5217 else 5218 { 5219 pt->pt_func = ret_pt->pt_func; 5220 func_ptr_ref(pt->pt_func); 5221 } 5222 if (ret_pt->pt_argc > 0) 5223 { 5224 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc); 5225 if (pt->pt_argv == NULL) 5226 // out of memory: drop the arguments 5227 pt->pt_argc = 0; 5228 else 5229 { 5230 pt->pt_argc = ret_pt->pt_argc; 5231 for (i = 0; i < pt->pt_argc; i++) 5232 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]); 5233 } 5234 } 5235 partial_unref(ret_pt); 5236 } 5237 rettv->v_type = VAR_PARTIAL; 5238 rettv->vval.v_partial = pt; 5239 } 5240 } 5241 return selfdict; 5242 } 5243 5244 /* 5245 * Return the name of the executed function. 5246 */ 5247 char_u * 5248 func_name(void *cookie) 5249 { 5250 return ((funccall_T *)cookie)->func->uf_name; 5251 } 5252 5253 /* 5254 * Return the address holding the next breakpoint line for a funccall cookie. 5255 */ 5256 linenr_T * 5257 func_breakpoint(void *cookie) 5258 { 5259 return &((funccall_T *)cookie)->breakpoint; 5260 } 5261 5262 /* 5263 * Return the address holding the debug tick for a funccall cookie. 5264 */ 5265 int * 5266 func_dbg_tick(void *cookie) 5267 { 5268 return &((funccall_T *)cookie)->dbg_tick; 5269 } 5270 5271 /* 5272 * Return the nesting level for a funccall cookie. 5273 */ 5274 int 5275 func_level(void *cookie) 5276 { 5277 return ((funccall_T *)cookie)->level; 5278 } 5279 5280 /* 5281 * Return TRUE when a function was ended by a ":return" command. 5282 */ 5283 int 5284 current_func_returned(void) 5285 { 5286 return current_funccal->returned; 5287 } 5288 5289 int 5290 free_unref_funccal(int copyID, int testing) 5291 { 5292 int did_free = FALSE; 5293 int did_free_funccal = FALSE; 5294 funccall_T *fc, **pfc; 5295 5296 for (pfc = &previous_funccal; *pfc != NULL; ) 5297 { 5298 if (can_free_funccal(*pfc, copyID)) 5299 { 5300 fc = *pfc; 5301 *pfc = fc->caller; 5302 free_funccal_contents(fc); 5303 did_free = TRUE; 5304 did_free_funccal = TRUE; 5305 } 5306 else 5307 pfc = &(*pfc)->caller; 5308 } 5309 if (did_free_funccal) 5310 // When a funccal was freed some more items might be garbage 5311 // collected, so run again. 5312 (void)garbage_collect(testing); 5313 5314 return did_free; 5315 } 5316 5317 /* 5318 * Get function call environment based on backtrace debug level 5319 */ 5320 static funccall_T * 5321 get_funccal(void) 5322 { 5323 int i; 5324 funccall_T *funccal; 5325 funccall_T *temp_funccal; 5326 5327 funccal = current_funccal; 5328 if (debug_backtrace_level > 0) 5329 { 5330 for (i = 0; i < debug_backtrace_level; i++) 5331 { 5332 temp_funccal = funccal->caller; 5333 if (temp_funccal) 5334 funccal = temp_funccal; 5335 else 5336 // backtrace level overflow. reset to max 5337 debug_backtrace_level = i; 5338 } 5339 } 5340 return funccal; 5341 } 5342 5343 /* 5344 * Return the hashtable used for local variables in the current funccal. 5345 * Return NULL if there is no current funccal. 5346 */ 5347 hashtab_T * 5348 get_funccal_local_ht() 5349 { 5350 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5351 return NULL; 5352 return &get_funccal()->l_vars.dv_hashtab; 5353 } 5354 5355 /* 5356 * Return the l: scope variable. 5357 * Return NULL if there is no current funccal. 5358 */ 5359 dictitem_T * 5360 get_funccal_local_var() 5361 { 5362 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5363 return NULL; 5364 return &get_funccal()->l_vars_var; 5365 } 5366 5367 /* 5368 * Return the hashtable used for argument in the current funccal. 5369 * Return NULL if there is no current funccal. 5370 */ 5371 hashtab_T * 5372 get_funccal_args_ht() 5373 { 5374 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5375 return NULL; 5376 return &get_funccal()->l_avars.dv_hashtab; 5377 } 5378 5379 /* 5380 * Return the a: scope variable. 5381 * Return NULL if there is no current funccal. 5382 */ 5383 dictitem_T * 5384 get_funccal_args_var() 5385 { 5386 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 5387 return NULL; 5388 return &get_funccal()->l_avars_var; 5389 } 5390 5391 /* 5392 * List function variables, if there is a function. 5393 */ 5394 void 5395 list_func_vars(int *first) 5396 { 5397 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0) 5398 list_hashtable_vars(¤t_funccal->l_vars.dv_hashtab, 5399 "l:", FALSE, first); 5400 } 5401 5402 /* 5403 * If "ht" is the hashtable for local variables in the current funccal, return 5404 * the dict that contains it. 5405 * Otherwise return NULL. 5406 */ 5407 dict_T * 5408 get_current_funccal_dict(hashtab_T *ht) 5409 { 5410 if (current_funccal != NULL 5411 && ht == ¤t_funccal->l_vars.dv_hashtab) 5412 return ¤t_funccal->l_vars; 5413 return NULL; 5414 } 5415 5416 /* 5417 * Search hashitem in parent scope. 5418 */ 5419 hashitem_T * 5420 find_hi_in_scoped_ht(char_u *name, hashtab_T **pht) 5421 { 5422 funccall_T *old_current_funccal = current_funccal; 5423 hashtab_T *ht; 5424 hashitem_T *hi = NULL; 5425 char_u *varname; 5426 5427 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 5428 return NULL; 5429 5430 // Search in parent scope, which can be referenced from a lambda. 5431 current_funccal = current_funccal->func->uf_scoped; 5432 while (current_funccal != NULL) 5433 { 5434 ht = find_var_ht(name, &varname); 5435 if (ht != NULL && *varname != NUL) 5436 { 5437 hi = hash_find(ht, varname); 5438 if (!HASHITEM_EMPTY(hi)) 5439 { 5440 *pht = ht; 5441 break; 5442 } 5443 } 5444 if (current_funccal == current_funccal->func->uf_scoped) 5445 break; 5446 current_funccal = current_funccal->func->uf_scoped; 5447 } 5448 current_funccal = old_current_funccal; 5449 5450 return hi; 5451 } 5452 5453 /* 5454 * Search variable in parent scope. 5455 */ 5456 dictitem_T * 5457 find_var_in_scoped_ht(char_u *name, int no_autoload) 5458 { 5459 dictitem_T *v = NULL; 5460 funccall_T *old_current_funccal = current_funccal; 5461 hashtab_T *ht; 5462 char_u *varname; 5463 5464 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 5465 return NULL; 5466 5467 // Search in parent scope which is possible to reference from lambda 5468 current_funccal = current_funccal->func->uf_scoped; 5469 while (current_funccal) 5470 { 5471 ht = find_var_ht(name, &varname); 5472 if (ht != NULL && *varname != NUL) 5473 { 5474 v = find_var_in_ht(ht, *name, varname, no_autoload); 5475 if (v != NULL) 5476 break; 5477 } 5478 if (current_funccal == current_funccal->func->uf_scoped) 5479 break; 5480 current_funccal = current_funccal->func->uf_scoped; 5481 } 5482 current_funccal = old_current_funccal; 5483 5484 return v; 5485 } 5486 5487 /* 5488 * Set "copyID + 1" in previous_funccal and callers. 5489 */ 5490 int 5491 set_ref_in_previous_funccal(int copyID) 5492 { 5493 funccall_T *fc; 5494 5495 for (fc = previous_funccal; fc != NULL; fc = fc->caller) 5496 { 5497 fc->fc_copyID = copyID + 1; 5498 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL) 5499 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL) 5500 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL)) 5501 return TRUE; 5502 } 5503 return FALSE; 5504 } 5505 5506 static int 5507 set_ref_in_funccal(funccall_T *fc, int copyID) 5508 { 5509 if (fc->fc_copyID != copyID) 5510 { 5511 fc->fc_copyID = copyID; 5512 if (set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL) 5513 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL) 5514 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL) 5515 || set_ref_in_func(NULL, fc->func, copyID)) 5516 return TRUE; 5517 } 5518 return FALSE; 5519 } 5520 5521 /* 5522 * Set "copyID" in all local vars and arguments in the call stack. 5523 */ 5524 int 5525 set_ref_in_call_stack(int copyID) 5526 { 5527 funccall_T *fc; 5528 funccal_entry_T *entry; 5529 5530 for (fc = current_funccal; fc != NULL; fc = fc->caller) 5531 if (set_ref_in_funccal(fc, copyID)) 5532 return TRUE; 5533 5534 // Also go through the funccal_stack. 5535 for (entry = funccal_stack; entry != NULL; entry = entry->next) 5536 for (fc = entry->top_funccal; fc != NULL; fc = fc->caller) 5537 if (set_ref_in_funccal(fc, copyID)) 5538 return TRUE; 5539 return FALSE; 5540 } 5541 5542 /* 5543 * Set "copyID" in all functions available by name. 5544 */ 5545 int 5546 set_ref_in_functions(int copyID) 5547 { 5548 int todo; 5549 hashitem_T *hi = NULL; 5550 ufunc_T *fp; 5551 5552 todo = (int)func_hashtab.ht_used; 5553 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 5554 { 5555 if (!HASHITEM_EMPTY(hi)) 5556 { 5557 --todo; 5558 fp = HI2UF(hi); 5559 if (!func_name_refcount(fp->uf_name) 5560 && set_ref_in_func(NULL, fp, copyID)) 5561 return TRUE; 5562 } 5563 } 5564 return FALSE; 5565 } 5566 5567 /* 5568 * Set "copyID" in all function arguments. 5569 */ 5570 int 5571 set_ref_in_func_args(int copyID) 5572 { 5573 int i; 5574 5575 for (i = 0; i < funcargs.ga_len; ++i) 5576 if (set_ref_in_item(((typval_T **)funcargs.ga_data)[i], 5577 copyID, NULL, NULL)) 5578 return TRUE; 5579 return FALSE; 5580 } 5581 5582 /* 5583 * Mark all lists and dicts referenced through function "name" with "copyID". 5584 * Returns TRUE if setting references failed somehow. 5585 */ 5586 int 5587 set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID) 5588 { 5589 ufunc_T *fp = fp_in; 5590 funccall_T *fc; 5591 int error = FCERR_NONE; 5592 char_u fname_buf[FLEN_FIXED + 1]; 5593 char_u *tofree = NULL; 5594 char_u *fname; 5595 int abort = FALSE; 5596 5597 if (name == NULL && fp_in == NULL) 5598 return FALSE; 5599 5600 if (fp_in == NULL) 5601 { 5602 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 5603 fp = find_func(fname, FALSE, NULL); 5604 } 5605 if (fp != NULL) 5606 { 5607 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped) 5608 abort = abort || set_ref_in_funccal(fc, copyID); 5609 } 5610 5611 vim_free(tofree); 5612 return abort; 5613 } 5614 5615 #endif // FEAT_EVAL 5616