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