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