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