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