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