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 * eval.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 /* 1451 * Invoke call_func() with a callback. 1452 */ 1453 int 1454 call_callback( 1455 callback_T *callback, 1456 int len, // length of "name" or -1 to use strlen() 1457 typval_T *rettv, // return value goes here 1458 int argcount, // number of "argvars" 1459 typval_T *argvars) // vars for arguments, must have "argcount" 1460 // PLUS ONE elements! 1461 { 1462 funcexe_T funcexe; 1463 1464 vim_memset(&funcexe, 0, sizeof(funcexe)); 1465 funcexe.evaluate = TRUE; 1466 funcexe.partial = callback->cb_partial; 1467 return call_func(callback->cb_name, len, rettv, argcount, argvars, 1468 &funcexe); 1469 } 1470 1471 /* 1472 * Call a function with its resolved parameters 1473 * 1474 * Return FAIL when the function can't be called, OK otherwise. 1475 * Also returns OK when an error was encountered while executing the function. 1476 */ 1477 int 1478 call_func( 1479 char_u *funcname, // name of the function 1480 int len, // length of "name" or -1 to use strlen() 1481 typval_T *rettv, // return value goes here 1482 int argcount_in, // number of "argvars" 1483 typval_T *argvars_in, // vars for arguments, must have "argcount" 1484 // PLUS ONE elements! 1485 funcexe_T *funcexe) // more arguments 1486 { 1487 int ret = FAIL; 1488 int error = ERROR_NONE; 1489 int i; 1490 ufunc_T *fp; 1491 char_u fname_buf[FLEN_FIXED + 1]; 1492 char_u *tofree = NULL; 1493 char_u *fname; 1494 char_u *name; 1495 int argcount = argcount_in; 1496 typval_T *argvars = argvars_in; 1497 dict_T *selfdict = funcexe->selfdict; 1498 typval_T argv[MAX_FUNC_ARGS + 1]; // used when "partial" or 1499 // "funcexe->basetv" is not NULL 1500 int argv_clear = 0; 1501 int argv_base = 0; 1502 partial_T *partial = funcexe->partial; 1503 1504 // Initialize rettv so that it is safe for caller to invoke clear_tv(rettv) 1505 // even when call_func() returns FAIL. 1506 rettv->v_type = VAR_UNKNOWN; 1507 1508 // Make a copy of the name, if it comes from a funcref variable it could 1509 // be changed or deleted in the called function. 1510 name = len > 0 ? vim_strnsave(funcname, len) : vim_strsave(funcname); 1511 if (name == NULL) 1512 return ret; 1513 1514 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 1515 1516 if (funcexe->doesrange != NULL) 1517 *funcexe->doesrange = FALSE; 1518 1519 if (partial != NULL) 1520 { 1521 /* When the function has a partial with a dict and there is a dict 1522 * argument, use the dict argument. That is backwards compatible. 1523 * When the dict was bound explicitly use the one from the partial. */ 1524 if (partial->pt_dict != NULL && (selfdict == NULL || !partial->pt_auto)) 1525 selfdict = partial->pt_dict; 1526 if (error == ERROR_NONE && partial->pt_argc > 0) 1527 { 1528 for (argv_clear = 0; argv_clear < partial->pt_argc; ++argv_clear) 1529 copy_tv(&partial->pt_argv[argv_clear], &argv[argv_clear]); 1530 for (i = 0; i < argcount_in; ++i) 1531 argv[i + argv_clear] = argvars_in[i]; 1532 argvars = argv; 1533 argcount = partial->pt_argc + argcount_in; 1534 } 1535 } 1536 1537 if (error == ERROR_NONE && funcexe->evaluate) 1538 { 1539 char_u *rfname = fname; 1540 1541 /* Ignore "g:" before a function name. */ 1542 if (fname[0] == 'g' && fname[1] == ':') 1543 rfname = fname + 2; 1544 1545 rettv->v_type = VAR_NUMBER; /* default rettv is number zero */ 1546 rettv->vval.v_number = 0; 1547 error = ERROR_UNKNOWN; 1548 1549 if (!builtin_function(rfname, -1)) 1550 { 1551 /* 1552 * User defined function. 1553 */ 1554 if (partial != NULL && partial->pt_func != NULL) 1555 fp = partial->pt_func; 1556 else 1557 fp = find_func(rfname); 1558 1559 /* Trigger FuncUndefined event, may load the function. */ 1560 if (fp == NULL 1561 && apply_autocmds(EVENT_FUNCUNDEFINED, 1562 rfname, rfname, TRUE, NULL) 1563 && !aborting()) 1564 { 1565 /* executed an autocommand, search for the function again */ 1566 fp = find_func(rfname); 1567 } 1568 /* Try loading a package. */ 1569 if (fp == NULL && script_autoload(rfname, TRUE) && !aborting()) 1570 { 1571 /* loaded a package, search for the function again */ 1572 fp = find_func(rfname); 1573 } 1574 1575 if (fp != NULL && (fp->uf_flags & FC_DELETED)) 1576 error = ERROR_DELETED; 1577 else if (fp != NULL) 1578 { 1579 if (funcexe->argv_func != NULL) 1580 argcount = funcexe->argv_func(argcount, argvars, 1581 fp->uf_args.ga_len); 1582 1583 if (funcexe->basetv != NULL) 1584 { 1585 // Method call: base->Method() 1586 mch_memmove(&argv[1], argvars, sizeof(typval_T) * argcount); 1587 argv[0] = *funcexe->basetv; 1588 argcount++; 1589 argvars = argv; 1590 argv_base = 1; 1591 } 1592 1593 if (fp->uf_flags & FC_RANGE && funcexe->doesrange != NULL) 1594 *funcexe->doesrange = TRUE; 1595 if (argcount < fp->uf_args.ga_len - fp->uf_def_args.ga_len) 1596 error = ERROR_TOOFEW; 1597 else if (!fp->uf_varargs && argcount > fp->uf_args.ga_len) 1598 error = ERROR_TOOMANY; 1599 else if ((fp->uf_flags & FC_DICT) && selfdict == NULL) 1600 error = ERROR_DICT; 1601 else 1602 { 1603 int did_save_redo = FALSE; 1604 save_redo_T save_redo; 1605 1606 /* 1607 * Call the user function. 1608 * Save and restore search patterns, script variables and 1609 * redo buffer. 1610 */ 1611 save_search_patterns(); 1612 if (!ins_compl_active()) 1613 { 1614 saveRedobuff(&save_redo); 1615 did_save_redo = TRUE; 1616 } 1617 ++fp->uf_calls; 1618 call_user_func(fp, argcount, argvars, rettv, 1619 funcexe->firstline, funcexe->lastline, 1620 (fp->uf_flags & FC_DICT) ? selfdict : NULL); 1621 if (--fp->uf_calls <= 0 && fp->uf_refcount <= 0) 1622 /* Function was unreferenced while being used, free it 1623 * now. */ 1624 func_clear_free(fp, FALSE); 1625 if (did_save_redo) 1626 restoreRedobuff(&save_redo); 1627 restore_search_patterns(); 1628 error = ERROR_NONE; 1629 } 1630 } 1631 } 1632 else if (funcexe->basetv != NULL) 1633 { 1634 /* 1635 * expr->method(): Find the method name in the table, call its 1636 * implementation with the base as one of the arguments. 1637 */ 1638 error = call_internal_method(fname, argcount, argvars, rettv, 1639 funcexe->basetv); 1640 } 1641 else 1642 { 1643 /* 1644 * Find the function name in the table, call its implementation. 1645 */ 1646 error = call_internal_func(fname, argcount, argvars, rettv); 1647 } 1648 /* 1649 * The function call (or "FuncUndefined" autocommand sequence) might 1650 * have been aborted by an error, an interrupt, or an explicitly thrown 1651 * exception that has not been caught so far. This situation can be 1652 * tested for by calling aborting(). For an error in an internal 1653 * function or for the "E132" error in call_user_func(), however, the 1654 * throw point at which the "force_abort" flag (temporarily reset by 1655 * emsg()) is normally updated has not been reached yet. We need to 1656 * update that flag first to make aborting() reliable. 1657 */ 1658 update_force_abort(); 1659 } 1660 if (error == ERROR_NONE) 1661 ret = OK; 1662 1663 /* 1664 * Report an error unless the argument evaluation or function call has been 1665 * cancelled due to an aborting error, an interrupt, or an exception. 1666 */ 1667 if (!aborting()) 1668 { 1669 switch (error) 1670 { 1671 case ERROR_UNKNOWN: 1672 emsg_funcname(N_("E117: Unknown function: %s"), name); 1673 break; 1674 case ERROR_NOTMETHOD: 1675 emsg_funcname( 1676 N_("E276: Cannot use function as a method: %s"), 1677 name); 1678 break; 1679 case ERROR_DELETED: 1680 emsg_funcname(N_("E933: Function was deleted: %s"), name); 1681 break; 1682 case ERROR_TOOMANY: 1683 emsg_funcname((char *)e_toomanyarg, name); 1684 break; 1685 case ERROR_TOOFEW: 1686 emsg_funcname( 1687 N_("E119: Not enough arguments for function: %s"), 1688 name); 1689 break; 1690 case ERROR_SCRIPT: 1691 emsg_funcname( 1692 N_("E120: Using <SID> not in a script context: %s"), 1693 name); 1694 break; 1695 case ERROR_DICT: 1696 emsg_funcname( 1697 N_("E725: Calling dict function without Dictionary: %s"), 1698 name); 1699 break; 1700 } 1701 } 1702 1703 // clear the copies made from the partial 1704 while (argv_clear > 0) 1705 clear_tv(&argv[--argv_clear + argv_base]); 1706 1707 vim_free(tofree); 1708 vim_free(name); 1709 1710 return ret; 1711 } 1712 1713 /* 1714 * List the head of the function: "name(arg1, arg2)". 1715 */ 1716 static void 1717 list_func_head(ufunc_T *fp, int indent) 1718 { 1719 int j; 1720 1721 msg_start(); 1722 if (indent) 1723 msg_puts(" "); 1724 msg_puts("function "); 1725 if (fp->uf_name[0] == K_SPECIAL) 1726 { 1727 msg_puts_attr("<SNR>", HL_ATTR(HLF_8)); 1728 msg_puts((char *)fp->uf_name + 3); 1729 } 1730 else 1731 msg_puts((char *)fp->uf_name); 1732 msg_putchar('('); 1733 for (j = 0; j < fp->uf_args.ga_len; ++j) 1734 { 1735 if (j) 1736 msg_puts(", "); 1737 msg_puts((char *)FUNCARG(fp, j)); 1738 if (j >= fp->uf_args.ga_len - fp->uf_def_args.ga_len) 1739 { 1740 msg_puts(" = "); 1741 msg_puts(((char **)(fp->uf_def_args.ga_data)) 1742 [j - fp->uf_args.ga_len + fp->uf_def_args.ga_len]); 1743 } 1744 } 1745 if (fp->uf_varargs) 1746 { 1747 if (j) 1748 msg_puts(", "); 1749 msg_puts("..."); 1750 } 1751 msg_putchar(')'); 1752 if (fp->uf_flags & FC_ABORT) 1753 msg_puts(" abort"); 1754 if (fp->uf_flags & FC_RANGE) 1755 msg_puts(" range"); 1756 if (fp->uf_flags & FC_DICT) 1757 msg_puts(" dict"); 1758 if (fp->uf_flags & FC_CLOSURE) 1759 msg_puts(" closure"); 1760 msg_clr_eos(); 1761 if (p_verbose > 0) 1762 last_set_msg(fp->uf_script_ctx); 1763 } 1764 1765 /* 1766 * Get a function name, translating "<SID>" and "<SNR>". 1767 * Also handles a Funcref in a List or Dictionary. 1768 * Returns the function name in allocated memory, or NULL for failure. 1769 * flags: 1770 * TFN_INT: internal function name OK 1771 * TFN_QUIET: be quiet 1772 * TFN_NO_AUTOLOAD: do not use script autoloading 1773 * TFN_NO_DEREF: do not dereference a Funcref 1774 * Advances "pp" to just after the function name (if no error). 1775 */ 1776 char_u * 1777 trans_function_name( 1778 char_u **pp, 1779 int skip, /* only find the end, don't evaluate */ 1780 int flags, 1781 funcdict_T *fdp, /* return: info about dictionary used */ 1782 partial_T **partial) /* return: partial of a FuncRef */ 1783 { 1784 char_u *name = NULL; 1785 char_u *start; 1786 char_u *end; 1787 int lead; 1788 char_u sid_buf[20]; 1789 int len; 1790 lval_T lv; 1791 1792 if (fdp != NULL) 1793 vim_memset(fdp, 0, sizeof(funcdict_T)); 1794 start = *pp; 1795 1796 /* Check for hard coded <SNR>: already translated function ID (from a user 1797 * command). */ 1798 if ((*pp)[0] == K_SPECIAL && (*pp)[1] == KS_EXTRA 1799 && (*pp)[2] == (int)KE_SNR) 1800 { 1801 *pp += 3; 1802 len = get_id_len(pp) + 3; 1803 return vim_strnsave(start, len); 1804 } 1805 1806 /* A name starting with "<SID>" or "<SNR>" is local to a script. But 1807 * don't skip over "s:", get_lval() needs it for "s:dict.func". */ 1808 lead = eval_fname_script(start); 1809 if (lead > 2) 1810 start += lead; 1811 1812 /* Note that TFN_ flags use the same values as GLV_ flags. */ 1813 end = get_lval(start, NULL, &lv, FALSE, skip, flags | GLV_READ_ONLY, 1814 lead > 2 ? 0 : FNE_CHECK_START); 1815 if (end == start) 1816 { 1817 if (!skip) 1818 emsg(_("E129: Function name required")); 1819 goto theend; 1820 } 1821 if (end == NULL || (lv.ll_tv != NULL && (lead > 2 || lv.ll_range))) 1822 { 1823 /* 1824 * Report an invalid expression in braces, unless the expression 1825 * evaluation has been cancelled due to an aborting error, an 1826 * interrupt, or an exception. 1827 */ 1828 if (!aborting()) 1829 { 1830 if (end != NULL) 1831 semsg(_(e_invarg2), start); 1832 } 1833 else 1834 *pp = find_name_end(start, NULL, NULL, FNE_INCL_BR); 1835 goto theend; 1836 } 1837 1838 if (lv.ll_tv != NULL) 1839 { 1840 if (fdp != NULL) 1841 { 1842 fdp->fd_dict = lv.ll_dict; 1843 fdp->fd_newkey = lv.ll_newkey; 1844 lv.ll_newkey = NULL; 1845 fdp->fd_di = lv.ll_di; 1846 } 1847 if (lv.ll_tv->v_type == VAR_FUNC && lv.ll_tv->vval.v_string != NULL) 1848 { 1849 name = vim_strsave(lv.ll_tv->vval.v_string); 1850 *pp = end; 1851 } 1852 else if (lv.ll_tv->v_type == VAR_PARTIAL 1853 && lv.ll_tv->vval.v_partial != NULL) 1854 { 1855 name = vim_strsave(partial_name(lv.ll_tv->vval.v_partial)); 1856 *pp = end; 1857 if (partial != NULL) 1858 *partial = lv.ll_tv->vval.v_partial; 1859 } 1860 else 1861 { 1862 if (!skip && !(flags & TFN_QUIET) && (fdp == NULL 1863 || lv.ll_dict == NULL || fdp->fd_newkey == NULL)) 1864 emsg(_(e_funcref)); 1865 else 1866 *pp = end; 1867 name = NULL; 1868 } 1869 goto theend; 1870 } 1871 1872 if (lv.ll_name == NULL) 1873 { 1874 /* Error found, but continue after the function name. */ 1875 *pp = end; 1876 goto theend; 1877 } 1878 1879 /* Check if the name is a Funcref. If so, use the value. */ 1880 if (lv.ll_exp_name != NULL) 1881 { 1882 len = (int)STRLEN(lv.ll_exp_name); 1883 name = deref_func_name(lv.ll_exp_name, &len, partial, 1884 flags & TFN_NO_AUTOLOAD); 1885 if (name == lv.ll_exp_name) 1886 name = NULL; 1887 } 1888 else if (!(flags & TFN_NO_DEREF)) 1889 { 1890 len = (int)(end - *pp); 1891 name = deref_func_name(*pp, &len, partial, flags & TFN_NO_AUTOLOAD); 1892 if (name == *pp) 1893 name = NULL; 1894 } 1895 if (name != NULL) 1896 { 1897 name = vim_strsave(name); 1898 *pp = end; 1899 if (STRNCMP(name, "<SNR>", 5) == 0) 1900 { 1901 /* Change "<SNR>" to the byte sequence. */ 1902 name[0] = K_SPECIAL; 1903 name[1] = KS_EXTRA; 1904 name[2] = (int)KE_SNR; 1905 mch_memmove(name + 3, name + 5, STRLEN(name + 5) + 1); 1906 } 1907 goto theend; 1908 } 1909 1910 if (lv.ll_exp_name != NULL) 1911 { 1912 len = (int)STRLEN(lv.ll_exp_name); 1913 if (lead <= 2 && lv.ll_name == lv.ll_exp_name 1914 && STRNCMP(lv.ll_name, "s:", 2) == 0) 1915 { 1916 /* When there was "s:" already or the name expanded to get a 1917 * leading "s:" then remove it. */ 1918 lv.ll_name += 2; 1919 len -= 2; 1920 lead = 2; 1921 } 1922 } 1923 else 1924 { 1925 /* skip over "s:" and "g:" */ 1926 if (lead == 2 || (lv.ll_name[0] == 'g' && lv.ll_name[1] == ':')) 1927 lv.ll_name += 2; 1928 len = (int)(end - lv.ll_name); 1929 } 1930 1931 /* 1932 * Copy the function name to allocated memory. 1933 * Accept <SID>name() inside a script, translate into <SNR>123_name(). 1934 * Accept <SNR>123_name() outside a script. 1935 */ 1936 if (skip) 1937 lead = 0; /* do nothing */ 1938 else if (lead > 0) 1939 { 1940 lead = 3; 1941 if ((lv.ll_exp_name != NULL && eval_fname_sid(lv.ll_exp_name)) 1942 || eval_fname_sid(*pp)) 1943 { 1944 /* It's "s:" or "<SID>" */ 1945 if (current_sctx.sc_sid <= 0) 1946 { 1947 emsg(_(e_usingsid)); 1948 goto theend; 1949 } 1950 sprintf((char *)sid_buf, "%ld_", (long)current_sctx.sc_sid); 1951 lead += (int)STRLEN(sid_buf); 1952 } 1953 } 1954 else if (!(flags & TFN_INT) && builtin_function(lv.ll_name, len)) 1955 { 1956 semsg(_("E128: Function name must start with a capital or \"s:\": %s"), 1957 start); 1958 goto theend; 1959 } 1960 if (!skip && !(flags & TFN_QUIET) && !(flags & TFN_NO_DEREF)) 1961 { 1962 char_u *cp = vim_strchr(lv.ll_name, ':'); 1963 1964 if (cp != NULL && cp < end) 1965 { 1966 semsg(_("E884: Function name cannot contain a colon: %s"), start); 1967 goto theend; 1968 } 1969 } 1970 1971 name = alloc(len + lead + 1); 1972 if (name != NULL) 1973 { 1974 if (lead > 0) 1975 { 1976 name[0] = K_SPECIAL; 1977 name[1] = KS_EXTRA; 1978 name[2] = (int)KE_SNR; 1979 if (lead > 3) /* If it's "<SID>" */ 1980 STRCPY(name + 3, sid_buf); 1981 } 1982 mch_memmove(name + lead, lv.ll_name, (size_t)len); 1983 name[lead + len] = NUL; 1984 } 1985 *pp = end; 1986 1987 theend: 1988 clear_lval(&lv); 1989 return name; 1990 } 1991 1992 /* 1993 * ":function" 1994 */ 1995 void 1996 ex_function(exarg_T *eap) 1997 { 1998 char_u *theline; 1999 char_u *line_to_free = NULL; 2000 int j; 2001 int c; 2002 int saved_did_emsg; 2003 int saved_wait_return = need_wait_return; 2004 char_u *name = NULL; 2005 char_u *p; 2006 char_u *arg; 2007 char_u *line_arg = NULL; 2008 garray_T newargs; 2009 garray_T default_args; 2010 garray_T newlines; 2011 int varargs = FALSE; 2012 int flags = 0; 2013 ufunc_T *fp; 2014 int overwrite = FALSE; 2015 int indent; 2016 int nesting; 2017 dictitem_T *v; 2018 funcdict_T fudi; 2019 static int func_nr = 0; /* number for nameless function */ 2020 int paren; 2021 hashtab_T *ht; 2022 int todo; 2023 hashitem_T *hi; 2024 int do_concat = TRUE; 2025 linenr_T sourcing_lnum_off; 2026 linenr_T sourcing_lnum_top; 2027 int is_heredoc = FALSE; 2028 char_u *skip_until = NULL; 2029 char_u *heredoc_trimmed = NULL; 2030 2031 /* 2032 * ":function" without argument: list functions. 2033 */ 2034 if (ends_excmd(*eap->arg)) 2035 { 2036 if (!eap->skip) 2037 { 2038 todo = (int)func_hashtab.ht_used; 2039 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 2040 { 2041 if (!HASHITEM_EMPTY(hi)) 2042 { 2043 --todo; 2044 fp = HI2UF(hi); 2045 if (message_filtered(fp->uf_name)) 2046 continue; 2047 if (!func_name_refcount(fp->uf_name)) 2048 list_func_head(fp, FALSE); 2049 } 2050 } 2051 } 2052 eap->nextcmd = check_nextcmd(eap->arg); 2053 return; 2054 } 2055 2056 /* 2057 * ":function /pat": list functions matching pattern. 2058 */ 2059 if (*eap->arg == '/') 2060 { 2061 p = skip_regexp(eap->arg + 1, '/', TRUE, NULL); 2062 if (!eap->skip) 2063 { 2064 regmatch_T regmatch; 2065 2066 c = *p; 2067 *p = NUL; 2068 regmatch.regprog = vim_regcomp(eap->arg + 1, RE_MAGIC); 2069 *p = c; 2070 if (regmatch.regprog != NULL) 2071 { 2072 regmatch.rm_ic = p_ic; 2073 2074 todo = (int)func_hashtab.ht_used; 2075 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 2076 { 2077 if (!HASHITEM_EMPTY(hi)) 2078 { 2079 --todo; 2080 fp = HI2UF(hi); 2081 if (!isdigit(*fp->uf_name) 2082 && vim_regexec(®match, fp->uf_name, 0)) 2083 list_func_head(fp, FALSE); 2084 } 2085 } 2086 vim_regfree(regmatch.regprog); 2087 } 2088 } 2089 if (*p == '/') 2090 ++p; 2091 eap->nextcmd = check_nextcmd(p); 2092 return; 2093 } 2094 2095 /* 2096 * Get the function name. There are these situations: 2097 * func normal function name 2098 * "name" == func, "fudi.fd_dict" == NULL 2099 * dict.func new dictionary entry 2100 * "name" == NULL, "fudi.fd_dict" set, 2101 * "fudi.fd_di" == NULL, "fudi.fd_newkey" == func 2102 * dict.func existing dict entry with a Funcref 2103 * "name" == func, "fudi.fd_dict" set, 2104 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 2105 * dict.func existing dict entry that's not a Funcref 2106 * "name" == NULL, "fudi.fd_dict" set, 2107 * "fudi.fd_di" set, "fudi.fd_newkey" == NULL 2108 * s:func script-local function name 2109 * g:func global function name, same as "func" 2110 */ 2111 p = eap->arg; 2112 name = trans_function_name(&p, eap->skip, TFN_NO_AUTOLOAD, &fudi, NULL); 2113 paren = (vim_strchr(p, '(') != NULL); 2114 if (name == NULL && (fudi.fd_dict == NULL || !paren) && !eap->skip) 2115 { 2116 /* 2117 * Return on an invalid expression in braces, unless the expression 2118 * evaluation has been cancelled due to an aborting error, an 2119 * interrupt, or an exception. 2120 */ 2121 if (!aborting()) 2122 { 2123 if (!eap->skip && fudi.fd_newkey != NULL) 2124 semsg(_(e_dictkey), fudi.fd_newkey); 2125 vim_free(fudi.fd_newkey); 2126 return; 2127 } 2128 else 2129 eap->skip = TRUE; 2130 } 2131 2132 /* An error in a function call during evaluation of an expression in magic 2133 * braces should not cause the function not to be defined. */ 2134 saved_did_emsg = did_emsg; 2135 did_emsg = FALSE; 2136 2137 /* 2138 * ":function func" with only function name: list function. 2139 */ 2140 if (!paren) 2141 { 2142 if (!ends_excmd(*skipwhite(p))) 2143 { 2144 emsg(_(e_trailing)); 2145 goto ret_free; 2146 } 2147 eap->nextcmd = check_nextcmd(p); 2148 if (eap->nextcmd != NULL) 2149 *p = NUL; 2150 if (!eap->skip && !got_int) 2151 { 2152 fp = find_func(name); 2153 if (fp != NULL) 2154 { 2155 list_func_head(fp, TRUE); 2156 for (j = 0; j < fp->uf_lines.ga_len && !got_int; ++j) 2157 { 2158 if (FUNCLINE(fp, j) == NULL) 2159 continue; 2160 msg_putchar('\n'); 2161 msg_outnum((long)(j + 1)); 2162 if (j < 9) 2163 msg_putchar(' '); 2164 if (j < 99) 2165 msg_putchar(' '); 2166 msg_prt_line(FUNCLINE(fp, j), FALSE); 2167 out_flush(); /* show a line at a time */ 2168 ui_breakcheck(); 2169 } 2170 if (!got_int) 2171 { 2172 msg_putchar('\n'); 2173 msg_puts(" endfunction"); 2174 } 2175 } 2176 else 2177 emsg_funcname(N_("E123: Undefined function: %s"), name); 2178 } 2179 goto ret_free; 2180 } 2181 2182 /* 2183 * ":function name(arg1, arg2)" Define function. 2184 */ 2185 p = skipwhite(p); 2186 if (*p != '(') 2187 { 2188 if (!eap->skip) 2189 { 2190 semsg(_("E124: Missing '(': %s"), eap->arg); 2191 goto ret_free; 2192 } 2193 /* attempt to continue by skipping some text */ 2194 if (vim_strchr(p, '(') != NULL) 2195 p = vim_strchr(p, '('); 2196 } 2197 p = skipwhite(p + 1); 2198 2199 ga_init2(&newlines, (int)sizeof(char_u *), 3); 2200 2201 if (!eap->skip) 2202 { 2203 /* Check the name of the function. Unless it's a dictionary function 2204 * (that we are overwriting). */ 2205 if (name != NULL) 2206 arg = name; 2207 else 2208 arg = fudi.fd_newkey; 2209 if (arg != NULL && (fudi.fd_di == NULL 2210 || (fudi.fd_di->di_tv.v_type != VAR_FUNC 2211 && fudi.fd_di->di_tv.v_type != VAR_PARTIAL))) 2212 { 2213 if (*arg == K_SPECIAL) 2214 j = 3; 2215 else 2216 j = 0; 2217 while (arg[j] != NUL && (j == 0 ? eval_isnamec1(arg[j]) 2218 : eval_isnamec(arg[j]))) 2219 ++j; 2220 if (arg[j] != NUL) 2221 emsg_funcname((char *)e_invarg2, arg); 2222 } 2223 /* Disallow using the g: dict. */ 2224 if (fudi.fd_dict != NULL && fudi.fd_dict->dv_scope == VAR_DEF_SCOPE) 2225 emsg(_("E862: Cannot use g: here")); 2226 } 2227 2228 if (get_function_args(&p, ')', &newargs, &varargs, 2229 &default_args, eap->skip) == FAIL) 2230 goto errret_2; 2231 2232 /* find extra arguments "range", "dict", "abort" and "closure" */ 2233 for (;;) 2234 { 2235 p = skipwhite(p); 2236 if (STRNCMP(p, "range", 5) == 0) 2237 { 2238 flags |= FC_RANGE; 2239 p += 5; 2240 } 2241 else if (STRNCMP(p, "dict", 4) == 0) 2242 { 2243 flags |= FC_DICT; 2244 p += 4; 2245 } 2246 else if (STRNCMP(p, "abort", 5) == 0) 2247 { 2248 flags |= FC_ABORT; 2249 p += 5; 2250 } 2251 else if (STRNCMP(p, "closure", 7) == 0) 2252 { 2253 flags |= FC_CLOSURE; 2254 p += 7; 2255 if (current_funccal == NULL) 2256 { 2257 emsg_funcname(N_("E932: Closure function should not be at top level: %s"), 2258 name == NULL ? (char_u *)"" : name); 2259 goto erret; 2260 } 2261 } 2262 else 2263 break; 2264 } 2265 2266 /* When there is a line break use what follows for the function body. 2267 * Makes 'exe "func Test()\n...\nendfunc"' work. */ 2268 if (*p == '\n') 2269 line_arg = p + 1; 2270 else if (*p != NUL && *p != '"' && !eap->skip && !did_emsg) 2271 emsg(_(e_trailing)); 2272 2273 /* 2274 * Read the body of the function, until ":endfunction" is found. 2275 */ 2276 if (KeyTyped) 2277 { 2278 /* Check if the function already exists, don't let the user type the 2279 * whole function before telling him it doesn't work! For a script we 2280 * need to skip the body to be able to find what follows. */ 2281 if (!eap->skip && !eap->forceit) 2282 { 2283 if (fudi.fd_dict != NULL && fudi.fd_newkey == NULL) 2284 emsg(_(e_funcdict)); 2285 else if (name != NULL && find_func(name) != NULL) 2286 emsg_funcname(e_funcexts, name); 2287 } 2288 2289 if (!eap->skip && did_emsg) 2290 goto erret; 2291 2292 msg_putchar('\n'); /* don't overwrite the function name */ 2293 cmdline_row = msg_row; 2294 } 2295 2296 // Save the starting line number. 2297 sourcing_lnum_top = sourcing_lnum; 2298 2299 indent = 2; 2300 nesting = 0; 2301 for (;;) 2302 { 2303 if (KeyTyped) 2304 { 2305 msg_scroll = TRUE; 2306 saved_wait_return = FALSE; 2307 } 2308 need_wait_return = FALSE; 2309 2310 if (line_arg != NULL) 2311 { 2312 /* Use eap->arg, split up in parts by line breaks. */ 2313 theline = line_arg; 2314 p = vim_strchr(theline, '\n'); 2315 if (p == NULL) 2316 line_arg += STRLEN(line_arg); 2317 else 2318 { 2319 *p = NUL; 2320 line_arg = p + 1; 2321 } 2322 } 2323 else 2324 { 2325 vim_free(line_to_free); 2326 if (eap->getline == NULL) 2327 theline = getcmdline(':', 0L, indent, do_concat); 2328 else 2329 theline = eap->getline(':', eap->cookie, indent, do_concat); 2330 line_to_free = theline; 2331 } 2332 if (KeyTyped) 2333 lines_left = Rows - 1; 2334 if (theline == NULL) 2335 { 2336 emsg(_("E126: Missing :endfunction")); 2337 goto erret; 2338 } 2339 2340 /* Detect line continuation: sourcing_lnum increased more than one. */ 2341 sourcing_lnum_off = get_sourced_lnum(eap->getline, eap->cookie); 2342 if (sourcing_lnum < sourcing_lnum_off) 2343 sourcing_lnum_off -= sourcing_lnum; 2344 else 2345 sourcing_lnum_off = 0; 2346 2347 if (skip_until != NULL) 2348 { 2349 // Don't check for ":endfunc" between 2350 // * ":append" and "." 2351 // * ":python <<EOF" and "EOF" 2352 // * ":let {var-name} =<< [trim] {marker}" and "{marker}" 2353 if (heredoc_trimmed == NULL 2354 || (is_heredoc && skipwhite(theline) == theline) 2355 || STRNCMP(theline, heredoc_trimmed, 2356 STRLEN(heredoc_trimmed)) == 0) 2357 { 2358 if (heredoc_trimmed == NULL) 2359 p = theline; 2360 else if (is_heredoc) 2361 p = skipwhite(theline) == theline 2362 ? theline : theline + STRLEN(heredoc_trimmed); 2363 else 2364 p = theline + STRLEN(heredoc_trimmed); 2365 if (STRCMP(p, skip_until) == 0) 2366 { 2367 VIM_CLEAR(skip_until); 2368 VIM_CLEAR(heredoc_trimmed); 2369 do_concat = TRUE; 2370 is_heredoc = FALSE; 2371 } 2372 } 2373 } 2374 else 2375 { 2376 /* skip ':' and blanks*/ 2377 for (p = theline; VIM_ISWHITE(*p) || *p == ':'; ++p) 2378 ; 2379 2380 /* Check for "endfunction". */ 2381 if (checkforcmd(&p, "endfunction", 4) && nesting-- == 0) 2382 { 2383 char_u *nextcmd = NULL; 2384 2385 if (*p == '|') 2386 nextcmd = p + 1; 2387 else if (line_arg != NULL && *skipwhite(line_arg) != NUL) 2388 nextcmd = line_arg; 2389 else if (*p != NUL && *p != '"' && p_verbose > 0) 2390 give_warning2( 2391 (char_u *)_("W22: Text found after :endfunction: %s"), 2392 p, TRUE); 2393 if (nextcmd != NULL) 2394 { 2395 /* Another command follows. If the line came from "eap" we 2396 * can simply point into it, otherwise we need to change 2397 * "eap->cmdlinep". */ 2398 eap->nextcmd = nextcmd; 2399 if (line_to_free != NULL) 2400 { 2401 vim_free(*eap->cmdlinep); 2402 *eap->cmdlinep = line_to_free; 2403 line_to_free = NULL; 2404 } 2405 } 2406 break; 2407 } 2408 2409 /* Increase indent inside "if", "while", "for" and "try", decrease 2410 * at "end". */ 2411 if (indent > 2 && STRNCMP(p, "end", 3) == 0) 2412 indent -= 2; 2413 else if (STRNCMP(p, "if", 2) == 0 2414 || STRNCMP(p, "wh", 2) == 0 2415 || STRNCMP(p, "for", 3) == 0 2416 || STRNCMP(p, "try", 3) == 0) 2417 indent += 2; 2418 2419 /* Check for defining a function inside this function. */ 2420 if (checkforcmd(&p, "function", 2)) 2421 { 2422 if (*p == '!') 2423 p = skipwhite(p + 1); 2424 p += eval_fname_script(p); 2425 vim_free(trans_function_name(&p, TRUE, 0, NULL, NULL)); 2426 if (*skipwhite(p) == '(') 2427 { 2428 ++nesting; 2429 indent += 2; 2430 } 2431 } 2432 2433 /* Check for ":append", ":change", ":insert". */ 2434 p = skip_range(p, NULL); 2435 if ((p[0] == 'a' && (!ASCII_ISALPHA(p[1]) || p[1] == 'p')) 2436 || (p[0] == 'c' 2437 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'h' 2438 && (!ASCII_ISALPHA(p[2]) || (p[2] == 'a' 2439 && (STRNCMP(&p[3], "nge", 3) != 0 2440 || !ASCII_ISALPHA(p[6]))))))) 2441 || (p[0] == 'i' 2442 && (!ASCII_ISALPHA(p[1]) || (p[1] == 'n' 2443 && (!ASCII_ISALPHA(p[2]) || (p[2] == 's')))))) 2444 skip_until = vim_strsave((char_u *)"."); 2445 2446 /* Check for ":python <<EOF", ":tcl <<EOF", etc. */ 2447 arg = skipwhite(skiptowhite(p)); 2448 if (arg[0] == '<' && arg[1] =='<' 2449 && ((p[0] == 'p' && p[1] == 'y' 2450 && (!ASCII_ISALNUM(p[2]) || p[2] == 't' 2451 || ((p[2] == '3' || p[2] == 'x') 2452 && !ASCII_ISALPHA(p[3])))) 2453 || (p[0] == 'p' && p[1] == 'e' 2454 && (!ASCII_ISALPHA(p[2]) || p[2] == 'r')) 2455 || (p[0] == 't' && p[1] == 'c' 2456 && (!ASCII_ISALPHA(p[2]) || p[2] == 'l')) 2457 || (p[0] == 'l' && p[1] == 'u' && p[2] == 'a' 2458 && !ASCII_ISALPHA(p[3])) 2459 || (p[0] == 'r' && p[1] == 'u' && p[2] == 'b' 2460 && (!ASCII_ISALPHA(p[3]) || p[3] == 'y')) 2461 || (p[0] == 'm' && p[1] == 'z' 2462 && (!ASCII_ISALPHA(p[2]) || p[2] == 's')) 2463 )) 2464 { 2465 /* ":python <<" continues until a dot, like ":append" */ 2466 p = skipwhite(arg + 2); 2467 if (*p == NUL) 2468 skip_until = vim_strsave((char_u *)"."); 2469 else 2470 skip_until = vim_strsave(p); 2471 } 2472 2473 // Check for ":let v =<< [trim] EOF" 2474 arg = skipwhite(skiptowhite(p)); 2475 arg = skipwhite(skiptowhite(arg)); 2476 if (arg[0] == '=' && arg[1] == '<' && arg[2] =='<' 2477 && ((p[0] == 'l' 2478 && p[1] == 'e' 2479 && (!ASCII_ISALNUM(p[2]) 2480 || (p[2] == 't' && !ASCII_ISALNUM(p[3])))))) 2481 { 2482 p = skipwhite(arg + 3); 2483 if (STRNCMP(p, "trim", 4) == 0) 2484 { 2485 // Ignore leading white space. 2486 p = skipwhite(p + 4); 2487 heredoc_trimmed = vim_strnsave(theline, 2488 (int)(skipwhite(theline) - theline)); 2489 } 2490 skip_until = vim_strnsave(p, (int)(skiptowhite(p) - p)); 2491 do_concat = FALSE; 2492 is_heredoc = TRUE; 2493 } 2494 } 2495 2496 /* Add the line to the function. */ 2497 if (ga_grow(&newlines, 1 + sourcing_lnum_off) == FAIL) 2498 goto erret; 2499 2500 /* Copy the line to newly allocated memory. get_one_sourceline() 2501 * allocates 250 bytes per line, this saves 80% on average. The cost 2502 * is an extra alloc/free. */ 2503 p = vim_strsave(theline); 2504 if (p == NULL) 2505 goto erret; 2506 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = p; 2507 2508 /* Add NULL lines for continuation lines, so that the line count is 2509 * equal to the index in the growarray. */ 2510 while (sourcing_lnum_off-- > 0) 2511 ((char_u **)(newlines.ga_data))[newlines.ga_len++] = NULL; 2512 2513 /* Check for end of eap->arg. */ 2514 if (line_arg != NULL && *line_arg == NUL) 2515 line_arg = NULL; 2516 } 2517 2518 /* Don't define the function when skipping commands or when an error was 2519 * detected. */ 2520 if (eap->skip || did_emsg) 2521 goto erret; 2522 2523 /* 2524 * If there are no errors, add the function 2525 */ 2526 if (fudi.fd_dict == NULL) 2527 { 2528 v = find_var(name, &ht, FALSE); 2529 if (v != NULL && v->di_tv.v_type == VAR_FUNC) 2530 { 2531 emsg_funcname(N_("E707: Function name conflicts with variable: %s"), 2532 name); 2533 goto erret; 2534 } 2535 2536 fp = find_func(name); 2537 if (fp != NULL) 2538 { 2539 // Function can be replaced with "function!" and when sourcing the 2540 // same script again, but only once. 2541 if (!eap->forceit 2542 && (fp->uf_script_ctx.sc_sid != current_sctx.sc_sid 2543 || fp->uf_script_ctx.sc_seq == current_sctx.sc_seq)) 2544 { 2545 emsg_funcname(e_funcexts, name); 2546 goto erret; 2547 } 2548 if (fp->uf_calls > 0) 2549 { 2550 emsg_funcname( 2551 N_("E127: Cannot redefine function %s: It is in use"), 2552 name); 2553 goto erret; 2554 } 2555 if (fp->uf_refcount > 1) 2556 { 2557 /* This function is referenced somewhere, don't redefine it but 2558 * create a new one. */ 2559 --fp->uf_refcount; 2560 fp->uf_flags |= FC_REMOVED; 2561 fp = NULL; 2562 overwrite = TRUE; 2563 } 2564 else 2565 { 2566 /* redefine existing function */ 2567 VIM_CLEAR(name); 2568 func_clear_items(fp); 2569 #ifdef FEAT_PROFILE 2570 fp->uf_profiling = FALSE; 2571 fp->uf_prof_initialized = FALSE; 2572 #endif 2573 } 2574 } 2575 } 2576 else 2577 { 2578 char numbuf[20]; 2579 2580 fp = NULL; 2581 if (fudi.fd_newkey == NULL && !eap->forceit) 2582 { 2583 emsg(_(e_funcdict)); 2584 goto erret; 2585 } 2586 if (fudi.fd_di == NULL) 2587 { 2588 /* Can't add a function to a locked dictionary */ 2589 if (var_check_lock(fudi.fd_dict->dv_lock, eap->arg, FALSE)) 2590 goto erret; 2591 } 2592 /* Can't change an existing function if it is locked */ 2593 else if (var_check_lock(fudi.fd_di->di_tv.v_lock, eap->arg, FALSE)) 2594 goto erret; 2595 2596 /* Give the function a sequential number. Can only be used with a 2597 * Funcref! */ 2598 vim_free(name); 2599 sprintf(numbuf, "%d", ++func_nr); 2600 name = vim_strsave((char_u *)numbuf); 2601 if (name == NULL) 2602 goto erret; 2603 } 2604 2605 if (fp == NULL) 2606 { 2607 if (fudi.fd_dict == NULL && vim_strchr(name, AUTOLOAD_CHAR) != NULL) 2608 { 2609 int slen, plen; 2610 char_u *scriptname; 2611 2612 /* Check that the autoload name matches the script name. */ 2613 j = FAIL; 2614 if (sourcing_name != NULL) 2615 { 2616 scriptname = autoload_name(name); 2617 if (scriptname != NULL) 2618 { 2619 p = vim_strchr(scriptname, '/'); 2620 plen = (int)STRLEN(p); 2621 slen = (int)STRLEN(sourcing_name); 2622 if (slen > plen && fnamecmp(p, 2623 sourcing_name + slen - plen) == 0) 2624 j = OK; 2625 vim_free(scriptname); 2626 } 2627 } 2628 if (j == FAIL) 2629 { 2630 semsg(_("E746: Function name does not match script file name: %s"), name); 2631 goto erret; 2632 } 2633 } 2634 2635 fp = alloc_clear(offsetof(ufunc_T, uf_name) + STRLEN(name) + 1); 2636 if (fp == NULL) 2637 goto erret; 2638 2639 if (fudi.fd_dict != NULL) 2640 { 2641 if (fudi.fd_di == NULL) 2642 { 2643 /* add new dict entry */ 2644 fudi.fd_di = dictitem_alloc(fudi.fd_newkey); 2645 if (fudi.fd_di == NULL) 2646 { 2647 vim_free(fp); 2648 goto erret; 2649 } 2650 if (dict_add(fudi.fd_dict, fudi.fd_di) == FAIL) 2651 { 2652 vim_free(fudi.fd_di); 2653 vim_free(fp); 2654 goto erret; 2655 } 2656 } 2657 else 2658 /* overwrite existing dict entry */ 2659 clear_tv(&fudi.fd_di->di_tv); 2660 fudi.fd_di->di_tv.v_type = VAR_FUNC; 2661 fudi.fd_di->di_tv.vval.v_string = vim_strsave(name); 2662 2663 /* behave like "dict" was used */ 2664 flags |= FC_DICT; 2665 } 2666 2667 /* insert the new function in the function list */ 2668 STRCPY(fp->uf_name, name); 2669 if (overwrite) 2670 { 2671 hi = hash_find(&func_hashtab, name); 2672 hi->hi_key = UF2HIKEY(fp); 2673 } 2674 else if (hash_add(&func_hashtab, UF2HIKEY(fp)) == FAIL) 2675 { 2676 vim_free(fp); 2677 goto erret; 2678 } 2679 fp->uf_refcount = 1; 2680 } 2681 fp->uf_args = newargs; 2682 fp->uf_def_args = default_args; 2683 fp->uf_lines = newlines; 2684 if ((flags & FC_CLOSURE) != 0) 2685 { 2686 if (register_closure(fp) == FAIL) 2687 goto erret; 2688 } 2689 else 2690 fp->uf_scoped = NULL; 2691 2692 #ifdef FEAT_PROFILE 2693 if (prof_def_func()) 2694 func_do_profile(fp); 2695 #endif 2696 fp->uf_varargs = varargs; 2697 if (sandbox) 2698 flags |= FC_SANDBOX; 2699 fp->uf_flags = flags; 2700 fp->uf_calls = 0; 2701 fp->uf_script_ctx = current_sctx; 2702 fp->uf_script_ctx.sc_lnum += sourcing_lnum_top; 2703 goto ret_free; 2704 2705 erret: 2706 ga_clear_strings(&newargs); 2707 ga_clear_strings(&default_args); 2708 errret_2: 2709 ga_clear_strings(&newlines); 2710 ret_free: 2711 vim_free(skip_until); 2712 vim_free(line_to_free); 2713 vim_free(fudi.fd_newkey); 2714 vim_free(name); 2715 did_emsg |= saved_did_emsg; 2716 need_wait_return |= saved_wait_return; 2717 } 2718 2719 /* 2720 * Return 5 if "p" starts with "<SID>" or "<SNR>" (ignoring case). 2721 * Return 2 if "p" starts with "s:". 2722 * Return 0 otherwise. 2723 */ 2724 int 2725 eval_fname_script(char_u *p) 2726 { 2727 /* Use MB_STRICMP() because in Turkish comparing the "I" may not work with 2728 * the standard library function. */ 2729 if (p[0] == '<' && (MB_STRNICMP(p + 1, "SID>", 4) == 0 2730 || MB_STRNICMP(p + 1, "SNR>", 4) == 0)) 2731 return 5; 2732 if (p[0] == 's' && p[1] == ':') 2733 return 2; 2734 return 0; 2735 } 2736 2737 int 2738 translated_function_exists(char_u *name) 2739 { 2740 if (builtin_function(name, -1)) 2741 return has_internal_func(name); 2742 return find_func(name) != NULL; 2743 } 2744 2745 /* 2746 * Return TRUE if a function "name" exists. 2747 * If "no_defef" is TRUE, do not dereference a Funcref. 2748 */ 2749 int 2750 function_exists(char_u *name, int no_deref) 2751 { 2752 char_u *nm = name; 2753 char_u *p; 2754 int n = FALSE; 2755 int flag; 2756 2757 flag = TFN_INT | TFN_QUIET | TFN_NO_AUTOLOAD; 2758 if (no_deref) 2759 flag |= TFN_NO_DEREF; 2760 p = trans_function_name(&nm, FALSE, flag, NULL, NULL); 2761 nm = skipwhite(nm); 2762 2763 /* Only accept "funcname", "funcname ", "funcname (..." and 2764 * "funcname(...", not "funcname!...". */ 2765 if (p != NULL && (*nm == NUL || *nm == '(')) 2766 n = translated_function_exists(p); 2767 vim_free(p); 2768 return n; 2769 } 2770 2771 #if defined(FEAT_PYTHON) || defined(FEAT_PYTHON3) || defined(PROTO) 2772 char_u * 2773 get_expanded_name(char_u *name, int check) 2774 { 2775 char_u *nm = name; 2776 char_u *p; 2777 2778 p = trans_function_name(&nm, FALSE, TFN_INT|TFN_QUIET, NULL, NULL); 2779 2780 if (p != NULL && *nm == NUL) 2781 if (!check || translated_function_exists(p)) 2782 return p; 2783 2784 vim_free(p); 2785 return NULL; 2786 } 2787 #endif 2788 2789 /* 2790 * Function given to ExpandGeneric() to obtain the list of user defined 2791 * function names. 2792 */ 2793 char_u * 2794 get_user_func_name(expand_T *xp, int idx) 2795 { 2796 static long_u done; 2797 static hashitem_T *hi; 2798 ufunc_T *fp; 2799 2800 if (idx == 0) 2801 { 2802 done = 0; 2803 hi = func_hashtab.ht_array; 2804 } 2805 if (done < func_hashtab.ht_used) 2806 { 2807 if (done++ > 0) 2808 ++hi; 2809 while (HASHITEM_EMPTY(hi)) 2810 ++hi; 2811 fp = HI2UF(hi); 2812 2813 if ((fp->uf_flags & FC_DICT) 2814 || STRNCMP(fp->uf_name, "<lambda>", 8) == 0) 2815 return (char_u *)""; /* don't show dict and lambda functions */ 2816 2817 if (STRLEN(fp->uf_name) + 4 >= IOSIZE) 2818 return fp->uf_name; /* prevents overflow */ 2819 2820 cat_func_name(IObuff, fp); 2821 if (xp->xp_context != EXPAND_USER_FUNC) 2822 { 2823 STRCAT(IObuff, "("); 2824 if (!fp->uf_varargs && fp->uf_args.ga_len == 0) 2825 STRCAT(IObuff, ")"); 2826 } 2827 return IObuff; 2828 } 2829 return NULL; 2830 } 2831 2832 /* 2833 * ":delfunction {name}" 2834 */ 2835 void 2836 ex_delfunction(exarg_T *eap) 2837 { 2838 ufunc_T *fp = NULL; 2839 char_u *p; 2840 char_u *name; 2841 funcdict_T fudi; 2842 2843 p = eap->arg; 2844 name = trans_function_name(&p, eap->skip, 0, &fudi, NULL); 2845 vim_free(fudi.fd_newkey); 2846 if (name == NULL) 2847 { 2848 if (fudi.fd_dict != NULL && !eap->skip) 2849 emsg(_(e_funcref)); 2850 return; 2851 } 2852 if (!ends_excmd(*skipwhite(p))) 2853 { 2854 vim_free(name); 2855 emsg(_(e_trailing)); 2856 return; 2857 } 2858 eap->nextcmd = check_nextcmd(p); 2859 if (eap->nextcmd != NULL) 2860 *p = NUL; 2861 2862 if (!eap->skip) 2863 fp = find_func(name); 2864 vim_free(name); 2865 2866 if (!eap->skip) 2867 { 2868 if (fp == NULL) 2869 { 2870 if (!eap->forceit) 2871 semsg(_(e_nofunc), eap->arg); 2872 return; 2873 } 2874 if (fp->uf_calls > 0) 2875 { 2876 semsg(_("E131: Cannot delete function %s: It is in use"), eap->arg); 2877 return; 2878 } 2879 2880 if (fudi.fd_dict != NULL) 2881 { 2882 /* Delete the dict item that refers to the function, it will 2883 * invoke func_unref() and possibly delete the function. */ 2884 dictitem_remove(fudi.fd_dict, fudi.fd_di); 2885 } 2886 else 2887 { 2888 /* A normal function (not a numbered function or lambda) has a 2889 * refcount of 1 for the entry in the hashtable. When deleting 2890 * it and the refcount is more than one, it should be kept. 2891 * A numbered function and lambda should be kept if the refcount is 2892 * one or more. */ 2893 if (fp->uf_refcount > (func_name_refcount(fp->uf_name) ? 0 : 1)) 2894 { 2895 /* Function is still referenced somewhere. Don't free it but 2896 * do remove it from the hashtable. */ 2897 if (func_remove(fp)) 2898 fp->uf_refcount--; 2899 fp->uf_flags |= FC_DELETED; 2900 } 2901 else 2902 func_clear_free(fp, FALSE); 2903 } 2904 } 2905 } 2906 2907 /* 2908 * Unreference a Function: decrement the reference count and free it when it 2909 * becomes zero. 2910 */ 2911 void 2912 func_unref(char_u *name) 2913 { 2914 ufunc_T *fp = NULL; 2915 2916 if (name == NULL || !func_name_refcount(name)) 2917 return; 2918 fp = find_func(name); 2919 if (fp == NULL && isdigit(*name)) 2920 { 2921 #ifdef EXITFREE 2922 if (!entered_free_all_mem) 2923 #endif 2924 internal_error("func_unref()"); 2925 } 2926 if (fp != NULL && --fp->uf_refcount <= 0) 2927 { 2928 /* Only delete it when it's not being used. Otherwise it's done 2929 * when "uf_calls" becomes zero. */ 2930 if (fp->uf_calls == 0) 2931 func_clear_free(fp, FALSE); 2932 } 2933 } 2934 2935 /* 2936 * Unreference a Function: decrement the reference count and free it when it 2937 * becomes zero. 2938 */ 2939 void 2940 func_ptr_unref(ufunc_T *fp) 2941 { 2942 if (fp != NULL && --fp->uf_refcount <= 0) 2943 { 2944 /* Only delete it when it's not being used. Otherwise it's done 2945 * when "uf_calls" becomes zero. */ 2946 if (fp->uf_calls == 0) 2947 func_clear_free(fp, FALSE); 2948 } 2949 } 2950 2951 /* 2952 * Count a reference to a Function. 2953 */ 2954 void 2955 func_ref(char_u *name) 2956 { 2957 ufunc_T *fp; 2958 2959 if (name == NULL || !func_name_refcount(name)) 2960 return; 2961 fp = find_func(name); 2962 if (fp != NULL) 2963 ++fp->uf_refcount; 2964 else if (isdigit(*name)) 2965 /* Only give an error for a numbered function. 2966 * Fail silently, when named or lambda function isn't found. */ 2967 internal_error("func_ref()"); 2968 } 2969 2970 /* 2971 * Count a reference to a Function. 2972 */ 2973 void 2974 func_ptr_ref(ufunc_T *fp) 2975 { 2976 if (fp != NULL) 2977 ++fp->uf_refcount; 2978 } 2979 2980 /* 2981 * Return TRUE if items in "fc" do not have "copyID". That means they are not 2982 * referenced from anywhere that is in use. 2983 */ 2984 static int 2985 can_free_funccal(funccall_T *fc, int copyID) 2986 { 2987 return (fc->l_varlist.lv_copyID != copyID 2988 && fc->l_vars.dv_copyID != copyID 2989 && fc->l_avars.dv_copyID != copyID 2990 && fc->fc_copyID != copyID); 2991 } 2992 2993 /* 2994 * ":return [expr]" 2995 */ 2996 void 2997 ex_return(exarg_T *eap) 2998 { 2999 char_u *arg = eap->arg; 3000 typval_T rettv; 3001 int returning = FALSE; 3002 3003 if (current_funccal == NULL) 3004 { 3005 emsg(_("E133: :return not inside a function")); 3006 return; 3007 } 3008 3009 if (eap->skip) 3010 ++emsg_skip; 3011 3012 eap->nextcmd = NULL; 3013 if ((*arg != NUL && *arg != '|' && *arg != '\n') 3014 && eval0(arg, &rettv, &eap->nextcmd, !eap->skip) != FAIL) 3015 { 3016 if (!eap->skip) 3017 returning = do_return(eap, FALSE, TRUE, &rettv); 3018 else 3019 clear_tv(&rettv); 3020 } 3021 /* It's safer to return also on error. */ 3022 else if (!eap->skip) 3023 { 3024 /* In return statement, cause_abort should be force_abort. */ 3025 update_force_abort(); 3026 3027 /* 3028 * Return unless the expression evaluation has been cancelled due to an 3029 * aborting error, an interrupt, or an exception. 3030 */ 3031 if (!aborting()) 3032 returning = do_return(eap, FALSE, TRUE, NULL); 3033 } 3034 3035 /* When skipping or the return gets pending, advance to the next command 3036 * in this line (!returning). Otherwise, ignore the rest of the line. 3037 * Following lines will be ignored by get_func_line(). */ 3038 if (returning) 3039 eap->nextcmd = NULL; 3040 else if (eap->nextcmd == NULL) /* no argument */ 3041 eap->nextcmd = check_nextcmd(arg); 3042 3043 if (eap->skip) 3044 --emsg_skip; 3045 } 3046 3047 /* 3048 * ":1,25call func(arg1, arg2)" function call. 3049 */ 3050 void 3051 ex_call(exarg_T *eap) 3052 { 3053 char_u *arg = eap->arg; 3054 char_u *startarg; 3055 char_u *name; 3056 char_u *tofree; 3057 int len; 3058 typval_T rettv; 3059 linenr_T lnum; 3060 int doesrange; 3061 int failed = FALSE; 3062 funcdict_T fudi; 3063 partial_T *partial = NULL; 3064 3065 if (eap->skip) 3066 { 3067 /* trans_function_name() doesn't work well when skipping, use eval0() 3068 * instead to skip to any following command, e.g. for: 3069 * :if 0 | call dict.foo().bar() | endif */ 3070 ++emsg_skip; 3071 if (eval0(eap->arg, &rettv, &eap->nextcmd, FALSE) != FAIL) 3072 clear_tv(&rettv); 3073 --emsg_skip; 3074 return; 3075 } 3076 3077 tofree = trans_function_name(&arg, eap->skip, TFN_INT, &fudi, &partial); 3078 if (fudi.fd_newkey != NULL) 3079 { 3080 /* Still need to give an error message for missing key. */ 3081 semsg(_(e_dictkey), fudi.fd_newkey); 3082 vim_free(fudi.fd_newkey); 3083 } 3084 if (tofree == NULL) 3085 return; 3086 3087 /* Increase refcount on dictionary, it could get deleted when evaluating 3088 * the arguments. */ 3089 if (fudi.fd_dict != NULL) 3090 ++fudi.fd_dict->dv_refcount; 3091 3092 /* If it is the name of a variable of type VAR_FUNC or VAR_PARTIAL use its 3093 * contents. For VAR_PARTIAL get its partial, unless we already have one 3094 * from trans_function_name(). */ 3095 len = (int)STRLEN(tofree); 3096 name = deref_func_name(tofree, &len, 3097 partial != NULL ? NULL : &partial, FALSE); 3098 3099 /* Skip white space to allow ":call func ()". Not good, but required for 3100 * backward compatibility. */ 3101 startarg = skipwhite(arg); 3102 rettv.v_type = VAR_UNKNOWN; /* clear_tv() uses this */ 3103 3104 if (*startarg != '(') 3105 { 3106 semsg(_(e_missingparen), eap->arg); 3107 goto end; 3108 } 3109 3110 /* 3111 * When skipping, evaluate the function once, to find the end of the 3112 * arguments. 3113 * When the function takes a range, this is discovered after the first 3114 * call, and the loop is broken. 3115 */ 3116 if (eap->skip) 3117 { 3118 ++emsg_skip; 3119 lnum = eap->line2; /* do it once, also with an invalid range */ 3120 } 3121 else 3122 lnum = eap->line1; 3123 for ( ; lnum <= eap->line2; ++lnum) 3124 { 3125 funcexe_T funcexe; 3126 3127 if (!eap->skip && eap->addr_count > 0) 3128 { 3129 if (lnum > curbuf->b_ml.ml_line_count) 3130 { 3131 // If the function deleted lines or switched to another buffer 3132 // the line number may become invalid. 3133 emsg(_(e_invrange)); 3134 break; 3135 } 3136 curwin->w_cursor.lnum = lnum; 3137 curwin->w_cursor.col = 0; 3138 curwin->w_cursor.coladd = 0; 3139 } 3140 arg = startarg; 3141 3142 vim_memset(&funcexe, 0, sizeof(funcexe)); 3143 funcexe.firstline = eap->line1; 3144 funcexe.lastline = eap->line2; 3145 funcexe.doesrange = &doesrange; 3146 funcexe.evaluate = !eap->skip; 3147 funcexe.partial = partial; 3148 funcexe.selfdict = fudi.fd_dict; 3149 if (get_func_tv(name, -1, &rettv, &arg, &funcexe) == FAIL) 3150 { 3151 failed = TRUE; 3152 break; 3153 } 3154 if (has_watchexpr()) 3155 dbg_check_breakpoint(eap); 3156 3157 // Handle a function returning a Funcref, Dictionary or List. 3158 if (handle_subscript(&arg, &rettv, !eap->skip, TRUE, 3159 name, &name) == FAIL) 3160 { 3161 failed = TRUE; 3162 break; 3163 } 3164 3165 clear_tv(&rettv); 3166 if (doesrange || eap->skip) 3167 break; 3168 3169 /* Stop when immediately aborting on error, or when an interrupt 3170 * occurred or an exception was thrown but not caught. 3171 * get_func_tv() returned OK, so that the check for trailing 3172 * characters below is executed. */ 3173 if (aborting()) 3174 break; 3175 } 3176 if (eap->skip) 3177 --emsg_skip; 3178 3179 if (!failed) 3180 { 3181 /* Check for trailing illegal characters and a following command. */ 3182 if (!ends_excmd(*arg)) 3183 { 3184 emsg_severe = TRUE; 3185 emsg(_(e_trailing)); 3186 } 3187 else 3188 eap->nextcmd = check_nextcmd(arg); 3189 } 3190 3191 end: 3192 dict_unref(fudi.fd_dict); 3193 vim_free(tofree); 3194 } 3195 3196 /* 3197 * Return from a function. Possibly makes the return pending. Also called 3198 * for a pending return at the ":endtry" or after returning from an extra 3199 * do_cmdline(). "reanimate" is used in the latter case. "is_cmd" is set 3200 * when called due to a ":return" command. "rettv" may point to a typval_T 3201 * with the return rettv. Returns TRUE when the return can be carried out, 3202 * FALSE when the return gets pending. 3203 */ 3204 int 3205 do_return( 3206 exarg_T *eap, 3207 int reanimate, 3208 int is_cmd, 3209 void *rettv) 3210 { 3211 int idx; 3212 struct condstack *cstack = eap->cstack; 3213 3214 if (reanimate) 3215 /* Undo the return. */ 3216 current_funccal->returned = FALSE; 3217 3218 /* 3219 * Cleanup (and inactivate) conditionals, but stop when a try conditional 3220 * not in its finally clause (which then is to be executed next) is found. 3221 * In this case, make the ":return" pending for execution at the ":endtry". 3222 * Otherwise, return normally. 3223 */ 3224 idx = cleanup_conditionals(eap->cstack, 0, TRUE); 3225 if (idx >= 0) 3226 { 3227 cstack->cs_pending[idx] = CSTP_RETURN; 3228 3229 if (!is_cmd && !reanimate) 3230 /* A pending return again gets pending. "rettv" points to an 3231 * allocated variable with the rettv of the original ":return"'s 3232 * argument if present or is NULL else. */ 3233 cstack->cs_rettv[idx] = rettv; 3234 else 3235 { 3236 /* When undoing a return in order to make it pending, get the stored 3237 * return rettv. */ 3238 if (reanimate) 3239 rettv = current_funccal->rettv; 3240 3241 if (rettv != NULL) 3242 { 3243 /* Store the value of the pending return. */ 3244 if ((cstack->cs_rettv[idx] = alloc_tv()) != NULL) 3245 *(typval_T *)cstack->cs_rettv[idx] = *(typval_T *)rettv; 3246 else 3247 emsg(_(e_outofmem)); 3248 } 3249 else 3250 cstack->cs_rettv[idx] = NULL; 3251 3252 if (reanimate) 3253 { 3254 /* The pending return value could be overwritten by a ":return" 3255 * without argument in a finally clause; reset the default 3256 * return value. */ 3257 current_funccal->rettv->v_type = VAR_NUMBER; 3258 current_funccal->rettv->vval.v_number = 0; 3259 } 3260 } 3261 report_make_pending(CSTP_RETURN, rettv); 3262 } 3263 else 3264 { 3265 current_funccal->returned = TRUE; 3266 3267 /* If the return is carried out now, store the return value. For 3268 * a return immediately after reanimation, the value is already 3269 * there. */ 3270 if (!reanimate && rettv != NULL) 3271 { 3272 clear_tv(current_funccal->rettv); 3273 *current_funccal->rettv = *(typval_T *)rettv; 3274 if (!is_cmd) 3275 vim_free(rettv); 3276 } 3277 } 3278 3279 return idx < 0; 3280 } 3281 3282 /* 3283 * Free the variable with a pending return value. 3284 */ 3285 void 3286 discard_pending_return(void *rettv) 3287 { 3288 free_tv((typval_T *)rettv); 3289 } 3290 3291 /* 3292 * Generate a return command for producing the value of "rettv". The result 3293 * is an allocated string. Used by report_pending() for verbose messages. 3294 */ 3295 char_u * 3296 get_return_cmd(void *rettv) 3297 { 3298 char_u *s = NULL; 3299 char_u *tofree = NULL; 3300 char_u numbuf[NUMBUFLEN]; 3301 3302 if (rettv != NULL) 3303 s = echo_string((typval_T *)rettv, &tofree, numbuf, 0); 3304 if (s == NULL) 3305 s = (char_u *)""; 3306 3307 STRCPY(IObuff, ":return "); 3308 STRNCPY(IObuff + 8, s, IOSIZE - 8); 3309 if (STRLEN(s) + 8 >= IOSIZE) 3310 STRCPY(IObuff + IOSIZE - 4, "..."); 3311 vim_free(tofree); 3312 return vim_strsave(IObuff); 3313 } 3314 3315 /* 3316 * Get next function line. 3317 * Called by do_cmdline() to get the next line. 3318 * Returns allocated string, or NULL for end of function. 3319 */ 3320 char_u * 3321 get_func_line( 3322 int c UNUSED, 3323 void *cookie, 3324 int indent UNUSED, 3325 int do_concat UNUSED) 3326 { 3327 funccall_T *fcp = (funccall_T *)cookie; 3328 ufunc_T *fp = fcp->func; 3329 char_u *retval; 3330 garray_T *gap; /* growarray with function lines */ 3331 3332 /* If breakpoints have been added/deleted need to check for it. */ 3333 if (fcp->dbg_tick != debug_tick) 3334 { 3335 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 3336 sourcing_lnum); 3337 fcp->dbg_tick = debug_tick; 3338 } 3339 #ifdef FEAT_PROFILE 3340 if (do_profiling == PROF_YES) 3341 func_line_end(cookie); 3342 #endif 3343 3344 gap = &fp->uf_lines; 3345 if (((fp->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 3346 || fcp->returned) 3347 retval = NULL; 3348 else 3349 { 3350 /* Skip NULL lines (continuation lines). */ 3351 while (fcp->linenr < gap->ga_len 3352 && ((char_u **)(gap->ga_data))[fcp->linenr] == NULL) 3353 ++fcp->linenr; 3354 if (fcp->linenr >= gap->ga_len) 3355 retval = NULL; 3356 else 3357 { 3358 retval = vim_strsave(((char_u **)(gap->ga_data))[fcp->linenr++]); 3359 sourcing_lnum = fcp->linenr; 3360 #ifdef FEAT_PROFILE 3361 if (do_profiling == PROF_YES) 3362 func_line_start(cookie); 3363 #endif 3364 } 3365 } 3366 3367 /* Did we encounter a breakpoint? */ 3368 if (fcp->breakpoint != 0 && fcp->breakpoint <= sourcing_lnum) 3369 { 3370 dbg_breakpoint(fp->uf_name, sourcing_lnum); 3371 /* Find next breakpoint. */ 3372 fcp->breakpoint = dbg_find_breakpoint(FALSE, fp->uf_name, 3373 sourcing_lnum); 3374 fcp->dbg_tick = debug_tick; 3375 } 3376 3377 return retval; 3378 } 3379 3380 /* 3381 * Return TRUE if the currently active function should be ended, because a 3382 * return was encountered or an error occurred. Used inside a ":while". 3383 */ 3384 int 3385 func_has_ended(void *cookie) 3386 { 3387 funccall_T *fcp = (funccall_T *)cookie; 3388 3389 /* Ignore the "abort" flag if the abortion behavior has been changed due to 3390 * an error inside a try conditional. */ 3391 return (((fcp->func->uf_flags & FC_ABORT) && did_emsg && !aborted_in_try()) 3392 || fcp->returned); 3393 } 3394 3395 /* 3396 * return TRUE if cookie indicates a function which "abort"s on errors. 3397 */ 3398 int 3399 func_has_abort( 3400 void *cookie) 3401 { 3402 return ((funccall_T *)cookie)->func->uf_flags & FC_ABORT; 3403 } 3404 3405 3406 /* 3407 * Turn "dict.Func" into a partial for "Func" bound to "dict". 3408 * Don't do this when "Func" is already a partial that was bound 3409 * explicitly (pt_auto is FALSE). 3410 * Changes "rettv" in-place. 3411 * Returns the updated "selfdict_in". 3412 */ 3413 dict_T * 3414 make_partial(dict_T *selfdict_in, typval_T *rettv) 3415 { 3416 char_u *fname; 3417 char_u *tofree = NULL; 3418 ufunc_T *fp; 3419 char_u fname_buf[FLEN_FIXED + 1]; 3420 int error; 3421 dict_T *selfdict = selfdict_in; 3422 3423 if (rettv->v_type == VAR_PARTIAL && rettv->vval.v_partial->pt_func != NULL) 3424 fp = rettv->vval.v_partial->pt_func; 3425 else 3426 { 3427 fname = rettv->v_type == VAR_FUNC ? rettv->vval.v_string 3428 : rettv->vval.v_partial->pt_name; 3429 /* Translate "s:func" to the stored function name. */ 3430 fname = fname_trans_sid(fname, fname_buf, &tofree, &error); 3431 fp = find_func(fname); 3432 vim_free(tofree); 3433 } 3434 3435 if (fp != NULL && (fp->uf_flags & FC_DICT)) 3436 { 3437 partial_T *pt = ALLOC_CLEAR_ONE(partial_T); 3438 3439 if (pt != NULL) 3440 { 3441 pt->pt_refcount = 1; 3442 pt->pt_dict = selfdict; 3443 pt->pt_auto = TRUE; 3444 selfdict = NULL; 3445 if (rettv->v_type == VAR_FUNC) 3446 { 3447 /* Just a function: Take over the function name and use 3448 * selfdict. */ 3449 pt->pt_name = rettv->vval.v_string; 3450 } 3451 else 3452 { 3453 partial_T *ret_pt = rettv->vval.v_partial; 3454 int i; 3455 3456 /* Partial: copy the function name, use selfdict and copy 3457 * args. Can't take over name or args, the partial might 3458 * be referenced elsewhere. */ 3459 if (ret_pt->pt_name != NULL) 3460 { 3461 pt->pt_name = vim_strsave(ret_pt->pt_name); 3462 func_ref(pt->pt_name); 3463 } 3464 else 3465 { 3466 pt->pt_func = ret_pt->pt_func; 3467 func_ptr_ref(pt->pt_func); 3468 } 3469 if (ret_pt->pt_argc > 0) 3470 { 3471 pt->pt_argv = ALLOC_MULT(typval_T, ret_pt->pt_argc); 3472 if (pt->pt_argv == NULL) 3473 /* out of memory: drop the arguments */ 3474 pt->pt_argc = 0; 3475 else 3476 { 3477 pt->pt_argc = ret_pt->pt_argc; 3478 for (i = 0; i < pt->pt_argc; i++) 3479 copy_tv(&ret_pt->pt_argv[i], &pt->pt_argv[i]); 3480 } 3481 } 3482 partial_unref(ret_pt); 3483 } 3484 rettv->v_type = VAR_PARTIAL; 3485 rettv->vval.v_partial = pt; 3486 } 3487 } 3488 return selfdict; 3489 } 3490 3491 /* 3492 * Return the name of the executed function. 3493 */ 3494 char_u * 3495 func_name(void *cookie) 3496 { 3497 return ((funccall_T *)cookie)->func->uf_name; 3498 } 3499 3500 /* 3501 * Return the address holding the next breakpoint line for a funccall cookie. 3502 */ 3503 linenr_T * 3504 func_breakpoint(void *cookie) 3505 { 3506 return &((funccall_T *)cookie)->breakpoint; 3507 } 3508 3509 /* 3510 * Return the address holding the debug tick for a funccall cookie. 3511 */ 3512 int * 3513 func_dbg_tick(void *cookie) 3514 { 3515 return &((funccall_T *)cookie)->dbg_tick; 3516 } 3517 3518 /* 3519 * Return the nesting level for a funccall cookie. 3520 */ 3521 int 3522 func_level(void *cookie) 3523 { 3524 return ((funccall_T *)cookie)->level; 3525 } 3526 3527 /* 3528 * Return TRUE when a function was ended by a ":return" command. 3529 */ 3530 int 3531 current_func_returned(void) 3532 { 3533 return current_funccal->returned; 3534 } 3535 3536 int 3537 free_unref_funccal(int copyID, int testing) 3538 { 3539 int did_free = FALSE; 3540 int did_free_funccal = FALSE; 3541 funccall_T *fc, **pfc; 3542 3543 for (pfc = &previous_funccal; *pfc != NULL; ) 3544 { 3545 if (can_free_funccal(*pfc, copyID)) 3546 { 3547 fc = *pfc; 3548 *pfc = fc->caller; 3549 free_funccal_contents(fc); 3550 did_free = TRUE; 3551 did_free_funccal = TRUE; 3552 } 3553 else 3554 pfc = &(*pfc)->caller; 3555 } 3556 if (did_free_funccal) 3557 /* When a funccal was freed some more items might be garbage 3558 * collected, so run again. */ 3559 (void)garbage_collect(testing); 3560 3561 return did_free; 3562 } 3563 3564 /* 3565 * Get function call environment based on backtrace debug level 3566 */ 3567 static funccall_T * 3568 get_funccal(void) 3569 { 3570 int i; 3571 funccall_T *funccal; 3572 funccall_T *temp_funccal; 3573 3574 funccal = current_funccal; 3575 if (debug_backtrace_level > 0) 3576 { 3577 for (i = 0; i < debug_backtrace_level; i++) 3578 { 3579 temp_funccal = funccal->caller; 3580 if (temp_funccal) 3581 funccal = temp_funccal; 3582 else 3583 /* backtrace level overflow. reset to max */ 3584 debug_backtrace_level = i; 3585 } 3586 } 3587 return funccal; 3588 } 3589 3590 /* 3591 * Return the hashtable used for local variables in the current funccal. 3592 * Return NULL if there is no current funccal. 3593 */ 3594 hashtab_T * 3595 get_funccal_local_ht() 3596 { 3597 if (current_funccal == NULL) 3598 return NULL; 3599 return &get_funccal()->l_vars.dv_hashtab; 3600 } 3601 3602 /* 3603 * Return the l: scope variable. 3604 * Return NULL if there is no current funccal. 3605 */ 3606 dictitem_T * 3607 get_funccal_local_var() 3608 { 3609 if (current_funccal == NULL) 3610 return NULL; 3611 return &get_funccal()->l_vars_var; 3612 } 3613 3614 /* 3615 * Return the hashtable used for argument in the current funccal. 3616 * Return NULL if there is no current funccal. 3617 */ 3618 hashtab_T * 3619 get_funccal_args_ht() 3620 { 3621 if (current_funccal == NULL) 3622 return NULL; 3623 return &get_funccal()->l_avars.dv_hashtab; 3624 } 3625 3626 /* 3627 * Return the a: scope variable. 3628 * Return NULL if there is no current funccal. 3629 */ 3630 dictitem_T * 3631 get_funccal_args_var() 3632 { 3633 if (current_funccal == NULL) 3634 return NULL; 3635 return &get_funccal()->l_avars_var; 3636 } 3637 3638 /* 3639 * List function variables, if there is a function. 3640 */ 3641 void 3642 list_func_vars(int *first) 3643 { 3644 if (current_funccal != NULL) 3645 list_hashtable_vars(¤t_funccal->l_vars.dv_hashtab, 3646 "l:", FALSE, first); 3647 } 3648 3649 /* 3650 * If "ht" is the hashtable for local variables in the current funccal, return 3651 * the dict that contains it. 3652 * Otherwise return NULL. 3653 */ 3654 dict_T * 3655 get_current_funccal_dict(hashtab_T *ht) 3656 { 3657 if (current_funccal != NULL 3658 && ht == ¤t_funccal->l_vars.dv_hashtab) 3659 return ¤t_funccal->l_vars; 3660 return NULL; 3661 } 3662 3663 /* 3664 * Search hashitem in parent scope. 3665 */ 3666 hashitem_T * 3667 find_hi_in_scoped_ht(char_u *name, hashtab_T **pht) 3668 { 3669 funccall_T *old_current_funccal = current_funccal; 3670 hashtab_T *ht; 3671 hashitem_T *hi = NULL; 3672 char_u *varname; 3673 3674 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 3675 return NULL; 3676 3677 /* Search in parent scope which is possible to reference from lambda */ 3678 current_funccal = current_funccal->func->uf_scoped; 3679 while (current_funccal != NULL) 3680 { 3681 ht = find_var_ht(name, &varname); 3682 if (ht != NULL && *varname != NUL) 3683 { 3684 hi = hash_find(ht, varname); 3685 if (!HASHITEM_EMPTY(hi)) 3686 { 3687 *pht = ht; 3688 break; 3689 } 3690 } 3691 if (current_funccal == current_funccal->func->uf_scoped) 3692 break; 3693 current_funccal = current_funccal->func->uf_scoped; 3694 } 3695 current_funccal = old_current_funccal; 3696 3697 return hi; 3698 } 3699 3700 /* 3701 * Search variable in parent scope. 3702 */ 3703 dictitem_T * 3704 find_var_in_scoped_ht(char_u *name, int no_autoload) 3705 { 3706 dictitem_T *v = NULL; 3707 funccall_T *old_current_funccal = current_funccal; 3708 hashtab_T *ht; 3709 char_u *varname; 3710 3711 if (current_funccal == NULL || current_funccal->func->uf_scoped == NULL) 3712 return NULL; 3713 3714 /* Search in parent scope which is possible to reference from lambda */ 3715 current_funccal = current_funccal->func->uf_scoped; 3716 while (current_funccal) 3717 { 3718 ht = find_var_ht(name, &varname); 3719 if (ht != NULL && *varname != NUL) 3720 { 3721 v = find_var_in_ht(ht, *name, varname, no_autoload); 3722 if (v != NULL) 3723 break; 3724 } 3725 if (current_funccal == current_funccal->func->uf_scoped) 3726 break; 3727 current_funccal = current_funccal->func->uf_scoped; 3728 } 3729 current_funccal = old_current_funccal; 3730 3731 return v; 3732 } 3733 3734 /* 3735 * Set "copyID + 1" in previous_funccal and callers. 3736 */ 3737 int 3738 set_ref_in_previous_funccal(int copyID) 3739 { 3740 int abort = FALSE; 3741 funccall_T *fc; 3742 3743 for (fc = previous_funccal; !abort && fc != NULL; fc = fc->caller) 3744 { 3745 fc->fc_copyID = copyID + 1; 3746 abort = abort 3747 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID + 1, NULL) 3748 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID + 1, NULL) 3749 || set_ref_in_list_items(&fc->l_varlist, copyID + 1, NULL); 3750 } 3751 return abort; 3752 } 3753 3754 static int 3755 set_ref_in_funccal(funccall_T *fc, int copyID) 3756 { 3757 int abort = FALSE; 3758 3759 if (fc->fc_copyID != copyID) 3760 { 3761 fc->fc_copyID = copyID; 3762 abort = abort 3763 || set_ref_in_ht(&fc->l_vars.dv_hashtab, copyID, NULL) 3764 || set_ref_in_ht(&fc->l_avars.dv_hashtab, copyID, NULL) 3765 || set_ref_in_list_items(&fc->l_varlist, copyID, NULL) 3766 || set_ref_in_func(NULL, fc->func, copyID); 3767 } 3768 return abort; 3769 } 3770 3771 /* 3772 * Set "copyID" in all local vars and arguments in the call stack. 3773 */ 3774 int 3775 set_ref_in_call_stack(int copyID) 3776 { 3777 int abort = FALSE; 3778 funccall_T *fc; 3779 funccal_entry_T *entry; 3780 3781 for (fc = current_funccal; !abort && fc != NULL; fc = fc->caller) 3782 abort = abort || set_ref_in_funccal(fc, copyID); 3783 3784 // Also go through the funccal_stack. 3785 for (entry = funccal_stack; !abort && entry != NULL; entry = entry->next) 3786 for (fc = entry->top_funccal; !abort && fc != NULL; fc = fc->caller) 3787 abort = abort || set_ref_in_funccal(fc, copyID); 3788 3789 return abort; 3790 } 3791 3792 /* 3793 * Set "copyID" in all functions available by name. 3794 */ 3795 int 3796 set_ref_in_functions(int copyID) 3797 { 3798 int todo; 3799 hashitem_T *hi = NULL; 3800 int abort = FALSE; 3801 ufunc_T *fp; 3802 3803 todo = (int)func_hashtab.ht_used; 3804 for (hi = func_hashtab.ht_array; todo > 0 && !got_int; ++hi) 3805 { 3806 if (!HASHITEM_EMPTY(hi)) 3807 { 3808 --todo; 3809 fp = HI2UF(hi); 3810 if (!func_name_refcount(fp->uf_name)) 3811 abort = abort || set_ref_in_func(NULL, fp, copyID); 3812 } 3813 } 3814 return abort; 3815 } 3816 3817 /* 3818 * Set "copyID" in all function arguments. 3819 */ 3820 int 3821 set_ref_in_func_args(int copyID) 3822 { 3823 int i; 3824 int abort = FALSE; 3825 3826 for (i = 0; i < funcargs.ga_len; ++i) 3827 abort = abort || set_ref_in_item(((typval_T **)funcargs.ga_data)[i], 3828 copyID, NULL, NULL); 3829 return abort; 3830 } 3831 3832 /* 3833 * Mark all lists and dicts referenced through function "name" with "copyID". 3834 * Returns TRUE if setting references failed somehow. 3835 */ 3836 int 3837 set_ref_in_func(char_u *name, ufunc_T *fp_in, int copyID) 3838 { 3839 ufunc_T *fp = fp_in; 3840 funccall_T *fc; 3841 int error = ERROR_NONE; 3842 char_u fname_buf[FLEN_FIXED + 1]; 3843 char_u *tofree = NULL; 3844 char_u *fname; 3845 int abort = FALSE; 3846 3847 if (name == NULL && fp_in == NULL) 3848 return FALSE; 3849 3850 if (fp_in == NULL) 3851 { 3852 fname = fname_trans_sid(name, fname_buf, &tofree, &error); 3853 fp = find_func(fname); 3854 } 3855 if (fp != NULL) 3856 { 3857 for (fc = fp->uf_scoped; fc != NULL; fc = fc->func->uf_scoped) 3858 abort = abort || set_ref_in_funccal(fc, copyID); 3859 } 3860 vim_free(tofree); 3861 return abort; 3862 } 3863 3864 #endif /* FEAT_EVAL */ 3865