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 // flags used in uf_flags 18 #define FC_ABORT 0x01 // abort function on error 19 #define FC_RANGE 0x02 // function accepts range 20 #define FC_DICT 0x04 // Dict function, uses "self" 21 #define FC_CLOSURE 0x08 // closure, uses outer scope variables 22 #define FC_DELETED 0x10 // :delfunction used while uf_refcount > 0 23 #define FC_REMOVED 0x20 // function redefined while uf_refcount > 0 24 #define FC_SANDBOX 0x40 // function defined in the sandbox 25 26 #define FUNCARG(fp, j) ((char_u **)(fp->uf_args.ga_data))[j] 27 28 /* 29 * All user-defined functions are found in this hashtable. 30 */ 31 static hashtab_T func_hashtab; 32 33 /* Used by get_func_tv() */ 34 static garray_T funcargs = GA_EMPTY; 35 36 // pointer to funccal for currently active function 37 static funccall_T *current_funccal = NULL; 38 39 // Pointer to list of previously used funccal, still around because some 40 // item in it is still being used. 41 static funccall_T *previous_funccal = NULL; 42 43 static char *e_funcexts = N_("E122: Function %s already exists, add ! to replace it"); 44 static char *e_funcdict = N_("E717: Dictionary entry already exists"); 45 static char *e_funcref = N_("E718: Funcref required"); 46 static char *e_nofunc = N_("E130: Unknown function: %s"); 47 48 static void funccal_unref(funccall_T *fc, ufunc_T *fp, int force); 49 50 void 51 func_init() 52 { 53 hash_init(&func_hashtab); 54 } 55 56 /* 57 * Return the function hash table 58 */ 59 hashtab_T * 60 func_tbl_get(void) 61 { 62 return &func_hashtab; 63 } 64 65 /* 66 * Get function arguments. 67 */ 68 static int 69 get_function_args( 70 char_u **argp, 71 char_u endchar, 72 garray_T *newargs, 73 int *varargs, 74 garray_T *default_args, 75 int skip) 76 { 77 int mustend = FALSE; 78 char_u *arg = *argp; 79 char_u *p = arg; 80 int c; 81 int i; 82 int any_default = FALSE; 83 char_u *expr; 84 85 if (newargs != NULL) 86 ga_init2(newargs, (int)sizeof(char_u *), 3); 87 if (default_args != NULL) 88 ga_init2(default_args, (int)sizeof(char_u *), 3); 89 90 if (varargs != NULL) 91 *varargs = FALSE; 92 93 /* 94 * Isolate the arguments: "arg1, arg2, ...)" 95 */ 96 while (*p != endchar) 97 { 98 if (p[0] == '.' && p[1] == '.' && p[2] == '.') 99 { 100 if (varargs != NULL) 101 *varargs = TRUE; 102 p += 3; 103 mustend = TRUE; 104 } 105 else 106 { 107 arg = p; 108 while (ASCII_ISALNUM(*p) || *p == '_') 109 ++p; 110 if (arg == p || isdigit(*arg) 111 || (p - arg == 9 && STRNCMP(arg, "firstline", 9) == 0) 112 || (p - arg == 8 && STRNCMP(arg, "lastline", 8) == 0)) 113 { 114 if (!skip) 115 semsg(_("E125: Illegal argument: %s"), arg); 116 break; 117 } 118 if (newargs != NULL && ga_grow(newargs, 1) == FAIL) 119 goto err_ret; 120 if (newargs != NULL) 121 { 122 c = *p; 123 *p = NUL; 124 arg = vim_strsave(arg); 125 if (arg == NULL) 126 { 127 *p = c; 128 goto err_ret; 129 } 130 131 /* Check for duplicate argument name. */ 132 for (i = 0; i < newargs->ga_len; ++i) 133 if (STRCMP(((char_u **)(newargs->ga_data))[i], arg) == 0) 134 { 135 semsg(_("E853: Duplicate argument name: %s"), arg); 136 vim_free(arg); 137 goto err_ret; 138 } 139 ((char_u **)(newargs->ga_data))[newargs->ga_len] = arg; 140 newargs->ga_len++; 141 142 *p = c; 143 } 144 if (*skipwhite(p) == '=' && default_args != NULL) 145 { 146 typval_T rettv; 147 148 any_default = TRUE; 149 p = skipwhite(p) + 1; 150 p = skipwhite(p); 151 expr = p; 152 if (eval1(&p, &rettv, FALSE) != FAIL) 153 { 154 if (ga_grow(default_args, 1) == FAIL) 155 goto err_ret; 156 157 // trim trailing whitespace 158 while (p > expr && VIM_ISWHITE(p[-1])) 159 p--; 160 c = *p; 161 *p = NUL; 162 expr = vim_strsave(expr); 163 if (expr == NULL) 164 { 165 *p = c; 166 goto err_ret; 167 } 168 ((char_u **)(default_args->ga_data)) 169 [default_args->ga_len] = expr; 170 default_args->ga_len++; 171 *p = c; 172 } 173 else 174 mustend = TRUE; 175 } 176 else if (any_default) 177 { 178 emsg(_("E989: Non-default argument follows default argument")); 179 mustend = TRUE; 180 } 181 if (*p == ',') 182 ++p; 183 else 184 mustend = TRUE; 185 } 186 p = skipwhite(p); 187 if (mustend && *p != endchar) 188 { 189 if (!skip) 190 semsg(_(e_invarg2), *argp); 191 break; 192 } 193 } 194 if (*p != endchar) 195 goto err_ret; 196 ++p; /* skip "endchar" */ 197 198 *argp = p; 199 return OK; 200 201 err_ret: 202 if (newargs != NULL) 203 ga_clear_strings(newargs); 204 if (default_args != NULL) 205 ga_clear_strings(default_args); 206 return FAIL; 207 } 208 209 /* 210 * Register function "fp" as using "current_funccal" as its scope. 211 */ 212 static int 213 register_closure(ufunc_T *fp) 214 { 215 if (fp->uf_scoped == current_funccal) 216 /* no change */ 217 return OK; 218 funccal_unref(fp->uf_scoped, fp, FALSE); 219 fp->uf_scoped = current_funccal; 220 current_funccal->fc_refcount++; 221 222 if (ga_grow(¤t_funccal->fc_funcs, 1) == FAIL) 223 return FAIL; 224 ((ufunc_T **)current_funccal->fc_funcs.ga_data) 225 [current_funccal->fc_funcs.ga_len++] = fp; 226 return OK; 227 } 228 229 /* 230 * Parse a lambda expression and get a Funcref from "*arg". 231 * Return OK or FAIL. Returns NOTDONE for dict or {expr}. 232 */ 233 int 234 get_lambda_tv(char_u **arg, typval_T *rettv, int evaluate) 235 { 236 garray_T newargs; 237 garray_T newlines; 238 garray_T *pnewargs; 239 ufunc_T *fp = NULL; 240 partial_T *pt = NULL; 241 int varargs; 242 int ret; 243 char_u *start = skipwhite(*arg + 1); 244 char_u *s, *e; 245 static int lambda_no = 0; 246 int *old_eval_lavars = eval_lavars_used; 247 int eval_lavars = FALSE; 248 249 ga_init(&newargs); 250 ga_init(&newlines); 251 252 /* First, check if this is a lambda expression. "->" must exist. */ 253 ret = get_function_args(&start, '-', NULL, NULL, NULL, TRUE); 254 if (ret == FAIL || *start != '>') 255 return NOTDONE; 256 257 /* Parse the arguments again. */ 258 if (evaluate) 259 pnewargs = &newargs; 260 else 261 pnewargs = NULL; 262 *arg = skipwhite(*arg + 1); 263 ret = get_function_args(arg, '-', pnewargs, &varargs, NULL, FALSE); 264 if (ret == FAIL || **arg != '>') 265 goto errret; 266 267 /* Set up a flag for checking local variables and arguments. */ 268 if (evaluate) 269 eval_lavars_used = &eval_lavars; 270 271 /* Get the start and the end of the expression. */ 272 *arg = skipwhite(*arg + 1); 273 s = *arg; 274 ret = skip_expr(arg); 275 if (ret == FAIL) 276 goto errret; 277 e = *arg; 278 *arg = skipwhite(*arg); 279 if (**arg != '}') 280 goto errret; 281 ++*arg; 282 283 if (evaluate) 284 { 285 int len, flags = 0; 286 char_u *p; 287 char_u name[20]; 288 289 sprintf((char*)name, "<lambda>%d", ++lambda_no); 290 291 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 292 if (fp == NULL) 293 goto errret; 294 pt = ALLOC_CLEAR_ONE(partial_T); 295 if (pt == NULL) 296 goto errret; 297 298 ga_init2(&newlines, (int)sizeof(char_u *), 1); 299 if (ga_grow(&newlines, 1) == FAIL) 300 goto errret; 301 302 /* Add "return " before the expression. */ 303 len = 7 + e - s + 1; 304 p = alloc(len); 305 if (p == NULL) 306 goto errret; 307 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p; 308 STRCPY(p, "return "); 309 vim_strncpy(p + 7, s, e - s); 310 311 fp->uf_refcount = 1; 312 STRCPY(fp->uf_name, name); 313 hash_add(&func_hashtab, UF2HIKEY(fp)); 314 fp->uf_args = newargs; 315 ga_init(&fp->uf_def_args); 316 fp->uf_lines = newlines; 317 if (current_funccal != NULL && eval_lavars) 318 { 319 flags |= FC_CLOSURE; 320 if (register_closure(fp) == FAIL) 321 goto errret; 322 } 323 else 324 fp->uf_scoped = NULL; 325 326 #ifdef FEAT_PROFILE 327 if (prof_def_func()) 328 func_do_profile(fp); 329 #endif 330 if (sandbox) 331 flags |= FC_SANDBOX; 332 fp->uf_varargs = TRUE; 333 fp->uf_flags = flags; 334 fp->uf_calls = 0; 335 fp->uf_script_ctx = current_sctx; 336 fp->uf_script_ctx.sc_lnum += sourcing_lnum - newlines.ga_len; 337 338 pt->pt_func = fp; 339 pt->pt_refcount = 1; 340 rettv->vval.v_partial = pt; 341 rettv->v_type = VAR_PARTIAL; 342 } 343 344 eval_lavars_used = old_eval_lavars; 345 return OK; 346 347 errret: 348 ga_clear_strings(&newargs); 349 ga_clear_strings(&newlines); 350 vim_free(fp); 351 vim_free(pt); 352 eval_lavars_used = old_eval_lavars; 353 return FAIL; 354 } 355 356 /* 357 * Check if "name" is a variable of type VAR_FUNC. If so, return the function 358 * name it contains, otherwise return "name". 359 * If "partialp" is not NULL, and "name" is of type VAR_PARTIAL also set 360 * "partialp". 361 */ 362 char_u * 363 deref_func_name(char_u *name, int *lenp, partial_T **partialp, int no_autoload) 364 { 365 dictitem_T *v; 366 int cc; 367 char_u *s; 368 369 if (partialp != NULL) 370 *partialp = NULL; 371 372 cc = name[*lenp]; 373 name[*lenp] = NUL; 374 v = find_var(name, NULL, no_autoload); 375 name[*lenp] = cc; 376 if (v != NULL && v->di_tv.v_type == VAR_FUNC) 377 { 378 if (v->di_tv.vval.v_string == NULL) 379 { 380 *lenp = 0; 381 return (char_u *)""; /* just in case */ 382 } 383 s = v->di_tv.vval.v_string; 384 *lenp = (int)STRLEN(s); 385 return s; 386 } 387 388 if (v != NULL && v->di_tv.v_type == VAR_PARTIAL) 389 { 390 partial_T *pt = v->di_tv.vval.v_partial; 391 392 if (pt == NULL) 393 { 394 *lenp = 0; 395 return (char_u *)""; /* just in case */ 396 } 397 if (partialp != NULL) 398 *partialp = pt; 399 s = partial_name(pt); 400 *lenp = (int)STRLEN(s); 401 return s; 402 } 403 404 return name; 405 } 406 407 /* 408 * Give an error message with a function name. Handle <SNR> things. 409 * "ermsg" is to be passed without translation, use N_() instead of _(). 410 */ 411 static void 412 emsg_funcname(char *ermsg, char_u *name) 413 { 414 char_u *p; 415 416 if (*name == K_SPECIAL) 417 p = concat_str((char_u *)"<SNR>", name + 3); 418 else 419 p = name; 420 semsg(_(ermsg), p); 421 if (p != name) 422 vim_free(p); 423 } 424 425 /* 426 * Allocate a variable for the result of a function. 427 * Return OK or FAIL. 428 */ 429 int 430 get_func_tv( 431 char_u *name, // name of the function 432 int len, // length of "name" or -1 to use strlen() 433 typval_T *rettv, 434 char_u **arg, // argument, pointing to the '(' 435 funcexe_T *funcexe) // various values 436 { 437 char_u *argp; 438 int ret = OK; 439 typval_T argvars[MAX_FUNC_ARGS + 1]; /* vars for arguments */ 440 int argcount = 0; /* number of arguments found */ 441 442 /* 443 * Get the arguments. 444 */ 445 argp = *arg; 446 while (argcount < MAX_FUNC_ARGS - (funcexe->partial == NULL ? 0 447 : funcexe->partial->pt_argc)) 448 { 449 argp = skipwhite(argp + 1); /* skip the '(' or ',' */ 450 if (*argp == ')' || *argp == ',' || *argp == NUL) 451 break; 452 if (eval1(&argp, &argvars[argcount], funcexe->evaluate) == FAIL) 453 { 454 ret = FAIL; 455 break; 456 } 457 ++argcount; 458 if (*argp != ',') 459 break; 460 } 461 if (*argp == ')') 462 ++argp; 463 else 464 ret = FAIL; 465 466 if (ret == OK) 467 { 468 int i = 0; 469 470 if (get_vim_var_nr(VV_TESTING)) 471 { 472 /* Prepare for calling test_garbagecollect_now(), need to know 473 * what variables are used on the call stack. */ 474 if (funcargs.ga_itemsize == 0) 475 ga_init2(&funcargs, (int)sizeof(typval_T *), 50); 476 for (i = 0; i < argcount; ++i) 477 if (ga_grow(&funcargs, 1) == OK) 478 ((typval_T **)funcargs.ga_data)[funcargs.ga_len++] = 479 &argvars[i]; 480 } 481 482 ret = call_func(name, len, rettv, argcount, argvars, funcexe); 483 484 funcargs.ga_len -= i; 485 } 486 else if (!aborting()) 487 { 488 if (argcount == MAX_FUNC_ARGS) 489 emsg_funcname(N_("E740: Too many arguments for function %s"), name); 490 else 491 emsg_funcname(N_("E116: Invalid arguments for function %s"), name); 492 } 493 494 while (--argcount >= 0) 495 clear_tv(&argvars[argcount]); 496 497 *arg = skipwhite(argp); 498 return ret; 499 } 500 501 #define FLEN_FIXED 40 502 503 /* 504 * Return TRUE if "p" starts with "<SID>" or "s:". 505 * Only works if eval_fname_script() returned non-zero for "p"! 506 */ 507 static int 508 eval_fname_sid(char_u *p) 509 { 510 return (*p == 's' || TOUPPER_ASC(p[2]) == 'I'); 511 } 512 513 /* 514 * In a script change <SID>name() and s:name() to K_SNR 123_name(). 515 * Change <SNR>123_name() to K_SNR 123_name(). 516 * Use "fname_buf[FLEN_FIXED + 1]" when it fits, otherwise allocate memory 517 * (slow). 518 */ 519 static char_u * 520 fname_trans_sid(char_u *name, char_u *fname_buf, char_u **tofree, int *error) 521 { 522 int llen; 523 char_u *fname; 524 int i; 525 526 llen = eval_fname_script(name); 527 if (llen > 0) 528 { 529 fname_buf[0] = K_SPECIAL; 530 fname_buf[1] = KS_EXTRA; 531 fname_buf[2] = (int)KE_SNR; 532 i = 3; 533 if (eval_fname_sid(name)) /* "<SID>" or "s:" */ 534 { 535 if (current_sctx.sc_sid <= 0) 536 *error = ERROR_SCRIPT; 537 else 538 { 539 sprintf((char *)fname_buf + 3, "%ld_", 540 (long)current_sctx.sc_sid); 541 i = (int)STRLEN(fname_buf); 542 } 543 } 544 if (i + STRLEN(name + llen) < FLEN_FIXED) 545 { 546 STRCPY(fname_buf + i, name + llen); 547 fname = fname_buf; 548 } 549 else 550 { 551 fname = alloc(i + STRLEN(name + llen) + 1); 552 if (fname == NULL) 553 *error = ERROR_OTHER; 554 else 555 { 556 *tofree = fname; 557 mch_memmove(fname, fname_buf, (size_t)i); 558 STRCPY(fname + i, name + llen); 559 } 560 } 561 } 562 else 563 fname = name; 564 return fname; 565 } 566 567 /* 568 * Find a function by name, return pointer to it in ufuncs. 569 * Return NULL for unknown function. 570 */ 571 ufunc_T * 572 find_func(char_u *name) 573 { 574 hashitem_T *hi; 575 576 hi = hash_find(&func_hashtab, name); 577 if (!HASHITEM_EMPTY(hi)) 578 return HI2UF(hi); 579 return NULL; 580 } 581 582 /* 583 * Copy the function name of "fp" to buffer "buf". 584 * "buf" must be able to hold the function name plus three bytes. 585 * Takes care of script-local function names. 586 */ 587 static void 588 cat_func_name(char_u *buf, ufunc_T *fp) 589 { 590 if (fp->uf_name[0] == K_SPECIAL) 591 { 592 STRCPY(buf, "<SNR>"); 593 STRCAT(buf, fp->uf_name + 3); 594 } 595 else 596 STRCPY(buf, fp->uf_name); 597 } 598 599 /* 600 * Add a number variable "name" to dict "dp" with value "nr". 601 */ 602 static void 603 add_nr_var( 604 dict_T *dp, 605 dictitem_T *v, 606 char *name, 607 varnumber_T nr) 608 { 609 STRCPY(v->di_key, name); 610 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 611 hash_add(&dp->dv_hashtab, DI2HIKEY(v)); 612 v->di_tv.v_type = VAR_NUMBER; 613 v->di_tv.v_lock = VAR_FIXED; 614 v->di_tv.vval.v_number = nr; 615 } 616 617 /* 618 * Free "fc". 619 */ 620 static void 621 free_funccal(funccall_T *fc) 622 { 623 int i; 624 625 for (i = 0; i < fc->fc_funcs.ga_len; ++i) 626 { 627 ufunc_T *fp = ((ufunc_T **)(fc->fc_funcs.ga_data))[i]; 628 629 // When garbage collecting a funccall_T may be freed before the 630 // function that references it, clear its uf_scoped field. 631 // The function may have been redefined and point to another 632 // funccall_T, don't clear it then. 633 if (fp != NULL && fp->uf_scoped == fc) 634 fp->uf_scoped = NULL; 635 } 636 ga_clear(&fc->fc_funcs); 637 638 func_ptr_unref(fc->func); 639 vim_free(fc); 640 } 641 642 /* 643 * Free "fc" and what it contains. 644 * Can be called only when "fc" is kept beyond the period of it called, 645 * i.e. after cleanup_function_call(fc). 646 */ 647 static void 648 free_funccal_contents(funccall_T *fc) 649 { 650 listitem_T *li; 651 652 // Free all l: variables. 653 vars_clear(&fc->l_vars.dv_hashtab); 654 655 // Free all a: variables. 656 vars_clear(&fc->l_avars.dv_hashtab); 657 658 // Free the a:000 variables. 659 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next) 660 clear_tv(&li->li_tv); 661 662 free_funccal(fc); 663 } 664 665 /* 666 * Handle the last part of returning from a function: free the local hashtable. 667 * Unless it is still in use by a closure. 668 */ 669 static void 670 cleanup_function_call(funccall_T *fc) 671 { 672 int may_free_fc = fc->fc_refcount <= 0; 673 int free_fc = TRUE; 674 675 current_funccal = fc->caller; 676 677 // Free all l: variables if not referred. 678 if (may_free_fc && fc->l_vars.dv_refcount == DO_NOT_FREE_CNT) 679 vars_clear(&fc->l_vars.dv_hashtab); 680 else 681 free_fc = FALSE; 682 683 // If the a:000 list and the l: and a: dicts are not referenced and 684 // there is no closure using it, we can free the funccall_T and what's 685 // in it. 686 if (may_free_fc && fc->l_avars.dv_refcount == DO_NOT_FREE_CNT) 687 vars_clear_ext(&fc->l_avars.dv_hashtab, FALSE); 688 else 689 { 690 int todo; 691 hashitem_T *hi; 692 dictitem_T *di; 693 694 free_fc = FALSE; 695 696 // Make a copy of the a: variables, since we didn't do that above. 697 todo = (int)fc->l_avars.dv_hashtab.ht_used; 698 for (hi = fc->l_avars.dv_hashtab.ht_array; todo > 0; ++hi) 699 { 700 if (!HASHITEM_EMPTY(hi)) 701 { 702 --todo; 703 di = HI2DI(hi); 704 copy_tv(&di->di_tv, &di->di_tv); 705 } 706 } 707 } 708 709 if (may_free_fc && fc->l_varlist.lv_refcount == DO_NOT_FREE_CNT) 710 fc->l_varlist.lv_first = NULL; 711 else 712 { 713 listitem_T *li; 714 715 free_fc = FALSE; 716 717 // Make a copy of the a:000 items, since we didn't do that above. 718 for (li = fc->l_varlist.lv_first; li != NULL; li = li->li_next) 719 copy_tv(&li->li_tv, &li->li_tv); 720 } 721 722 if (free_fc) 723 free_funccal(fc); 724 else 725 { 726 static int made_copy = 0; 727 728 // "fc" is still in use. This can happen when returning "a:000", 729 // assigning "l:" to a global variable or defining a closure. 730 // Link "fc" in the list for garbage collection later. 731 fc->caller = previous_funccal; 732 previous_funccal = fc; 733 734 if (want_garbage_collect) 735 // If garbage collector is ready, clear count. 736 made_copy = 0; 737 else if (++made_copy >= (int)((4096 * 1024) / sizeof(*fc))) 738 { 739 // We have made a lot of copies, worth 4 Mbyte. This can happen 740 // when repetitively calling a function that creates a reference to 741 // itself somehow. Call the garbage collector soon to avoid using 742 // too much memory. 743 made_copy = 0; 744 want_garbage_collect = TRUE; 745 } 746 } 747 } 748 749 /* 750 * Call a user function. 751 */ 752 static void 753 call_user_func( 754 ufunc_T *fp, /* pointer to function */ 755 int argcount, /* nr of args */ 756 typval_T *argvars, /* arguments */ 757 typval_T *rettv, /* return value */ 758 linenr_T firstline, /* first line of range */ 759 linenr_T lastline, /* last line of range */ 760 dict_T *selfdict) /* Dictionary for "self" */ 761 { 762 char_u *save_sourcing_name; 763 linenr_T save_sourcing_lnum; 764 sctx_T save_current_sctx; 765 int using_sandbox = FALSE; 766 funccall_T *fc; 767 int save_did_emsg; 768 int default_arg_err = FALSE; 769 static int depth = 0; 770 dictitem_T *v; 771 int fixvar_idx = 0; /* index in fixvar[] */ 772 int i; 773 int ai; 774 int islambda = FALSE; 775 char_u numbuf[NUMBUFLEN]; 776 char_u *name; 777 size_t len; 778 #ifdef FEAT_PROFILE 779 proftime_T wait_start; 780 proftime_T call_start; 781 int started_profiling = FALSE; 782 #endif 783 784 /* If depth of calling is getting too high, don't execute the function */ 785 if (depth >= p_mfd) 786 { 787 emsg(_("E132: Function call depth is higher than 'maxfuncdepth'")); 788 rettv->v_type = VAR_NUMBER; 789 rettv->vval.v_number = -1; 790 return; 791 } 792 ++depth; 793 794 line_breakcheck(); /* check for CTRL-C hit */ 795 796 fc = ALLOC_CLEAR_ONE(funccall_T); 797 if (fc == NULL) 798 return; 799 fc->caller = current_funccal; 800 current_funccal = fc; 801 fc->func = fp; 802 fc->rettv = rettv; 803 rettv->vval.v_number = 0; 804 fc->linenr = 0; 805 fc->returned = FALSE; 806 fc->level = ex_nesting_level; 807 /* Check if this function has a breakpoint. */ 808 fc->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, (linenr_T)0); 809 fc->dbg_tick = debug_tick; 810 /* Set up fields for closure. */ 811 fc->fc_refcount = 0; 812 fc->fc_copyID = 0; 813 ga_init2(&fc->fc_funcs, sizeof(ufunc_T *), 1); 814 func_ptr_ref(fp); 815 816 if (STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 817 islambda = TRUE; 818 819 /* 820 * Note about using fc->fixvar[]: This is an array of FIXVAR_CNT variables 821 * with names up to VAR_SHORT_LEN long. This avoids having to alloc/free 822 * each argument variable and saves a lot of time. 823 */ 824 /* 825 * Init l: variables. 826 */ 827 init_var_dict(&fc->l_vars, &fc->l_vars_var, VAR_DEF_SCOPE); 828 if (selfdict != NULL) 829 { 830 /* Set l:self to "selfdict". Use "name" to avoid a warning from 831 * some compiler that checks the destination size. */ 832 v = &fc->fixvar[fixvar_idx++].var; 833 name = v->di_key; 834 STRCPY(name, "self"); 835 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 836 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 837 v->di_tv.v_type = VAR_DICT; 838 v->di_tv.v_lock = 0; 839 v->di_tv.vval.v_dict = selfdict; 840 ++selfdict->dv_refcount; 841 } 842 843 /* 844 * Init a: variables. 845 * Set a:0 to "argcount" less number of named arguments, if >= 0. 846 * Set a:000 to a list with room for the "..." arguments. 847 */ 848 init_var_dict(&fc->l_avars, &fc->l_avars_var, VAR_SCOPE); 849 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "0", 850 (varnumber_T)(argcount >= fp->uf_args.ga_len 851 ? argcount - fp->uf_args.ga_len : 0)); 852 fc->l_avars.dv_lock = VAR_FIXED; 853 /* Use "name" to avoid a warning from some compiler that checks the 854 * destination size. */ 855 v = &fc->fixvar[fixvar_idx++].var; 856 name = v->di_key; 857 STRCPY(name, "000"); 858 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 859 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 860 v->di_tv.v_type = VAR_LIST; 861 v->di_tv.v_lock = VAR_FIXED; 862 v->di_tv.vval.v_list = &fc->l_varlist; 863 vim_memset(&fc->l_varlist, 0, sizeof(list_T)); 864 fc->l_varlist.lv_refcount = DO_NOT_FREE_CNT; 865 fc->l_varlist.lv_lock = VAR_FIXED; 866 867 /* 868 * Set a:firstline to "firstline" and a:lastline to "lastline". 869 * Set a:name to named arguments. 870 * Set a:N to the "..." arguments. 871 */ 872 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "firstline", 873 (varnumber_T)firstline); 874 add_nr_var(&fc->l_avars, &fc->fixvar[fixvar_idx++].var, "lastline", 875 (varnumber_T)lastline); 876 for (i = 0; i < argcount || i < fp->uf_args.ga_len; ++i) 877 { 878 int addlocal = FALSE; 879 typval_T def_rettv; 880 int isdefault = FALSE; 881 882 ai = i - fp->uf_args.ga_len; 883 if (ai < 0) 884 { 885 /* named argument a:name */ 886 name = FUNCARG(fp, i); 887 if (islambda) 888 addlocal = TRUE; 889 890 // evaluate named argument default expression 891 isdefault = ai + fp->uf_def_args.ga_len >= 0 892 && (i >= argcount || (argvars[i].v_type == VAR_SPECIAL 893 && argvars[i].vval.v_number == VVAL_NONE)); 894 if (isdefault) 895 { 896 char_u *default_expr = NULL; 897 def_rettv.v_type = VAR_NUMBER; 898 def_rettv.vval.v_number = -1; 899 900 default_expr = ((char_u **)(fp->uf_def_args.ga_data)) 901 [ai + fp->uf_def_args.ga_len]; 902 if (eval1(&default_expr, &def_rettv, TRUE) == FAIL) 903 { 904 default_arg_err = 1; 905 break; 906 } 907 } 908 } 909 else 910 { 911 /* "..." argument a:1, a:2, etc. */ 912 sprintf((char *)numbuf, "%d", ai + 1); 913 name = numbuf; 914 } 915 if (fixvar_idx < FIXVAR_CNT && STRLEN(name) <= VAR_SHORT_LEN) 916 { 917 v = &fc->fixvar[fixvar_idx++].var; 918 v->di_flags = DI_FLAGS_RO | DI_FLAGS_FIX; 919 STRCPY(v->di_key, name); 920 } 921 else 922 { 923 v = dictitem_alloc(name); 924 if (v == NULL) 925 break; 926 v->di_flags |= DI_FLAGS_RO | DI_FLAGS_FIX; 927 } 928 929 // Note: the values are copied directly to avoid alloc/free. 930 // "argvars" must have VAR_FIXED for v_lock. 931 v->di_tv = isdefault ? def_rettv : argvars[i]; 932 v->di_tv.v_lock = VAR_FIXED; 933 934 if (addlocal) 935 { 936 /* Named arguments should be accessed without the "a:" prefix in 937 * lambda expressions. Add to the l: dict. */ 938 copy_tv(&v->di_tv, &v->di_tv); 939 hash_add(&fc->l_vars.dv_hashtab, DI2HIKEY(v)); 940 } 941 else 942 hash_add(&fc->l_avars.dv_hashtab, DI2HIKEY(v)); 943 944 if (ai >= 0 && ai < MAX_FUNC_ARGS) 945 { 946 listitem_T *li = &fc->l_listitems[ai]; 947 948 li->li_tv = argvars[i]; 949 li->li_tv.v_lock = VAR_FIXED; 950 list_append(&fc->l_varlist, li); 951 } 952 } 953 954 /* Don't redraw while executing the function. */ 955 ++RedrawingDisabled; 956 save_sourcing_name = sourcing_name; 957 save_sourcing_lnum = sourcing_lnum; 958 sourcing_lnum = 1; 959 960 if (fp->uf_flags & FC_SANDBOX) 961 { 962 using_sandbox = TRUE; 963 ++sandbox; 964 } 965 966 /* need space for function name + ("function " + 3) or "[number]" */ 967 len = (save_sourcing_name == NULL ? 0 : STRLEN(save_sourcing_name)) 968 + STRLEN(fp->uf_name) + 20; 969 sourcing_name = alloc(len); 970 if (sourcing_name != NULL) 971 { 972 if (save_sourcing_name != NULL 973 && STRNCMP(save_sourcing_name, "function ", 9) == 0) 974 sprintf((char *)sourcing_name, "%s[%d]..", 975 save_sourcing_name, (int)save_sourcing_lnum); 976 else 977 STRCPY(sourcing_name, "function "); 978 cat_func_name(sourcing_name + STRLEN(sourcing_name), fp); 979 980 if (p_verbose >= 12) 981 { 982 ++no_wait_return; 983 verbose_enter_scroll(); 984 985 smsg(_("calling %s"), sourcing_name); 986 if (p_verbose >= 14) 987 { 988 char_u buf[MSG_BUF_LEN]; 989 char_u numbuf2[NUMBUFLEN]; 990 char_u *tofree; 991 char_u *s; 992 993 msg_puts("("); 994 for (i = 0; i < argcount; ++i) 995 { 996 if (i > 0) 997 msg_puts(", "); 998 if (argvars[i].v_type == VAR_NUMBER) 999 msg_outnum((long)argvars[i].vval.v_number); 1000 else 1001 { 1002 /* Do not want errors such as E724 here. */ 1003 ++emsg_off; 1004 s = tv2string(&argvars[i], &tofree, numbuf2, 0); 1005 --emsg_off; 1006 if (s != NULL) 1007 { 1008 if (vim_strsize(s) > MSG_BUF_CLEN) 1009 { 1010 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 1011 s = buf; 1012 } 1013 msg_puts((char *)s); 1014 vim_free(tofree); 1015 } 1016 } 1017 } 1018 msg_puts(")"); 1019 } 1020 msg_puts("\n"); /* don't overwrite this either */ 1021 1022 verbose_leave_scroll(); 1023 --no_wait_return; 1024 } 1025 } 1026 #ifdef FEAT_PROFILE 1027 if (do_profiling == PROF_YES) 1028 { 1029 if (!fp->uf_profiling && has_profiling(FALSE, fp->uf_name, NULL)) 1030 { 1031 started_profiling = TRUE; 1032 func_do_profile(fp); 1033 } 1034 if (fp->uf_profiling 1035 || (fc->caller != NULL && fc->caller->func->uf_profiling)) 1036 { 1037 ++fp->uf_tm_count; 1038 profile_start(&call_start); 1039 profile_zero(&fp->uf_tm_children); 1040 } 1041 script_prof_save(&wait_start); 1042 } 1043 #endif 1044 1045 save_current_sctx = current_sctx; 1046 current_sctx = fp->uf_script_ctx; 1047 save_did_emsg = did_emsg; 1048 did_emsg = FALSE; 1049 1050 if (default_arg_err && (fp->uf_flags & FC_ABORT)) 1051 did_emsg = TRUE; 1052 else 1053 // call do_cmdline() to execute the lines 1054 do_cmdline(NULL, get_func_line, (void *)fc, 1055 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT); 1056 1057 --RedrawingDisabled; 1058 1059 /* when the function was aborted because of an error, return -1 */ 1060 if ((did_emsg && (fp->uf_flags & FC_ABORT)) || rettv->v_type == VAR_UNKNOWN) 1061 { 1062 clear_tv(rettv); 1063 rettv->v_type = VAR_NUMBER; 1064 rettv->vval.v_number = -1; 1065 } 1066 1067 #ifdef FEAT_PROFILE 1068 if (do_profiling == PROF_YES && (fp->uf_profiling 1069 || (fc->caller != NULL && fc->caller->func->uf_profiling))) 1070 { 1071 profile_end(&call_start); 1072 profile_sub_wait(&wait_start, &call_start); 1073 profile_add(&fp->uf_tm_total, &call_start); 1074 profile_self(&fp->uf_tm_self, &call_start, &fp->uf_tm_children); 1075 if (fc->caller != NULL && fc->caller->func->uf_profiling) 1076 { 1077 profile_add(&fc->caller->func->uf_tm_children, &call_start); 1078 profile_add(&fc->caller->func->uf_tml_children, &call_start); 1079 } 1080 if (started_profiling) 1081 // make a ":profdel func" stop profiling the function 1082 fp->uf_profiling = FALSE; 1083 } 1084 #endif 1085 1086 /* when being verbose, mention the return value */ 1087 if (p_verbose >= 12) 1088 { 1089 ++no_wait_return; 1090 verbose_enter_scroll(); 1091 1092 if (aborting()) 1093 smsg(_("%s aborted"), sourcing_name); 1094 else if (fc->rettv->v_type == VAR_NUMBER) 1095 smsg(_("%s returning #%ld"), sourcing_name, 1096 (long)fc->rettv->vval.v_number); 1097 else 1098 { 1099 char_u buf[MSG_BUF_LEN]; 1100 char_u numbuf2[NUMBUFLEN]; 1101 char_u *tofree; 1102 char_u *s; 1103 1104 /* The value may be very long. Skip the middle part, so that we 1105 * have some idea how it starts and ends. smsg() would always 1106 * truncate it at the end. Don't want errors such as E724 here. */ 1107 ++emsg_off; 1108 s = tv2string(fc->rettv, &tofree, numbuf2, 0); 1109 --emsg_off; 1110 if (s != NULL) 1111 { 1112 if (vim_strsize(s) > MSG_BUF_CLEN) 1113 { 1114 trunc_string(s, buf, MSG_BUF_CLEN, MSG_BUF_LEN); 1115 s = buf; 1116 } 1117 smsg(_("%s returning %s"), sourcing_name, s); 1118 vim_free(tofree); 1119 } 1120 } 1121 msg_puts("\n"); /* don't overwrite this either */ 1122 1123 verbose_leave_scroll(); 1124 --no_wait_return; 1125 } 1126 1127 vim_free(sourcing_name); 1128 sourcing_name = save_sourcing_name; 1129 sourcing_lnum = save_sourcing_lnum; 1130 current_sctx = save_current_sctx; 1131 #ifdef FEAT_PROFILE 1132 if (do_profiling == PROF_YES) 1133 script_prof_restore(&wait_start); 1134 #endif 1135 if (using_sandbox) 1136 --sandbox; 1137 1138 if (p_verbose >= 12 && sourcing_name != NULL) 1139 { 1140 ++no_wait_return; 1141 verbose_enter_scroll(); 1142 1143 smsg(_("continuing in %s"), sourcing_name); 1144 msg_puts("\n"); /* don't overwrite this either */ 1145 1146 verbose_leave_scroll(); 1147 --no_wait_return; 1148 } 1149 1150 did_emsg |= save_did_emsg; 1151 --depth; 1152 1153 cleanup_function_call(fc); 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 = hash_find(&func_hashtab, UF2HIKEY(fp)); 1197 1198 if (!HASHITEM_EMPTY(hi)) 1199 { 1200 hash_remove(&func_hashtab, hi); 1201 return TRUE; 1202 } 1203 return FALSE; 1204 } 1205 1206 static void 1207 func_clear_items(ufunc_T *fp) 1208 { 1209 ga_clear_strings(&(fp->uf_args)); 1210 ga_clear_strings(&(fp->uf_def_args)); 1211 ga_clear_strings(&(fp->uf_lines)); 1212 #ifdef FEAT_PROFILE 1213 vim_free(fp->uf_tml_count); 1214 fp->uf_tml_count = NULL; 1215 vim_free(fp->uf_tml_total); 1216 fp->uf_tml_total = NULL; 1217 vim_free(fp->uf_tml_self); 1218 fp->uf_tml_self = NULL; 1219 #endif 1220 } 1221 1222 /* 1223 * Free all things that a function contains. Does not free the function 1224 * itself, use func_free() for that. 1225 * When "force" is TRUE we are exiting. 1226 */ 1227 static void 1228 func_clear(ufunc_T *fp, int force) 1229 { 1230 if (fp->uf_cleared) 1231 return; 1232 fp->uf_cleared = TRUE; 1233 1234 /* clear this function */ 1235 func_clear_items(fp); 1236 funccal_unref(fp->uf_scoped, fp, force); 1237 } 1238 1239 /* 1240 * Free a function and remove it from the list of functions. Does not free 1241 * what a function contains, call func_clear() first. 1242 */ 1243 static void 1244 func_free(ufunc_T *fp) 1245 { 1246 /* only remove it when not done already, otherwise we would remove a newer 1247 * version of the function */ 1248 if ((fp->uf_flags & (FC_DELETED | FC_REMOVED)) == 0) 1249 func_remove(fp); 1250 1251 vim_free(fp); 1252 } 1253 1254 /* 1255 * Free all things that a function contains and free the function itself. 1256 * When "force" is TRUE we are exiting. 1257 */ 1258 static void 1259 func_clear_free(ufunc_T *fp, int force) 1260 { 1261 func_clear(fp, force); 1262 func_free(fp); 1263 } 1264 1265 /* 1266 * There are two kinds of function names: 1267 * 1. ordinary names, function defined with :function 1268 * 2. numbered functions and lambdas 1269 * For the first we only count the name stored in func_hashtab as a reference, 1270 * using function() does not count as a reference, because the function is 1271 * looked up by name. 1272 */ 1273 static int 1274 func_name_refcount(char_u *name) 1275 { 1276 return isdigit(*name) || *name == '<'; 1277 } 1278 1279 static funccal_entry_T *funccal_stack = NULL; 1280 1281 /* 1282 * Save the current function call pointer, and set it to NULL. 1283 * Used when executing autocommands and for ":source". 1284 */ 1285 void 1286 save_funccal(funccal_entry_T *entry) 1287 { 1288 entry->top_funccal = current_funccal; 1289 entry->next = funccal_stack; 1290 funccal_stack = entry; 1291 current_funccal = NULL; 1292 } 1293 1294 void 1295 restore_funccal(void) 1296 { 1297 if (funccal_stack == NULL) 1298 iemsg("INTERNAL: restore_funccal()"); 1299 else 1300 { 1301 current_funccal = funccal_stack->top_funccal; 1302 funccal_stack = funccal_stack->next; 1303 } 1304 } 1305 1306 funccall_T * 1307 get_current_funccal(void) 1308 { 1309 return current_funccal; 1310 } 1311 1312 #if defined(EXITFREE) || defined(PROTO) 1313 void 1314 free_all_functions(void) 1315 { 1316 hashitem_T *hi; 1317 ufunc_T *fp; 1318 long_u skipped = 0; 1319 long_u todo = 1; 1320 long_u used; 1321 1322 /* Clean up the current_funccal chain and the funccal stack. */ 1323 while (current_funccal != NULL) 1324 { 1325 clear_tv(current_funccal->rettv); 1326 cleanup_function_call(current_funccal); 1327 if (current_funccal == NULL && funccal_stack != NULL) 1328 restore_funccal(); 1329 } 1330 1331 /* First clear what the functions contain. Since this may lower the 1332 * reference count of a function, it may also free a function and change 1333 * the hash table. Restart if that happens. */ 1334 while (todo > 0) 1335 { 1336 todo = func_hashtab.ht_used; 1337 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 1338 if (!HASHITEM_EMPTY(hi)) 1339 { 1340 /* Only free functions that are not refcounted, those are 1341 * supposed to be freed when no longer referenced. */ 1342 fp = HI2UF(hi); 1343 if (func_name_refcount(fp->uf_name)) 1344 ++skipped; 1345 else 1346 { 1347 used = func_hashtab.ht_used; 1348 func_clear(fp, TRUE); 1349 if (used != func_hashtab.ht_used) 1350 { 1351 skipped = 0; 1352 break; 1353 } 1354 } 1355 --todo; 1356 } 1357 } 1358 1359 /* Now actually free the functions. Need to start all over every time, 1360 * because func_free() may change the hash table. */ 1361 skipped = 0; 1362 while (func_hashtab.ht_used > skipped) 1363 { 1364 todo = func_hashtab.ht_used; 1365 for (hi = func_hashtab.ht_array; todo > 0; ++hi) 1366 if (!HASHITEM_EMPTY(hi)) 1367 { 1368 --todo; 1369 /* Only free functions that are not refcounted, those are 1370 * supposed to be freed when no longer referenced. */ 1371 fp = HI2UF(hi); 1372 if (func_name_refcount(fp->uf_name)) 1373 ++skipped; 1374 else 1375 { 1376 func_free(fp); 1377 skipped = 0; 1378 break; 1379 } 1380 } 1381 } 1382 if (skipped == 0) 1383 hash_clear(&func_hashtab); 1384 } 1385 #endif 1386 1387 /* 1388 * Return TRUE if "name" looks like a builtin function name: starts with a 1389 * lower case letter and doesn't contain AUTOLOAD_CHAR. 1390 * "len" is the length of "name", or -1 for NUL terminated. 1391 */ 1392 static int 1393 builtin_function(char_u *name, int len) 1394 { 1395 char_u *p; 1396 1397 if (!ASCII_ISLOWER(name[0])) 1398 return FALSE; 1399 p = vim_strchr(name, AUTOLOAD_CHAR); 1400 return p == NULL || (len > 0 && p > name + len); 1401 } 1402 1403 int 1404 func_call( 1405 char_u *name, 1406 typval_T *args, 1407 partial_T *partial, 1408 dict_T *selfdict, 1409 typval_T *rettv) 1410 { 1411 listitem_T *item; 1412 typval_T argv[MAX_FUNC_ARGS + 1]; 1413 int argc = 0; 1414 int r = 0; 1415 1416 for (item = args->vval.v_list->lv_first; item != NULL; 1417 item = item->li_next) 1418 { 1419 if (argc == MAX_FUNC_ARGS - (partial == NULL ? 0 : partial->pt_argc)) 1420 { 1421 emsg(_("E699: Too many arguments")); 1422 break; 1423 } 1424 /* Make a copy of each argument. This is needed to be able to set 1425 * v_lock to VAR_FIXED in the copy without changing the original list. 1426 */ 1427 copy_tv(&item->li_tv, &argv[argc++]); 1428 } 1429 1430 if (item == NULL) 1431 { 1432 funcexe_T funcexe; 1433 1434 vim_memset(&funcexe, 0, sizeof(funcexe)); 1435 funcexe.firstline = curwin->w_cursor.lnum; 1436 funcexe.lastline = curwin->w_cursor.lnum; 1437 funcexe.evaluate = TRUE; 1438 funcexe.partial = partial; 1439 funcexe.selfdict = selfdict; 1440 r = call_func(name, -1, rettv, argc, argv, &funcexe); 1441 } 1442 1443 /* Free the arguments. */ 1444 while (argc > 0) 1445 clear_tv(&argv[--argc]); 1446 1447 return r; 1448 } 1449 1450 static int callback_depth = 0; 1451 1452 int 1453 get_callback_depth(void) 1454 { 1455 return callback_depth; 1456 } 1457 1458 /* 1459 * Invoke call_func() with a callback. 1460 */ 1461 int 1462 call_callback( 1463 callback_T *callback, 1464 int len, // length of "name" or -1 to use strlen() 1465 typval_T *rettv, // return value goes here 1466 int argcount, // number of "argvars" 1467 typval_T *argvars) // vars for arguments, must have "argcount" 1468 // PLUS ONE elements! 1469 { 1470 funcexe_T funcexe; 1471 int ret; 1472 1473 vim_memset(&funcexe, 0, sizeof(funcexe)); 1474 funcexe.evaluate = TRUE; 1475 funcexe.partial = callback->cb_partial; 1476 ++callback_depth; 1477 ret = call_func(callback->cb_name, len, rettv, argcount, argvars, &funcexe); 1478 --callback_depth; 1479 return ret; 1480 } 1481 1482 /* 1483 * Call a function with its resolved parameters 1484 * 1485 * Return FAIL when the function can't be called, OK otherwise. 1486 * Also returns OK when an error was encountered while executing the function. 1487 */ 1488 int 1489 call_func( 1490 char_u *funcname, // name of the function 1491 int len, // length of "name" or -1 to use strlen() 1492 typval_T *rettv, // return value goes here 1493 int argcount_in, // number of "argvars" 1494 typval_T *argvars_in, // vars for arguments, must have "argcount" 1495 // PLUS ONE elements! 1496 funcexe_T *funcexe) // more arguments 1497 { 1498 int ret = FAIL; 1499 int error = ERROR_NONE; 1500 int i; 1501 ufunc_T *fp; 1502 char_u fname_buf[FLEN_FIXED + 1]; 1503 char_u *tofree = NULL; 1504 char_u *fname; 1505 char_u *name; 1506 int argcount = argcount_in; 1507 typval_T *argvars = argvars_in; 1508 dict_T *selfdict = funcexe->selfdict; 1509 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or 1510 // "funcexe->basetv" is not NULL 1511 int argv_clear = 0; 1512 int argv_base = 0; 1513 partial_T *partial = funcexe->partial; 1514 1515 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv) 1516 // even when call_func() returns FAIL. 1517 rettv->v_type = VAR_UNKNOWN; 1518 1519 // Make a copy of the name, if it comes from a funcref variable it could 1520 // be changed or deleted in the called function. 1521 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname); 1522 if (name == NULL) 1523 return ret; 1524 1525 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 1526 1527 if (funcexe->doesrange != NULL) 1528 *funcexe->doesrange = FALSE; 1529 1530 if (partial != NULL) 1531 { 1532 /* When the function has a partial with a dict and there is a dict 1533 * argument, use the dict argument. That is backwards compatible. 1534 * When the dict was bound explicitly use the one from the partial. */ 1535 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto)) 1536 selfdict = partial->pt_dict; 1537 if (error == ERROR_NONE && partial->pt_argc > 0) 1538 { 1539 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear) 1540 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]); 1541 for (i = 0; i < argcount_in; ++i) 1542 argv[i + argv_clear] = argvars_in[i]; 1543 argvars = argv; 1544 argcount = partial->pt_argc + argcount_in; 1545 } 1546 } 1547 1548 if (error == ERROR_NONE && funcexe->evaluate) 1549 { 1550 char_u *rfname = fname; 1551 1552 /* Ignore "g:" before a function name. */ 1553 if (fname[0] == 'g' && fname[1] == ':') 1554 rfname = fname + 2; 1555 1556 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */ 1557 rettv->vval.v_number = 0; 1558 error = ERROR_UNKNOWN; 1559 1560 if (!builtin_function(rfname, -1)) 1561 { 1562 /* 1563 * User defined function. 1564 */ 1565 if (partial != NULL && partial->pt_func != NULL) 1566 fp = partial->pt_func; 1567 else 1568 fp = find_func(rfname); 1569 1570 /* Trigger FuncUndefined event, may load the function. */ 1571 if (fp == NULL 1572 && apply_autocmds(EVENT_FUNCUNDEFINED, 1573 rfname, rfname, TRUE, NULL) 1574 && !aborting()) 1575 { 1576 /* executed an autocommand, search for the function again */ 1577 fp = find_func(rfname); 1578 } 1579 /* Try loading a package. */ 1580 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting()) 1581 { 1582 /* loaded a package, search for the function again */ 1583 fp = find_func(rfname); 1584 } 1585 1586 if (fp != NULL && (fp->uf_flags & FC_DELETED)) 1587 error = ERROR_DELETED; 1588 else if (fp != NULL) 1589 { 1590 if (funcexe->argv_func != NULL) 1591 argcount = funcexe->argv_func(argcount, argvars, 1592 fp->uf_args.ga_len); 1593 1594 if (funcexe->basetv != NULL) 1595 { 1596 // Method call: base->Method() 1597 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount); 1598 argv[0] = *funcexe->basetv; 1599 argcount++; 1600 argvars = argv; 1601 argv_base = 1; 1602 } 1603 1604 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL) 1605 *funcexe->doesrange = TRUE; 1606 if (argcount < fp->uf_args.ga_len - fp->uf_def_args.ga_len) 1607 error = ERROR_TOOFEW; 1608 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len) 1609 error = ERROR_TOOMANY; 1610 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL) 1611 error = ERROR_DICT; 1612 else 1613 { 1614 int did_save_redo = FALSE; 1615 save_redo_T save_redo; 1616 1617 /* 1618 * Call the user function. 1619 * Save and restore search patterns, script variables and 1620 * redo buffer. 1621 */ 1622 save_search_patterns(); 1623 if (!ins_compl_active()) 1624 { 1625 saveRedobuff(&save_redo); 1626 did_save_redo = TRUE; 1627 } 1628 ++fp->uf_calls; 1629 call_user_func(fp, argcount, argvars, rettv, 1630 funcexe->firstline, funcexe->lastline, 1631 (fp->uf_flags & FC_DICT) ? selfdict : NULL); 1632 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0) 1633 /* Function was unreferenced while being used, free it 1634 * now. */ 1635 func_clear_free(fp, FALSE); 1636 if (did_save_redo) 1637 restoreRedobuff(&save_redo); 1638 restore_search_patterns(); 1639 error = ERROR_NONE; 1640 } 1641 } 1642 } 1643 else if (funcexe->basetv != NULL) 1644 { 1645 /* 1646 * expr->method(): Find the method name in the table, call its 1647 * implementation with the base as one of the arguments. 1648 */ 1649 error = call_internal_method(fname, argcount, argvars, rettv, 1650 funcexe->basetv); 1651 } 1652 else 1653 { 1654 /* 1655 * Find the function name in the table, call its implementation. 1656 */ 1657 error = call_internal_func(fname, argcount, argvars, rettv); 1658 } 1659 /* 1660 * The function call (or "FuncUndefined" autocommand sequence) might 1661 * have been aborted by an error, an interrupt, or an explicitly thrown 1662 * exception that has not been caught so far. This situation can be 1663 * tested for by calling aborting(). For an error in an internal 1664 * function or for the "E132" error in call_user_func(), however, the 1665 * throw point at which the "force_abort" flag (temporarily reset by 1666 * emsg()) is normally updated has not been reached yet. We need to 1667 * update that flag first to make aborting() reliable. 1668 */ 1669 update_force_abort(); 1670 } 1671 if (error == ERROR_NONE) 1672 ret = OK; 1673 1674 /* 1675 * Report an error unless the argument evaluation or function call has been 1676 * cancelled due to an aborting error, an interrupt, or an exception. 1677 */ 1678 if (!aborting()) 1679 { 1680 switch (error) 1681 { 1682 case ERROR_UNKNOWN: 1683 emsg_funcname(N_("E117: Unknown function: %s"), name); 1684 break; 1685 case ERROR_NOTMETHOD: 1686 emsg_funcname( 1687 N_("E276: Cannot use function as a method: %s"), 1688 name); 1689 break; 1690 case ERROR_DELETED: 1691 emsg_funcname(N_("E933: Function was deleted: %s"), name); 1692 break; 1693 case ERROR_TOOMANY: 1694 emsg_funcname((char *)e_toomanyarg, name); 1695 break; 1696 case ERROR_TOOFEW: 1697 emsg_funcname( 1698 N_("E119: Not enough arguments for function: %s"), 1699 name); 1700 break; 1701 case ERROR_SCRIPT: 1702 emsg_funcname( 1703 N_("E120: Using <SID> not in a script context: %s"), 1704 name); 1705 break; 1706 case ERROR_DICT: 1707 emsg_funcname( 1708 N_("E725: Calling dict function without Dictionary: %s"), 1709 name); 1710 break; 1711 } 1712 } 1713 1714 // clear the copies made from the partial 1715 while (argv_clear > 0) 1716 clear_tv(&argv[--argv_clear + argv_base]); 1717 1718 vim_free(tofree); 1719 vim_free(name); 1720 1721 return ret; 1722 } 1723 1724 /* 1725 * List the head of the function: "name(arg1, arg2)". 1726 */ 1727 static void 1728 list_func_head(ufunc_T *fp, int indent) 1729 { 1730 int j; 1731 1732 msg_start(); 1733 if (indent) 1734 msg_puts(" "); 1735 msg_puts("function "); 1736 if (fp->uf_name[0] == K_SPECIAL) 1737 { 1738 msg_puts_attr("<SNR>", HL_ATTR(HLF_8)); 1739 msg_puts((char *)fp->uf_name + 3); 1740 } 1741 else 1742 msg_puts((char *)fp->uf_name); 1743 msg_putchar('('); 1744 for (j = 0; j < fp->uf_args.ga_len; ++j) 1745 { 1746 if (j) 1747 msg_puts(", "); 1748 msg_puts((char *)FUNCARG(fp, j)); 1749 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len) 1750 { 1751 msg_puts(" = "); 1752 msg_puts(((char **)(fp->uf_def_args.ga_data)) 1753 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]); 1754 } 1755 } 1756 if (fp->uf_varargs) 1757 { 1758 if (j) 1759 msg_puts(", "); 1760 msg_puts("..."); 1761 } 1762 msg_putchar(')'); 1763 if (fp->uf_flags & FC_ABORT) 1764 msg_puts(" abort"); 1765 if (fp->uf_flags & FC_RANGE) 1766 msg_puts(" range"); 1767 if (fp->uf_flags & FC_DICT) 1768 msg_puts(" dict"); 1769 if (fp->uf_flags & FC_CLOSURE) 1770 msg_puts(" closure"); 1771 msg_clr_eos(); 1772 if (p_verbose > 0) 1773 last_set_msg(fp->uf_script_ctx); 1774 } 1775 1776 /* 1777 * Get a function name, translating "<SID>" and "<SNR>". 1778 * Also handles a Funcref in a List or Dictionary. 1779 * Returns the function name in allocated memory, or NULL for failure. 1780 * flags: 1781 * TFN_INT: internal function name OK 1782 * TFN_QUIET: be quiet 1783 * TFN_NO_AUTOLOAD: do not use script autoloading 1784 * TFN_NO_DEREF: do not dereference a Funcref 1785 * Advances "pp" to just after the function name (if no error). 1786 */ 1787 char_u * 1788 trans_function_name( 1789 char_u **pp, 1790 int skip, /* only find the end, don't evaluate */ 1791 int flags, 1792 funcdict_T *fdp, /* return: info about dictionary used */ 1793 partial_T **partial) /* return: partial of a FuncRef */ 1794 { 1795 char_u *name = NULL; 1796 char_u *start; 1797 char_u *end; 1798 int lead; 1799 char_u sid_buf[20]; 1800 int len; 1801 lval_T lv; 1802 1803 if (fdp != NULL) 1804 vim_memset(fdp, 0, sizeof(funcdict_T)); 1805 start = *pp; 1806 1807 /* Check for hard coded <SNR>: already translated function ID (from a user 1808 * command). */ 1809 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA 1810 && (*pp)[2] == (int)KE_SNR) 1811 { 1812 *pp += 3; 1813 len = get_id_len(pp) + 3; 1814 return vim_strnsave(start, len); 1815 } 1816 1817 /* A name starting with "<SID>" or "<SNR>" is local to a script. But 1818 * don't skip over "s:", get_lval() needs it for "s:dict.func". */ 1819 lead = eval_fname_script(start); 1820 if (lead > 2) 1821 start += lead; 1822 1823 /* Note that TFN_ flags use the same values as GLV_ flags. */ 1824 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY, 1825 lead > 2 ? 0 : FNE_CHECK_START); 1826 if (end == start) 1827 { 1828 if (!skip) 1829 emsg(_("E129: Function name required")); 1830 goto theend; 1831 } 1832 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range))) 1833 { 1834 /* 1835 * Report an invalid expression in braces, unless the expression 1836 * evaluation has been cancelled due to an aborting error, an 1837 * interrupt, or an exception. 1838 */ 1839 if (!aborting()) 1840 { 1841 if (end != NULL) 1842 semsg(_(e_invarg2), start); 1843 } 1844 else 1845 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR); 1846 goto theend; 1847 } 1848 1849 if (lv.ll_tv != NULL) 1850 { 1851 if (fdp != NULL) 1852 { 1853 fdp->fd_dict = lv.ll_dict; 1854 fdp->fd_newkey = lv.ll_newkey; 1855 lv.ll_newkey = NULL; 1856 fdp->fd_di = lv.ll_di; 1857 } 1858 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL) 1859 { 1860 name = vim_strsave(lv.ll_tv->vval.v_string); 1861 *pp = end; 1862 } 1863 else if (lv.ll_tv->v_type == VAR_PARTIAL 1864 && lv.ll_tv->vval.v_partial != NULL) 1865 { 1866 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial)); 1867 *pp = end; 1868 if (partial != NULL) 1869 *partial = lv.ll_tv->vval.v_partial; 1870 } 1871 else 1872 { 1873 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL 1874 || lv.ll_dict == NULL || fdp->fd_newkey == NULL)) 1875 emsg(_(e_funcref)); 1876 else 1877 *pp = end; 1878 name = NULL; 1879 } 1880 goto theend; 1881 } 1882 1883 if (lv.ll_name == NULL) 1884 { 1885 /* Error found, but continue after the function name. */ 1886 *pp = end; 1887 goto theend; 1888 } 1889 1890 /* Check if the name is a Funcref. If so, use the value. */ 1891 if (lv.ll_exp_name != NULL) 1892 { 1893 len = (int)STRLEN(lv.ll_exp_name); 1894 name = deref_func_name(lv.ll_exp_name, &len, partial, 1895 flags & TFN_NO_AUTOLOAD); 1896 if (name == lv.ll_exp_name) 1897 name = NULL; 1898 } 1899 else if (!(flags & TFN_NO_DEREF)) 1900 { 1901 len = (int)(end - *pp); 1902 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD); 1903 if (name == *pp) 1904 name = NULL; 1905 } 1906 if (name != NULL) 1907 { 1908 name = vim_strsave(name); 1909 *pp = end; 1910 if (STRNCMP(name, "<SNR>", 5) == 0) 1911 { 1912 /* Change "<SNR>" to the byte sequence. */ 1913 name[0] = K_SPECIAL; 1914 name[1] = KS_EXTRA; 1915 name[2] = (int)KE_SNR; 1916 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1); 1917 } 1918 goto theend; 1919 } 1920 1921 if (lv.ll_exp_name != NULL) 1922 { 1923 len = (int)STRLEN(lv.ll_exp_name); 1924 if (lead <= 2 && lv.ll_name == lv.ll_exp_name 1925 && STRNCMP(lv.ll_name, "s:", 2) == 0) 1926 { 1927 /* When there was "s:" already or the name expanded to get a 1928 * leading "s:" then remove it. */ 1929 lv.ll_name += 2; 1930 len -= 2; 1931 lead = 2; 1932 } 1933 } 1934 else 1935 { 1936 /* skip over "s:" and "g:" */ 1937 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':')) 1938 lv.ll_name += 2; 1939 len = (int)(end - lv.ll_name); 1940 } 1941 1942 /* 1943 * Copy the function name to allocated memory. 1944 * Accept <SID>name() inside a script, translate into <SNR>123_name(). 1945 * Accept <SNR>123_name() outside a script. 1946 */ 1947 if (skip) 1948 lead = 0; /* do nothing */ 1949 else if (lead > 0) 1950 { 1951 lead = 3; 1952 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name)) 1953 || eval_fname_sid(*pp)) 1954 { 1955 /* It's "s:" or "<SID>" */ 1956 if (current_sctx.sc_sid <= 0) 1957 { 1958 emsg(_(e_usingsid)); 1959 goto theend; 1960 } 1961 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid); 1962 lead += (int)STRLEN(sid_buf); 1963 } 1964 } 1965 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len)) 1966 { 1967 semsg(_("E128: Function name must start with a capital or \"s:\": %s"), 1968 start); 1969 goto theend; 1970 } 1971 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF)) 1972 { 1973 char_u *cp = vim_strchr(lv.ll_name, ':'); 1974 1975 if (cp != NULL && cp < end) 1976 { 1977 semsg(_("E884: Function name cannot contain a colon: %s"), start); 1978 goto theend; 1979 } 1980 } 1981 1982 name = alloc(len + lead + 1); 1983 if (name != NULL) 1984 { 1985 if (lead > 0) 1986 { 1987 name[0] = K_SPECIAL; 1988 name[1] = KS_EXTRA; 1989 name[2] = (int)KE_SNR; 1990 if (lead > 3) /* If it's "<SID>" */ 1991 STRCPY(name + 3, sid_buf); 1992 } 1993 mch_memmove(name + lead, lv.ll_name, (size_t)len); 1994 name[lead + len] = NUL; 1995 } 1996 *pp = end; 1997 1998 theend: 1999 clear_lval(&lv); 2000 return name; 2001 } 2002 2003 /* 2004 * ":function" 2005 */ 2006 void 2007 ex_function(exarg_T *eap) 2008 { 2009 char_u *theline; 2010 char_u *line_to_free = NULL; 2011 int j; 2012 int c; 2013 int saved_did_emsg; 2014 int saved_wait_return = need_wait_return; 2015 char_u *name = NULL; 2016 char_u *p; 2017 char_u *arg; 2018 char_u *line_arg = NULL; 2019 garray_T newargs; 2020 garray_T default_args; 2021 garray_T newlines; 2022 int varargs = FALSE; 2023 int flags = 0; 2024 ufunc_T *fp; 2025 int overwrite = FALSE; 2026 int indent; 2027 int nesting; 2028 dictitem_T *v; 2029 funcdict_T fudi; 2030 static int func_nr = 0; /* number for nameless function */ 2031 int paren; 2032 hashtab_T *ht; 2033 int todo; 2034 hashitem_T *hi; 2035 int do_concat = TRUE; 2036 linenr_T sourcing_lnum_off; 2037 linenr_T sourcing_lnum_top; 2038 int is_heredoc = FALSE; 2039 char_u *skip_until = NULL; 2040 char_u *heredoc_trimmed = NULL; 2041 2042 /* 2043 * ":function" without argument: list functions. 2044 */ 2045 if (ends_excmd(*eap->arg)) 2046 { 2047 if (!eap->skip) 2048 { 2049 todo = (int)func_hashtab.ht_used; 2050 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 2051 { 2052 if (!HASHITEM_EMPTY(hi)) 2053 { 2054 --todo; 2055 fp = HI2UF(hi); 2056 if (message_filtered(fp->uf_name)) 2057 continue; 2058 if (!func_name_refcount(fp->uf_name)) 2059 list_func_head(fp, FALSE); 2060 } 2061 } 2062 } 2063 eap->nextcmd = check_nextcmd(eap->arg); 2064 return; 2065 } 2066 2067 /* 2068 * ":function /pat": list functions matching pattern. 2069 */ 2070 if (*eap->arg == '/') 2071 { 2072 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL); 2073 if (!eap->skip) 2074 { 2075 regmatch_T regmatch; 2076 2077 c = *p; 2078 *p = NUL; 2079 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC); 2080 *p = c; 2081 if (regmatch.regprog != NULL) 2082 { 2083 regmatch.rm_ic = p_ic; 2084 2085 todo = (int)func_hashtab.ht_used; 2086 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 2087 { 2088 if (!HASHITEM_EMPTY(hi)) 2089 { 2090 --todo; 2091 fp = HI2UF(hi); 2092 if (!isdigit(*fp->uf_name) 2093 && vim_regexec(®match, fp->uf_name, 0)) 2094 list_func_head(fp, FALSE); 2095 } 2096 } 2097 vim_regfree(regmatch.regprog); 2098 } 2099 } 2100 if (*p == '/') 2101 ++p; 2102 eap->nextcmd = check_nextcmd(p); 2103 return; 2104 } 2105 2106 /* 2107 * Get the function name. There are these situations: 2108 * func normal function name 2109 * "name" == func, "fudi.fd_dict" == NULL 2110 * dict.func new dictionary entry 2111 * "name" == NULL, "fudi.fd_dict" set, 2112 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func 2113 * dict.func existing dict entry with a Funcref 2114 * "name" == func, "fudi.fd_dict" set, 2115 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 2116 * dict.func existing dict entry that's not a Funcref 2117 * "name" == NULL, "fudi.fd_dict" set, 2118 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 2119 * s:func script-local function name 2120 * g:func global function name, same as "func" 2121 */ 2122 p = eap->arg; 2123 name = trans_function_name(&p, eap->skip, TFN_NO_AUTOLOAD, &fudi, NULL); 2124 paren = (vim_strchr(p, '(') != NULL); 2125 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip) 2126 { 2127 /* 2128 * Return on an invalid expression in braces, unless the expression 2129 * evaluation has been cancelled due to an aborting error, an 2130 * interrupt, or an exception. 2131 */ 2132 if (!aborting()) 2133 { 2134 if (!eap->skip && fudi.fd_newkey != NULL) 2135 semsg(_(e_dictkey), fudi.fd_newkey); 2136 vim_free(fudi.fd_newkey); 2137 return; 2138 } 2139 else 2140 eap->skip = TRUE; 2141 } 2142 2143 /* An error in a function call during evaluation of an expression in magic 2144 * braces should not cause the function not to be defined. */ 2145 saved_did_emsg = did_emsg; 2146 did_emsg = FALSE; 2147 2148 /* 2149 * ":function func" with only function name: list function. 2150 */ 2151 if (!paren) 2152 { 2153 if (!ends_excmd(*skipwhite(p))) 2154 { 2155 emsg(_(e_trailing)); 2156 goto ret_free; 2157 } 2158 eap->nextcmd = check_nextcmd(p); 2159 if (eap->nextcmd != NULL) 2160 *p = NUL; 2161 if (!eap->skip && !got_int) 2162 { 2163 fp = find_func(name); 2164 if (fp != NULL) 2165 { 2166 list_func_head(fp, TRUE); 2167 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j) 2168 { 2169 if (FUNCLINE(fp, j) == NULL) 2170 continue; 2171 msg_putchar('\n'); 2172 msg_outnum((long)(j + 1)); 2173 if (j < 9) 2174 msg_putchar(' '); 2175 if (j < 99) 2176 msg_putchar(' '); 2177 msg_prt_line(FUNCLINE(fp, j), FALSE); 2178 out_flush(); /* show a line at a time */ 2179 ui_breakcheck(); 2180 } 2181 if (!got_int) 2182 { 2183 msg_putchar('\n'); 2184 msg_puts(" endfunction"); 2185 } 2186 } 2187 else 2188 emsg_funcname(N_("E123: Undefined function: %s"), name); 2189 } 2190 goto ret_free; 2191 } 2192 2193 /* 2194 * ":function name(arg1, arg2)" Define function. 2195 */ 2196 p = skipwhite(p); 2197 if (*p != '(') 2198 { 2199 if (!eap->skip) 2200 { 2201 semsg(_("E124: Missing '(': %s"), eap->arg); 2202 goto ret_free; 2203 } 2204 /* attempt to continue by skipping some text */ 2205 if (vim_strchr(p, '(') != NULL) 2206 p = vim_strchr(p, '('); 2207 } 2208 p = skipwhite(p + 1); 2209 2210 ga_init2(&newlines, (int)sizeof(char_u *), 3); 2211 2212 if (!eap->skip) 2213 { 2214 /* Check the name of the function. Unless it's a dictionary function 2215 * (that we are overwriting). */ 2216 if (name != NULL) 2217 arg = name; 2218 else 2219 arg = fudi.fd_newkey; 2220 if (arg != NULL && (fudi.fd_di == NULL 2221 || (fudi.fd_di->di_tv.v_type != VAR_FUNC 2222 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL))) 2223 { 2224 if (*arg == K_SPECIAL) 2225 j = 3; 2226 else 2227 j = 0; 2228 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j]) 2229 : eval_isnamec(arg[j]))) 2230 ++j; 2231 if (arg[j] != NUL) 2232 emsg_funcname((char *)e_invarg2, arg); 2233 } 2234 /* Disallow using the g: dict. */ 2235 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE) 2236 emsg(_("E862: Cannot use g: here")); 2237 } 2238 2239 if (get_function_args(&p, ')', &newargs, &varargs, 2240 &default_args, eap->skip) == FAIL) 2241 goto errret_2; 2242 2243 /* find extra arguments "range", "dict", "abort" and "closure" */ 2244 for (;;) 2245 { 2246 p = skipwhite(p); 2247 if (STRNCMP(p, "range", 5) == 0) 2248 { 2249 flags |= FC_RANGE; 2250 p += 5; 2251 } 2252 else if (STRNCMP(p, "dict", 4) == 0) 2253 { 2254 flags |= FC_DICT; 2255 p += 4; 2256 } 2257 else if (STRNCMP(p, "abort", 5) == 0) 2258 { 2259 flags |= FC_ABORT; 2260 p += 5; 2261 } 2262 else if (STRNCMP(p, "closure", 7) == 0) 2263 { 2264 flags |= FC_CLOSURE; 2265 p += 7; 2266 if (current_funccal == NULL) 2267 { 2268 emsg_funcname(N_("E932: Closure function should not be at top level: %s"), 2269 name == NULL ? (char_u *)"" : name); 2270 goto erret; 2271 } 2272 } 2273 else 2274 break; 2275 } 2276 2277 /* When there is a line break use what follows for the function body. 2278 * Makes 'exe "func Test()\n...\nendfunc"' work. */ 2279 if (*p == '\n') 2280 line_arg = p + 1; 2281 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg) 2282 emsg(_(e_trailing)); 2283 2284 /* 2285 * Read the body of the function, until ":endfunction" is found. 2286 */ 2287 if (KeyTyped) 2288 { 2289 /* Check if the function already exists, don't let the user type the 2290 * whole function before telling him it doesn't work! For a script we 2291 * need to skip the body to be able to find what follows. */ 2292 if (!eap->skip && !eap->forceit) 2293 { 2294 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL) 2295 emsg(_(e_funcdict)); 2296 else if (name != NULL && find_func(name) != NULL) 2297 emsg_funcname(e_funcexts, name); 2298 } 2299 2300 if (!eap->skip && did_emsg) 2301 goto erret; 2302 2303 msg_putchar('\n'); /* don't overwrite the function name */ 2304 cmdline_row = msg_row; 2305 } 2306 2307 // Save the starting line number. 2308 sourcing_lnum_top = sourcing_lnum; 2309 2310 indent = 2; 2311 nesting = 0; 2312 for (;;) 2313 { 2314 if (KeyTyped) 2315 { 2316 msg_scroll = TRUE; 2317 saved_wait_return = FALSE; 2318 } 2319 need_wait_return = FALSE; 2320 2321 if (line_arg != NULL) 2322 { 2323 /* Use eap->arg, split up in parts by line breaks. */ 2324 theline = line_arg; 2325 p = vim_strchr(theline, '\n'); 2326 if (p == NULL) 2327 line_arg += STRLEN(line_arg); 2328 else 2329 { 2330 *p = NUL; 2331 line_arg = p + 1; 2332 } 2333 } 2334 else 2335 { 2336 vim_free(line_to_free); 2337 if (eap->getline == NULL) 2338 theline = getcmdline(':', 0L, indent, do_concat); 2339 else 2340 theline = eap->getline(':', eap->cookie, indent, do_concat); 2341 line_to_free = theline; 2342 } 2343 if (KeyTyped) 2344 lines_left = Rows - 1; 2345 if (theline == NULL) 2346 { 2347 emsg(_("E126: Missing :endfunction")); 2348 goto erret; 2349 } 2350 2351 /* Detect line continuation: sourcing_lnum increased more than one. */ 2352 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie); 2353 if (sourcing_lnum < sourcing_lnum_off) 2354 sourcing_lnum_off -= sourcing_lnum; 2355 else 2356 sourcing_lnum_off = 0; 2357 2358 if (skip_until != NULL) 2359 { 2360 // Don't check for ":endfunc" between 2361 // * ":append" and "." 2362 // * ":python <<EOF" and "EOF" 2363 // * ":let {var-name} =<< [trim] {marker}" and "{marker}" 2364 if (heredoc_trimmed == NULL 2365 || (is_heredoc && skipwhite(theline) == theline) 2366 || STRNCMP(theline, heredoc_trimmed, 2367 STRLEN(heredoc_trimmed)) == 0) 2368 { 2369 if (heredoc_trimmed == NULL) 2370 p = theline; 2371 else if (is_heredoc) 2372 p = skipwhite(theline) == theline 2373 ? theline : theline + STRLEN(heredoc_trimmed); 2374 else 2375 p = theline + STRLEN(heredoc_trimmed); 2376 if (STRCMP(p, skip_until) == 0) 2377 { 2378 VIM_CLEAR(skip_until); 2379 VIM_CLEAR(heredoc_trimmed); 2380 do_concat = TRUE; 2381 is_heredoc = FALSE; 2382 } 2383 } 2384 } 2385 else 2386 { 2387 /* skip ':' and blanks*/ 2388 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p) 2389 ; 2390 2391 /* Check for "endfunction". */ 2392 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0) 2393 { 2394 char_u *nextcmd = NULL; 2395 2396 if (*p == '|') 2397 nextcmd = p + 1; 2398 else if (line_arg != NULL && *skipwhite(line_arg) != NUL) 2399 nextcmd = line_arg; 2400 else if (*p != NUL && *p != '"' && p_verbose > 0) 2401 give_warning2( 2402 (char_u *)_("W22: Text found after :endfunction: %s"), 2403 p, TRUE); 2404 if (nextcmd != NULL) 2405 { 2406 /* Another command follows. If the line came from "eap" we 2407 * can simply point into it, otherwise we need to change 2408 * "eap->cmdlinep". */ 2409 eap->nextcmd = nextcmd; 2410 if (line_to_free != NULL) 2411 { 2412 vim_free(*eap->cmdlinep); 2413 *eap->cmdlinep = line_to_free; 2414 line_to_free = NULL; 2415 } 2416 } 2417 break; 2418 } 2419 2420 /* Increase indent inside "if", "while", "for" and "try", decrease 2421 * at "end". */ 2422 if (indent > 2 && STRNCMP(p, "end", 3) == 0) 2423 indent -= 2; 2424 else if (STRNCMP(p, "if", 2) == 0 2425 || STRNCMP(p, "wh", 2) == 0 2426 || STRNCMP(p, "for", 3) == 0 2427 || STRNCMP(p, "try", 3) == 0) 2428 indent += 2; 2429 2430 /* Check for defining a function inside this function. */ 2431 if (checkforcmd(&p, "function", 2)) 2432 { 2433 if (*p == '!') 2434 p = skipwhite(p + 1); 2435 p += eval_fname_script(p); 2436 vim_free(trans_function_name(&p, TRUE, 0, NULL, NULL)); 2437 if (*skipwhite(p) == '(') 2438 { 2439 ++nesting; 2440 indent += 2; 2441 } 2442 } 2443 2444 /* Check for ":append", ":change", ":insert". */ 2445 p = skip_range(p, NULL); 2446 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p')) 2447 || (p[0] == 'c' 2448 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h' 2449 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a' 2450 && (STRNCMP(&p[3], "nge", 3) != 0 2451 || !ASCII_ISALPHA(p[6]))))))) 2452 || (p[0] == 'i' 2453 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n' 2454 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's')))))) 2455 skip_until = vim_strsave((char_u *)"."); 2456 2457 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */ 2458 arg = skipwhite(skiptowhite(p)); 2459 if (arg[0] == '<' && arg[1] =='<' 2460 && ((p[0] == 'p' && p[1] == 'y' 2461 && (!ASCII_ISALNUM(p[2]) || p[2] == 't' 2462 || ((p[2] == '3' || p[2] == 'x') 2463 && !ASCII_ISALPHA(p[3])))) 2464 || (p[0] == 'p' && p[1] == 'e' 2465 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r')) 2466 || (p[0] == 't' && p[1] == 'c' 2467 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l')) 2468 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a' 2469 && !ASCII_ISALPHA(p[3])) 2470 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b' 2471 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y')) 2472 || (p[0] == 'm' && p[1] == 'z' 2473 && (!ASCII_ISALPHA(p[2]) || p[2] == 's')) 2474 )) 2475 { 2476 /* ":python <<" continues until a dot, like ":append" */ 2477 p = skipwhite(arg + 2); 2478 if (*p == NUL) 2479 skip_until = vim_strsave((char_u *)"."); 2480 else 2481 skip_until = vim_strsave(p); 2482 } 2483 2484 // Check for ":let v =<< [trim] EOF" 2485 arg = skipwhite(skiptowhite(p)); 2486 arg = skipwhite(skiptowhite(arg)); 2487 if (arg[0] == '=' && arg[1] == '<' && arg[2] =='<' 2488 && ((p[0] == 'l' 2489 && p[1] == 'e' 2490 && (!ASCII_ISALNUM(p[2]) 2491 || (p[2] == 't' && !ASCII_ISALNUM(p[3])))))) 2492 { 2493 p = skipwhite(arg + 3); 2494 if (STRNCMP(p, "trim", 4) == 0) 2495 { 2496 // Ignore leading white space. 2497 p = skipwhite(p + 4); 2498 heredoc_trimmed = vim_strnsave(theline, 2499 (int)(skipwhite(theline) - theline)); 2500 } 2501 skip_until = vim_strnsave(p, (int)(skiptowhite(p) - p)); 2502 do_concat = FALSE; 2503 is_heredoc = TRUE; 2504 } 2505 } 2506 2507 /* Add the line to the function. */ 2508 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL) 2509 goto erret; 2510 2511 /* Copy the line to newly allocated memory. get_one_sourceline() 2512 * allocates 250 bytes per line, this saves 80% on average. The cost 2513 * is an extra alloc/free. */ 2514 p = vim_strsave(theline); 2515 if (p == NULL) 2516 goto erret; 2517 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p; 2518 2519 /* Add NULL lines for continuation lines, so that the line count is 2520 * equal to the index in the growarray. */ 2521 while (sourcing_lnum_off-- > 0) 2522 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL; 2523 2524 /* Check for end of eap->arg. */ 2525 if (line_arg != NULL && *line_arg == NUL) 2526 line_arg = NULL; 2527 } 2528 2529 /* Don't define the function when skipping commands or when an error was 2530 * detected. */ 2531 if (eap->skip || did_emsg) 2532 goto erret; 2533 2534 /* 2535 * If there are no errors, add the function 2536 */ 2537 if (fudi.fd_dict == NULL) 2538 { 2539 v = find_var(name, &ht, FALSE); 2540 if (v != NULL && v->di_tv.v_type == VAR_FUNC) 2541 { 2542 emsg_funcname(N_("E707: Function name conflicts with variable: %s"), 2543 name); 2544 goto erret; 2545 } 2546 2547 fp = find_func(name); 2548 if (fp != NULL) 2549 { 2550 // Function can be replaced with "function!" and when sourcing the 2551 // same script again, but only once. 2552 if (!eap->forceit 2553 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid 2554 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)) 2555 { 2556 emsg_funcname(e_funcexts, name); 2557 goto erret; 2558 } 2559 if (fp->uf_calls > 0) 2560 { 2561 emsg_funcname( 2562 N_("E127: Cannot redefine function %s: It is in use"), 2563 name); 2564 goto erret; 2565 } 2566 if (fp->uf_refcount > 1) 2567 { 2568 /* This function is referenced somewhere, don't redefine it but 2569 * create a new one. */ 2570 --fp->uf_refcount; 2571 fp->uf_flags |= FC_REMOVED; 2572 fp = NULL; 2573 overwrite = TRUE; 2574 } 2575 else 2576 { 2577 /* redefine existing function */ 2578 VIM_CLEAR(name); 2579 func_clear_items(fp); 2580 #ifdef FEAT_PROFILE 2581 fp->uf_profiling = FALSE; 2582 fp->uf_prof_initialized = FALSE; 2583 #endif 2584 } 2585 } 2586 } 2587 else 2588 { 2589 char numbuf[20]; 2590 2591 fp = NULL; 2592 if (fudi.fd_newkey == NULL && !eap->forceit) 2593 { 2594 emsg(_(e_funcdict)); 2595 goto erret; 2596 } 2597 if (fudi.fd_di == NULL) 2598 { 2599 /* Can't add a function to a locked dictionary */ 2600 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE)) 2601 goto erret; 2602 } 2603 /* Can't change an existing function if it is locked */ 2604 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE)) 2605 goto erret; 2606 2607 /* Give the function a sequential number. Can only be used with a 2608 * Funcref! */ 2609 vim_free(name); 2610 sprintf(numbuf, "%d", ++func_nr); 2611 name = vim_strsave((char_u *)numbuf); 2612 if (name == NULL) 2613 goto erret; 2614 } 2615 2616 if (fp == NULL) 2617 { 2618 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL) 2619 { 2620 int slen, plen; 2621 char_u *scriptname; 2622 2623 /* Check that the autoload name matches the script name. */ 2624 j = FAIL; 2625 if (sourcing_name != NULL) 2626 { 2627 scriptname = autoload_name(name); 2628 if (scriptname != NULL) 2629 { 2630 p = vim_strchr(scriptname, '/'); 2631 plen = (int)STRLEN(p); 2632 slen = (int)STRLEN(sourcing_name); 2633 if (slen > plen && fnamecmp(p, 2634 sourcing_name + slen - plen) == 0) 2635 j = OK; 2636 vim_free(scriptname); 2637 } 2638 } 2639 if (j == FAIL) 2640 { 2641 semsg(_("E746: Function name does not match script file name: %s"), name); 2642 goto erret; 2643 } 2644 } 2645 2646 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 2647 if (fp == NULL) 2648 goto erret; 2649 2650 if (fudi.fd_dict != NULL) 2651 { 2652 if (fudi.fd_di == NULL) 2653 { 2654 /* add new dict entry */ 2655 fudi.fd_di = dictitem_alloc(fudi.fd_newkey); 2656 if (fudi.fd_di == NULL) 2657 { 2658 vim_free(fp); 2659 goto erret; 2660 } 2661 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL) 2662 { 2663 vim_free(fudi.fd_di); 2664 vim_free(fp); 2665 goto erret; 2666 } 2667 } 2668 else 2669 /* overwrite existing dict entry */ 2670 clear_tv(&fudi.fd_di->di_tv); 2671 fudi.fd_di->di_tv.v_type = VAR_FUNC; 2672 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name); 2673 2674 /* behave like "dict" was used */ 2675 flags |= FC_DICT; 2676 } 2677 2678 /* insert the new function in the function list */ 2679 STRCPY(fp->uf_name, name); 2680 if (overwrite) 2681 { 2682 hi = hash_find(&func_hashtab, name); 2683 hi->hi_key = UF2HIKEY(fp); 2684 } 2685 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL) 2686 { 2687 vim_free(fp); 2688 goto erret; 2689 } 2690 fp->uf_refcount = 1; 2691 } 2692 fp->uf_args = newargs; 2693 fp->uf_def_args = default_args; 2694 fp->uf_lines = newlines; 2695 if ((flags & FC_CLOSURE) != 0) 2696 { 2697 if (register_closure(fp) == FAIL) 2698 goto erret; 2699 } 2700 else 2701 fp->uf_scoped = NULL; 2702 2703 #ifdef FEAT_PROFILE 2704 if (prof_def_func()) 2705 func_do_profile(fp); 2706 #endif 2707 fp->uf_varargs = varargs; 2708 if (sandbox) 2709 flags |= FC_SANDBOX; 2710 fp->uf_flags = flags; 2711 fp->uf_calls = 0; 2712 fp->uf_script_ctx = current_sctx; 2713 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top; 2714 goto ret_free; 2715 2716 erret: 2717 ga_clear_strings(&newargs); 2718 ga_clear_strings(&default_args); 2719 errret_2: 2720 ga_clear_strings(&newlines); 2721 ret_free: 2722 vim_free(skip_until); 2723 vim_free(line_to_free); 2724 vim_free(fudi.fd_newkey); 2725 vim_free(name); 2726 did_emsg |= saved_did_emsg; 2727 need_wait_return |= saved_wait_return; 2728 } 2729 2730 /* 2731 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case). 2732 * Return 2 if "p" starts with "s:". 2733 * Return 0 otherwise. 2734 */ 2735 int 2736 eval_fname_script(char_u *p) 2737 { 2738 /* Use MB_STRICMP() because in Turkish comparing the "I" may not work with 2739 * the standard library function. */ 2740 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0 2741 || MB_STRNICMP(p + 1, "SNR>", 4) == 0)) 2742 return 5; 2743 if (p[0] == 's' && p[1] == ':') 2744 return 2; 2745 return 0; 2746 } 2747 2748 int 2749 translated_function_exists(char_u *name) 2750 { 2751 if (builtin_function(name, -1)) 2752 return has_internal_func(name); 2753 return find_func(name) != NULL; 2754 } 2755 2756 /* 2757 * Return TRUE if a function "name" exists. 2758 * If "no_defef" is TRUE, do not dereference a Funcref. 2759 */ 2760 int 2761 function_exists(char_u *name, int no_deref) 2762 { 2763 char_u *nm = name; 2764 char_u *p; 2765 int n = FALSE; 2766 int flag; 2767 2768 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD; 2769 if (no_deref) 2770 flag |= TFN_NO_DEREF; 2771 p = trans_function_name(&nm, FALSE, flag, NULL, NULL); 2772 nm = skipwhite(nm); 2773 2774 /* Only accept "funcname", "funcname ", "funcname (..." and 2775 * "funcname(...", not "funcname!...". */ 2776 if (p != NULL && (*nm == NUL || *nm == '(')) 2777 n = translated_function_exists(p); 2778 vim_free(p); 2779 return n; 2780 } 2781 2782 #if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO) 2783 char_u * 2784 get_expanded_name(char_u *name, int check) 2785 { 2786 char_u *nm = name; 2787 char_u *p; 2788 2789 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL, NULL); 2790 2791 if (p != NULL && *nm == NUL) 2792 if (!check || translated_function_exists(p)) 2793 return p; 2794 2795 vim_free(p); 2796 return NULL; 2797 } 2798 #endif 2799 2800 /* 2801 * Function given to ExpandGeneric() to obtain the list of user defined 2802 * function names. 2803 */ 2804 char_u * 2805 get_user_func_name(expand_T *xp, int idx) 2806 { 2807 static long_u done; 2808 static hashitem_T *hi; 2809 ufunc_T *fp; 2810 2811 if (idx == 0) 2812 { 2813 done = 0; 2814 hi = func_hashtab.ht_array; 2815 } 2816 if (done < func_hashtab.ht_used) 2817 { 2818 if (done++ > 0) 2819 ++hi; 2820 while (HASHITEM_EMPTY(hi)) 2821 ++hi; 2822 fp = HI2UF(hi); 2823 2824 if ((fp->uf_flags & FC_DICT) 2825 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 2826 return (char_u *)""; /* don't show dict and lambda functions */ 2827 2828 if (STRLEN(fp->uf_name) + 4 >= IOSIZE) 2829 return fp->uf_name; /* prevents overflow */ 2830 2831 cat_func_name(IObuff, fp); 2832 if (xp->xp_context != EXPAND_USER_FUNC) 2833 { 2834 STRCAT(IObuff, "("); 2835 if (!fp->uf_varargs && fp->uf_args.ga_len == 0) 2836 STRCAT(IObuff, ")"); 2837 } 2838 return IObuff; 2839 } 2840 return NULL; 2841 } 2842 2843 /* 2844 * ":delfunction {name}" 2845 */ 2846 void 2847 ex_delfunction(exarg_T *eap) 2848 { 2849 ufunc_T *fp = NULL; 2850 char_u *p; 2851 char_u *name; 2852 funcdict_T fudi; 2853 2854 p = eap->arg; 2855 name = trans_function_name(&p, eap->skip, 0, &fudi, NULL); 2856 vim_free(fudi.fd_newkey); 2857 if (name == NULL) 2858 { 2859 if (fudi.fd_dict != NULL && !eap->skip) 2860 emsg(_(e_funcref)); 2861 return; 2862 } 2863 if (!ends_excmd(*skipwhite(p))) 2864 { 2865 vim_free(name); 2866 emsg(_(e_trailing)); 2867 return; 2868 } 2869 eap->nextcmd = check_nextcmd(p); 2870 if (eap->nextcmd != NULL) 2871 *p = NUL; 2872 2873 if (!eap->skip) 2874 fp = find_func(name); 2875 vim_free(name); 2876 2877 if (!eap->skip) 2878 { 2879 if (fp == NULL) 2880 { 2881 if (!eap->forceit) 2882 semsg(_(e_nofunc), eap->arg); 2883 return; 2884 } 2885 if (fp->uf_calls > 0) 2886 { 2887 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg); 2888 return; 2889 } 2890 2891 if (fudi.fd_dict != NULL) 2892 { 2893 /* Delete the dict item that refers to the function, it will 2894 * invoke func_unref() and possibly delete the function. */ 2895 dictitem_remove(fudi.fd_dict, fudi.fd_di); 2896 } 2897 else 2898 { 2899 /* A normal function (not a numbered function or lambda) has a 2900 * refcount of 1 for the entry in the hashtable. When deleting 2901 * it and the refcount is more than one, it should be kept. 2902 * A numbered function and lambda should be kept if the refcount is 2903 * one or more. */ 2904 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1)) 2905 { 2906 /* Function is still referenced somewhere. Don't free it but 2907 * do remove it from the hashtable. */ 2908 if (func_remove(fp)) 2909 fp->uf_refcount--; 2910 fp->uf_flags |= FC_DELETED; 2911 } 2912 else 2913 func_clear_free(fp, FALSE); 2914 } 2915 } 2916 } 2917 2918 /* 2919 * Unreference a Function: decrement the reference count and free it when it 2920 * becomes zero. 2921 */ 2922 void 2923 func_unref(char_u *name) 2924 { 2925 ufunc_T *fp = NULL; 2926 2927 if (name == NULL || !func_name_refcount(name)) 2928 return; 2929 fp = find_func(name); 2930 if (fp == NULL && isdigit(*name)) 2931 { 2932 #ifdef EXITFREE 2933 if (!entered_free_all_mem) 2934 #endif 2935 internal_error("func_unref()"); 2936 } 2937 if (fp != NULL && --fp->uf_refcount <= 0) 2938 { 2939 /* Only delete it when it's not being used. Otherwise it's done 2940 * when "uf_calls" becomes zero. */ 2941 if (fp->uf_calls == 0) 2942 func_clear_free(fp, FALSE); 2943 } 2944 } 2945 2946 /* 2947 * Unreference a Function: decrement the reference count and free it when it 2948 * becomes zero. 2949 */ 2950 void 2951 func_ptr_unref(ufunc_T *fp) 2952 { 2953 if (fp != NULL && --fp->uf_refcount <= 0) 2954 { 2955 /* Only delete it when it's not being used. Otherwise it's done 2956 * when "uf_calls" becomes zero. */ 2957 if (fp->uf_calls == 0) 2958 func_clear_free(fp, FALSE); 2959 } 2960 } 2961 2962 /* 2963 * Count a reference to a Function. 2964 */ 2965 void 2966 func_ref(char_u *name) 2967 { 2968 ufunc_T *fp; 2969 2970 if (name == NULL || !func_name_refcount(name)) 2971 return; 2972 fp = find_func(name); 2973 if (fp != NULL) 2974 ++fp->uf_refcount; 2975 else if (isdigit(*name)) 2976 /* Only give an error for a numbered function. 2977 * Fail silently, when named or lambda function isn't found. */ 2978 internal_error("func_ref()"); 2979 } 2980 2981 /* 2982 * Count a reference to a Function. 2983 */ 2984 void 2985 func_ptr_ref(ufunc_T *fp) 2986 { 2987 if (fp != NULL) 2988 ++fp->uf_refcount; 2989 } 2990 2991 /* 2992 * Return TRUE if items in "fc" do not have "copyID". That means they are not 2993 * referenced from anywhere that is in use. 2994 */ 2995 static int 2996 can_free_funccal(funccall_T *fc, int copyID) 2997 { 2998 return (fc->l_varlist.lv_copyID != copyID 2999 && fc->l_vars.dv_copyID != copyID 3000 && fc->l_avars.dv_copyID != copyID 3001 && fc->fc_copyID != copyID); 3002 } 3003 3004 /* 3005 * ":return [expr]" 3006 */ 3007 void 3008 ex_return(exarg_T *eap) 3009 { 3010 char_u *arg = eap->arg; 3011 typval_T rettv; 3012 int returning = FALSE; 3013 3014 if (current_funccal == NULL) 3015 { 3016 emsg(_("E133: :return not inside a function")); 3017 return; 3018 } 3019 3020 if (eap->skip) 3021 ++emsg_skip; 3022 3023 eap->nextcmd = NULL; 3024 if ((*arg != NUL && *arg != '|' && *arg != '\n') 3025 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL) 3026 { 3027 if (!eap->skip) 3028 returning = do_return(eap, FALSE, TRUE, &rettv); 3029 else 3030 clear_tv(&rettv); 3031 } 3032 /* It's safer to return also on error. */ 3033 else if (!eap->skip) 3034 { 3035 /* In return statement, cause_abort should be force_abort. */ 3036 update_force_abort(); 3037 3038 /* 3039 * Return unless the expression evaluation has been cancelled due to an 3040 * aborting error, an interrupt, or an exception. 3041 */ 3042 if (!aborting()) 3043 returning = do_return(eap, FALSE, TRUE, NULL); 3044 } 3045 3046 /* When skipping or the return gets pending, advance to the next command 3047 * in this line (!returning). Otherwise, ignore the rest of the line. 3048 * Following lines will be ignored by get_func_line(). */ 3049 if (returning) 3050 eap->nextcmd = NULL; 3051 else if (eap->nextcmd == NULL) /* no argument */ 3052 eap->nextcmd = check_nextcmd(arg); 3053 3054 if (eap->skip) 3055 --emsg_skip; 3056 } 3057 3058 /* 3059 * ":1,25call func(arg1, arg2)" function call. 3060 */ 3061 void 3062 ex_call(exarg_T *eap) 3063 { 3064 char_u *arg = eap->arg; 3065 char_u *startarg; 3066 char_u *name; 3067 char_u *tofree; 3068 int len; 3069 typval_T rettv; 3070 linenr_T lnum; 3071 int doesrange; 3072 int failed = FALSE; 3073 funcdict_T fudi; 3074 partial_T *partial = NULL; 3075 3076 if (eap->skip) 3077 { 3078 /* trans_function_name() doesn't work well when skipping, use eval0() 3079 * instead to skip to any following command, e.g. for: 3080 * :if 0 | call dict.foo().bar() | endif */ 3081 ++emsg_skip; 3082 if (eval0(eap->arg, &rettv, &eap->nextcmd, FALSE) != FAIL) 3083 clear_tv(&rettv); 3084 --emsg_skip; 3085 return; 3086 } 3087 3088 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi, &partial); 3089 if (fudi.fd_newkey != NULL) 3090 { 3091 /* Still need to give an error message for missing key. */ 3092 semsg(_(e_dictkey), fudi.fd_newkey); 3093 vim_free(fudi.fd_newkey); 3094 } 3095 if (tofree == NULL) 3096 return; 3097 3098 /* Increase refcount on dictionary, it could get deleted when evaluating 3099 * the arguments. */ 3100 if (fudi.fd_dict != NULL) 3101 ++fudi.fd_dict->dv_refcount; 3102 3103 /* If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its 3104 * contents. For VAR_PARTIAL get its partial, unless we already have one 3105 * from trans_function_name(). */ 3106 len = (int)STRLEN(tofree); 3107 name = deref_func_name(tofree, &len, 3108 partial != NULL ? NULL : &partial, FALSE); 3109 3110 /* Skip white space to allow ":call func ()". Not good, but required for 3111 * backward compatibility. */ 3112 startarg = skipwhite(arg); 3113 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */ 3114 3115 if (*startarg != '(') 3116 { 3117 semsg(_(e_missingparen), eap->arg); 3118 goto end; 3119 } 3120 3121 /* 3122 * When skipping, evaluate the function once, to find the end of the 3123 * arguments. 3124 * When the function takes a range, this is discovered after the first 3125 * call, and the loop is broken. 3126 */ 3127 if (eap->skip) 3128 { 3129 ++emsg_skip; 3130 lnum = eap->line2; /* do it once, also with an invalid range */ 3131 } 3132 else 3133 lnum = eap->line1; 3134 for ( ; lnum <= eap->line2; ++lnum) 3135 { 3136 funcexe_T funcexe; 3137 3138 if (!eap->skip && eap->addr_count > 0) 3139 { 3140 if (lnum > curbuf->b_ml.ml_line_count) 3141 { 3142 // If the function deleted lines or switched to another buffer 3143 // the line number may become invalid. 3144 emsg(_(e_invrange)); 3145 break; 3146 } 3147 curwin->w_cursor.lnum = lnum; 3148 curwin->w_cursor.col = 0; 3149 curwin->w_cursor.coladd = 0; 3150 } 3151 arg = startarg; 3152 3153 vim_memset(&funcexe, 0, sizeof(funcexe)); 3154 funcexe.firstline = eap->line1; 3155 funcexe.lastline = eap->line2; 3156 funcexe.doesrange = &doesrange; 3157 funcexe.evaluate = !eap->skip; 3158 funcexe.partial = partial; 3159 funcexe.selfdict = fudi.fd_dict; 3160 if (get_func_tv(name, -1, &rettv, &arg, &funcexe) == FAIL) 3161 { 3162 failed = TRUE; 3163 break; 3164 } 3165 if (has_watchexpr()) 3166 dbg_check_breakpoint(eap); 3167 3168 // Handle a function returning a Funcref, Dictionary or List. 3169 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE, 3170 name, &name) == FAIL) 3171 { 3172 failed = TRUE; 3173 break; 3174 } 3175 3176 clear_tv(&rettv); 3177 if (doesrange || eap->skip) 3178 break; 3179 3180 /* Stop when immediately aborting on error, or when an interrupt 3181 * occurred or an exception was thrown but not caught. 3182 * get_func_tv() returned OK, so that the check for trailing 3183 * characters below is executed. */ 3184 if (aborting()) 3185 break; 3186 } 3187 if (eap->skip) 3188 --emsg_skip; 3189 3190 if (!failed) 3191 { 3192 /* Check for trailing illegal characters and a following command. */ 3193 if (!ends_excmd(*arg)) 3194 { 3195 emsg_severe = TRUE; 3196 emsg(_(e_trailing)); 3197 } 3198 else 3199 eap->nextcmd = check_nextcmd(arg); 3200 } 3201 3202 end: 3203 dict_unref(fudi.fd_dict); 3204 vim_free(tofree); 3205 } 3206 3207 /* 3208 * Return from a function. Possibly makes the return pending. Also called 3209 * for a pending return at the ":endtry" or after returning from an extra 3210 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set 3211 * when called due to a ":return" command. "rettv" may point to a typval_T 3212 * with the return rettv. Returns TRUE when the return can be carried out, 3213 * FALSE when the return gets pending. 3214 */ 3215 int 3216 do_return( 3217 exarg_T *eap, 3218 int reanimate, 3219 int is_cmd, 3220 void *rettv) 3221 { 3222 int idx; 3223 struct condstack *cstack = eap->cstack; 3224 3225 if (reanimate) 3226 /* Undo the return. */ 3227 current_funccal->returned = FALSE; 3228 3229 /* 3230 * Cleanup (and inactivate) conditionals, but stop when a try conditional 3231 * not in its finally clause (which then is to be executed next) is found. 3232 * In this case, make the ":return" pending for execution at the ":endtry". 3233 * Otherwise, return normally. 3234 */ 3235 idx = cleanup_conditionals(eap->cstack, 0, TRUE); 3236 if (idx >= 0) 3237 { 3238 cstack->cs_pending[idx] = CSTP_RETURN; 3239 3240 if (!is_cmd && !reanimate) 3241 /* A pending return again gets pending. "rettv" points to an 3242 * allocated variable with the rettv of the original ":return"'s 3243 * argument if present or is NULL else. */ 3244 cstack->cs_rettv[idx] = rettv; 3245 else 3246 { 3247 /* When undoing a return in order to make it pending, get the stored 3248 * return rettv. */ 3249 if (reanimate) 3250 rettv = current_funccal->rettv; 3251 3252 if (rettv != NULL) 3253 { 3254 /* Store the value of the pending return. */ 3255 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL) 3256 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv; 3257 else 3258 emsg(_(e_outofmem)); 3259 } 3260 else 3261 cstack->cs_rettv[idx] = NULL; 3262 3263 if (reanimate) 3264 { 3265 /* The pending return value could be overwritten by a ":return" 3266 * without argument in a finally clause; reset the default 3267 * return value. */ 3268 current_funccal->rettv->v_type = VAR_NUMBER; 3269 current_funccal->rettv->vval.v_number = 0; 3270 } 3271 } 3272 report_make_pending(CSTP_RETURN, rettv); 3273 } 3274 else 3275 { 3276 current_funccal->returned = TRUE; 3277 3278 /* If the return is carried out now, store the return value. For 3279 * a return immediately after reanimation, the value is already 3280 * there. */ 3281 if (!reanimate && rettv != NULL) 3282 { 3283 clear_tv(current_funccal->rettv); 3284 *current_funccal->rettv = *(typval_T *)rettv; 3285 if (!is_cmd) 3286 vim_free(rettv); 3287 } 3288 } 3289 3290 return idx < 0; 3291 } 3292 3293 /* 3294 * Free the variable with a pending return value. 3295 */ 3296 void 3297 discard_pending_return(void *rettv) 3298 { 3299 free_tv((typval_T *)rettv); 3300 } 3301 3302 /* 3303 * Generate a return command for producing the value of "rettv". The result 3304 * is an allocated string. Used by report_pending() for verbose messages. 3305 */ 3306 char_u * 3307 get_return_cmd(void *rettv) 3308 { 3309 char_u *s = NULL; 3310 char_u *tofree = NULL; 3311 char_u numbuf[NUMBUFLEN]; 3312 3313 if (rettv != NULL) 3314 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0); 3315 if (s == NULL) 3316 s = (char_u *)""; 3317 3318 STRCPY(IObuff, ":return "); 3319 STRNCPY(IObuff + 8, s, IOSIZE - 8); 3320 if (STRLEN(s) + 8 >= IOSIZE) 3321 STRCPY(IObuff + IOSIZE - 4, "..."); 3322 vim_free(tofree); 3323 return vim_strsave(IObuff); 3324 } 3325 3326 /* 3327 * Get next function line. 3328 * Called by do_cmdline() to get the next line. 3329 * Returns allocated string, or NULL for end of function. 3330 */ 3331 char_u * 3332 get_func_line( 3333 int c UNUSED, 3334 void *cookie, 3335 int indent UNUSED, 3336 int do_concat UNUSED) 3337 { 3338 funccall_T *fcp = (funccall_T *)cookie; 3339 ufunc_T *fp = fcp->func; 3340 char_u *retval; 3341 garray_T *gap; /* growarray with function lines */ 3342 3343 /* If breakpoints have been added/deleted need to check for it. */ 3344 if (fcp->dbg_tick != debug_tick) 3345 { 3346 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 3347 sourcing_lnum); 3348 fcp->dbg_tick = debug_tick; 3349 } 3350 #ifdef FEAT_PROFILE 3351 if (do_profiling == PROF_YES) 3352 func_line_end(cookie); 3353 #endif 3354 3355 gap = &fp->uf_lines; 3356 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 3357 || fcp->returned) 3358 retval = NULL; 3359 else 3360 { 3361 /* Skip NULL lines (continuation lines). */ 3362 while (fcp->linenr < gap->ga_len 3363 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL) 3364 ++fcp->linenr; 3365 if (fcp->linenr >= gap->ga_len) 3366 retval = NULL; 3367 else 3368 { 3369 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]); 3370 sourcing_lnum = fcp->linenr; 3371 #ifdef FEAT_PROFILE 3372 if (do_profiling == PROF_YES) 3373 func_line_start(cookie); 3374 #endif 3375 } 3376 } 3377 3378 /* Did we encounter a breakpoint? */ 3379 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum) 3380 { 3381 dbg_breakpoint(fp->uf_name, sourcing_lnum); 3382 /* Find next breakpoint. */ 3383 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 3384 sourcing_lnum); 3385 fcp->dbg_tick = debug_tick; 3386 } 3387 3388 return retval; 3389 } 3390 3391 /* 3392 * Return TRUE if the currently active function should be ended, because a 3393 * return was encountered or an error occurred. Used inside a ":while". 3394 */ 3395 int 3396 func_has_ended(void *cookie) 3397 { 3398 funccall_T *fcp = (funccall_T *)cookie; 3399 3400 /* Ignore the "abort" flag if the abortion behavior has been changed due to 3401 * an error inside a try conditional. */ 3402 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 3403 || fcp->returned); 3404 } 3405 3406 /* 3407 * return TRUE if cookie indicates a function which "abort"s on errors. 3408 */ 3409 int 3410 func_has_abort( 3411 void *cookie) 3412 { 3413 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT; 3414 } 3415 3416 3417 /* 3418 * Turn "dict.Func" into a partial for "Func" bound to "dict". 3419 * Don't do this when "Func" is already a partial that was bound 3420 * explicitly (pt_auto is FALSE). 3421 * Changes "rettv" in-place. 3422 * Returns the updated "selfdict_in". 3423 */ 3424 dict_T * 3425 make_partial(dict_T *selfdict_in, typval_T *rettv) 3426 { 3427 char_u *fname; 3428 char_u *tofree = NULL; 3429 ufunc_T *fp; 3430 char_u fname_buf[FLEN_FIXED + 1]; 3431 int error; 3432 dict_T *selfdict = selfdict_in; 3433 3434 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL) 3435 fp = rettv->vval.v_partial->pt_func; 3436 else 3437 { 3438 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string 3439 : rettv->vval.v_partial->pt_name; 3440 /* Translate "s:func" to the stored function name. */ 3441 fname = fname_trans_sid(fname, fname_buf, &tofree, &error); 3442 fp = find_func(fname); 3443 vim_free(tofree); 3444 } 3445 3446 if (fp != NULL && (fp->uf_flags & FC_DICT)) 3447 { 3448 partial_T *pt = ALLOC_CLEAR_ONE(partial_T); 3449 3450 if (pt != NULL) 3451 { 3452 pt->pt_refcount = 1; 3453 pt->pt_dict = selfdict; 3454 pt->pt_auto = TRUE; 3455 selfdict = NULL; 3456 if (rettv->v_type == VAR_FUNC) 3457 { 3458 /* Just a function: Take over the function name and use 3459 * selfdict. */ 3460 pt->pt_name = rettv->vval.v_string; 3461 } 3462 else 3463 { 3464 partial_T *ret_pt = rettv->vval.v_partial; 3465 int i; 3466 3467 /* Partial: copy the function name, use selfdict and copy 3468 * args. Can't take over name or args, the partial might 3469 * be referenced elsewhere. */ 3470 if (ret_pt->pt_name != NULL) 3471 { 3472 pt->pt_name = vim_strsave(ret_pt->pt_name); 3473 func_ref(pt->pt_name); 3474 } 3475 else 3476 { 3477 pt->pt_func = ret_pt->pt_func; 3478 func_ptr_ref(pt->pt_func); 3479 } 3480 if (ret_pt->pt_argc > 0) 3481 { 3482 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc); 3483 if (pt->pt_argv == NULL) 3484 /* out of memory: drop the arguments */ 3485 pt->pt_argc = 0; 3486 else 3487 { 3488 pt->pt_argc = ret_pt->pt_argc; 3489 for (i = 0; i < pt->pt_argc; i++) 3490 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]); 3491 } 3492 } 3493 partial_unref(ret_pt); 3494 } 3495 rettv->v_type = VAR_PARTIAL; 3496 rettv->vval.v_partial = pt; 3497 } 3498 } 3499 return selfdict; 3500 } 3501 3502 /* 3503 * Return the name of the executed function. 3504 */ 3505 char_u * 3506 func_name(void *cookie) 3507 { 3508 return ((funccall_T *)cookie)->func->uf_name; 3509 } 3510 3511 /* 3512 * Return the address holding the next breakpoint line for a funccall cookie. 3513 */ 3514 linenr_T * 3515 func_breakpoint(void *cookie) 3516 { 3517 return &((funccall_T *)cookie)->breakpoint; 3518 } 3519 3520 /* 3521 * Return the address holding the debug tick for a funccall cookie. 3522 */ 3523 int * 3524 func_dbg_tick(void *cookie) 3525 { 3526 return &((funccall_T *)cookie)->dbg_tick; 3527 } 3528 3529 /* 3530 * Return the nesting level for a funccall cookie. 3531 */ 3532 int 3533 func_level(void *cookie) 3534 { 3535 return ((funccall_T *)cookie)->level; 3536 } 3537 3538 /* 3539 * Return TRUE when a function was ended by a ":return" command. 3540 */ 3541 int 3542 current_func_returned(void) 3543 { 3544 return current_funccal->returned; 3545 } 3546 3547 int 3548 free_unref_funccal(int copyID, int testing) 3549 { 3550 int did_free = FALSE; 3551 int did_free_funccal = FALSE; 3552 funccall_T *fc, **pfc; 3553 3554 for (pfc = &previous_funccal; *pfc != NULL; ) 3555 { 3556 if (can_free_funccal(*pfc, copyID)) 3557 { 3558 fc = *pfc; 3559 *pfc = fc->caller; 3560 free_funccal_contents(fc); 3561 did_free = TRUE; 3562 did_free_funccal = TRUE; 3563 } 3564 else 3565 pfc = &(*pfc)->caller; 3566 } 3567 if (did_free_funccal) 3568 /* When a funccal was freed some more items might be garbage 3569 * collected, so run again. */ 3570 (void)garbage_collect(testing); 3571 3572 return did_free; 3573 } 3574 3575 /* 3576 * Get function call environment based on backtrace debug level 3577 */ 3578 static funccall_T * 3579 get_funccal(void) 3580 { 3581 int i; 3582 funccall_T *funccal; 3583 funccall_T *temp_funccal; 3584 3585 funccal = current_funccal; 3586 if (debug_backtrace_level > 0) 3587 { 3588 for (i = 0; i < debug_backtrace_level; i++) 3589 { 3590 temp_funccal = funccal->caller; 3591 if (temp_funccal) 3592 funccal = temp_funccal; 3593 else 3594 /* backtrace level overflow. reset to max */ 3595 debug_backtrace_level = i; 3596 } 3597 } 3598 return funccal; 3599 } 3600 3601 /* 3602 * Return the hashtable used for local variables in the current funccal. 3603 * Return NULL if there is no current funccal. 3604 */ 3605 hashtab_T * 3606 get_funccal_local_ht() 3607 { 3608 if (current_funccal == NULL) 3609 return NULL; 3610 return &get_funccal()->l_vars.dv_hashtab; 3611 } 3612 3613 /* 3614 * Return the l: scope variable. 3615 * Return NULL if there is no current funccal. 3616 */ 3617 dictitem_T * 3618 get_funccal_local_var() 3619 { 3620 if (current_funccal == NULL) 3621 return NULL; 3622 return &get_funccal()->l_vars_var; 3623 } 3624 3625 /* 3626 * Return the hashtable used for argument in the current funccal. 3627 * Return NULL if there is no current funccal. 3628 */ 3629 hashtab_T * 3630 get_funccal_args_ht() 3631 { 3632 if (current_funccal == NULL) 3633 return NULL; 3634 return &get_funccal()->l_avars.dv_hashtab; 3635 } 3636 3637 /* 3638 * Return the a: scope variable. 3639 * Return NULL if there is no current funccal. 3640 */ 3641 dictitem_T * 3642 get_funccal_args_var() 3643 { 3644 if (current_funccal == NULL) 3645 return NULL; 3646 return &get_funccal()->l_avars_var; 3647 } 3648 3649 /* 3650 * List function variables, if there is a function. 3651 */ 3652 void 3653 list_func_vars(int *first) 3654 { 3655 if (current_funccal != NULL) 3656 list_hashtable_vars(¤t_funccal->l_vars.dv_hashtab, 3657 "l:", FALSE, first); 3658 } 3659 3660 /* 3661 * If "ht" is the hashtable for local variables in the current funccal, return 3662 * the dict that contains it. 3663 * Otherwise return NULL. 3664 */ 3665 dict_T * 3666 get_current_funccal_dict(hashtab_T *ht) 3667 { 3668 if (current_funccal != NULL 3669 && ht == ¤t_funccal->l_vars.dv_hashtab) 3670 return ¤t_funccal->l_vars; 3671 return NULL; 3672 } 3673 3674 /* 3675 * Search hashitem in parent scope. 3676 */ 3677 hashitem_T * 3678 find_hi_in_scoped_ht(char_u *name, hashtab_T **pht) 3679 { 3680 funccall_T *old_current_funccal = current_funccal; 3681 hashtab_T *ht; 3682 hashitem_T *hi = NULL; 3683 char_u *varname; 3684 3685 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 3686 return NULL; 3687 3688 /* Search in parent scope which is possible to reference from lambda */ 3689 current_funccal = current_funccal->func->uf_scoped; 3690 while (current_funccal != NULL) 3691 { 3692 ht = find_var_ht(name, &varname); 3693 if (ht != NULL && *varname != NUL) 3694 { 3695 hi = hash_find(ht, varname); 3696 if (!HASHITEM_EMPTY(hi)) 3697 { 3698 *pht = ht; 3699 break; 3700 } 3701 } 3702 if (current_funccal == current_funccal->func->uf_scoped) 3703 break; 3704 current_funccal = current_funccal->func->uf_scoped; 3705 } 3706 current_funccal = old_current_funccal; 3707 3708 return hi; 3709 } 3710 3711 /* 3712 * Search variable in parent scope. 3713 */ 3714 dictitem_T * 3715 find_var_in_scoped_ht(char_u *name, int no_autoload) 3716 { 3717 dictitem_T *v = NULL; 3718 funccall_T *old_current_funccal = current_funccal; 3719 hashtab_T *ht; 3720 char_u *varname; 3721 3722 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 3723 return NULL; 3724 3725 /* Search in parent scope which is possible to reference from lambda */ 3726 current_funccal = current_funccal->func->uf_scoped; 3727 while (current_funccal) 3728 { 3729 ht = find_var_ht(name, &varname); 3730 if (ht != NULL && *varname != NUL) 3731 { 3732 v = find_var_in_ht(ht, *name, varname, no_autoload); 3733 if (v != NULL) 3734 break; 3735 } 3736 if (current_funccal == current_funccal->func->uf_scoped) 3737 break; 3738 current_funccal = current_funccal->func->uf_scoped; 3739 } 3740 current_funccal = old_current_funccal; 3741 3742 return v; 3743 } 3744 3745 /* 3746 * Set "copyID + 1" in previous_funccal and callers. 3747 */ 3748 int 3749 set_ref_in_previous_funccal(int copyID) 3750 { 3751 int abort = FALSE; 3752 funccall_T *fc; 3753 3754 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller) 3755 { 3756 fc->fc_copyID = copyID + 1; 3757 abort = abort 3758 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL) 3759 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL) 3760 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL); 3761 } 3762 return abort; 3763 } 3764 3765 static int 3766 set_ref_in_funccal(funccall_T *fc, int copyID) 3767 { 3768 int abort = FALSE; 3769 3770 if (fc->fc_copyID != copyID) 3771 { 3772 fc->fc_copyID = copyID; 3773 abort = abort 3774 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL) 3775 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL) 3776 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL) 3777 || set_ref_in_func(NULL, fc->func, copyID); 3778 } 3779 return abort; 3780 } 3781 3782 /* 3783 * Set "copyID" in all local vars and arguments in the call stack. 3784 */ 3785 int 3786 set_ref_in_call_stack(int copyID) 3787 { 3788 int abort = FALSE; 3789 funccall_T *fc; 3790 funccal_entry_T *entry; 3791 3792 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller) 3793 abort = abort || set_ref_in_funccal(fc, copyID); 3794 3795 // Also go through the funccal_stack. 3796 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next) 3797 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller) 3798 abort = abort || set_ref_in_funccal(fc, copyID); 3799 3800 return abort; 3801 } 3802 3803 /* 3804 * Set "copyID" in all functions available by name. 3805 */ 3806 int 3807 set_ref_in_functions(int copyID) 3808 { 3809 int todo; 3810 hashitem_T *hi = NULL; 3811 int abort = FALSE; 3812 ufunc_T *fp; 3813 3814 todo = (int)func_hashtab.ht_used; 3815 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 3816 { 3817 if (!HASHITEM_EMPTY(hi)) 3818 { 3819 --todo; 3820 fp = HI2UF(hi); 3821 if (!func_name_refcount(fp->uf_name)) 3822 abort = abort || set_ref_in_func(NULL, fp, copyID); 3823 } 3824 } 3825 return abort; 3826 } 3827 3828 /* 3829 * Set "copyID" in all function arguments. 3830 */ 3831 int 3832 set_ref_in_func_args(int copyID) 3833 { 3834 int i; 3835 int abort = FALSE; 3836 3837 for (i = 0; i < funcargs.ga_len; ++i) 3838 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i], 3839 copyID, NULL, NULL); 3840 return abort; 3841 } 3842 3843 /* 3844 * Mark all lists and dicts referenced through function "name" with "copyID". 3845 * Returns TRUE if setting references failed somehow. 3846 */ 3847 int 3848 set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID) 3849 { 3850 ufunc_T *fp = fp_in; 3851 funccall_T *fc; 3852 int error = ERROR_NONE; 3853 char_u fname_buf[FLEN_FIXED + 1]; 3854 char_u *tofree = NULL; 3855 char_u *fname; 3856 int abort = FALSE; 3857 3858 if (name == NULL && fp_in == NULL) 3859 return FALSE; 3860 3861 if (fp_in == NULL) 3862 { 3863 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 3864 fp = find_func(fname); 3865 } 3866 if (fp != NULL) 3867 { 3868 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped) 3869 abort = abort || set_ref_in_funccal(fc, copyID); 3870 } 3871 vim_free(tofree); 3872 return abort; 3873 } 3874 3875 #endif /* FEAT_EVAL */ 3876