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