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