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