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