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