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 partial_unref(fp->uf_partial); 1229 fp->uf_partial = NULL; 1230 1231 #ifdef FEAT_LUA 1232 if (fp->uf_cb_free != NULL) 1233 { 1234 fp->uf_cb_free(fp->uf_cb_state); 1235 fp->uf_cb_free = NULL; 1236 } 1237 1238 fp->uf_cb_state = NULL; 1239 fp->uf_cb = NULL; 1240 #endif 1241 #ifdef FEAT_PROFILE 1242 VIM_CLEAR(fp->uf_tml_count); 1243 VIM_CLEAR(fp->uf_tml_total); 1244 VIM_CLEAR(fp->uf_tml_self); 1245 #endif 1246 } 1247 1248 /* 1249 * Free all things that a function contains. Does not free the function 1250 * itself, use func_free() for that. 1251 * When "force" is TRUE we are exiting. 1252 */ 1253 static void 1254 func_clear(ufunc_T *fp, int force) 1255 { 1256 if (fp->uf_cleared) 1257 return; 1258 fp->uf_cleared = TRUE; 1259 1260 // clear this function 1261 func_clear_items(fp); 1262 funccal_unref(fp->uf_scoped, fp, force); 1263 if ((fp->uf_flags & FC_COPY) == 0) 1264 clear_def_function(fp); 1265 } 1266 1267 /* 1268 * Free a function and remove it from the list of functions. Does not free 1269 * what a function contains, call func_clear() first. 1270 * When "force" is TRUE we are exiting. 1271 * Returns OK when the function was actually freed. 1272 */ 1273 static int 1274 func_free(ufunc_T *fp, int force) 1275 { 1276 // Only remove it when not done already, otherwise we would remove a newer 1277 // version of the function with the same name. 1278 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0) 1279 func_remove(fp); 1280 1281 if ((fp->uf_flags & FC_DEAD) == 0 || force) 1282 { 1283 if (fp->uf_dfunc_idx > 0) 1284 unlink_def_function(fp); 1285 VIM_CLEAR(fp->uf_name_exp); 1286 vim_free(fp); 1287 return OK; 1288 } 1289 return FAIL; 1290 } 1291 1292 /* 1293 * Free all things that a function contains and free the function itself. 1294 * When "force" is TRUE we are exiting. 1295 */ 1296 static void 1297 func_clear_free(ufunc_T *fp, int force) 1298 { 1299 func_clear(fp, force); 1300 if (force || fp->uf_dfunc_idx == 0 || func_name_refcount(fp->uf_name) 1301 || (fp->uf_flags & FC_COPY)) 1302 func_free(fp, force); 1303 else 1304 fp->uf_flags |= FC_DEAD; 1305 } 1306 1307 /* 1308 * Copy already defined function "lambda" to a new function with name "global". 1309 * This is for when a compiled function defines a global function. 1310 * Caller should take care of adding a partial for a closure. 1311 */ 1312 ufunc_T * 1313 copy_func(char_u *lambda, char_u *global) 1314 { 1315 ufunc_T *ufunc = find_func_even_dead(lambda, TRUE, NULL); 1316 ufunc_T *fp = NULL; 1317 1318 if (ufunc == NULL) 1319 semsg(_(e_lambda_function_not_found_str), lambda); 1320 else 1321 { 1322 // TODO: handle ! to overwrite 1323 fp = find_func(global, TRUE, NULL); 1324 if (fp != NULL) 1325 { 1326 semsg(_(e_funcexts), global); 1327 return NULL; 1328 } 1329 1330 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(global) + 1); 1331 if (fp == NULL) 1332 return NULL; 1333 1334 fp->uf_varargs = ufunc->uf_varargs; 1335 fp->uf_flags = (ufunc->uf_flags & ~FC_VIM9) | FC_COPY; 1336 fp->uf_def_status = ufunc->uf_def_status; 1337 fp->uf_dfunc_idx = ufunc->uf_dfunc_idx; 1338 if (ga_copy_strings(&ufunc->uf_args, &fp->uf_args) == FAIL 1339 || ga_copy_strings(&ufunc->uf_def_args, &fp->uf_def_args) 1340 == FAIL 1341 || ga_copy_strings(&ufunc->uf_lines, &fp->uf_lines) == FAIL) 1342 goto failed; 1343 1344 fp->uf_name_exp = ufunc->uf_name_exp == NULL ? NULL 1345 : vim_strsave(ufunc->uf_name_exp); 1346 if (ufunc->uf_arg_types != NULL) 1347 { 1348 fp->uf_arg_types = ALLOC_MULT(type_T *, fp->uf_args.ga_len); 1349 if (fp->uf_arg_types == NULL) 1350 goto failed; 1351 mch_memmove(fp->uf_arg_types, ufunc->uf_arg_types, 1352 sizeof(type_T *) * fp->uf_args.ga_len); 1353 } 1354 if (ufunc->uf_def_arg_idx != NULL) 1355 { 1356 fp->uf_def_arg_idx = ALLOC_MULT(int, fp->uf_def_args.ga_len + 1); 1357 if (fp->uf_def_arg_idx == NULL) 1358 goto failed; 1359 mch_memmove(fp->uf_def_arg_idx, ufunc->uf_def_arg_idx, 1360 sizeof(int) * fp->uf_def_args.ga_len + 1); 1361 } 1362 if (ufunc->uf_va_name != NULL) 1363 { 1364 fp->uf_va_name = vim_strsave(ufunc->uf_va_name); 1365 if (fp->uf_va_name == NULL) 1366 goto failed; 1367 } 1368 fp->uf_ret_type = ufunc->uf_ret_type; 1369 1370 fp->uf_refcount = 1; 1371 STRCPY(fp->uf_name, global); 1372 hash_add(&func_hashtab, UF2HIKEY(fp)); 1373 } 1374 return fp; 1375 1376 failed: 1377 func_clear_free(fp, TRUE); 1378 return NULL; 1379 } 1380 1381 static int funcdepth = 0; 1382 1383 /* 1384 * Increment the function call depth count. 1385 * Return FAIL when going over 'maxfuncdepth'. 1386 * Otherwise return OK, must call funcdepth_decrement() later! 1387 */ 1388 int 1389 funcdepth_increment(void) 1390 { 1391 if (funcdepth >= p_mfd) 1392 { 1393 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'")); 1394 return FAIL; 1395 } 1396 ++funcdepth; 1397 return OK; 1398 } 1399 1400 void 1401 funcdepth_decrement(void) 1402 { 1403 --funcdepth; 1404 } 1405 1406 /* 1407 * Get the current function call depth. 1408 */ 1409 int 1410 funcdepth_get(void) 1411 { 1412 return funcdepth; 1413 } 1414 1415 /* 1416 * Restore the function call depth. This is for cases where there is no 1417 * guarantee funcdepth_decrement() can be called exactly the same number of 1418 * times as funcdepth_increment(). 1419 */ 1420 void 1421 funcdepth_restore(int depth) 1422 { 1423 funcdepth = depth; 1424 } 1425 1426 /* 1427 * Call a user function. 1428 */ 1429 static void 1430 call_user_func( 1431 ufunc_T *fp, // pointer to function 1432 int argcount, // nr of args 1433 typval_T *argvars, // arguments 1434 typval_T *rettv, // return value 1435 funcexe_T *funcexe, // context 1436 dict_T *selfdict) // Dictionary for "self" 1437 { 1438 sctx_T save_current_sctx; 1439 int using_sandbox = FALSE; 1440 funccall_T *fc; 1441 int save_did_emsg; 1442 int default_arg_err = FALSE; 1443 dictitem_T *v; 1444 int fixvar_idx = 0; // index in fixvar[] 1445 int i; 1446 int ai; 1447 int islambda = FALSE; 1448 char_u numbuf[NUMBUFLEN]; 1449 char_u *name; 1450 #ifdef FEAT_PROFILE 1451 proftime_T wait_start; 1452 proftime_T call_start; 1453 int started_profiling = FALSE; 1454 #endif 1455 ESTACK_CHECK_DECLARATION 1456 1457 // If depth of calling is getting too high, don't execute the function. 1458 if (funcdepth_increment() == FAIL) 1459 { 1460 rettv->v_type = VAR_NUMBER; 1461 rettv->vval.v_number = -1; 1462 return; 1463 } 1464 1465 line_breakcheck(); // check for CTRL-C hit 1466 1467 fc = ALLOC_CLEAR_ONE(funccall_T); 1468 if (fc == NULL) 1469 return; 1470 fc->caller = current_funccal; 1471 current_funccal = fc; 1472 fc->func = fp; 1473 fc->rettv = rettv; 1474 fc->level = ex_nesting_level; 1475 // Check if this function has a breakpoint. 1476 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0); 1477 fc->dbg_tick = debug_tick; 1478 // Set up fields for closure. 1479 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1); 1480 func_ptr_ref(fp); 1481 1482 if (fp->uf_def_status != UF_NOT_COMPILED) 1483 { 1484 // Execute the function, possibly compiling it first. 1485 call_def_function(fp, argcount, argvars, funcexe->partial, rettv); 1486 funcdepth_decrement(); 1487 current_funccal = fc->caller; 1488 free_funccal(fc); 1489 return; 1490 } 1491 1492 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 1493 islambda = TRUE; 1494 1495 /* 1496 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables 1497 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free 1498 * each argument variable and saves a lot of time. 1499 */ 1500 /* 1501 * Init l: variables. 1502 */ 1503 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE); 1504 if (selfdict != NULL) 1505 { 1506 // Set l:self to "selfdict". Use "name" to avoid a warning from 1507 // some compiler that checks the destination size. 1508 v = &fc->fixvar[fixvar_idx++].var; 1509 name = v->di_key; 1510 STRCPY(name, "self"); 1511 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 1512 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 1513 v->di_tv.v_type = VAR_DICT; 1514 v->di_tv.v_lock = 0; 1515 v->di_tv.vval.v_dict = selfdict; 1516 ++selfdict->dv_refcount; 1517 } 1518 1519 /* 1520 * Init a: variables, unless none found (in lambda). 1521 * Set a:0 to "argcount" less number of named arguments, if >= 0. 1522 * Set a:000 to a list with room for the "..." arguments. 1523 */ 1524 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE); 1525 if ((fp->uf_flags & FC_NOARGS) == 0) 1526 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0", 1527 (varnumber_T)(argcount >= fp->uf_args.ga_len 1528 ? argcount - fp->uf_args.ga_len : 0)); 1529 fc->l_avars.dv_lock = VAR_FIXED; 1530 if ((fp->uf_flags & FC_NOARGS) == 0) 1531 { 1532 // Use "name" to avoid a warning from some compiler that checks the 1533 // destination size. 1534 v = &fc->fixvar[fixvar_idx++].var; 1535 name = v->di_key; 1536 STRCPY(name, "000"); 1537 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 1538 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 1539 v->di_tv.v_type = VAR_LIST; 1540 v->di_tv.v_lock = VAR_FIXED; 1541 v->di_tv.vval.v_list = &fc->l_varlist; 1542 } 1543 CLEAR_FIELD(fc->l_varlist); 1544 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT; 1545 fc->l_varlist.lv_lock = VAR_FIXED; 1546 1547 /* 1548 * Set a:firstline to "firstline" and a:lastline to "lastline". 1549 * Set a:name to named arguments. 1550 * Set a:N to the "..." arguments. 1551 * Skipped when no a: variables used (in lambda). 1552 */ 1553 if ((fp->uf_flags & FC_NOARGS) == 0) 1554 { 1555 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline", 1556 (varnumber_T)funcexe->firstline); 1557 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline", 1558 (varnumber_T)funcexe->lastline); 1559 } 1560 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i) 1561 { 1562 int addlocal = FALSE; 1563 typval_T def_rettv; 1564 int isdefault = FALSE; 1565 1566 ai = i - fp->uf_args.ga_len; 1567 if (ai < 0) 1568 { 1569 // named argument a:name 1570 name = FUNCARG(fp, i); 1571 if (islambda) 1572 addlocal = TRUE; 1573 1574 // evaluate named argument default expression 1575 isdefault = ai + fp->uf_def_args.ga_len >= 0 1576 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL 1577 && argvars[i].vval.v_number == VVAL_NONE)); 1578 if (isdefault) 1579 { 1580 char_u *default_expr = NULL; 1581 def_rettv.v_type = VAR_NUMBER; 1582 def_rettv.vval.v_number = -1; 1583 1584 default_expr = ((char_u **)(fp->uf_def_args.ga_data)) 1585 [ai + fp->uf_def_args.ga_len]; 1586 if (eval1(&default_expr, &def_rettv, &EVALARG_EVALUATE) == FAIL) 1587 { 1588 default_arg_err = 1; 1589 break; 1590 } 1591 } 1592 } 1593 else 1594 { 1595 if ((fp->uf_flags & FC_NOARGS) != 0) 1596 // Bail out if no a: arguments used (in lambda). 1597 break; 1598 1599 // "..." argument a:1, a:2, etc. 1600 sprintf((char *)numbuf, "%d", ai + 1); 1601 name = numbuf; 1602 } 1603 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN) 1604 { 1605 v = &fc->fixvar[fixvar_idx++].var; 1606 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 1607 STRCPY(v->di_key, name); 1608 } 1609 else 1610 { 1611 v = dictitem_alloc(name); 1612 if (v == NULL) 1613 break; 1614 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX; 1615 } 1616 1617 // Note: the values are copied directly to avoid alloc/free. 1618 // "argvars" must have VAR_FIXED for v_lock. 1619 v->di_tv = isdefault ? def_rettv : argvars[i]; 1620 v->di_tv.v_lock = VAR_FIXED; 1621 1622 if (addlocal) 1623 { 1624 // Named arguments should be accessed without the "a:" prefix in 1625 // lambda expressions. Add to the l: dict. 1626 copy_tv(&v->di_tv, &v->di_tv); 1627 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 1628 } 1629 else 1630 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 1631 1632 if (ai >= 0 && ai < MAX_FUNC_ARGS) 1633 { 1634 listitem_T *li = &fc->l_listitems[ai]; 1635 1636 li->li_tv = argvars[i]; 1637 li->li_tv.v_lock = VAR_FIXED; 1638 list_append(&fc->l_varlist, li); 1639 } 1640 } 1641 1642 // Don't redraw while executing the function. 1643 ++RedrawingDisabled; 1644 1645 if (fp->uf_flags & FC_SANDBOX) 1646 { 1647 using_sandbox = TRUE; 1648 ++sandbox; 1649 } 1650 1651 estack_push_ufunc(fp, 1); 1652 ESTACK_CHECK_SETUP 1653 if (p_verbose >= 12) 1654 { 1655 ++no_wait_return; 1656 verbose_enter_scroll(); 1657 1658 smsg(_("calling %s"), SOURCING_NAME); 1659 if (p_verbose >= 14) 1660 { 1661 char_u buf[MSG_BUF_LEN]; 1662 char_u numbuf2[NUMBUFLEN]; 1663 char_u *tofree; 1664 char_u *s; 1665 1666 msg_puts("("); 1667 for (i = 0; i < argcount; ++i) 1668 { 1669 if (i > 0) 1670 msg_puts(", "); 1671 if (argvars[i].v_type == VAR_NUMBER) 1672 msg_outnum((long)argvars[i].vval.v_number); 1673 else 1674 { 1675 // Do not want errors such as E724 here. 1676 ++emsg_off; 1677 s = tv2string(&argvars[i], &tofree, numbuf2, 0); 1678 --emsg_off; 1679 if (s != NULL) 1680 { 1681 if (vim_strsize(s) > MSG_BUF_CLEN) 1682 { 1683 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 1684 s = buf; 1685 } 1686 msg_puts((char *)s); 1687 vim_free(tofree); 1688 } 1689 } 1690 } 1691 msg_puts(")"); 1692 } 1693 msg_puts("\n"); // don't overwrite this either 1694 1695 verbose_leave_scroll(); 1696 --no_wait_return; 1697 } 1698 #ifdef FEAT_PROFILE 1699 if (do_profiling == PROF_YES) 1700 { 1701 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL)) 1702 { 1703 started_profiling = TRUE; 1704 func_do_profile(fp); 1705 } 1706 if (fp->uf_profiling 1707 || (fc->caller != NULL && fc->caller->func->uf_profiling)) 1708 { 1709 ++fp->uf_tm_count; 1710 profile_start(&call_start); 1711 profile_zero(&fp->uf_tm_children); 1712 } 1713 script_prof_save(&wait_start); 1714 } 1715 #endif 1716 1717 save_current_sctx = current_sctx; 1718 current_sctx = fp->uf_script_ctx; 1719 save_did_emsg = did_emsg; 1720 did_emsg = FALSE; 1721 1722 if (default_arg_err && (fp->uf_flags & FC_ABORT)) 1723 did_emsg = TRUE; 1724 else if (islambda) 1725 { 1726 char_u *p = *(char_u **)fp->uf_lines.ga_data + 7; 1727 1728 // A Lambda always has the command "return {expr}". It is much faster 1729 // to evaluate {expr} directly. 1730 ++ex_nesting_level; 1731 (void)eval1(&p, rettv, &EVALARG_EVALUATE); 1732 --ex_nesting_level; 1733 } 1734 else 1735 // call do_cmdline() to execute the lines 1736 do_cmdline(NULL, get_func_line, (void *)fc, 1737 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT); 1738 1739 --RedrawingDisabled; 1740 1741 // when the function was aborted because of an error, return -1 1742 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN) 1743 { 1744 clear_tv(rettv); 1745 rettv->v_type = VAR_NUMBER; 1746 rettv->vval.v_number = -1; 1747 } 1748 1749 #ifdef FEAT_PROFILE 1750 if (do_profiling == PROF_YES && (fp->uf_profiling 1751 || (fc->caller != NULL && fc->caller->func->uf_profiling))) 1752 { 1753 profile_end(&call_start); 1754 profile_sub_wait(&wait_start, &call_start); 1755 profile_add(&fp->uf_tm_total, &call_start); 1756 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children); 1757 if (fc->caller != NULL && fc->caller->func->uf_profiling) 1758 { 1759 profile_add(&fc->caller->func->uf_tm_children, &call_start); 1760 profile_add(&fc->caller->func->uf_tml_children, &call_start); 1761 } 1762 if (started_profiling) 1763 // make a ":profdel func" stop profiling the function 1764 fp->uf_profiling = FALSE; 1765 } 1766 #endif 1767 1768 // when being verbose, mention the return value 1769 if (p_verbose >= 12) 1770 { 1771 ++no_wait_return; 1772 verbose_enter_scroll(); 1773 1774 if (aborting()) 1775 smsg(_("%s aborted"), SOURCING_NAME); 1776 else if (fc->rettv->v_type == VAR_NUMBER) 1777 smsg(_("%s returning #%ld"), SOURCING_NAME, 1778 (long)fc->rettv->vval.v_number); 1779 else 1780 { 1781 char_u buf[MSG_BUF_LEN]; 1782 char_u numbuf2[NUMBUFLEN]; 1783 char_u *tofree; 1784 char_u *s; 1785 1786 // The value may be very long. Skip the middle part, so that we 1787 // have some idea how it starts and ends. smsg() would always 1788 // truncate it at the end. Don't want errors such as E724 here. 1789 ++emsg_off; 1790 s = tv2string(fc->rettv, &tofree, numbuf2, 0); 1791 --emsg_off; 1792 if (s != NULL) 1793 { 1794 if (vim_strsize(s) > MSG_BUF_CLEN) 1795 { 1796 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 1797 s = buf; 1798 } 1799 smsg(_("%s returning %s"), SOURCING_NAME, s); 1800 vim_free(tofree); 1801 } 1802 } 1803 msg_puts("\n"); // don't overwrite this either 1804 1805 verbose_leave_scroll(); 1806 --no_wait_return; 1807 } 1808 1809 ESTACK_CHECK_NOW 1810 estack_pop(); 1811 current_sctx = save_current_sctx; 1812 #ifdef FEAT_PROFILE 1813 if (do_profiling == PROF_YES) 1814 script_prof_restore(&wait_start); 1815 #endif 1816 if (using_sandbox) 1817 --sandbox; 1818 1819 if (p_verbose >= 12 && SOURCING_NAME != NULL) 1820 { 1821 ++no_wait_return; 1822 verbose_enter_scroll(); 1823 1824 smsg(_("continuing in %s"), SOURCING_NAME); 1825 msg_puts("\n"); // don't overwrite this either 1826 1827 verbose_leave_scroll(); 1828 --no_wait_return; 1829 } 1830 1831 did_emsg |= save_did_emsg; 1832 funcdepth_decrement(); 1833 cleanup_function_call(fc); 1834 } 1835 1836 /* 1837 * Check the argument count for user function "fp". 1838 * Return FCERR_UNKNOWN if OK, FCERR_TOOFEW or FCERR_TOOMANY otherwise. 1839 */ 1840 int 1841 check_user_func_argcount(ufunc_T *fp, int argcount) 1842 { 1843 int regular_args = fp->uf_args.ga_len; 1844 1845 if (argcount < regular_args - fp->uf_def_args.ga_len) 1846 return FCERR_TOOFEW; 1847 else if (!has_varargs(fp) && argcount > regular_args) 1848 return FCERR_TOOMANY; 1849 return FCERR_UNKNOWN; 1850 } 1851 1852 /* 1853 * Call a user function after checking the arguments. 1854 */ 1855 int 1856 call_user_func_check( 1857 ufunc_T *fp, 1858 int argcount, 1859 typval_T *argvars, 1860 typval_T *rettv, 1861 funcexe_T *funcexe, 1862 dict_T *selfdict) 1863 { 1864 int error; 1865 1866 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL) 1867 *funcexe->doesrange = TRUE; 1868 error = check_user_func_argcount(fp, argcount); 1869 if (error != FCERR_UNKNOWN) 1870 return error; 1871 if ((fp->uf_flags & FC_DICT) && selfdict == NULL) 1872 error = FCERR_DICT; 1873 else 1874 { 1875 int did_save_redo = FALSE; 1876 save_redo_T save_redo; 1877 1878 /* 1879 * Call the user function. 1880 * Save and restore search patterns, script variables and 1881 * redo buffer. 1882 */ 1883 save_search_patterns(); 1884 if (!ins_compl_active()) 1885 { 1886 saveRedobuff(&save_redo); 1887 did_save_redo = TRUE; 1888 } 1889 ++fp->uf_calls; 1890 call_user_func(fp, argcount, argvars, rettv, funcexe, 1891 (fp->uf_flags & FC_DICT) ? selfdict : NULL); 1892 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0) 1893 // Function was unreferenced while being used, free it now. 1894 func_clear_free(fp, FALSE); 1895 if (did_save_redo) 1896 restoreRedobuff(&save_redo); 1897 restore_search_patterns(); 1898 error = FCERR_NONE; 1899 } 1900 return error; 1901 } 1902 1903 static funccal_entry_T *funccal_stack = NULL; 1904 1905 /* 1906 * Save the current function call pointer, and set it to NULL. 1907 * Used when executing autocommands and for ":source". 1908 */ 1909 void 1910 save_funccal(funccal_entry_T *entry) 1911 { 1912 entry->top_funccal = current_funccal; 1913 entry->next = funccal_stack; 1914 funccal_stack = entry; 1915 current_funccal = NULL; 1916 } 1917 1918 void 1919 restore_funccal(void) 1920 { 1921 if (funccal_stack == NULL) 1922 iemsg("INTERNAL: restore_funccal()"); 1923 else 1924 { 1925 current_funccal = funccal_stack->top_funccal; 1926 funccal_stack = funccal_stack->next; 1927 } 1928 } 1929 1930 funccall_T * 1931 get_current_funccal(void) 1932 { 1933 return current_funccal; 1934 } 1935 1936 /* 1937 * Mark all functions of script "sid" as deleted. 1938 */ 1939 void 1940 delete_script_functions(int sid) 1941 { 1942 hashitem_T *hi; 1943 ufunc_T *fp; 1944 long_u todo = 1; 1945 char_u buf[30]; 1946 size_t len; 1947 1948 buf[0] = K_SPECIAL; 1949 buf[1] = KS_EXTRA; 1950 buf[2] = (int)KE_SNR; 1951 sprintf((char *)buf + 3, "%d_", sid); 1952 len = STRLEN(buf); 1953 1954 while (todo > 0) 1955 { 1956 todo = func_hashtab.ht_used; 1957 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 1958 if (!HASHITEM_EMPTY(hi)) 1959 { 1960 fp = HI2UF(hi); 1961 if (STRNCMP(fp->uf_name, buf, len) == 0) 1962 { 1963 int changed = func_hashtab.ht_changed; 1964 1965 fp->uf_flags |= FC_DEAD; 1966 func_clear(fp, TRUE); 1967 // When clearing a function another function can be cleared 1968 // as a side effect. When that happens start over. 1969 if (changed != func_hashtab.ht_changed) 1970 break; 1971 } 1972 --todo; 1973 } 1974 } 1975 } 1976 1977 #if defined(EXITFREE) || defined(PROTO) 1978 void 1979 free_all_functions(void) 1980 { 1981 hashitem_T *hi; 1982 ufunc_T *fp; 1983 long_u skipped = 0; 1984 long_u todo = 1; 1985 int changed; 1986 1987 // Clean up the current_funccal chain and the funccal stack. 1988 while (current_funccal != NULL) 1989 { 1990 clear_tv(current_funccal->rettv); 1991 cleanup_function_call(current_funccal); 1992 if (current_funccal == NULL && funccal_stack != NULL) 1993 restore_funccal(); 1994 } 1995 1996 // First clear what the functions contain. Since this may lower the 1997 // reference count of a function, it may also free a function and change 1998 // the hash table. Restart if that happens. 1999 while (todo > 0) 2000 { 2001 todo = func_hashtab.ht_used; 2002 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2003 if (!HASHITEM_EMPTY(hi)) 2004 { 2005 // clear the def function index now 2006 fp = HI2UF(hi); 2007 fp->uf_flags &= ~FC_DEAD; 2008 fp->uf_def_status = UF_NOT_COMPILED; 2009 2010 // Only free functions that are not refcounted, those are 2011 // supposed to be freed when no longer referenced. 2012 if (func_name_refcount(fp->uf_name)) 2013 ++skipped; 2014 else 2015 { 2016 changed = func_hashtab.ht_changed; 2017 func_clear(fp, TRUE); 2018 if (changed != func_hashtab.ht_changed) 2019 { 2020 skipped = 0; 2021 break; 2022 } 2023 } 2024 --todo; 2025 } 2026 } 2027 2028 // Now actually free the functions. Need to start all over every time, 2029 // because func_free() may change the hash table. 2030 skipped = 0; 2031 while (func_hashtab.ht_used > skipped) 2032 { 2033 todo = func_hashtab.ht_used; 2034 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 2035 if (!HASHITEM_EMPTY(hi)) 2036 { 2037 --todo; 2038 // Only free functions that are not refcounted, those are 2039 // supposed to be freed when no longer referenced. 2040 fp = HI2UF(hi); 2041 if (func_name_refcount(fp->uf_name)) 2042 ++skipped; 2043 else 2044 { 2045 if (func_free(fp, FALSE) == OK) 2046 { 2047 skipped = 0; 2048 break; 2049 } 2050 // did not actually free it 2051 ++skipped; 2052 } 2053 } 2054 } 2055 if (skipped == 0) 2056 hash_clear(&func_hashtab); 2057 2058 free_def_functions(); 2059 } 2060 #endif 2061 2062 /* 2063 * Return TRUE if "name" looks like a builtin function name: starts with a 2064 * lower case letter and doesn't contain AUTOLOAD_CHAR or ':'. 2065 * "len" is the length of "name", or -1 for NUL terminated. 2066 */ 2067 int 2068 builtin_function(char_u *name, int len) 2069 { 2070 char_u *p; 2071 2072 if (!ASCII_ISLOWER(name[0]) || name[1] == ':') 2073 return FALSE; 2074 p = vim_strchr(name, AUTOLOAD_CHAR); 2075 return p == NULL || (len > 0 && p > name + len); 2076 } 2077 2078 int 2079 func_call( 2080 char_u *name, 2081 typval_T *args, 2082 partial_T *partial, 2083 dict_T *selfdict, 2084 typval_T *rettv) 2085 { 2086 list_T *l = args->vval.v_list; 2087 listitem_T *item; 2088 typval_T argv[MAX_FUNC_ARGS + 1]; 2089 int argc = 0; 2090 int r = 0; 2091 2092 CHECK_LIST_MATERIALIZE(l); 2093 FOR_ALL_LIST_ITEMS(l, item) 2094 { 2095 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc)) 2096 { 2097 emsg(_("E699: Too many arguments")); 2098 break; 2099 } 2100 // Make a copy of each argument. This is needed to be able to set 2101 // v_lock to VAR_FIXED in the copy without changing the original list. 2102 copy_tv(&item->li_tv, &argv[argc++]); 2103 } 2104 2105 if (item == NULL) 2106 { 2107 funcexe_T funcexe; 2108 2109 CLEAR_FIELD(funcexe); 2110 funcexe.firstline = curwin->w_cursor.lnum; 2111 funcexe.lastline = curwin->w_cursor.lnum; 2112 funcexe.evaluate = TRUE; 2113 funcexe.partial = partial; 2114 funcexe.selfdict = selfdict; 2115 r = call_func(name, -1, rettv, argc, argv, &funcexe); 2116 } 2117 2118 // Free the arguments. 2119 while (argc > 0) 2120 clear_tv(&argv[--argc]); 2121 2122 return r; 2123 } 2124 2125 static int callback_depth = 0; 2126 2127 int 2128 get_callback_depth(void) 2129 { 2130 return callback_depth; 2131 } 2132 2133 /* 2134 * Invoke call_func() with a callback. 2135 */ 2136 int 2137 call_callback( 2138 callback_T *callback, 2139 int len, // length of "name" or -1 to use strlen() 2140 typval_T *rettv, // return value goes here 2141 int argcount, // number of "argvars" 2142 typval_T *argvars) // vars for arguments, must have "argcount" 2143 // PLUS ONE elements! 2144 { 2145 funcexe_T funcexe; 2146 int ret; 2147 2148 CLEAR_FIELD(funcexe); 2149 funcexe.evaluate = TRUE; 2150 funcexe.partial = callback->cb_partial; 2151 ++callback_depth; 2152 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe); 2153 --callback_depth; 2154 return ret; 2155 } 2156 2157 /* 2158 * Give an error message for the result of a function. 2159 * Nothing if "error" is FCERR_NONE. 2160 */ 2161 void 2162 user_func_error(int error, char_u *name) 2163 { 2164 switch (error) 2165 { 2166 case FCERR_UNKNOWN: 2167 emsg_funcname(e_unknownfunc, name); 2168 break; 2169 case FCERR_NOTMETHOD: 2170 emsg_funcname( 2171 N_("E276: Cannot use function as a method: %s"), name); 2172 break; 2173 case FCERR_DELETED: 2174 emsg_funcname(N_(e_func_deleted), name); 2175 break; 2176 case FCERR_TOOMANY: 2177 emsg_funcname((char *)e_toomanyarg, name); 2178 break; 2179 case FCERR_TOOFEW: 2180 emsg_funcname((char *)e_toofewarg, name); 2181 break; 2182 case FCERR_SCRIPT: 2183 emsg_funcname( 2184 N_("E120: Using <SID> not in a script context: %s"), name); 2185 break; 2186 case FCERR_DICT: 2187 emsg_funcname( 2188 N_("E725: Calling dict function without Dictionary: %s"), 2189 name); 2190 break; 2191 } 2192 } 2193 2194 /* 2195 * Call a function with its resolved parameters 2196 * 2197 * Return FAIL when the function can't be called, OK otherwise. 2198 * Also returns OK when an error was encountered while executing the function. 2199 */ 2200 int 2201 call_func( 2202 char_u *funcname, // name of the function 2203 int len, // length of "name" or -1 to use strlen() 2204 typval_T *rettv, // return value goes here 2205 int argcount_in, // number of "argvars" 2206 typval_T *argvars_in, // vars for arguments, must have "argcount" 2207 // PLUS ONE elements! 2208 funcexe_T *funcexe) // more arguments 2209 { 2210 int ret = FAIL; 2211 int error = FCERR_NONE; 2212 int i; 2213 ufunc_T *fp = NULL; 2214 char_u fname_buf[FLEN_FIXED + 1]; 2215 char_u *tofree = NULL; 2216 char_u *fname = NULL; 2217 char_u *name = NULL; 2218 int argcount = argcount_in; 2219 typval_T *argvars = argvars_in; 2220 dict_T *selfdict = funcexe->selfdict; 2221 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or 2222 // "funcexe->basetv" is not NULL 2223 int argv_clear = 0; 2224 int argv_base = 0; 2225 partial_T *partial = funcexe->partial; 2226 2227 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv) 2228 // even when call_func() returns FAIL. 2229 rettv->v_type = VAR_UNKNOWN; 2230 2231 if (partial != NULL) 2232 fp = partial->pt_func; 2233 if (fp == NULL) 2234 { 2235 // Make a copy of the name, if it comes from a funcref variable it 2236 // could be changed or deleted in the called function. 2237 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname); 2238 if (name == NULL) 2239 return ret; 2240 2241 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 2242 } 2243 2244 if (funcexe->doesrange != NULL) 2245 *funcexe->doesrange = FALSE; 2246 2247 if (partial != NULL) 2248 { 2249 // When the function has a partial with a dict and there is a dict 2250 // argument, use the dict argument. That is backwards compatible. 2251 // When the dict was bound explicitly use the one from the partial. 2252 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto)) 2253 selfdict = partial->pt_dict; 2254 if (error == FCERR_NONE && partial->pt_argc > 0) 2255 { 2256 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear) 2257 { 2258 if (argv_clear + argcount_in >= MAX_FUNC_ARGS) 2259 { 2260 error = FCERR_TOOMANY; 2261 goto theend; 2262 } 2263 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]); 2264 } 2265 for (i = 0; i < argcount_in; ++i) 2266 argv[i + argv_clear] = argvars_in[i]; 2267 argvars = argv; 2268 argcount = partial->pt_argc + argcount_in; 2269 } 2270 } 2271 2272 if (error == FCERR_NONE && funcexe->evaluate) 2273 { 2274 char_u *rfname = fname; 2275 int is_global = FALSE; 2276 2277 // Skip "g:" before a function name. 2278 if (fp == NULL && fname[0] == 'g' && fname[1] == ':') 2279 { 2280 is_global = TRUE; 2281 rfname = fname + 2; 2282 } 2283 2284 rettv->v_type = VAR_NUMBER; // default rettv is number zero 2285 rettv->vval.v_number = 0; 2286 error = FCERR_UNKNOWN; 2287 2288 if (fp != NULL || !builtin_function(rfname, -1)) 2289 { 2290 /* 2291 * User defined function. 2292 */ 2293 if (fp == NULL) 2294 fp = find_func(rfname, is_global, NULL); 2295 2296 // Trigger FuncUndefined event, may load the function. 2297 if (fp == NULL 2298 && apply_autocmds(EVENT_FUNCUNDEFINED, 2299 rfname, rfname, TRUE, NULL) 2300 && !aborting()) 2301 { 2302 // executed an autocommand, search for the function again 2303 fp = find_func(rfname, is_global, NULL); 2304 } 2305 // Try loading a package. 2306 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting()) 2307 { 2308 // loaded a package, search for the function again 2309 fp = find_func(rfname, is_global, NULL); 2310 } 2311 if (fp == NULL) 2312 { 2313 char_u *p = untrans_function_name(rfname); 2314 2315 // If using Vim9 script try not local to the script. 2316 // Don't do this if the name starts with "s:". 2317 if (p != NULL && (funcname[0] != 's' || funcname[1] != ':')) 2318 fp = find_func(p, is_global, NULL); 2319 } 2320 2321 if (fp != NULL && (fp->uf_flags & FC_DELETED)) 2322 error = FCERR_DELETED; 2323 #ifdef FEAT_LUA 2324 else if (fp != NULL && (fp->uf_flags & FC_CFUNC)) 2325 { 2326 cfunc_T cb = fp->uf_cb; 2327 2328 error = (*cb)(argcount, argvars, rettv, fp->uf_cb_state); 2329 } 2330 #endif 2331 else if (fp != NULL) 2332 { 2333 if (funcexe->argv_func != NULL) 2334 // postponed filling in the arguments, do it now 2335 argcount = funcexe->argv_func(argcount, argvars, argv_clear, 2336 fp->uf_args.ga_len); 2337 2338 if (funcexe->basetv != NULL) 2339 { 2340 // Method call: base->Method() 2341 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount); 2342 argv[0] = *funcexe->basetv; 2343 argcount++; 2344 argvars = argv; 2345 argv_base = 1; 2346 } 2347 2348 error = call_user_func_check(fp, argcount, argvars, rettv, 2349 funcexe, selfdict); 2350 } 2351 } 2352 else if (funcexe->basetv != NULL) 2353 { 2354 /* 2355 * expr->method(): Find the method name in the table, call its 2356 * implementation with the base as one of the arguments. 2357 */ 2358 error = call_internal_method(fname, argcount, argvars, rettv, 2359 funcexe->basetv); 2360 } 2361 else 2362 { 2363 /* 2364 * Find the function name in the table, call its implementation. 2365 */ 2366 error = call_internal_func(fname, argcount, argvars, rettv); 2367 } 2368 2369 /* 2370 * The function call (or "FuncUndefined" autocommand sequence) might 2371 * have been aborted by an error, an interrupt, or an explicitly thrown 2372 * exception that has not been caught so far. This situation can be 2373 * tested for by calling aborting(). For an error in an internal 2374 * function or for the "E132" error in call_user_func(), however, the 2375 * throw point at which the "force_abort" flag (temporarily reset by 2376 * emsg()) is normally updated has not been reached yet. We need to 2377 * update that flag first to make aborting() reliable. 2378 */ 2379 update_force_abort(); 2380 } 2381 if (error == FCERR_NONE) 2382 ret = OK; 2383 2384 theend: 2385 /* 2386 * Report an error unless the argument evaluation or function call has been 2387 * cancelled due to an aborting error, an interrupt, or an exception. 2388 */ 2389 if (!aborting()) 2390 { 2391 user_func_error(error, (name != NULL) ? name : funcname); 2392 } 2393 2394 // clear the copies made from the partial 2395 while (argv_clear > 0) 2396 clear_tv(&argv[--argv_clear + argv_base]); 2397 2398 vim_free(tofree); 2399 vim_free(name); 2400 2401 return ret; 2402 } 2403 2404 char_u * 2405 printable_func_name(ufunc_T *fp) 2406 { 2407 return fp->uf_name_exp != NULL ? fp->uf_name_exp : fp->uf_name; 2408 } 2409 2410 /* 2411 * List the head of the function: "function name(arg1, arg2)". 2412 */ 2413 static void 2414 list_func_head(ufunc_T *fp, int indent) 2415 { 2416 int j; 2417 2418 msg_start(); 2419 if (indent) 2420 msg_puts(" "); 2421 if (fp->uf_def_status != UF_NOT_COMPILED) 2422 msg_puts("def "); 2423 else 2424 msg_puts("function "); 2425 msg_puts((char *)printable_func_name(fp)); 2426 msg_putchar('('); 2427 for (j = 0; j < fp->uf_args.ga_len; ++j) 2428 { 2429 if (j) 2430 msg_puts(", "); 2431 msg_puts((char *)FUNCARG(fp, j)); 2432 if (fp->uf_arg_types != NULL) 2433 { 2434 char *tofree; 2435 2436 msg_puts(": "); 2437 msg_puts(type_name(fp->uf_arg_types[j], &tofree)); 2438 vim_free(tofree); 2439 } 2440 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len) 2441 { 2442 msg_puts(" = "); 2443 msg_puts(((char **)(fp->uf_def_args.ga_data)) 2444 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]); 2445 } 2446 } 2447 if (fp->uf_varargs) 2448 { 2449 if (j) 2450 msg_puts(", "); 2451 msg_puts("..."); 2452 } 2453 if (fp->uf_va_name != NULL) 2454 { 2455 if (j) 2456 msg_puts(", "); 2457 msg_puts("..."); 2458 msg_puts((char *)fp->uf_va_name); 2459 if (fp->uf_va_type) 2460 { 2461 char *tofree; 2462 2463 msg_puts(": "); 2464 msg_puts(type_name(fp->uf_va_type, &tofree)); 2465 vim_free(tofree); 2466 } 2467 } 2468 msg_putchar(')'); 2469 2470 if (fp->uf_def_status != UF_NOT_COMPILED) 2471 { 2472 if (fp->uf_ret_type != &t_void) 2473 { 2474 char *tofree; 2475 2476 msg_puts(": "); 2477 msg_puts(type_name(fp->uf_ret_type, &tofree)); 2478 vim_free(tofree); 2479 } 2480 } 2481 else if (fp->uf_flags & FC_ABORT) 2482 msg_puts(" abort"); 2483 if (fp->uf_flags & FC_RANGE) 2484 msg_puts(" range"); 2485 if (fp->uf_flags & FC_DICT) 2486 msg_puts(" dict"); 2487 if (fp->uf_flags & FC_CLOSURE) 2488 msg_puts(" closure"); 2489 msg_clr_eos(); 2490 if (p_verbose > 0) 2491 last_set_msg(fp->uf_script_ctx); 2492 } 2493 2494 /* 2495 * Get a function name, translating "<SID>" and "<SNR>". 2496 * Also handles a Funcref in a List or Dictionary. 2497 * Returns the function name in allocated memory, or NULL for failure. 2498 * Set "*is_global" to TRUE when the function must be global, unless 2499 * "is_global" is NULL. 2500 * flags: 2501 * TFN_INT: internal function name OK 2502 * TFN_QUIET: be quiet 2503 * TFN_NO_AUTOLOAD: do not use script autoloading 2504 * TFN_NO_DEREF: do not dereference a Funcref 2505 * Advances "pp" to just after the function name (if no error). 2506 */ 2507 char_u * 2508 trans_function_name( 2509 char_u **pp, 2510 int *is_global, 2511 int skip, // only find the end, don't evaluate 2512 int flags, 2513 funcdict_T *fdp, // return: info about dictionary used 2514 partial_T **partial) // return: partial of a FuncRef 2515 { 2516 char_u *name = NULL; 2517 char_u *start; 2518 char_u *end; 2519 int lead; 2520 char_u sid_buf[20]; 2521 int len; 2522 int extra = 0; 2523 lval_T lv; 2524 int vim9script; 2525 static char *e_function_name = N_("E129: Function name required"); 2526 2527 if (fdp != NULL) 2528 CLEAR_POINTER(fdp); 2529 start = *pp; 2530 2531 // Check for hard coded <SNR>: already translated function ID (from a user 2532 // command). 2533 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA 2534 && (*pp)[2] == (int)KE_SNR) 2535 { 2536 *pp += 3; 2537 len = get_id_len(pp) + 3; 2538 return vim_strnsave(start, len); 2539 } 2540 2541 // A name starting with "<SID>" or "<SNR>" is local to a script. But 2542 // don't skip over "s:", get_lval() needs it for "s:dict.func". 2543 lead = eval_fname_script(start); 2544 if (lead > 2) 2545 start += lead; 2546 2547 // Note that TFN_ flags use the same values as GLV_ flags. 2548 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY, 2549 lead > 2 ? 0 : FNE_CHECK_START); 2550 if (end == start) 2551 { 2552 if (!skip) 2553 emsg(_(e_function_name)); 2554 goto theend; 2555 } 2556 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range))) 2557 { 2558 /* 2559 * Report an invalid expression in braces, unless the expression 2560 * evaluation has been cancelled due to an aborting error, an 2561 * interrupt, or an exception. 2562 */ 2563 if (!aborting()) 2564 { 2565 if (end != NULL) 2566 semsg(_(e_invarg2), start); 2567 } 2568 else 2569 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR); 2570 goto theend; 2571 } 2572 2573 if (lv.ll_tv != NULL) 2574 { 2575 if (fdp != NULL) 2576 { 2577 fdp->fd_dict = lv.ll_dict; 2578 fdp->fd_newkey = lv.ll_newkey; 2579 lv.ll_newkey = NULL; 2580 fdp->fd_di = lv.ll_di; 2581 } 2582 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL) 2583 { 2584 name = vim_strsave(lv.ll_tv->vval.v_string); 2585 *pp = end; 2586 } 2587 else if (lv.ll_tv->v_type == VAR_PARTIAL 2588 && lv.ll_tv->vval.v_partial != NULL) 2589 { 2590 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial)); 2591 *pp = end; 2592 if (partial != NULL) 2593 *partial = lv.ll_tv->vval.v_partial; 2594 } 2595 else 2596 { 2597 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL 2598 || lv.ll_dict == NULL || fdp->fd_newkey == NULL)) 2599 emsg(_(e_funcref)); 2600 else 2601 *pp = end; 2602 name = NULL; 2603 } 2604 goto theend; 2605 } 2606 2607 if (lv.ll_name == NULL) 2608 { 2609 // Error found, but continue after the function name. 2610 *pp = end; 2611 goto theend; 2612 } 2613 2614 // Check if the name is a Funcref. If so, use the value. 2615 if (lv.ll_exp_name != NULL) 2616 { 2617 len = (int)STRLEN(lv.ll_exp_name); 2618 name = deref_func_name(lv.ll_exp_name, &len, partial, 2619 flags & TFN_NO_AUTOLOAD); 2620 if (name == lv.ll_exp_name) 2621 name = NULL; 2622 } 2623 else if (!(flags & TFN_NO_DEREF)) 2624 { 2625 len = (int)(end - *pp); 2626 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD); 2627 if (name == *pp) 2628 name = NULL; 2629 } 2630 if (name != NULL) 2631 { 2632 name = vim_strsave(name); 2633 *pp = end; 2634 if (STRNCMP(name, "<SNR>", 5) == 0) 2635 { 2636 // Change "<SNR>" to the byte sequence. 2637 name[0] = K_SPECIAL; 2638 name[1] = KS_EXTRA; 2639 name[2] = (int)KE_SNR; 2640 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1); 2641 } 2642 goto theend; 2643 } 2644 2645 if (lv.ll_exp_name != NULL) 2646 { 2647 len = (int)STRLEN(lv.ll_exp_name); 2648 if (lead <= 2 && lv.ll_name == lv.ll_exp_name 2649 && STRNCMP(lv.ll_name, "s:", 2) == 0) 2650 { 2651 // When there was "s:" already or the name expanded to get a 2652 // leading "s:" then remove it. 2653 lv.ll_name += 2; 2654 len -= 2; 2655 lead = 2; 2656 } 2657 } 2658 else 2659 { 2660 // skip over "s:" and "g:" 2661 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':')) 2662 { 2663 if (is_global != NULL && lv.ll_name[0] == 'g') 2664 *is_global = TRUE; 2665 lv.ll_name += 2; 2666 } 2667 len = (int)(end - lv.ll_name); 2668 } 2669 if (len <= 0) 2670 { 2671 if (!skip) 2672 emsg(_(e_function_name)); 2673 goto theend; 2674 } 2675 2676 // In Vim9 script a user function is script-local by default, unless it 2677 // starts with a lower case character: dict.func(). 2678 vim9script = ASCII_ISUPPER(*start) && in_vim9script(); 2679 if (vim9script) 2680 { 2681 char_u *p; 2682 2683 // SomeScript#func() is a global function. 2684 for (p = start; *p != NUL && *p != '('; ++p) 2685 if (*p == AUTOLOAD_CHAR) 2686 vim9script = FALSE; 2687 } 2688 2689 /* 2690 * Copy the function name to allocated memory. 2691 * Accept <SID>name() inside a script, translate into <SNR>123_name(). 2692 * Accept <SNR>123_name() outside a script. 2693 */ 2694 if (skip) 2695 lead = 0; // do nothing 2696 else if (lead > 0 || vim9script) 2697 { 2698 if (!vim9script) 2699 lead = 3; 2700 if (vim9script || (lv.ll_exp_name != NULL 2701 && eval_fname_sid(lv.ll_exp_name)) 2702 || eval_fname_sid(*pp)) 2703 { 2704 // It's script-local, "s:" or "<SID>" 2705 if (current_sctx.sc_sid <= 0) 2706 { 2707 emsg(_(e_usingsid)); 2708 goto theend; 2709 } 2710 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid); 2711 if (vim9script) 2712 extra = 3 + (int)STRLEN(sid_buf); 2713 else 2714 lead += (int)STRLEN(sid_buf); 2715 } 2716 } 2717 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len)) 2718 { 2719 semsg(_("E128: Function name must start with a capital or \"s:\": %s"), 2720 start); 2721 goto theend; 2722 } 2723 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF)) 2724 { 2725 char_u *cp = vim_strchr(lv.ll_name, ':'); 2726 2727 if (cp != NULL && cp < end) 2728 { 2729 semsg(_("E884: Function name cannot contain a colon: %s"), start); 2730 goto theend; 2731 } 2732 } 2733 2734 name = alloc(len + lead + extra + 1); 2735 if (name != NULL) 2736 { 2737 if (!skip && (lead > 0 || vim9script)) 2738 { 2739 name[0] = K_SPECIAL; 2740 name[1] = KS_EXTRA; 2741 name[2] = (int)KE_SNR; 2742 if (vim9script || lead > 3) // If it's "<SID>" 2743 STRCPY(name + 3, sid_buf); 2744 } 2745 mch_memmove(name + lead + extra, lv.ll_name, (size_t)len); 2746 name[lead + extra + len] = NUL; 2747 } 2748 *pp = end; 2749 2750 theend: 2751 clear_lval(&lv); 2752 return name; 2753 } 2754 2755 /* 2756 * Assuming "name" is the result of trans_function_name() and it was prefixed 2757 * to use the script-local name, return the unmodified name (points into 2758 * "name"). Otherwise return NULL. 2759 * This can be used to first search for a script-local function and fall back 2760 * to the global function if not found. 2761 */ 2762 char_u * 2763 untrans_function_name(char_u *name) 2764 { 2765 char_u *p; 2766 2767 if (*name == K_SPECIAL && in_vim9script()) 2768 { 2769 p = vim_strchr(name, '_'); 2770 if (p != NULL) 2771 return p + 1; 2772 } 2773 return NULL; 2774 } 2775 2776 /* 2777 * List functions. When "regmatch" is NULL all of then. 2778 * Otherwise functions matching "regmatch". 2779 */ 2780 void 2781 list_functions(regmatch_T *regmatch) 2782 { 2783 int changed = func_hashtab.ht_changed; 2784 long_u todo = func_hashtab.ht_used; 2785 hashitem_T *hi; 2786 2787 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 2788 { 2789 if (!HASHITEM_EMPTY(hi)) 2790 { 2791 ufunc_T *fp = HI2UF(hi); 2792 2793 --todo; 2794 if ((fp->uf_flags & FC_DEAD) == 0 2795 && (regmatch == NULL 2796 ? !message_filtered(fp->uf_name) 2797 && !func_name_refcount(fp->uf_name) 2798 : !isdigit(*fp->uf_name) 2799 && vim_regexec(regmatch, fp->uf_name, 0))) 2800 { 2801 list_func_head(fp, FALSE); 2802 if (changed != func_hashtab.ht_changed) 2803 { 2804 emsg(_("E454: function list was modified")); 2805 return; 2806 } 2807 } 2808 } 2809 } 2810 } 2811 2812 /* 2813 * ":function" also supporting nested ":def". 2814 * When "name_arg" is not NULL this is a nested function, using "name_arg" for 2815 * the function name. 2816 * Returns a pointer to the function or NULL if no function defined. 2817 */ 2818 ufunc_T * 2819 define_function(exarg_T *eap, char_u *name_arg) 2820 { 2821 char_u *theline; 2822 char_u *line_to_free = NULL; 2823 int j; 2824 int c; 2825 int saved_did_emsg; 2826 int saved_wait_return = need_wait_return; 2827 char_u *name = name_arg; 2828 int is_global = FALSE; 2829 char_u *p; 2830 char_u *arg; 2831 char_u *line_arg = NULL; 2832 garray_T newargs; 2833 garray_T argtypes; 2834 garray_T default_args; 2835 garray_T newlines; 2836 int varargs = FALSE; 2837 int flags = 0; 2838 char_u *ret_type = NULL; 2839 ufunc_T *fp = NULL; 2840 int overwrite = FALSE; 2841 int indent; 2842 int nesting; 2843 #define MAX_FUNC_NESTING 50 2844 char nesting_def[MAX_FUNC_NESTING]; 2845 dictitem_T *v; 2846 funcdict_T fudi; 2847 static int func_nr = 0; // number for nameless function 2848 int paren; 2849 hashitem_T *hi; 2850 getline_opt_T getline_options = GETLINE_CONCAT_CONT; 2851 linenr_T sourcing_lnum_off; 2852 linenr_T sourcing_lnum_top; 2853 int is_heredoc = FALSE; 2854 char_u *skip_until = NULL; 2855 char_u *heredoc_trimmed = NULL; 2856 int vim9script = in_vim9script(); 2857 imported_T *import = NULL; 2858 2859 /* 2860 * ":function" without argument: list functions. 2861 */ 2862 if (ends_excmd2(eap->cmd, eap->arg)) 2863 { 2864 if (!eap->skip) 2865 list_functions(NULL); 2866 eap->nextcmd = check_nextcmd(eap->arg); 2867 return NULL; 2868 } 2869 2870 /* 2871 * ":function /pat": list functions matching pattern. 2872 */ 2873 if (*eap->arg == '/') 2874 { 2875 p = skip_regexp(eap->arg + 1, '/', TRUE); 2876 if (!eap->skip) 2877 { 2878 regmatch_T regmatch; 2879 2880 c = *p; 2881 *p = NUL; 2882 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC); 2883 *p = c; 2884 if (regmatch.regprog != NULL) 2885 { 2886 regmatch.rm_ic = p_ic; 2887 list_functions(®match); 2888 vim_regfree(regmatch.regprog); 2889 } 2890 } 2891 if (*p == '/') 2892 ++p; 2893 eap->nextcmd = check_nextcmd(p); 2894 return NULL; 2895 } 2896 2897 ga_init(&newargs); 2898 ga_init(&argtypes); 2899 ga_init(&default_args); 2900 2901 /* 2902 * Get the function name. There are these situations: 2903 * func normal function name 2904 * "name" == func, "fudi.fd_dict" == NULL 2905 * dict.func new dictionary entry 2906 * "name" == NULL, "fudi.fd_dict" set, 2907 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func 2908 * dict.func existing dict entry with a Funcref 2909 * "name" == func, "fudi.fd_dict" set, 2910 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 2911 * dict.func existing dict entry that's not a Funcref 2912 * "name" == NULL, "fudi.fd_dict" set, 2913 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 2914 * s:func script-local function name 2915 * g:func global function name, same as "func" 2916 */ 2917 p = eap->arg; 2918 if (name_arg != NULL) 2919 { 2920 // nested function, argument is (args). 2921 paren = TRUE; 2922 CLEAR_FIELD(fudi); 2923 } 2924 else 2925 { 2926 name = trans_function_name(&p, &is_global, eap->skip, 2927 TFN_NO_AUTOLOAD, &fudi, NULL); 2928 paren = (vim_strchr(p, '(') != NULL); 2929 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip) 2930 { 2931 /* 2932 * Return on an invalid expression in braces, unless the expression 2933 * evaluation has been cancelled due to an aborting error, an 2934 * interrupt, or an exception. 2935 */ 2936 if (!aborting()) 2937 { 2938 if (!eap->skip && fudi.fd_newkey != NULL) 2939 semsg(_(e_dictkey), fudi.fd_newkey); 2940 vim_free(fudi.fd_newkey); 2941 return NULL; 2942 } 2943 else 2944 eap->skip = TRUE; 2945 } 2946 } 2947 2948 // An error in a function call during evaluation of an expression in magic 2949 // braces should not cause the function not to be defined. 2950 saved_did_emsg = did_emsg; 2951 did_emsg = FALSE; 2952 2953 /* 2954 * ":function func" with only function name: list function. 2955 */ 2956 if (!paren) 2957 { 2958 if (!ends_excmd(*skipwhite(p))) 2959 { 2960 semsg(_(e_trailing_arg), p); 2961 goto ret_free; 2962 } 2963 eap->nextcmd = check_nextcmd(p); 2964 if (eap->nextcmd != NULL) 2965 *p = NUL; 2966 if (!eap->skip && !got_int) 2967 { 2968 fp = find_func(name, is_global, NULL); 2969 if (fp == NULL && ASCII_ISUPPER(*eap->arg)) 2970 { 2971 char_u *up = untrans_function_name(name); 2972 2973 // With Vim9 script the name was made script-local, if not 2974 // found try again with the original name. 2975 if (up != NULL) 2976 fp = find_func(up, FALSE, NULL); 2977 } 2978 2979 if (fp != NULL) 2980 { 2981 list_func_head(fp, TRUE); 2982 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j) 2983 { 2984 if (FUNCLINE(fp, j) == NULL) 2985 continue; 2986 msg_putchar('\n'); 2987 msg_outnum((long)(j + 1)); 2988 if (j < 9) 2989 msg_putchar(' '); 2990 if (j < 99) 2991 msg_putchar(' '); 2992 msg_prt_line(FUNCLINE(fp, j), FALSE); 2993 out_flush(); // show a line at a time 2994 ui_breakcheck(); 2995 } 2996 if (!got_int) 2997 { 2998 msg_putchar('\n'); 2999 if (fp->uf_def_status != UF_NOT_COMPILED) 3000 msg_puts(" enddef"); 3001 else 3002 msg_puts(" endfunction"); 3003 } 3004 } 3005 else 3006 emsg_funcname(N_("E123: Undefined function: %s"), eap->arg); 3007 } 3008 goto ret_free; 3009 } 3010 3011 /* 3012 * ":function name(arg1, arg2)" Define function. 3013 */ 3014 p = skipwhite(p); 3015 if (*p != '(') 3016 { 3017 if (!eap->skip) 3018 { 3019 semsg(_("E124: Missing '(': %s"), eap->arg); 3020 goto ret_free; 3021 } 3022 // attempt to continue by skipping some text 3023 if (vim_strchr(p, '(') != NULL) 3024 p = vim_strchr(p, '('); 3025 } 3026 p = skipwhite(p + 1); 3027 3028 // In Vim9 script only global functions can be redefined. 3029 if (vim9script && eap->forceit && !is_global) 3030 { 3031 emsg(_(e_nobang)); 3032 goto ret_free; 3033 } 3034 3035 ga_init2(&newlines, (int)sizeof(char_u *), 3); 3036 3037 if (!eap->skip && name_arg == NULL) 3038 { 3039 // Check the name of the function. Unless it's a dictionary function 3040 // (that we are overwriting). 3041 if (name != NULL) 3042 arg = name; 3043 else 3044 arg = fudi.fd_newkey; 3045 if (arg != NULL && (fudi.fd_di == NULL 3046 || (fudi.fd_di->di_tv.v_type != VAR_FUNC 3047 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL))) 3048 { 3049 if (*arg == K_SPECIAL) 3050 j = 3; 3051 else 3052 j = 0; 3053 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j]) 3054 : eval_isnamec(arg[j]))) 3055 ++j; 3056 if (arg[j] != NUL) 3057 emsg_funcname((char *)e_invarg2, arg); 3058 } 3059 // Disallow using the g: dict. 3060 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE) 3061 emsg(_("E862: Cannot use g: here")); 3062 } 3063 3064 // This may get more lines and make the pointers into the first line 3065 // invalid. 3066 if (get_function_args(&p, ')', &newargs, 3067 eap->cmdidx == CMD_def ? &argtypes : NULL, FALSE, 3068 &varargs, &default_args, eap->skip, 3069 eap, &line_to_free) == FAIL) 3070 goto errret_2; 3071 3072 if (eap->cmdidx == CMD_def) 3073 { 3074 // find the return type: :def Func(): type 3075 if (*p == ':') 3076 { 3077 ret_type = skipwhite(p + 1); 3078 p = skip_type(ret_type, FALSE); 3079 if (p > ret_type) 3080 { 3081 ret_type = vim_strnsave(ret_type, p - ret_type); 3082 p = skipwhite(p); 3083 } 3084 else 3085 { 3086 semsg(_(e_expected_type_str), ret_type); 3087 ret_type = NULL; 3088 } 3089 } 3090 p = skipwhite(p); 3091 } 3092 else 3093 // find extra arguments "range", "dict", "abort" and "closure" 3094 for (;;) 3095 { 3096 p = skipwhite(p); 3097 if (STRNCMP(p, "range", 5) == 0) 3098 { 3099 flags |= FC_RANGE; 3100 p += 5; 3101 } 3102 else if (STRNCMP(p, "dict", 4) == 0) 3103 { 3104 flags |= FC_DICT; 3105 p += 4; 3106 } 3107 else if (STRNCMP(p, "abort", 5) == 0) 3108 { 3109 flags |= FC_ABORT; 3110 p += 5; 3111 } 3112 else if (STRNCMP(p, "closure", 7) == 0) 3113 { 3114 flags |= FC_CLOSURE; 3115 p += 7; 3116 if (current_funccal == NULL) 3117 { 3118 emsg_funcname(N_("E932: Closure function should not be at top level: %s"), 3119 name == NULL ? (char_u *)"" : name); 3120 goto erret; 3121 } 3122 } 3123 else 3124 break; 3125 } 3126 3127 // When there is a line break use what follows for the function body. 3128 // Makes 'exe "func Test()\n...\nendfunc"' work. 3129 if (*p == '\n') 3130 line_arg = p + 1; 3131 else if (*p != NUL 3132 && !(*p == '"' && (!vim9script || eap->cmdidx == CMD_function) 3133 && eap->cmdidx != CMD_def) 3134 && !(*p == '#' && (vim9script || eap->cmdidx == CMD_def)) 3135 && !eap->skip 3136 && !did_emsg) 3137 semsg(_(e_trailing_arg), p); 3138 3139 /* 3140 * Read the body of the function, until "}", ":endfunction" or ":enddef" is 3141 * found. 3142 */ 3143 if (KeyTyped) 3144 { 3145 // Check if the function already exists, don't let the user type the 3146 // whole function before telling him it doesn't work! For a script we 3147 // need to skip the body to be able to find what follows. 3148 if (!eap->skip && !eap->forceit) 3149 { 3150 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL) 3151 emsg(_(e_funcdict)); 3152 else if (name != NULL && find_func(name, is_global, NULL) != NULL) 3153 emsg_funcname(e_funcexts, name); 3154 } 3155 3156 if (!eap->skip && did_emsg) 3157 goto erret; 3158 3159 msg_putchar('\n'); // don't overwrite the function name 3160 cmdline_row = msg_row; 3161 } 3162 3163 // Save the starting line number. 3164 sourcing_lnum_top = SOURCING_LNUM; 3165 3166 // Detect having skipped over comment lines to find the return 3167 // type. Add NULL lines to keep the line count correct. 3168 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie); 3169 if (SOURCING_LNUM < sourcing_lnum_off) 3170 { 3171 sourcing_lnum_off -= SOURCING_LNUM; 3172 if (ga_grow(&newlines, sourcing_lnum_off) == FAIL) 3173 goto erret; 3174 while (sourcing_lnum_off-- > 0) 3175 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL; 3176 } 3177 3178 indent = 2; 3179 nesting = 0; 3180 nesting_def[nesting] = (eap->cmdidx == CMD_def); 3181 for (;;) 3182 { 3183 if (KeyTyped) 3184 { 3185 msg_scroll = TRUE; 3186 saved_wait_return = FALSE; 3187 } 3188 need_wait_return = FALSE; 3189 3190 if (line_arg != NULL) 3191 { 3192 // Use eap->arg, split up in parts by line breaks. 3193 theline = line_arg; 3194 p = vim_strchr(theline, '\n'); 3195 if (p == NULL) 3196 line_arg += STRLEN(line_arg); 3197 else 3198 { 3199 *p = NUL; 3200 line_arg = p + 1; 3201 } 3202 } 3203 else 3204 { 3205 vim_free(line_to_free); 3206 if (eap->getline == NULL) 3207 theline = getcmdline(':', 0L, indent, getline_options); 3208 else 3209 theline = eap->getline(':', eap->cookie, indent, 3210 getline_options); 3211 line_to_free = theline; 3212 } 3213 if (KeyTyped) 3214 lines_left = Rows - 1; 3215 if (theline == NULL) 3216 { 3217 if (skip_until != NULL) 3218 semsg(_(e_missing_heredoc_end_marker_str), skip_until); 3219 else if (eap->cmdidx == CMD_def) 3220 emsg(_(e_missing_enddef)); 3221 else 3222 emsg(_("E126: Missing :endfunction")); 3223 goto erret; 3224 } 3225 3226 // Detect line continuation: SOURCING_LNUM increased more than one. 3227 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie); 3228 if (SOURCING_LNUM < sourcing_lnum_off) 3229 sourcing_lnum_off -= SOURCING_LNUM; 3230 else 3231 sourcing_lnum_off = 0; 3232 3233 if (skip_until != NULL) 3234 { 3235 // Don't check for ":endfunc"/":enddef" between 3236 // * ":append" and "." 3237 // * ":python <<EOF" and "EOF" 3238 // * ":let {var-name} =<< [trim] {marker}" and "{marker}" 3239 if (heredoc_trimmed == NULL 3240 || (is_heredoc && skipwhite(theline) == theline) 3241 || STRNCMP(theline, heredoc_trimmed, 3242 STRLEN(heredoc_trimmed)) == 0) 3243 { 3244 if (heredoc_trimmed == NULL) 3245 p = theline; 3246 else if (is_heredoc) 3247 p = skipwhite(theline) == theline 3248 ? theline : theline + STRLEN(heredoc_trimmed); 3249 else 3250 p = theline + STRLEN(heredoc_trimmed); 3251 if (STRCMP(p, skip_until) == 0) 3252 { 3253 VIM_CLEAR(skip_until); 3254 VIM_CLEAR(heredoc_trimmed); 3255 getline_options = GETLINE_CONCAT_CONT; 3256 is_heredoc = FALSE; 3257 } 3258 } 3259 } 3260 else 3261 { 3262 // skip ':' and blanks 3263 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p) 3264 ; 3265 3266 // Check for "endfunction" or "enddef". 3267 if (checkforcmd(&p, nesting_def[nesting] 3268 ? "enddef" : "endfunction", 4) && nesting-- == 0) 3269 { 3270 char_u *nextcmd = NULL; 3271 3272 if (*p == '|') 3273 nextcmd = p + 1; 3274 else if (line_arg != NULL && *skipwhite(line_arg) != NUL) 3275 nextcmd = line_arg; 3276 else if (*p != NUL && *p != '"' && p_verbose > 0) 3277 give_warning2(eap->cmdidx == CMD_def 3278 ? (char_u *)_("W1001: Text found after :enddef: %s") 3279 : (char_u *)_("W22: Text found after :endfunction: %s"), 3280 p, TRUE); 3281 if (nextcmd != NULL) 3282 { 3283 // Another command follows. If the line came from "eap" we 3284 // can simply point into it, otherwise we need to change 3285 // "eap->cmdlinep". 3286 eap->nextcmd = nextcmd; 3287 if (line_to_free != NULL) 3288 { 3289 vim_free(*eap->cmdlinep); 3290 *eap->cmdlinep = line_to_free; 3291 line_to_free = NULL; 3292 } 3293 } 3294 break; 3295 } 3296 3297 // Increase indent inside "if", "while", "for" and "try", decrease 3298 // at "end". 3299 if (indent > 2 && (*p == '}' || STRNCMP(p, "end", 3) == 0)) 3300 indent -= 2; 3301 else if (STRNCMP(p, "if", 2) == 0 3302 || STRNCMP(p, "wh", 2) == 0 3303 || STRNCMP(p, "for", 3) == 0 3304 || STRNCMP(p, "try", 3) == 0) 3305 indent += 2; 3306 3307 // Check for defining a function inside this function. 3308 // Only recognize "def" inside "def", not inside "function", 3309 // For backwards compatibility, see Test_function_python(). 3310 c = *p; 3311 if (checkforcmd(&p, "function", 2) 3312 || (eap->cmdidx == CMD_def && checkforcmd(&p, "def", 3))) 3313 { 3314 if (*p == '!') 3315 p = skipwhite(p + 1); 3316 p += eval_fname_script(p); 3317 vim_free(trans_function_name(&p, NULL, TRUE, 0, NULL, NULL)); 3318 if (*skipwhite(p) == '(') 3319 { 3320 if (nesting == MAX_FUNC_NESTING - 1) 3321 emsg(_(e_function_nesting_too_deep)); 3322 else 3323 { 3324 ++nesting; 3325 nesting_def[nesting] = (c == 'd'); 3326 indent += 2; 3327 } 3328 } 3329 } 3330 3331 // Check for ":append", ":change", ":insert". Not for :def. 3332 p = skip_range(p, FALSE, NULL); 3333 if (eap->cmdidx != CMD_def 3334 && ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p')) 3335 || (p[0] == 'c' 3336 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h' 3337 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a' 3338 && (STRNCMP(&p[3], "nge", 3) != 0 3339 || !ASCII_ISALPHA(p[6]))))))) 3340 || (p[0] == 'i' 3341 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n' 3342 && (!ASCII_ISALPHA(p[2]) 3343 || (p[2] == 's' 3344 && (!ASCII_ISALPHA(p[3]) 3345 || p[3] == 'e')))))))) 3346 skip_until = vim_strsave((char_u *)"."); 3347 3348 // Check for ":python <<EOF", ":tcl <<EOF", etc. 3349 arg = skipwhite(skiptowhite(p)); 3350 if (arg[0] == '<' && arg[1] =='<' 3351 && ((p[0] == 'p' && p[1] == 'y' 3352 && (!ASCII_ISALNUM(p[2]) || p[2] == 't' 3353 || ((p[2] == '3' || p[2] == 'x') 3354 && !ASCII_ISALPHA(p[3])))) 3355 || (p[0] == 'p' && p[1] == 'e' 3356 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r')) 3357 || (p[0] == 't' && p[1] == 'c' 3358 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l')) 3359 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a' 3360 && !ASCII_ISALPHA(p[3])) 3361 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b' 3362 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y')) 3363 || (p[0] == 'm' && p[1] == 'z' 3364 && (!ASCII_ISALPHA(p[2]) || p[2] == 's')) 3365 )) 3366 { 3367 // ":python <<" continues until a dot, like ":append" 3368 p = skipwhite(arg + 2); 3369 if (STRNCMP(p, "trim", 4) == 0) 3370 { 3371 // Ignore leading white space. 3372 p = skipwhite(p + 4); 3373 heredoc_trimmed = vim_strnsave(theline, 3374 skipwhite(theline) - theline); 3375 } 3376 if (*p == NUL) 3377 skip_until = vim_strsave((char_u *)"."); 3378 else 3379 skip_until = vim_strnsave(p, skiptowhite(p) - p); 3380 getline_options = GETLINE_NONE; 3381 is_heredoc = TRUE; 3382 } 3383 3384 // Check for ":cmd v =<< [trim] EOF" 3385 // and ":cmd [a, b] =<< [trim] EOF" 3386 // and "lines =<< [trim] EOF" for Vim9 3387 // Where "cmd" can be "let", "var", "final" or "const". 3388 arg = skipwhite(skiptowhite(p)); 3389 if (*arg == '[') 3390 arg = vim_strchr(arg, ']'); 3391 if (arg != NULL) 3392 { 3393 int found = (eap->cmdidx == CMD_def && arg[0] == '=' 3394 && arg[1] == '<' && arg[2] =='<'); 3395 3396 if (!found) 3397 // skip over the argument after "cmd" 3398 arg = skipwhite(skiptowhite(arg)); 3399 if (found || (arg[0] == '=' && arg[1] == '<' && arg[2] =='<' 3400 && (checkforcmd(&p, "let", 2) 3401 || checkforcmd(&p, "var", 3) 3402 || checkforcmd(&p, "final", 5) 3403 || checkforcmd(&p, "const", 5)))) 3404 { 3405 p = skipwhite(arg + 3); 3406 if (STRNCMP(p, "trim", 4) == 0) 3407 { 3408 // Ignore leading white space. 3409 p = skipwhite(p + 4); 3410 heredoc_trimmed = vim_strnsave(theline, 3411 skipwhite(theline) - theline); 3412 } 3413 skip_until = vim_strnsave(p, skiptowhite(p) - p); 3414 getline_options = GETLINE_NONE; 3415 is_heredoc = TRUE; 3416 } 3417 } 3418 } 3419 3420 // Add the line to the function. 3421 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL) 3422 goto erret; 3423 3424 // Copy the line to newly allocated memory. get_one_sourceline() 3425 // allocates 250 bytes per line, this saves 80% on average. The cost 3426 // is an extra alloc/free. 3427 p = vim_strsave(theline); 3428 if (p == NULL) 3429 goto erret; 3430 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p; 3431 3432 // Add NULL lines for continuation lines, so that the line count is 3433 // equal to the index in the growarray. 3434 while (sourcing_lnum_off-- > 0) 3435 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL; 3436 3437 // Check for end of eap->arg. 3438 if (line_arg != NULL && *line_arg == NUL) 3439 line_arg = NULL; 3440 } 3441 3442 // Don't define the function when skipping commands or when an error was 3443 // detected. 3444 if (eap->skip || did_emsg) 3445 goto erret; 3446 3447 /* 3448 * If there are no errors, add the function 3449 */ 3450 if (fudi.fd_dict == NULL) 3451 { 3452 hashtab_T *ht; 3453 3454 v = find_var(name, &ht, FALSE); 3455 if (v != NULL && v->di_tv.v_type == VAR_FUNC) 3456 { 3457 emsg_funcname(N_("E707: Function name conflicts with variable: %s"), 3458 name); 3459 goto erret; 3460 } 3461 3462 fp = find_func_even_dead(name, is_global, NULL); 3463 if (vim9script) 3464 { 3465 char_u *uname = untrans_function_name(name); 3466 3467 import = find_imported(uname == NULL ? name : uname, 0, NULL); 3468 } 3469 3470 if (fp != NULL || import != NULL) 3471 { 3472 int dead = fp != NULL && (fp->uf_flags & FC_DEAD); 3473 3474 // Function can be replaced with "function!" and when sourcing the 3475 // same script again, but only once. 3476 // A name that is used by an import can not be overruled. 3477 if (import != NULL 3478 || (!dead && !eap->forceit 3479 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid 3480 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq))) 3481 { 3482 if (vim9script) 3483 emsg_funcname(e_name_already_defined_str, name); 3484 else 3485 emsg_funcname(e_funcexts, name); 3486 goto erret; 3487 } 3488 if (fp->uf_calls > 0) 3489 { 3490 emsg_funcname( 3491 N_("E127: Cannot redefine function %s: It is in use"), 3492 name); 3493 goto erret; 3494 } 3495 if (fp->uf_refcount > 1) 3496 { 3497 // This function is referenced somewhere, don't redefine it but 3498 // create a new one. 3499 --fp->uf_refcount; 3500 fp->uf_flags |= FC_REMOVED; 3501 fp = NULL; 3502 overwrite = TRUE; 3503 } 3504 else 3505 { 3506 char_u *exp_name = fp->uf_name_exp; 3507 3508 // redefine existing function, keep the expanded name 3509 VIM_CLEAR(name); 3510 fp->uf_name_exp = NULL; 3511 func_clear_items(fp); 3512 fp->uf_name_exp = exp_name; 3513 fp->uf_flags &= ~FC_DEAD; 3514 #ifdef FEAT_PROFILE 3515 fp->uf_profiling = FALSE; 3516 fp->uf_prof_initialized = FALSE; 3517 #endif 3518 clear_def_function(fp); 3519 } 3520 } 3521 } 3522 else 3523 { 3524 char numbuf[20]; 3525 3526 fp = NULL; 3527 if (fudi.fd_newkey == NULL && !eap->forceit) 3528 { 3529 emsg(_(e_funcdict)); 3530 goto erret; 3531 } 3532 if (fudi.fd_di == NULL) 3533 { 3534 // Can't add a function to a locked dictionary 3535 if (value_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE)) 3536 goto erret; 3537 } 3538 // Can't change an existing function if it is locked 3539 else if (value_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE)) 3540 goto erret; 3541 3542 // Give the function a sequential number. Can only be used with a 3543 // Funcref! 3544 vim_free(name); 3545 sprintf(numbuf, "%d", ++func_nr); 3546 name = vim_strsave((char_u *)numbuf); 3547 if (name == NULL) 3548 goto erret; 3549 } 3550 3551 if (fp == NULL) 3552 { 3553 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL) 3554 { 3555 int slen, plen; 3556 char_u *scriptname; 3557 3558 // Check that the autoload name matches the script name. 3559 j = FAIL; 3560 if (SOURCING_NAME != NULL) 3561 { 3562 scriptname = autoload_name(name); 3563 if (scriptname != NULL) 3564 { 3565 p = vim_strchr(scriptname, '/'); 3566 plen = (int)STRLEN(p); 3567 slen = (int)STRLEN(SOURCING_NAME); 3568 if (slen > plen && fnamecmp(p, 3569 SOURCING_NAME + slen - plen) == 0) 3570 j = OK; 3571 vim_free(scriptname); 3572 } 3573 } 3574 if (j == FAIL) 3575 { 3576 semsg(_("E746: Function name does not match script file name: %s"), name); 3577 goto erret; 3578 } 3579 } 3580 3581 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 3582 if (fp == NULL) 3583 goto erret; 3584 fp->uf_def_status = eap->cmdidx == CMD_def ? UF_TO_BE_COMPILED 3585 : UF_NOT_COMPILED; 3586 3587 if (fudi.fd_dict != NULL) 3588 { 3589 if (fudi.fd_di == NULL) 3590 { 3591 // add new dict entry 3592 fudi.fd_di = dictitem_alloc(fudi.fd_newkey); 3593 if (fudi.fd_di == NULL) 3594 { 3595 vim_free(fp); 3596 fp = NULL; 3597 goto erret; 3598 } 3599 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL) 3600 { 3601 vim_free(fudi.fd_di); 3602 vim_free(fp); 3603 fp = NULL; 3604 goto erret; 3605 } 3606 } 3607 else 3608 // overwrite existing dict entry 3609 clear_tv(&fudi.fd_di->di_tv); 3610 fudi.fd_di->di_tv.v_type = VAR_FUNC; 3611 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name); 3612 3613 // behave like "dict" was used 3614 flags |= FC_DICT; 3615 } 3616 3617 // insert the new function in the function list 3618 set_ufunc_name(fp, name); 3619 if (overwrite) 3620 { 3621 hi = hash_find(&func_hashtab, name); 3622 hi->hi_key = UF2HIKEY(fp); 3623 } 3624 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL) 3625 { 3626 vim_free(fp); 3627 fp = NULL; 3628 goto erret; 3629 } 3630 fp->uf_refcount = 1; 3631 } 3632 fp->uf_args = newargs; 3633 fp->uf_def_args = default_args; 3634 fp->uf_ret_type = &t_any; 3635 fp->uf_func_type = &t_func_any; 3636 3637 if (eap->cmdidx == CMD_def) 3638 { 3639 int lnum_save = SOURCING_LNUM; 3640 cstack_T *cstack = eap->cstack; 3641 3642 fp->uf_def_status = UF_TO_BE_COMPILED; 3643 3644 // error messages are for the first function line 3645 SOURCING_LNUM = sourcing_lnum_top; 3646 3647 if (cstack != NULL && cstack->cs_idx >= 0) 3648 { 3649 int count = cstack->cs_idx + 1; 3650 int i; 3651 3652 // The block context may be needed for script variables declared in 3653 // a block that is visible now but not when the function is called 3654 // later. 3655 fp->uf_block_ids = ALLOC_MULT(int, count); 3656 if (fp->uf_block_ids != NULL) 3657 { 3658 mch_memmove(fp->uf_block_ids, cstack->cs_block_id, 3659 sizeof(int) * count); 3660 fp->uf_block_depth = count; 3661 } 3662 3663 // Set flag in each block to indicate a function was defined. This 3664 // is used to keep the variable when leaving the block, see 3665 // hide_script_var(). 3666 for (i = 0; i <= cstack->cs_idx; ++i) 3667 cstack->cs_flags[i] |= CSF_FUNC_DEF; 3668 } 3669 3670 if (parse_argument_types(fp, &argtypes, varargs) == FAIL) 3671 { 3672 SOURCING_LNUM = lnum_save; 3673 goto errret_2; 3674 } 3675 varargs = FALSE; 3676 3677 // parse the return type, if any 3678 if (ret_type == NULL) 3679 fp->uf_ret_type = &t_void; 3680 else 3681 { 3682 p = ret_type; 3683 fp->uf_ret_type = parse_type(&p, &fp->uf_type_list); 3684 } 3685 SOURCING_LNUM = lnum_save; 3686 } 3687 else 3688 fp->uf_def_status = UF_NOT_COMPILED; 3689 3690 fp->uf_lines = newlines; 3691 if ((flags & FC_CLOSURE) != 0) 3692 { 3693 if (register_closure(fp) == FAIL) 3694 goto erret; 3695 } 3696 else 3697 fp->uf_scoped = NULL; 3698 3699 #ifdef FEAT_PROFILE 3700 if (prof_def_func()) 3701 func_do_profile(fp); 3702 #endif 3703 fp->uf_varargs = varargs; 3704 if (sandbox) 3705 flags |= FC_SANDBOX; 3706 if (vim9script && !ASCII_ISUPPER(*fp->uf_name)) 3707 flags |= FC_VIM9; 3708 fp->uf_flags = flags; 3709 fp->uf_calls = 0; 3710 fp->uf_cleared = FALSE; 3711 fp->uf_script_ctx = current_sctx; 3712 fp->uf_script_ctx_version = current_sctx.sc_version; 3713 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top; 3714 if (is_export) 3715 { 3716 fp->uf_flags |= FC_EXPORT; 3717 // let ex_export() know the export worked. 3718 is_export = FALSE; 3719 } 3720 3721 if (eap->cmdidx == CMD_def) 3722 set_function_type(fp); 3723 else if (fp->uf_script_ctx.sc_version == SCRIPT_VERSION_VIM9) 3724 // :func does not use Vim9 script syntax, even in a Vim9 script file 3725 fp->uf_script_ctx.sc_version = SCRIPT_VERSION_MAX; 3726 3727 goto ret_free; 3728 3729 erret: 3730 ga_clear_strings(&newargs); 3731 ga_clear_strings(&default_args); 3732 errret_2: 3733 ga_clear_strings(&newlines); 3734 ret_free: 3735 ga_clear_strings(&argtypes); 3736 vim_free(skip_until); 3737 vim_free(heredoc_trimmed); 3738 vim_free(line_to_free); 3739 vim_free(fudi.fd_newkey); 3740 if (name != name_arg) 3741 vim_free(name); 3742 vim_free(ret_type); 3743 did_emsg |= saved_did_emsg; 3744 need_wait_return |= saved_wait_return; 3745 3746 return fp; 3747 } 3748 3749 /* 3750 * ":function" 3751 */ 3752 void 3753 ex_function(exarg_T *eap) 3754 { 3755 (void)define_function(eap, NULL); 3756 } 3757 3758 /* 3759 * :defcompile - compile all :def functions in the current script that need to 3760 * be compiled. Except dead functions. 3761 */ 3762 void 3763 ex_defcompile(exarg_T *eap UNUSED) 3764 { 3765 long todo = (long)func_hashtab.ht_used; 3766 int changed = func_hashtab.ht_changed; 3767 hashitem_T *hi; 3768 ufunc_T *ufunc; 3769 3770 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 3771 { 3772 if (!HASHITEM_EMPTY(hi)) 3773 { 3774 --todo; 3775 ufunc = HI2UF(hi); 3776 if (ufunc->uf_script_ctx.sc_sid == current_sctx.sc_sid 3777 && ufunc->uf_def_status == UF_TO_BE_COMPILED 3778 && (ufunc->uf_flags & FC_DEAD) == 0) 3779 { 3780 compile_def_function(ufunc, FALSE, NULL); 3781 3782 if (func_hashtab.ht_changed != changed) 3783 { 3784 // a function has been added or removed, need to start over 3785 todo = (long)func_hashtab.ht_used; 3786 changed = func_hashtab.ht_changed; 3787 hi = func_hashtab.ht_array; 3788 --hi; 3789 } 3790 } 3791 } 3792 } 3793 } 3794 3795 /* 3796 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case). 3797 * Return 2 if "p" starts with "s:". 3798 * Return 0 otherwise. 3799 */ 3800 int 3801 eval_fname_script(char_u *p) 3802 { 3803 // Use MB_STRICMP() because in Turkish comparing the "I" may not work with 3804 // the standard library function. 3805 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0 3806 || MB_STRNICMP(p + 1, "SNR>", 4) == 0)) 3807 return 5; 3808 if (p[0] == 's' && p[1] == ':') 3809 return 2; 3810 return 0; 3811 } 3812 3813 int 3814 translated_function_exists(char_u *name, int is_global) 3815 { 3816 if (builtin_function(name, -1)) 3817 return has_internal_func(name); 3818 return find_func(name, is_global, NULL) != NULL; 3819 } 3820 3821 /* 3822 * Return TRUE when "ufunc" has old-style "..." varargs 3823 * or named varargs "...name: type". 3824 */ 3825 int 3826 has_varargs(ufunc_T *ufunc) 3827 { 3828 return ufunc->uf_varargs || ufunc->uf_va_name != NULL; 3829 } 3830 3831 /* 3832 * Return TRUE if a function "name" exists. 3833 * If "no_defef" is TRUE, do not dereference a Funcref. 3834 */ 3835 int 3836 function_exists(char_u *name, int no_deref) 3837 { 3838 char_u *nm = name; 3839 char_u *p; 3840 int n = FALSE; 3841 int flag; 3842 int is_global = FALSE; 3843 3844 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD; 3845 if (no_deref) 3846 flag |= TFN_NO_DEREF; 3847 p = trans_function_name(&nm, &is_global, FALSE, flag, NULL, NULL); 3848 nm = skipwhite(nm); 3849 3850 // Only accept "funcname", "funcname ", "funcname (..." and 3851 // "funcname(...", not "funcname!...". 3852 if (p != NULL && (*nm == NUL || *nm == '(')) 3853 n = translated_function_exists(p, is_global); 3854 vim_free(p); 3855 return n; 3856 } 3857 3858 #if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO) 3859 char_u * 3860 get_expanded_name(char_u *name, int check) 3861 { 3862 char_u *nm = name; 3863 char_u *p; 3864 int is_global = FALSE; 3865 3866 p = trans_function_name(&nm, &is_global, FALSE, 3867 TFN_INT|TFN_QUIET, NULL, NULL); 3868 3869 if (p != NULL && *nm == NUL 3870 && (!check || translated_function_exists(p, is_global))) 3871 return p; 3872 3873 vim_free(p); 3874 return NULL; 3875 } 3876 #endif 3877 3878 /* 3879 * Function given to ExpandGeneric() to obtain the list of user defined 3880 * function names. 3881 */ 3882 char_u * 3883 get_user_func_name(expand_T *xp, int idx) 3884 { 3885 static long_u done; 3886 static int changed; 3887 static hashitem_T *hi; 3888 ufunc_T *fp; 3889 3890 if (idx == 0) 3891 { 3892 done = 0; 3893 hi = func_hashtab.ht_array; 3894 changed = func_hashtab.ht_changed; 3895 } 3896 if (changed == func_hashtab.ht_changed && done < func_hashtab.ht_used) 3897 { 3898 if (done++ > 0) 3899 ++hi; 3900 while (HASHITEM_EMPTY(hi)) 3901 ++hi; 3902 fp = HI2UF(hi); 3903 3904 // don't show dead, dict and lambda functions 3905 if ((fp->uf_flags & FC_DEAD) || (fp->uf_flags & FC_DICT) 3906 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 3907 return (char_u *)""; 3908 3909 if (STRLEN(fp->uf_name) + 4 >= IOSIZE) 3910 return fp->uf_name; // prevents overflow 3911 3912 cat_func_name(IObuff, fp); 3913 if (xp->xp_context != EXPAND_USER_FUNC) 3914 { 3915 STRCAT(IObuff, "("); 3916 if (!has_varargs(fp) && fp->uf_args.ga_len == 0) 3917 STRCAT(IObuff, ")"); 3918 } 3919 return IObuff; 3920 } 3921 return NULL; 3922 } 3923 3924 /* 3925 * ":delfunction {name}" 3926 */ 3927 void 3928 ex_delfunction(exarg_T *eap) 3929 { 3930 ufunc_T *fp = NULL; 3931 char_u *p; 3932 char_u *name; 3933 funcdict_T fudi; 3934 int is_global = FALSE; 3935 3936 p = eap->arg; 3937 name = trans_function_name(&p, &is_global, eap->skip, 0, &fudi, NULL); 3938 vim_free(fudi.fd_newkey); 3939 if (name == NULL) 3940 { 3941 if (fudi.fd_dict != NULL && !eap->skip) 3942 emsg(_(e_funcref)); 3943 return; 3944 } 3945 if (!ends_excmd(*skipwhite(p))) 3946 { 3947 vim_free(name); 3948 semsg(_(e_trailing_arg), p); 3949 return; 3950 } 3951 eap->nextcmd = check_nextcmd(p); 3952 if (eap->nextcmd != NULL) 3953 *p = NUL; 3954 3955 if (!eap->skip) 3956 fp = find_func(name, is_global, NULL); 3957 vim_free(name); 3958 3959 if (!eap->skip) 3960 { 3961 if (fp == NULL) 3962 { 3963 if (!eap->forceit) 3964 semsg(_(e_nofunc), eap->arg); 3965 return; 3966 } 3967 if (fp->uf_calls > 0) 3968 { 3969 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg); 3970 return; 3971 } 3972 if (fp->uf_flags & FC_VIM9) 3973 { 3974 semsg(_(e_cannot_delete_vim9_script_function_str), eap->arg); 3975 return; 3976 } 3977 3978 if (fudi.fd_dict != NULL) 3979 { 3980 // Delete the dict item that refers to the function, it will 3981 // invoke func_unref() and possibly delete the function. 3982 dictitem_remove(fudi.fd_dict, fudi.fd_di); 3983 } 3984 else 3985 { 3986 // A normal function (not a numbered function or lambda) has a 3987 // refcount of 1 for the entry in the hashtable. When deleting 3988 // it and the refcount is more than one, it should be kept. 3989 // A numbered function and lambda should be kept if the refcount is 3990 // one or more. 3991 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1)) 3992 { 3993 // Function is still referenced somewhere. Don't free it but 3994 // do remove it from the hashtable. 3995 if (func_remove(fp)) 3996 fp->uf_refcount--; 3997 fp->uf_flags |= FC_DELETED; 3998 } 3999 else 4000 func_clear_free(fp, FALSE); 4001 } 4002 } 4003 } 4004 4005 /* 4006 * Unreference a Function: decrement the reference count and free it when it 4007 * becomes zero. 4008 */ 4009 void 4010 func_unref(char_u *name) 4011 { 4012 ufunc_T *fp = NULL; 4013 4014 if (name == NULL || !func_name_refcount(name)) 4015 return; 4016 fp = find_func(name, FALSE, NULL); 4017 if (fp == NULL && isdigit(*name)) 4018 { 4019 #ifdef EXITFREE 4020 if (!entered_free_all_mem) 4021 #endif 4022 internal_error("func_unref()"); 4023 } 4024 if (fp != NULL && --fp->uf_refcount <= 0) 4025 { 4026 // Only delete it when it's not being used. Otherwise it's done 4027 // when "uf_calls" becomes zero. 4028 if (fp->uf_calls == 0) 4029 func_clear_free(fp, FALSE); 4030 } 4031 } 4032 4033 /* 4034 * Unreference a Function: decrement the reference count and free it when it 4035 * becomes zero. 4036 */ 4037 void 4038 func_ptr_unref(ufunc_T *fp) 4039 { 4040 if (fp != NULL && --fp->uf_refcount <= 0) 4041 { 4042 // Only delete it when it's not being used. Otherwise it's done 4043 // when "uf_calls" becomes zero. 4044 if (fp->uf_calls == 0) 4045 func_clear_free(fp, FALSE); 4046 } 4047 } 4048 4049 /* 4050 * Count a reference to a Function. 4051 */ 4052 void 4053 func_ref(char_u *name) 4054 { 4055 ufunc_T *fp; 4056 4057 if (name == NULL || !func_name_refcount(name)) 4058 return; 4059 fp = find_func(name, FALSE, NULL); 4060 if (fp != NULL) 4061 ++fp->uf_refcount; 4062 else if (isdigit(*name)) 4063 // Only give an error for a numbered function. 4064 // Fail silently, when named or lambda function isn't found. 4065 internal_error("func_ref()"); 4066 } 4067 4068 /* 4069 * Count a reference to a Function. 4070 */ 4071 void 4072 func_ptr_ref(ufunc_T *fp) 4073 { 4074 if (fp != NULL) 4075 ++fp->uf_refcount; 4076 } 4077 4078 /* 4079 * Return TRUE if items in "fc" do not have "copyID". That means they are not 4080 * referenced from anywhere that is in use. 4081 */ 4082 static int 4083 can_free_funccal(funccall_T *fc, int copyID) 4084 { 4085 return (fc->l_varlist.lv_copyID != copyID 4086 && fc->l_vars.dv_copyID != copyID 4087 && fc->l_avars.dv_copyID != copyID 4088 && fc->fc_copyID != copyID); 4089 } 4090 4091 /* 4092 * ":return [expr]" 4093 */ 4094 void 4095 ex_return(exarg_T *eap) 4096 { 4097 char_u *arg = eap->arg; 4098 typval_T rettv; 4099 int returning = FALSE; 4100 evalarg_T evalarg; 4101 4102 if (current_funccal == NULL) 4103 { 4104 emsg(_("E133: :return not inside a function")); 4105 return; 4106 } 4107 4108 CLEAR_FIELD(evalarg); 4109 evalarg.eval_flags = eap->skip ? 0 : EVAL_EVALUATE; 4110 4111 if (eap->skip) 4112 ++emsg_skip; 4113 4114 eap->nextcmd = NULL; 4115 if ((*arg != NUL && *arg != '|' && *arg != '\n') 4116 && eval0(arg, &rettv, eap, &evalarg) != FAIL) 4117 { 4118 if (!eap->skip) 4119 returning = do_return(eap, FALSE, TRUE, &rettv); 4120 else 4121 clear_tv(&rettv); 4122 } 4123 // It's safer to return also on error. 4124 else if (!eap->skip) 4125 { 4126 // In return statement, cause_abort should be force_abort. 4127 update_force_abort(); 4128 4129 /* 4130 * Return unless the expression evaluation has been cancelled due to an 4131 * aborting error, an interrupt, or an exception. 4132 */ 4133 if (!aborting()) 4134 returning = do_return(eap, FALSE, TRUE, NULL); 4135 } 4136 4137 // When skipping or the return gets pending, advance to the next command 4138 // in this line (!returning). Otherwise, ignore the rest of the line. 4139 // Following lines will be ignored by get_func_line(). 4140 if (returning) 4141 eap->nextcmd = NULL; 4142 else if (eap->nextcmd == NULL) // no argument 4143 eap->nextcmd = check_nextcmd(arg); 4144 4145 if (eap->skip) 4146 --emsg_skip; 4147 clear_evalarg(&evalarg, eap); 4148 } 4149 4150 /* 4151 * ":1,25call func(arg1, arg2)" function call. 4152 */ 4153 void 4154 ex_call(exarg_T *eap) 4155 { 4156 char_u *arg = eap->arg; 4157 char_u *startarg; 4158 char_u *name; 4159 char_u *tofree; 4160 int len; 4161 typval_T rettv; 4162 linenr_T lnum; 4163 int doesrange; 4164 int failed = FALSE; 4165 funcdict_T fudi; 4166 partial_T *partial = NULL; 4167 evalarg_T evalarg; 4168 4169 fill_evalarg_from_eap(&evalarg, eap, eap->skip); 4170 if (eap->skip) 4171 { 4172 // trans_function_name() doesn't work well when skipping, use eval0() 4173 // instead to skip to any following command, e.g. for: 4174 // :if 0 | call dict.foo().bar() | endif 4175 ++emsg_skip; 4176 if (eval0(eap->arg, &rettv, eap, &evalarg) != FAIL) 4177 clear_tv(&rettv); 4178 --emsg_skip; 4179 clear_evalarg(&evalarg, eap); 4180 return; 4181 } 4182 4183 tofree = trans_function_name(&arg, NULL, eap->skip, 4184 TFN_INT, &fudi, &partial); 4185 if (fudi.fd_newkey != NULL) 4186 { 4187 // Still need to give an error message for missing key. 4188 semsg(_(e_dictkey), fudi.fd_newkey); 4189 vim_free(fudi.fd_newkey); 4190 } 4191 if (tofree == NULL) 4192 return; 4193 4194 // Increase refcount on dictionary, it could get deleted when evaluating 4195 // the arguments. 4196 if (fudi.fd_dict != NULL) 4197 ++fudi.fd_dict->dv_refcount; 4198 4199 // If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its 4200 // contents. For VAR_PARTIAL get its partial, unless we already have one 4201 // from trans_function_name(). 4202 len = (int)STRLEN(tofree); 4203 name = deref_func_name(tofree, &len, 4204 partial != NULL ? NULL : &partial, FALSE); 4205 4206 // Skip white space to allow ":call func ()". Not good, but required for 4207 // backward compatibility. 4208 startarg = skipwhite(arg); 4209 rettv.v_type = VAR_UNKNOWN; // clear_tv() uses this 4210 4211 if (*startarg != '(') 4212 { 4213 semsg(_(e_missing_paren), eap->arg); 4214 goto end; 4215 } 4216 4217 /* 4218 * When skipping, evaluate the function once, to find the end of the 4219 * arguments. 4220 * When the function takes a range, this is discovered after the first 4221 * call, and the loop is broken. 4222 */ 4223 if (eap->skip) 4224 { 4225 ++emsg_skip; 4226 lnum = eap->line2; // do it once, also with an invalid range 4227 } 4228 else 4229 lnum = eap->line1; 4230 for ( ; lnum <= eap->line2; ++lnum) 4231 { 4232 funcexe_T funcexe; 4233 4234 if (!eap->skip && eap->addr_count > 0) 4235 { 4236 if (lnum > curbuf->b_ml.ml_line_count) 4237 { 4238 // If the function deleted lines or switched to another buffer 4239 // the line number may become invalid. 4240 emsg(_(e_invrange)); 4241 break; 4242 } 4243 curwin->w_cursor.lnum = lnum; 4244 curwin->w_cursor.col = 0; 4245 curwin->w_cursor.coladd = 0; 4246 } 4247 arg = startarg; 4248 4249 CLEAR_FIELD(funcexe); 4250 funcexe.firstline = eap->line1; 4251 funcexe.lastline = eap->line2; 4252 funcexe.doesrange = &doesrange; 4253 funcexe.evaluate = !eap->skip; 4254 funcexe.partial = partial; 4255 funcexe.selfdict = fudi.fd_dict; 4256 if (get_func_tv(name, -1, &rettv, &arg, &evalarg, &funcexe) == FAIL) 4257 { 4258 failed = TRUE; 4259 break; 4260 } 4261 if (has_watchexpr()) 4262 dbg_check_breakpoint(eap); 4263 4264 // Handle a function returning a Funcref, Dictionary or List. 4265 if (handle_subscript(&arg, &rettv, 4266 eap->skip ? NULL : &EVALARG_EVALUATE, TRUE) == FAIL) 4267 { 4268 failed = TRUE; 4269 break; 4270 } 4271 4272 clear_tv(&rettv); 4273 if (doesrange || eap->skip) 4274 break; 4275 4276 // Stop when immediately aborting on error, or when an interrupt 4277 // occurred or an exception was thrown but not caught. 4278 // get_func_tv() returned OK, so that the check for trailing 4279 // characters below is executed. 4280 if (aborting()) 4281 break; 4282 } 4283 if (eap->skip) 4284 --emsg_skip; 4285 clear_evalarg(&evalarg, eap); 4286 4287 // When inside :try we need to check for following "| catch". 4288 if (!failed || eap->cstack->cs_trylevel > 0) 4289 { 4290 // Check for trailing illegal characters and a following command. 4291 arg = skipwhite(arg); 4292 if (!ends_excmd2(eap->arg, arg)) 4293 { 4294 if (!failed) 4295 { 4296 emsg_severe = TRUE; 4297 semsg(_(e_trailing_arg), arg); 4298 } 4299 } 4300 else 4301 eap->nextcmd = check_nextcmd(arg); 4302 } 4303 4304 end: 4305 dict_unref(fudi.fd_dict); 4306 vim_free(tofree); 4307 } 4308 4309 /* 4310 * Return from a function. Possibly makes the return pending. Also called 4311 * for a pending return at the ":endtry" or after returning from an extra 4312 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set 4313 * when called due to a ":return" command. "rettv" may point to a typval_T 4314 * with the return rettv. Returns TRUE when the return can be carried out, 4315 * FALSE when the return gets pending. 4316 */ 4317 int 4318 do_return( 4319 exarg_T *eap, 4320 int reanimate, 4321 int is_cmd, 4322 void *rettv) 4323 { 4324 int idx; 4325 cstack_T *cstack = eap->cstack; 4326 4327 if (reanimate) 4328 // Undo the return. 4329 current_funccal->returned = FALSE; 4330 4331 /* 4332 * Cleanup (and inactivate) conditionals, but stop when a try conditional 4333 * not in its finally clause (which then is to be executed next) is found. 4334 * In this case, make the ":return" pending for execution at the ":endtry". 4335 * Otherwise, return normally. 4336 */ 4337 idx = cleanup_conditionals(eap->cstack, 0, TRUE); 4338 if (idx >= 0) 4339 { 4340 cstack->cs_pending[idx] = CSTP_RETURN; 4341 4342 if (!is_cmd && !reanimate) 4343 // A pending return again gets pending. "rettv" points to an 4344 // allocated variable with the rettv of the original ":return"'s 4345 // argument if present or is NULL else. 4346 cstack->cs_rettv[idx] = rettv; 4347 else 4348 { 4349 // When undoing a return in order to make it pending, get the stored 4350 // return rettv. 4351 if (reanimate) 4352 rettv = current_funccal->rettv; 4353 4354 if (rettv != NULL) 4355 { 4356 // Store the value of the pending return. 4357 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL) 4358 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv; 4359 else 4360 emsg(_(e_outofmem)); 4361 } 4362 else 4363 cstack->cs_rettv[idx] = NULL; 4364 4365 if (reanimate) 4366 { 4367 // The pending return value could be overwritten by a ":return" 4368 // without argument in a finally clause; reset the default 4369 // return value. 4370 current_funccal->rettv->v_type = VAR_NUMBER; 4371 current_funccal->rettv->vval.v_number = 0; 4372 } 4373 } 4374 report_make_pending(CSTP_RETURN, rettv); 4375 } 4376 else 4377 { 4378 current_funccal->returned = TRUE; 4379 4380 // If the return is carried out now, store the return value. For 4381 // a return immediately after reanimation, the value is already 4382 // there. 4383 if (!reanimate && rettv != NULL) 4384 { 4385 clear_tv(current_funccal->rettv); 4386 *current_funccal->rettv = *(typval_T *)rettv; 4387 if (!is_cmd) 4388 vim_free(rettv); 4389 } 4390 } 4391 4392 return idx < 0; 4393 } 4394 4395 /* 4396 * Free the variable with a pending return value. 4397 */ 4398 void 4399 discard_pending_return(void *rettv) 4400 { 4401 free_tv((typval_T *)rettv); 4402 } 4403 4404 /* 4405 * Generate a return command for producing the value of "rettv". The result 4406 * is an allocated string. Used by report_pending() for verbose messages. 4407 */ 4408 char_u * 4409 get_return_cmd(void *rettv) 4410 { 4411 char_u *s = NULL; 4412 char_u *tofree = NULL; 4413 char_u numbuf[NUMBUFLEN]; 4414 4415 if (rettv != NULL) 4416 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0); 4417 if (s == NULL) 4418 s = (char_u *)""; 4419 4420 STRCPY(IObuff, ":return "); 4421 STRNCPY(IObuff + 8, s, IOSIZE - 8); 4422 if (STRLEN(s) + 8 >= IOSIZE) 4423 STRCPY(IObuff + IOSIZE - 4, "..."); 4424 vim_free(tofree); 4425 return vim_strsave(IObuff); 4426 } 4427 4428 /* 4429 * Get next function line. 4430 * Called by do_cmdline() to get the next line. 4431 * Returns allocated string, or NULL for end of function. 4432 */ 4433 char_u * 4434 get_func_line( 4435 int c UNUSED, 4436 void *cookie, 4437 int indent UNUSED, 4438 getline_opt_T options UNUSED) 4439 { 4440 funccall_T *fcp = (funccall_T *)cookie; 4441 ufunc_T *fp = fcp->func; 4442 char_u *retval; 4443 garray_T *gap; // growarray with function lines 4444 4445 // If breakpoints have been added/deleted need to check for it. 4446 if (fcp->dbg_tick != debug_tick) 4447 { 4448 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 4449 SOURCING_LNUM); 4450 fcp->dbg_tick = debug_tick; 4451 } 4452 #ifdef FEAT_PROFILE 4453 if (do_profiling == PROF_YES) 4454 func_line_end(cookie); 4455 #endif 4456 4457 gap = &fp->uf_lines; 4458 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 4459 || fcp->returned) 4460 retval = NULL; 4461 else 4462 { 4463 // Skip NULL lines (continuation lines). 4464 while (fcp->linenr < gap->ga_len 4465 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL) 4466 ++fcp->linenr; 4467 if (fcp->linenr >= gap->ga_len) 4468 retval = NULL; 4469 else 4470 { 4471 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]); 4472 SOURCING_LNUM = fcp->linenr; 4473 #ifdef FEAT_PROFILE 4474 if (do_profiling == PROF_YES) 4475 func_line_start(cookie); 4476 #endif 4477 } 4478 } 4479 4480 // Did we encounter a breakpoint? 4481 if (fcp->breakpoint != 0 && fcp->breakpoint <= SOURCING_LNUM) 4482 { 4483 dbg_breakpoint(fp->uf_name, SOURCING_LNUM); 4484 // Find next breakpoint. 4485 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 4486 SOURCING_LNUM); 4487 fcp->dbg_tick = debug_tick; 4488 } 4489 4490 return retval; 4491 } 4492 4493 /* 4494 * Return TRUE if the currently active function should be ended, because a 4495 * return was encountered or an error occurred. Used inside a ":while". 4496 */ 4497 int 4498 func_has_ended(void *cookie) 4499 { 4500 funccall_T *fcp = (funccall_T *)cookie; 4501 4502 // Ignore the "abort" flag if the abortion behavior has been changed due to 4503 // an error inside a try conditional. 4504 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 4505 || fcp->returned); 4506 } 4507 4508 /* 4509 * return TRUE if cookie indicates a function which "abort"s on errors. 4510 */ 4511 int 4512 func_has_abort( 4513 void *cookie) 4514 { 4515 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT; 4516 } 4517 4518 4519 /* 4520 * Turn "dict.Func" into a partial for "Func" bound to "dict". 4521 * Don't do this when "Func" is already a partial that was bound 4522 * explicitly (pt_auto is FALSE). 4523 * Changes "rettv" in-place. 4524 * Returns the updated "selfdict_in". 4525 */ 4526 dict_T * 4527 make_partial(dict_T *selfdict_in, typval_T *rettv) 4528 { 4529 char_u *fname; 4530 char_u *tofree = NULL; 4531 ufunc_T *fp; 4532 char_u fname_buf[FLEN_FIXED + 1]; 4533 int error; 4534 dict_T *selfdict = selfdict_in; 4535 4536 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL) 4537 fp = rettv->vval.v_partial->pt_func; 4538 else 4539 { 4540 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string 4541 : rettv->vval.v_partial->pt_name; 4542 // Translate "s:func" to the stored function name. 4543 fname = fname_trans_sid(fname, fname_buf, &tofree, &error); 4544 fp = find_func(fname, FALSE, NULL); 4545 vim_free(tofree); 4546 } 4547 4548 if (fp != NULL && (fp->uf_flags & FC_DICT)) 4549 { 4550 partial_T *pt = ALLOC_CLEAR_ONE(partial_T); 4551 4552 if (pt != NULL) 4553 { 4554 pt->pt_refcount = 1; 4555 pt->pt_dict = selfdict; 4556 pt->pt_auto = TRUE; 4557 selfdict = NULL; 4558 if (rettv->v_type == VAR_FUNC) 4559 { 4560 // Just a function: Take over the function name and use 4561 // selfdict. 4562 pt->pt_name = rettv->vval.v_string; 4563 } 4564 else 4565 { 4566 partial_T *ret_pt = rettv->vval.v_partial; 4567 int i; 4568 4569 // Partial: copy the function name, use selfdict and copy 4570 // args. Can't take over name or args, the partial might 4571 // be referenced elsewhere. 4572 if (ret_pt->pt_name != NULL) 4573 { 4574 pt->pt_name = vim_strsave(ret_pt->pt_name); 4575 func_ref(pt->pt_name); 4576 } 4577 else 4578 { 4579 pt->pt_func = ret_pt->pt_func; 4580 func_ptr_ref(pt->pt_func); 4581 } 4582 if (ret_pt->pt_argc > 0) 4583 { 4584 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc); 4585 if (pt->pt_argv == NULL) 4586 // out of memory: drop the arguments 4587 pt->pt_argc = 0; 4588 else 4589 { 4590 pt->pt_argc = ret_pt->pt_argc; 4591 for (i = 0; i < pt->pt_argc; i++) 4592 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]); 4593 } 4594 } 4595 partial_unref(ret_pt); 4596 } 4597 rettv->v_type = VAR_PARTIAL; 4598 rettv->vval.v_partial = pt; 4599 } 4600 } 4601 return selfdict; 4602 } 4603 4604 /* 4605 * Return the name of the executed function. 4606 */ 4607 char_u * 4608 func_name(void *cookie) 4609 { 4610 return ((funccall_T *)cookie)->func->uf_name; 4611 } 4612 4613 /* 4614 * Return the address holding the next breakpoint line for a funccall cookie. 4615 */ 4616 linenr_T * 4617 func_breakpoint(void *cookie) 4618 { 4619 return &((funccall_T *)cookie)->breakpoint; 4620 } 4621 4622 /* 4623 * Return the address holding the debug tick for a funccall cookie. 4624 */ 4625 int * 4626 func_dbg_tick(void *cookie) 4627 { 4628 return &((funccall_T *)cookie)->dbg_tick; 4629 } 4630 4631 /* 4632 * Return the nesting level for a funccall cookie. 4633 */ 4634 int 4635 func_level(void *cookie) 4636 { 4637 return ((funccall_T *)cookie)->level; 4638 } 4639 4640 /* 4641 * Return TRUE when a function was ended by a ":return" command. 4642 */ 4643 int 4644 current_func_returned(void) 4645 { 4646 return current_funccal->returned; 4647 } 4648 4649 int 4650 free_unref_funccal(int copyID, int testing) 4651 { 4652 int did_free = FALSE; 4653 int did_free_funccal = FALSE; 4654 funccall_T *fc, **pfc; 4655 4656 for (pfc = &previous_funccal; *pfc != NULL; ) 4657 { 4658 if (can_free_funccal(*pfc, copyID)) 4659 { 4660 fc = *pfc; 4661 *pfc = fc->caller; 4662 free_funccal_contents(fc); 4663 did_free = TRUE; 4664 did_free_funccal = TRUE; 4665 } 4666 else 4667 pfc = &(*pfc)->caller; 4668 } 4669 if (did_free_funccal) 4670 // When a funccal was freed some more items might be garbage 4671 // collected, so run again. 4672 (void)garbage_collect(testing); 4673 4674 return did_free; 4675 } 4676 4677 /* 4678 * Get function call environment based on backtrace debug level 4679 */ 4680 static funccall_T * 4681 get_funccal(void) 4682 { 4683 int i; 4684 funccall_T *funccal; 4685 funccall_T *temp_funccal; 4686 4687 funccal = current_funccal; 4688 if (debug_backtrace_level > 0) 4689 { 4690 for (i = 0; i < debug_backtrace_level; i++) 4691 { 4692 temp_funccal = funccal->caller; 4693 if (temp_funccal) 4694 funccal = temp_funccal; 4695 else 4696 // backtrace level overflow. reset to max 4697 debug_backtrace_level = i; 4698 } 4699 } 4700 return funccal; 4701 } 4702 4703 /* 4704 * Return the hashtable used for local variables in the current funccal. 4705 * Return NULL if there is no current funccal. 4706 */ 4707 hashtab_T * 4708 get_funccal_local_ht() 4709 { 4710 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 4711 return NULL; 4712 return &get_funccal()->l_vars.dv_hashtab; 4713 } 4714 4715 /* 4716 * Return the l: scope variable. 4717 * Return NULL if there is no current funccal. 4718 */ 4719 dictitem_T * 4720 get_funccal_local_var() 4721 { 4722 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 4723 return NULL; 4724 return &get_funccal()->l_vars_var; 4725 } 4726 4727 /* 4728 * Return the hashtable used for argument in the current funccal. 4729 * Return NULL if there is no current funccal. 4730 */ 4731 hashtab_T * 4732 get_funccal_args_ht() 4733 { 4734 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 4735 return NULL; 4736 return &get_funccal()->l_avars.dv_hashtab; 4737 } 4738 4739 /* 4740 * Return the a: scope variable. 4741 * Return NULL if there is no current funccal. 4742 */ 4743 dictitem_T * 4744 get_funccal_args_var() 4745 { 4746 if (current_funccal == NULL || current_funccal->l_vars.dv_refcount == 0) 4747 return NULL; 4748 return &get_funccal()->l_avars_var; 4749 } 4750 4751 /* 4752 * List function variables, if there is a function. 4753 */ 4754 void 4755 list_func_vars(int *first) 4756 { 4757 if (current_funccal != NULL && current_funccal->l_vars.dv_refcount > 0) 4758 list_hashtable_vars(¤t_funccal->l_vars.dv_hashtab, 4759 "l:", FALSE, first); 4760 } 4761 4762 /* 4763 * If "ht" is the hashtable for local variables in the current funccal, return 4764 * the dict that contains it. 4765 * Otherwise return NULL. 4766 */ 4767 dict_T * 4768 get_current_funccal_dict(hashtab_T *ht) 4769 { 4770 if (current_funccal != NULL 4771 && ht == ¤t_funccal->l_vars.dv_hashtab) 4772 return ¤t_funccal->l_vars; 4773 return NULL; 4774 } 4775 4776 /* 4777 * Search hashitem in parent scope. 4778 */ 4779 hashitem_T * 4780 find_hi_in_scoped_ht(char_u *name, hashtab_T **pht) 4781 { 4782 funccall_T *old_current_funccal = current_funccal; 4783 hashtab_T *ht; 4784 hashitem_T *hi = NULL; 4785 char_u *varname; 4786 4787 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 4788 return NULL; 4789 4790 // Search in parent scope, which can be referenced from a lambda. 4791 current_funccal = current_funccal->func->uf_scoped; 4792 while (current_funccal != NULL) 4793 { 4794 ht = find_var_ht(name, &varname); 4795 if (ht != NULL && *varname != NUL) 4796 { 4797 hi = hash_find(ht, varname); 4798 if (!HASHITEM_EMPTY(hi)) 4799 { 4800 *pht = ht; 4801 break; 4802 } 4803 } 4804 if (current_funccal == current_funccal->func->uf_scoped) 4805 break; 4806 current_funccal = current_funccal->func->uf_scoped; 4807 } 4808 current_funccal = old_current_funccal; 4809 4810 return hi; 4811 } 4812 4813 /* 4814 * Search variable in parent scope. 4815 */ 4816 dictitem_T * 4817 find_var_in_scoped_ht(char_u *name, int no_autoload) 4818 { 4819 dictitem_T *v = NULL; 4820 funccall_T *old_current_funccal = current_funccal; 4821 hashtab_T *ht; 4822 char_u *varname; 4823 4824 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 4825 return NULL; 4826 4827 // Search in parent scope which is possible to reference from lambda 4828 current_funccal = current_funccal->func->uf_scoped; 4829 while (current_funccal) 4830 { 4831 ht = find_var_ht(name, &varname); 4832 if (ht != NULL && *varname != NUL) 4833 { 4834 v = find_var_in_ht(ht, *name, varname, no_autoload); 4835 if (v != NULL) 4836 break; 4837 } 4838 if (current_funccal == current_funccal->func->uf_scoped) 4839 break; 4840 current_funccal = current_funccal->func->uf_scoped; 4841 } 4842 current_funccal = old_current_funccal; 4843 4844 return v; 4845 } 4846 4847 /* 4848 * Set "copyID + 1" in previous_funccal and callers. 4849 */ 4850 int 4851 set_ref_in_previous_funccal(int copyID) 4852 { 4853 int abort = FALSE; 4854 funccall_T *fc; 4855 4856 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller) 4857 { 4858 fc->fc_copyID = copyID + 1; 4859 abort = abort 4860 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL) 4861 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL) 4862 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL); 4863 } 4864 return abort; 4865 } 4866 4867 static int 4868 set_ref_in_funccal(funccall_T *fc, int copyID) 4869 { 4870 int abort = FALSE; 4871 4872 if (fc->fc_copyID != copyID) 4873 { 4874 fc->fc_copyID = copyID; 4875 abort = abort 4876 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL) 4877 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL) 4878 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL) 4879 || set_ref_in_func(NULL, fc->func, copyID); 4880 } 4881 return abort; 4882 } 4883 4884 /* 4885 * Set "copyID" in all local vars and arguments in the call stack. 4886 */ 4887 int 4888 set_ref_in_call_stack(int copyID) 4889 { 4890 int abort = FALSE; 4891 funccall_T *fc; 4892 funccal_entry_T *entry; 4893 4894 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller) 4895 abort = abort || set_ref_in_funccal(fc, copyID); 4896 4897 // Also go through the funccal_stack. 4898 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next) 4899 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller) 4900 abort = abort || set_ref_in_funccal(fc, copyID); 4901 4902 return abort; 4903 } 4904 4905 /* 4906 * Set "copyID" in all functions available by name. 4907 */ 4908 int 4909 set_ref_in_functions(int copyID) 4910 { 4911 int todo; 4912 hashitem_T *hi = NULL; 4913 int abort = FALSE; 4914 ufunc_T *fp; 4915 4916 todo = (int)func_hashtab.ht_used; 4917 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 4918 { 4919 if (!HASHITEM_EMPTY(hi)) 4920 { 4921 --todo; 4922 fp = HI2UF(hi); 4923 if (!func_name_refcount(fp->uf_name)) 4924 abort = abort || set_ref_in_func(NULL, fp, copyID); 4925 } 4926 } 4927 return abort; 4928 } 4929 4930 /* 4931 * Set "copyID" in all function arguments. 4932 */ 4933 int 4934 set_ref_in_func_args(int copyID) 4935 { 4936 int i; 4937 int abort = FALSE; 4938 4939 for (i = 0; i < funcargs.ga_len; ++i) 4940 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i], 4941 copyID, NULL, NULL); 4942 return abort; 4943 } 4944 4945 /* 4946 * Mark all lists and dicts referenced through function "name" with "copyID". 4947 * Returns TRUE if setting references failed somehow. 4948 */ 4949 int 4950 set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID) 4951 { 4952 ufunc_T *fp = fp_in; 4953 funccall_T *fc; 4954 int error = FCERR_NONE; 4955 char_u fname_buf[FLEN_FIXED + 1]; 4956 char_u *tofree = NULL; 4957 char_u *fname; 4958 int abort = FALSE; 4959 4960 if (name == NULL && fp_in == NULL) 4961 return FALSE; 4962 4963 if (fp_in == NULL) 4964 { 4965 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 4966 fp = find_func(fname, FALSE, NULL); 4967 } 4968 if (fp != NULL) 4969 { 4970 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped) 4971 abort = abort || set_ref_in_funccal(fc, copyID); 4972 } 4973 4974 vim_free(tofree); 4975 return abort; 4976 } 4977 4978 #endif // FEAT_EVAL 4979