Parameters.xs

   1 /*
   2 Copyright 2012 Lukas Mai.
   3
   4 This program is free software; you can redistribute it and/or modify it
   5 under the terms of either: the GNU General Public License as published
   6 by the Free Software Foundation; or the Artistic License.
   7
   8 See http://dev.perl.org/licenses/ for more information.
   9  */
  10
  11 #ifdef __GNUC__
  12  #if (__GNUC__ == 4 && __GNUC_MINOR__ >= 6) || __GNUC__ >= 5
  13   #define PRAGMA_GCC_(X) _Pragma(#X)
  14   #define PRAGMA_GCC(X) PRAGMA_GCC_(GCC X)
  15  #endif
  16 #endif
  17
  18 #ifndef PRAGMA_GCC
  19  #define PRAGMA_GCC(X)
  20 #endif
  21
  22 #ifdef DEVEL
  23  #define WARNINGS_RESET PRAGMA_GCC(diagnostic pop)
  24  #define WARNINGS_ENABLEW(X) PRAGMA_GCC(diagnostic warning #X)
  25  #define WARNINGS_ENABLE \
  26         WARNINGS_ENABLEW(-Wall) \
  27         WARNINGS_ENABLEW(-Wextra) \
  28         WARNINGS_ENABLEW(-Wundef) \
  29         /* WARNINGS_ENABLEW(-Wshadow) :-( */ \
  30         WARNINGS_ENABLEW(-Wbad-function-cast) \
  31         WARNINGS_ENABLEW(-Wcast-align) \
  32         WARNINGS_ENABLEW(-Wwrite-strings) \
  33         /* WARNINGS_ENABLEW(-Wnested-externs) wtf? */ \
  34         WARNINGS_ENABLEW(-Wstrict-prototypes) \
  35         WARNINGS_ENABLEW(-Wmissing-prototypes) \
  36         WARNINGS_ENABLEW(-Winline) \
  37         WARNINGS_ENABLEW(-Wdisabled-optimization)
  38
  39 #else
  40  #define WARNINGS_RESET
  41  #define WARNINGS_ENABLE
  42 #endif
  43
  44
  45 #define PERL_NO_GET_CONTEXT
  46 #include "EXTERN.h"
  47 #include "perl.h"
  48 #include "XSUB.h"
  49
  50 #include <string.h>
  51
  52
  53 WARNINGS_ENABLE
  54
  55
  56 #define HAVE_PERL_VERSION(R, V, S) \
  57         (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  58
  59 #if HAVE_PERL_VERSION(5, 16, 0)
  60  #define IF_HAVE_PERL_5_16(YES, NO) YES
  61 #else
  62  #define IF_HAVE_PERL_5_16(YES, NO) NO
  63 #endif
  64
  65 #if 0
  66  #if HAVE_PERL_VERSION(5, 17, 6)
  67   #error "internal error: missing definition of KEY_my (your perl is too new)"
  68  #elif HAVE_PERL_VERSION(5, 15, 8)
  69   #define S_KEY_my 134
  70  #elif HAVE_PERL_VERSION(5, 15, 6)
  71   #define S_KEY_my 133
  72  #elif HAVE_PERL_VERSION(5, 15, 5)
  73   #define S_KEY_my 132
  74  #elif HAVE_PERL_VERSION(5, 13, 0)
  75   #define S_KEY_my 131
  76  #else
  77   #error "internal error: missing definition of KEY_my (your perl is too old)"
  78  #endif
  79 #endif
  80
  81
  82 #define MY_PKG "Function::Parameters"
  83
  84 #define HINTK_KEYWORDS MY_PKG "/keywords"
  85 #define HINTK_FLAGS_   MY_PKG "/flags:"
  86 #define HINTK_SHIFT_   MY_PKG "/shift:"
  87 #define HINTK_ATTRS_   MY_PKG "/attrs:"
  88
  89 #define DEFSTRUCT(T) typedef struct T T; struct T
  90
  91 #define UV_BITS (sizeof (UV) * CHAR_BIT)
  92
  93 enum {
  94         FLAG_NAME_OK      = 0x01,
  95         FLAG_ANON_OK      = 0x02,
  96         FLAG_DEFAULT_ARGS = 0x04,
  97         FLAG_CHECK_NARGS  = 0x08,
  98         FLAG_INVOCANT     = 0x10,
  99         FLAG_NAMED_PARAMS = 0x20
 100 };
 101
 102 DEFSTRUCT(KWSpec) {
 103         unsigned flags;
 104         SV *shift;
 105         SV *attrs;
 106 };
 107
 108 static int (*next_keyword_plugin)(pTHX_ char *, STRLEN, OP **);
 109
 110 DEFSTRUCT(Resource) {
 111         Resource *next;
 112         void *data;
 113         void (*destroy)(pTHX_ void *);
 114 };
 115
 116 typedef Resource *Sentinel[1];
 117
 118 static void sentinel_clear_void(pTHX_ void *p) {
 119         Resource **pp = p;
 120         while (*pp) {
 121                 Resource *cur = *pp;
 122                 cur->destroy(aTHX_ cur->data);
 123                 cur->data = (void *)"no";
 124                 cur->destroy = NULL;
 125                 *pp = cur->next;
 126                 Safefree(cur);
 127         }
 128 }
 129
 130 static void sentinel_register(Sentinel sen, void *data, void (*destroy)(pTHX_ void *)) {
 131         Resource *cur;
 132
 133         Newx(cur, 1, Resource);
 134         cur->data = data;
 135         cur->destroy = destroy;
 136         cur->next = *sen;
 137         *sen = cur;
 138 }
 139
 140 static void my_sv_refcnt_dec_void(pTHX_ void *p) {
 141         SV *sv = p;
 142         SvREFCNT_dec(sv);
 143 }
 144
 145 static SV *sentinel_mortalize(Sentinel sen, SV *sv) {
 146         sentinel_register(sen, sv, my_sv_refcnt_dec_void);
 147         return sv;
 148 }
 149
 150 static void my_safefree(void *p) {
 151         Safefree(p);
 152 }
 153
 154 #define SENTINEL_ALLOC(SEN, P, N, T) STMT_START { \
 155         Newx(P, N, T); \
 156         sentinel_register(SEN, P, my_safefree); \
 157 } STMT_END
 158
 159 #define SENTINEL_MDUP(SEN, P, O, N, T) STMT_START { \
 160         void *const _sentinel_mdup_tmp_ = (P); \
 161         SENTINEL_ALLOC(SEN, P, N, T); \
 162         memcpy(P, _sentinel_mdup_tmp_, O * sizeof (T)); \
 163 } STMT_END
 164
 165 #define SENTINEL_REALLOC(SEN, P, N, T) STMT_START { \
 166         assert((N) > 0); \
 167         if (!(P)) { \
 168                 SENTINEL_ALLOC(SEN, P, N, T); \
 169         } else { \
 170                 Resource **_sentinel_realloc_tmp_ = (SEN); \
 171                 for (;;) { \
 172                         assert(*_sentinel_realloc_tmp_ != NULL); \
 173                         if ((*_sentinel_realloc_tmp_)->data == (P)) { \
 174                                 Renew((*_sentinel_realloc_tmp_)->data, N, T); \
 175                                 (P) = (*_sentinel_realloc_tmp_)->data; \
 176                                 break; \
 177                         } \
 178                         _sentinel_realloc_tmp_ = &(*_sentinel_realloc_tmp_)->next; \
 179                 } \
 180         } \
 181 } STMT_END
 182
 183 static int kw_flags(pTHX_ Sentinel sen, const char *kw_ptr, STRLEN kw_len, KWSpec *spec) {
 184         HV *hints;
 185         SV *sv, **psv;
 186         const char *p, *kw_active;
 187         STRLEN kw_active_len;
 188
 189         spec->flags = 0;
 190         spec->shift = sentinel_mortalize(sen, newSVpvs(""));
 191         spec->attrs = sentinel_mortalize(sen, newSVpvs(""));
 192
 193         if (!(hints = GvHV(PL_hintgv))) {
 194                 return FALSE;
 195         }
 196         if (!(psv = hv_fetchs(hints, HINTK_KEYWORDS, 0))) {
 197                 return FALSE;
 198         }
 199         sv = *psv;
 200         kw_active = SvPV(sv, kw_active_len);
 201         if (kw_active_len <= kw_len) {
 202                 return FALSE;
 203         }
 204         for (
 205                 p = kw_active;
 206                 (p = strchr(p, *kw_ptr)) &&
 207                 p < kw_active + kw_active_len - kw_len;
 208                 p++
 209         ) {
 210                 if (
 211                         (p == kw_active || p[-1] == ' ') &&
 212                         p[kw_len] == ' ' &&
 213                         memcmp(kw_ptr, p, kw_len) == 0
 214                 ) {
 215
 216 #define FETCH_HINTK_INTO(NAME, PTR, LEN, X) STMT_START { \
 217         const char *fk_ptr_; \
 218         STRLEN fk_len_; \
 219         SV *fk_sv_; \
 220         fk_sv_ = sentinel_mortalize(sen, newSVpvs(HINTK_ ## NAME)); \
 221         sv_catpvn(fk_sv_, PTR, LEN); \
 222         fk_ptr_ = SvPV(fk_sv_, fk_len_); \
 223         if (!((X) = hv_fetch(hints, fk_ptr_, fk_len_, 0))) { \
 224                 croak("%s: internal error: $^H{'%.*s'} not set", MY_PKG, (int)fk_len_, fk_ptr_); \
 225         } \
 226 } STMT_END
 227
 228                         FETCH_HINTK_INTO(FLAGS_, kw_ptr, kw_len, psv);
 229                         spec->flags = SvIV(*psv);
 230
 231                         FETCH_HINTK_INTO(SHIFT_, kw_ptr, kw_len, psv);
 232                         SvSetSV(spec->shift, *psv);
 233
 234                         FETCH_HINTK_INTO(ATTRS_, kw_ptr, kw_len, psv);
 235                         SvSetSV(spec->attrs, *psv);
 236
 237 #undef FETCH_HINTK_INTO
 238                         return TRUE;
 239                 }
 240         }
 241         return FALSE;
 242 }
 243
 244
 245 static void free_ptr_op(pTHX_ void *vp) {
 246         OP **pp = vp;
 247         op_free(*pp);
 248         Safefree(pp);
 249 }
 250
 251 #define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
 252
 253 static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
 254         STRLEN sv_len;
 255         const char *sv_p = SvPV(sv, sv_len);
 256         return memcmp(sv_p, p, n) == 0;
 257 }
 258
 259
 260 #include "padop_on_crack.c.inc"
 261
 262
 263 enum {
 264         MY_ATTR_LVALUE = 0x01,
 265         MY_ATTR_METHOD = 0x02,
 266         MY_ATTR_SPECIAL = 0x04
 267 };
 268
 269 static void my_sv_cat_c(pTHX_ SV *sv, U32 c) {
 270         char ds[UTF8_MAXBYTES + 1], *d;
 271         d = uvchr_to_utf8(ds, c);
 272         if (d - ds > 1) {
 273                 sv_utf8_upgrade(sv);
 274         }
 275         sv_catpvn(sv, ds, d - ds);
 276 }
 277
 278 static bool my_is_uni_xidfirst(pTHX_ UV c) {
 279         U8 tmpbuf[UTF8_MAXBYTES + 1];
 280         uvchr_to_utf8(tmpbuf, c);
 281         return is_utf8_xidfirst(tmpbuf);
 282 }
 283
 284 static bool my_is_uni_xidcont(pTHX_ UV c) {
 285         U8 tmpbuf[UTF8_MAXBYTES + 1];
 286         uvchr_to_utf8(tmpbuf, c);
 287         return is_utf8_xidcont(tmpbuf);
 288 }
 289
 290 static SV *my_scan_word(pTHX_ Sentinel sen, bool allow_package) {
 291         bool at_start, at_substart;
 292         I32 c;
 293         SV *sv = sentinel_mortalize(sen, newSVpvs(""));
 294         if (lex_bufutf8()) {
 295                 SvUTF8_on(sv);
 296         }
 297
 298         at_start = at_substart = TRUE;
 299         c = lex_peek_unichar(0);
 300
 301         while (c != -1) {
 302                 if (at_substart ? my_is_uni_xidfirst(aTHX_ c) : my_is_uni_xidcont(aTHX_ c)) {
 303                         lex_read_unichar(0);
 304                         my_sv_cat_c(aTHX_ sv, c);
 305                         at_substart = FALSE;
 306                         c = lex_peek_unichar(0);
 307                 } else if (allow_package && !at_substart && c == '\'') {
 308                         lex_read_unichar(0);
 309                         c = lex_peek_unichar(0);
 310                         if (!my_is_uni_xidfirst(aTHX_ c)) {
 311                                 lex_stuff_pvs("'", 0);
 312                                 break;
 313                         }
 314                         sv_catpvs(sv, "'");
 315                         at_substart = TRUE;
 316                 } else if (allow_package && (at_start || !at_substart) && c == ':') {
 317                         lex_read_unichar(0);
 318                         if (lex_peek_unichar(0) != ':') {
 319                                 lex_stuff_pvs(":", 0);
 320                                 break;
 321                         }
 322                         lex_read_unichar(0);
 323                         c = lex_peek_unichar(0);
 324                         if (!my_is_uni_xidfirst(aTHX_ c)) {
 325                                 lex_stuff_pvs("::", 0);
 326                                 break;
 327                         }
 328                         sv_catpvs(sv, "::");
 329                         at_substart = TRUE;
 330                 } else {
 331                         break;
 332                 }
 333                 at_start = FALSE;
 334         }
 335
 336         return SvCUR(sv) ? sv : NULL;
 337 }
 338
 339 static SV *my_scan_parens_tail(pTHX_ Sentinel sen, bool keep_backslash) {
 340         I32 c, nesting;
 341         SV *sv;
 342         line_t start;
 343
 344         start = CopLINE(PL_curcop);
 345
 346         sv = sentinel_mortalize(sen, newSVpvs(""));
 347         if (lex_bufutf8()) {
 348                 SvUTF8_on(sv);
 349         }
 350
 351         nesting = 0;
 352         for (;;) {
 353                 c = lex_read_unichar(0);
 354                 if (c == EOF) {
 355                         CopLINE_set(PL_curcop, start);
 356                         return NULL;
 357                 }
 358
 359                 if (c == '\\') {
 360                         c = lex_read_unichar(0);
 361                         if (c == EOF) {
 362                                 CopLINE_set(PL_curcop, start);
 363                                 return NULL;
 364                         }
 365                         if (keep_backslash || (c != '(' && c != ')')) {
 366                                 sv_catpvs(sv, "\\");
 367                         }
 368                 } else if (c == '(') {
 369                         nesting++;
 370                 } else if (c == ')') {
 371                         if (!nesting) {
 372                                 break;
 373                         }
 374                         nesting--;
 375                 }
 376
 377                 my_sv_cat_c(aTHX_ sv, c);
 378         }
 379
 380         return sv;
 381 }
 382
 383 static void my_check_prototype(pTHX_ Sentinel sen, const SV *declarator, SV *proto) {
 384         char *start, *r, *w, *end;
 385         STRLEN len;
 386
 387         /* strip spaces */
 388         start = SvPV(proto, len);
 389         end = start + len;
 390
 391         for (w = r = start; r < end; r++) {
 392                 if (!isSPACE(*r)) {
 393                         *w++ = *r;
 394                 }
 395         }
 396         *w = '\0';
 397         SvCUR_set(proto, w - start);
 398         end = w;
 399         len = end - start;
 400
 401         if (!ckWARN(WARN_ILLEGALPROTO)) {
 402                 return;
 403         }
 404
 405         /* check for bad characters */
 406         if (strspn(start, "$@%*;[]&\\_+") != len) {
 407                 SV *dsv = sentinel_mortalize(sen, newSVpvs(""));
 408                 warner(
 409                         packWARN(WARN_ILLEGALPROTO),
 410                         "Illegal character in prototype for %"SVf" : %s",
 411                         SVfARG(declarator),
 412                         SvUTF8(proto)
 413                                 ? sv_uni_display(
 414                                         dsv,
 415                                         proto,
 416                                         len,
 417                                         UNI_DISPLAY_ISPRINT
 418                                 )
 419                                 : pv_pretty(dsv, start, len, 60, NULL, NULL,
 420                                         PERL_PV_ESCAPE_NONASCII
 421                                 )
 422                 );
 423                 return;
 424         }
 425
 426         for (r = start; r < end; r++) {
 427                 switch (*r) {
 428                         default:
 429                                 warner(
 430                                         packWARN(WARN_ILLEGALPROTO),
 431                                         "Illegal character in prototype for %"SVf" : %s",
 432                                         SVfARG(declarator), r
 433                                 );
 434                                 return;
 435
 436                         case '_':
 437                                 if (r[1] && !strchr(";@%", *r)) {
 438                                         warner(
 439                                                 packWARN(WARN_ILLEGALPROTO),
 440                                                 "Illegal character after '_' in prototype for %"SVf" : %s",
 441                                                 SVfARG(declarator), r
 442                                         );
 443                                         return;
 444                                 }
 445                                 break;
 446
 447                         case '@':
 448                         case '%':
 449                                 if (r[1]) {
 450                                         warner(
 451                                                 packWARN(WARN_ILLEGALPROTO),
 452                                                 "prototype after '%c' for %"SVf": %s",
 453                                                 *r, SVfARG(declarator), r + 1
 454                                         );
 455                                         return;
 456                                 }
 457                                 break;
 458
 459                         case '\\':
 460                                 r++;
 461                                 if (strchr("$@%&*", *r)) {
 462                                         break;
 463                                 }
 464                                 if (*r == '[') {
 465                                         r++;
 466                                         for (; r < end && *r != ']'; r++) {
 467                                                 if (!strchr("$@%&*", *r)) {
 468                                                         break;
 469                                                 }
 470                                         }
 471                                         if (*r == ']' && r[-1] != '[') {
 472                                                 break;
 473                                         }
 474                                 }
 475                                 warner(
 476                                         packWARN(WARN_ILLEGALPROTO),
 477                                         "Illegal character after '\\' in prototype for %"SVf" : %s",
 478                                         SVfARG(declarator), r
 479                                 );
 480                                 return;
 481
 482                         case '$':
 483                         case '*':
 484                         case '&':
 485                         case ';':
 486                         case '+':
 487                                 break;
 488                 }
 489         }
 490 }
 491
 492
 493 DEFSTRUCT(Param) {
 494         SV *name;
 495         PADOFFSET padoff;
 496 };
 497
 498 DEFSTRUCT(ParamInit) {
 499         Param param;
 500         OP *init;
 501 };
 502
 503 #define VEC(B) B ## _Vec
 504
 505 #define DEFVECTOR(B) DEFSTRUCT(VEC(B)) { \
 506         B (*data); \
 507         size_t used, size; \
 508 }
 509
 510 DEFVECTOR(Param);
 511 DEFVECTOR(ParamInit);
 512
 513 #define DEFVECTOR_INIT(N, B) static void N(VEC(B) *p) { \
 514         p->used = 0; \
 515         p->size = 23; \
 516         Newx(p->data, p->size, B); \
 517 } static void N(VEC(B) *)
 518
 519 DEFSTRUCT(ParamSpec) {
 520         Param invocant;
 521         VEC(Param) positional_required;
 522         VEC(ParamInit) positional_optional;
 523         VEC(Param) named_required;
 524         VEC(ParamInit) named_optional;
 525         Param slurpy;
 526         PADOFFSET rest_hash;
 527 };
 528
 529 DEFVECTOR_INIT(pv_init, Param);
 530 DEFVECTOR_INIT(piv_init, ParamInit);
 531
 532 static void p_init(Param *p) {
 533         p->name = NULL;
 534         p->padoff = NOT_IN_PAD;
 535 }
 536
 537 static void ps_init(ParamSpec *ps) {
 538         p_init(&ps->invocant);
 539         pv_init(&ps->positional_required);
 540         piv_init(&ps->positional_optional);
 541         pv_init(&ps->named_required);
 542         piv_init(&ps->named_optional);
 543         p_init(&ps->slurpy);
 544         ps->rest_hash = NOT_IN_PAD;
 545 }
 546
 547 #define DEFVECTOR_EXTEND(N, B) static B (*N(VEC(B) *p)) { \
 548         assert(p->used <= p->size); \
 549         if (p->used == p->size) { \
 550                 const size_t n = p->size / 2 * 3 + 1; \
 551                 Renew(p->data, n, B); \
 552                 p->size = n; \
 553         } \
 554         return &p->data[p->used]; \
 555 } static B (*N(VEC(B) *))
 556
 557 DEFVECTOR_EXTEND(pv_extend, Param);
 558 DEFVECTOR_EXTEND(piv_extend, ParamInit);
 559
 560 #define DEFVECTOR_CLEAR(N, B, F) static void N(pTHX_ VEC(B) *p) { \
 561         while (p->used) { \
 562                 p->used--; \
 563                 F(aTHX_ &p->data[p->used]); \
 564         } \
 565         Safefree(p->data); \
 566         p->data = NULL; \
 567         p->size = 0; \
 568 } static void N(pTHX_ VEC(B) *)
 569
 570 static void p_clear(pTHX_ Param *p) {
 571         p->name = NULL;
 572         p->padoff = NOT_IN_PAD;
 573 }
 574
 575 static void pi_clear(pTHX_ ParamInit *pi) {
 576         p_clear(aTHX_ &pi->param);
 577         if (pi->init) {
 578                 op_free(pi->init);
 579                 pi->init = NULL;
 580         }
 581 }
 582
 583 DEFVECTOR_CLEAR(pv_clear, Param, p_clear);
 584 DEFVECTOR_CLEAR(piv_clear, ParamInit, pi_clear);
 585
 586 static void ps_clear(pTHX_ ParamSpec *ps) {
 587         p_clear(aTHX_ &ps->invocant);
 588
 589         pv_clear(aTHX_ &ps->positional_required);
 590         piv_clear(aTHX_ &ps->positional_optional);
 591
 592         pv_clear(aTHX_ &ps->named_required);
 593         piv_clear(aTHX_ &ps->named_optional);
 594
 595         p_clear(aTHX_ &ps->slurpy);
 596 }
 597
 598 static int ps_contains(pTHX_ const ParamSpec *ps, SV *sv) {
 599         size_t i, lim;
 600
 601         if (ps->invocant.name && sv_eq(sv, ps->invocant.name)) {
 602                 return 1;
 603         }
 604
 605         for (i = 0, lim = ps->positional_required.used; i < lim; i++) {
 606                 if (sv_eq(sv, ps->positional_required.data[i].name)) {
 607                         return 1;
 608                 }
 609         }
 610
 611         for (i = 0, lim = ps->positional_optional.used; i < lim; i++) {
 612                 if (sv_eq(sv, ps->positional_optional.data[i].param.name)) {
 613                         return 1;
 614                 }
 615         }
 616
 617         for (i = 0, lim = ps->named_required.used; i < lim; i++) {
 618                 if (sv_eq(sv, ps->named_required.data[i].name)) {
 619                         return 1;
 620                 }
 621         }
 622
 623         for (i = 0, lim = ps->named_optional.used; i < lim; i++) {
 624                 if (sv_eq(sv, ps->named_optional.data[i].param.name)) {
 625                         return 1;
 626                 }
 627         }
 628
 629         return 0;
 630 }
 631
 632 static void ps_free_void(pTHX_ void *p) {
 633         ps_clear(aTHX_ p);
 634         Safefree(p);
 635 }
 636
 637 static int args_min(pTHX_ const ParamSpec *ps, const KWSpec *ks) {
 638         int n = 0;
 639         if (!ps) {
 640                 return SvTRUE(ks->shift) ? 1 : 0;
 641         }
 642         if (ps->invocant.name) {
 643                 n++;
 644         }
 645         n += ps->positional_required.used;
 646         n += ps->named_required.used * 2;
 647         return n;
 648 }
 649
 650 static int args_max(const ParamSpec *ps) {
 651         int n = 0;
 652         if (!ps) {
 653                 return -1;
 654         }
 655         if (ps->invocant.name) {
 656                 n++;
 657         }
 658         n += ps->positional_required.used;
 659         n += ps->positional_optional.used;
 660         if (ps->named_required.used || ps->named_optional.used || ps->slurpy.name) {
 661                 n = -1;
 662         }
 663         return n;
 664 }
 665
 666 static size_t count_positional_params(const ParamSpec *ps) {
 667         return ps->positional_required.used + ps->positional_optional.used;
 668 }
 669
 670 static size_t count_named_params(const ParamSpec *ps) {
 671         return ps->named_required.used + ps->named_optional.used;
 672 }
 673
 674 enum {
 675         PARAM_INVOCANT = 0x01,
 676         PARAM_NAMED    = 0x02
 677 };
 678
 679 /* *pinit must be NULL on entry.
 680  * caller must free *pinit on error.
 681  */
 682 static PADOFFSET parse_param(
 683         pTHX_
 684         Sentinel sen,
 685         const SV *declarator, const KWSpec *spec, ParamSpec *param_spec,
 686         int *pflags, SV **pname, OP **pinit
 687 ) {
 688         I32 c;
 689         char sigil;
 690         SV *name;
 691
 692         assert(!*pinit);
 693         *pflags = 0;
 694
 695         c = lex_peek_unichar(0);
 696
 697         if (c == ':') {
 698                 lex_read_unichar(0);
 699                 lex_read_space(0);
 700
 701                 *pflags |= PARAM_NAMED;
 702
 703                 c = lex_peek_unichar(0);
 704         }
 705
 706         if (c == -1) {
 707                 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
 708         }
 709         if (!(c == '$' || c == '@' || c == '%')) {
 710                 croak("In %"SVf": unexpected '%c' in parameter list (expecting a sigil)", SVfARG(declarator), (int)c);
 711         }
 712
 713         sigil = c;
 714
 715         lex_read_unichar(0);
 716         lex_read_space(0);
 717
 718         if (!(name = my_scan_word(aTHX_ sen, FALSE))) {
 719                 croak("In %"SVf": missing identifier after '%c'", SVfARG(declarator), sigil);
 720         }
 721         sv_insert(name, 0, 0, &sigil, 1);
 722         *pname = name;
 723
 724         lex_read_space(0);
 725         c = lex_peek_unichar(0);
 726
 727         if (c == '=') {
 728                 lex_read_unichar(0);
 729                 lex_read_space(0);
 730
 731
 732                 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
 733                         param_spec->invocant.name = spec->shift;
 734                         param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
 735                 }
 736
 737                 *pinit = parse_termexpr(0);
 738
 739                 lex_read_space(0);
 740                 c = lex_peek_unichar(0);
 741         }
 742
 743         if (c == ':') {
 744                 *pflags |= PARAM_INVOCANT;
 745                 lex_read_unichar(0);
 746                 lex_read_space(0);
 747         } else if (c == ',') {
 748                 lex_read_unichar(0);
 749                 lex_read_space(0);
 750         } else if (c != ')') {
 751                 if (c == -1) {
 752                         croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
 753                 }
 754                 croak("In %"SVf": unexpected '%c' in parameter list (expecting ',')", SVfARG(declarator), (int)c);
 755         }
 756
 757         return pad_add_name_sv(*pname, IF_HAVE_PERL_5_16(padadd_NO_DUP_CHECK, 0), NULL, NULL);
 758 }
 759
 760 static OP *my_var_g(pTHX_ I32 type, I32 flags, PADOFFSET padoff) {
 761         OP *var = newOP(type, flags);
 762         var->op_targ = padoff;
 763         return var;
 764 }
 765
 766 static OP *my_var(pTHX_ I32 flags, PADOFFSET padoff) {
 767         return my_var_g(aTHX_ OP_PADSV, flags, padoff);
 768 }
 769
 770 static OP *mkhvelem(pTHX_ PADOFFSET h, OP *k) {
 771         OP *hv = my_var_g(aTHX_ OP_PADHV, OPf_REF, h);
 772         return newBINOP(OP_HELEM, 0, hv, k);
 773 }
 774
 775 static OP *mkconstsv(pTHX_ SV *sv) {
 776         return newSVOP(OP_CONST, 0, sv);
 777 }
 778
 779 static OP *mkconstiv(pTHX_ IV i) {
 780         return mkconstsv(aTHX_ newSViv(i));
 781 }
 782
 783 static OP *mkconstpv(pTHX_ const char *p, size_t n) {
 784         return mkconstsv(aTHX_ newSVpv(p, n));
 785 }
 786
 787 #define mkconstpvs(S) mkconstpv(aTHX_ "" S "", sizeof S - 1)
 788
 789 static void register_info(pTHX_ UV key, SV *declarator, const KWSpec *kws, const ParamSpec *ps) {
 790         dSP;
 791
 792         ENTER;
 793         SAVETMPS;
 794
 795         PUSHMARK(SP);
 796         EXTEND(SP, 8);
 797
 798         /* 0 */ {
 799                 mPUSHu(key);
 800         }
 801         /* 1 */ {
 802                 size_t n;
 803                 char *p = SvPV(declarator, n);
 804                 char *q = memchr(p, ' ', n);
 805                 mPUSHp(p, q ? q - p : n);
 806         }
 807         if (!ps) {
 808                 if (SvTRUE(kws->shift)) {
 809                         PUSHs(kws->shift);
 810                 } else {
 811                         PUSHmortal;
 812                 }
 813                 mPUSHs(newRV_noinc((SV *)newAV()));
 814                 mPUSHs(newRV_noinc((SV *)newAV()));
 815                 mPUSHs(newRV_noinc((SV *)newAV()));
 816                 mPUSHs(newRV_noinc((SV *)newAV()));
 817                 mPUSHp("@_", 2);
 818         } else {
 819                 /* 2 */ {
 820                         if (ps->invocant.name) {
 821                                 PUSHs(ps->invocant.name);
 822                         } else {
 823                                 PUSHmortal;
 824                         }
 825                 }
 826                 /* 3 */ {
 827                         size_t i, lim;
 828                         AV *av;
 829
 830                         lim = ps->positional_required.used;
 831
 832                         av = newAV();
 833                         if (lim) {
 834                                 av_extend(av, lim - 1);
 835                                 for (i = 0; i < lim; i++) {
 836                                         av_push(av, SvREFCNT_inc_simple_NN(ps->positional_required.data[i].name));
 837                                 }
 838                         }
 839
 840                         mPUSHs(newRV_noinc((SV *)av));
 841                 }
 842                 /* 4 */ {
 843                         size_t i, lim;
 844                         AV *av;
 845
 846                         lim = ps->positional_optional.used;
 847
 848                         av = newAV();
 849                         if (lim) {
 850                                 av_extend(av, lim - 1);
 851                                 for (i = 0; i < lim; i++) {
 852                                         av_push(av, SvREFCNT_inc_simple_NN(ps->positional_optional.data[i].param.name));
 853                                 }
 854                         }
 855
 856                         mPUSHs(newRV_noinc((SV *)av));
 857                 }
 858                 /* 5 */ {
 859                         size_t i, lim;
 860                         AV *av;
 861
 862                         lim = ps->named_required.used;
 863
 864                         av = newAV();
 865                         if (lim) {
 866                                 av_extend(av, lim - 1);
 867                                 for (i = 0; i < lim; i++) {
 868                                         av_push(av, SvREFCNT_inc_simple_NN(ps->named_required.data[i].name));
 869                                 }
 870                         }
 871
 872                         mPUSHs(newRV_noinc((SV *)av));
 873                 }
 874                 /* 6 */ {
 875                         size_t i, lim;
 876                         AV *av;
 877
 878                         lim = ps->named_optional.used;
 879
 880                         av = newAV();
 881                         if (lim) {
 882                                 av_extend(av, lim - 1);
 883                                 for (i = 0; i < lim; i++) {
 884                                         av_push(av, SvREFCNT_inc_simple_NN(ps->named_optional.data[i].param.name));
 885                                 }
 886                         }
 887
 888                         mPUSHs(newRV_noinc((SV *)av));
 889                 }
 890                 /* 7 */ {
 891                         if (ps->slurpy.name) {
 892                                 PUSHs(ps->slurpy.name);
 893                         } else {
 894                                 PUSHmortal;
 895                         }
 896                 }
 897         }
 898         PUTBACK;
 899
 900         call_pv(MY_PKG "::_register_info", G_VOID);
 901
 902         FREETMPS;
 903         LEAVE;
 904 }
 905
 906 static int parse_fun(pTHX_ Sentinel sen, OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
 907         ParamSpec *param_spec;
 908         SV *declarator;
 909         I32 floor_ix;
 910         int save_ix;
 911         SV *saw_name;
 912         OP **prelude_sentinel;
 913         SV *proto;
 914         OP **attrs_sentinel, *body;
 915         unsigned builtin_attrs;
 916         I32 c;
 917
 918         declarator = sentinel_mortalize(sen, newSVpvn(keyword_ptr, keyword_len));
 919
 920         lex_read_space(0);
 921
 922         builtin_attrs = 0;
 923
 924         /* function name */
 925         saw_name = NULL;
 926         if ((spec->flags & FLAG_NAME_OK) && (saw_name = my_scan_word(aTHX_ sen, TRUE))) {
 927
 928                 if (PL_parser->expect != XSTATE) {
 929                         /* bail out early so we don't predeclare $saw_name */
 930                         croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
 931                 }
 932
 933                 sv_catpvs(declarator, " ");
 934                 sv_catsv(declarator, saw_name);
 935
 936                 if (
 937                         sv_eq_pvs(saw_name, "BEGIN") ||
 938                         sv_eq_pvs(saw_name, "END") ||
 939                         sv_eq_pvs(saw_name, "INIT") ||
 940                         sv_eq_pvs(saw_name, "CHECK") ||
 941                         sv_eq_pvs(saw_name, "UNITCHECK")
 942                 ) {
 943                         builtin_attrs |= MY_ATTR_SPECIAL;
 944                 }
 945
 946                 lex_read_space(0);
 947         } else if (!(spec->flags & FLAG_ANON_OK)) {
 948                 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - PL_parser->bufptr), PL_parser->bufptr);
 949         } else {
 950                 sv_catpvs(declarator, " (anon)");
 951         }
 952
 953         /* we're a subroutine declaration */
 954         floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
 955         SAVEFREESV(PL_compcv);
 956
 957         /* create outer block: '{' */
 958         save_ix = S_block_start(aTHX_ TRUE);
 959
 960         /* initialize synthetic optree */
 961         Newx(prelude_sentinel, 1, OP *);
 962         *prelude_sentinel = NULL;
 963         sentinel_register(sen, prelude_sentinel, free_ptr_op);
 964
 965         /* parameters */
 966         param_spec = NULL;
 967
 968         c = lex_peek_unichar(0);
 969         if (c == '(') {
 970                 OP **init_sentinel;
 971
 972                 Newx(init_sentinel, 1, OP *);
 973                 *init_sentinel = NULL;
 974                 sentinel_register(sen, init_sentinel, free_ptr_op);
 975
 976                 Newx(param_spec, 1, ParamSpec);
 977                 ps_init(param_spec);
 978                 sentinel_register(sen, param_spec, ps_free_void);
 979
 980                 lex_read_unichar(0);
 981                 lex_read_space(0);
 982
 983                 while ((c = lex_peek_unichar(0)) != ')') {
 984                         int flags;
 985                         SV *name;
 986                         char sigil;
 987                         PADOFFSET padoff;
 988
 989                         padoff = parse_param(aTHX_ sen, declarator, spec, param_spec, &flags, &name, init_sentinel);
 990
 991                         S_intro_my(aTHX);
 992
 993                         sigil = SvPV_nolen(name)[0];
 994
 995                         /* internal consistency */
 996                         if (flags & PARAM_NAMED) {
 997                                 if (flags & PARAM_INVOCANT) {
 998                                         croak("In %"SVf": invocant %"SVf" can't be a named parameter", SVfARG(declarator), SVfARG(name));
 999                                 }
1000                                 if (sigil != '$') {
1001                                         croak("In %"SVf": named parameter %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
1002                                 }
1003                         } else if (flags & PARAM_INVOCANT) {
1004                                 if (*init_sentinel) {
1005                                         croak("In %"SVf": invocant %"SVf" can't have a default value", SVfARG(declarator), SVfARG(name));
1006                                 }
1007                                 if (sigil != '$') {
1008                                         croak("In %"SVf": invocant %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
1009                                 }
1010                         } else if (sigil != '$' && *init_sentinel) {
1011                                 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(name));
1012                         }
1013
1014                         /* external constraints */
1015                         if (param_spec->slurpy.name) {
1016                                 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(param_spec->slurpy.name), SVfARG(name));
1017                         }
1018                         if (sigil != '$') {
1019                                 assert(!*init_sentinel);
1020                                 param_spec->slurpy.name = name;
1021                                 param_spec->slurpy.padoff = padoff;
1022                                 continue;
1023                         }
1024
1025                         if (!(flags & PARAM_NAMED) && count_named_params(param_spec)) {
1026                                 croak("In %"SVf": positional parameter %"SVf" can't appear after named parameter %"SVf"", SVfARG(declarator), SVfARG(name), SVfARG((param_spec->named_required.used ? param_spec->named_required.data[0] : param_spec->named_optional.data[0].param).name));
1027                         }
1028
1029                         if (flags & PARAM_INVOCANT) {
1030                                 if (param_spec->invocant.name) {
1031                                         croak("In %"SVf": invalid double invocants %"SVf", %"SVf"", SVfARG(declarator), SVfARG(param_spec->invocant.name), SVfARG(name));
1032                                 }
1033                                 if (count_positional_params(param_spec) || count_named_params(param_spec)) {
1034                                         croak("In %"SVf": invocant %"SVf" must be first in parameter list", SVfARG(declarator), SVfARG(name));
1035                                 }
1036                                 if (!(spec->flags & FLAG_INVOCANT)) {
1037                                         croak("In %"SVf": invocant %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
1038                                 }
1039                                 param_spec->invocant.name = name;
1040                                 param_spec->invocant.padoff = padoff;
1041                                 continue;
1042                         }
1043
1044                         if (*init_sentinel && !(spec->flags & FLAG_DEFAULT_ARGS)) {
1045                                 croak("In %"SVf": default argument for %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
1046                         }
1047
1048                         if (ps_contains(aTHX_ param_spec, name)) {
1049                                 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(name));
1050                         }
1051
1052                         if (flags & PARAM_NAMED) {
1053                                 if (!(spec->flags & FLAG_NAMED_PARAMS)) {
1054                                         croak("In %"SVf": named parameter :%"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
1055                                 }
1056
1057                                 if (*init_sentinel) {
1058                                         ParamInit *pi = piv_extend(&param_spec->named_optional);
1059                                         pi->param.name = name;
1060                                         pi->param.padoff = padoff;
1061                                         pi->init = *init_sentinel;
1062                                         *init_sentinel = NULL;
1063                                         param_spec->named_optional.used++;
1064                                 } else {
1065                                         if (param_spec->positional_optional.used) {
1066                                                 croak("In %"SVf": can't combine optional positional (%"SVf") and required named (%"SVf") parameters", SVfARG(declarator), SVfARG(param_spec->positional_optional.data[0].param.name), SVfARG(name));
1067                                         }
1068
1069                                         Param *p = pv_extend(&param_spec->named_required);
1070                                         p->name = name;
1071                                         p->padoff = padoff;
1072                                         param_spec->named_required.used++;
1073                                 }
1074                         } else {
1075                                 if (*init_sentinel || param_spec->positional_optional.used) {
1076                                         ParamInit *pi = piv_extend(&param_spec->positional_optional);
1077                                         pi->param.name = name;
1078                                         pi->param.padoff = padoff;
1079                                         pi->init = *init_sentinel;
1080                                         *init_sentinel = NULL;
1081                                         param_spec->positional_optional.used++;
1082                                 } else {
1083                                         Param *p = pv_extend(&param_spec->positional_required);
1084                                         p->name = name;
1085                                         p->padoff = padoff;
1086                                         param_spec->positional_required.used++;
1087                                 }
1088                         }
1089
1090                 }
1091                 lex_read_unichar(0);
1092                 lex_read_space(0);
1093                 *init_sentinel = NULL;
1094
1095                 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
1096                         if (ps_contains(aTHX_ param_spec, spec->shift)) {
1097                                 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(spec->shift));
1098                         }
1099
1100                         param_spec->invocant.name = spec->shift;
1101                         param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
1102                 }
1103         }
1104
1105         /* prototype */
1106         proto = NULL;
1107         c = lex_peek_unichar(0);
1108         if (c == ':') {
1109                 lex_read_unichar(0);
1110                 lex_read_space(0);
1111
1112                 c = lex_peek_unichar(0);
1113                 if (c != '(') {
1114                         lex_stuff_pvs(":", 0);
1115                         c = ':';
1116                 } else {
1117                         lex_read_unichar(0);
1118                         if (!(proto = my_scan_parens_tail(aTHX_ sen, FALSE))) {
1119                                 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
1120                         }
1121                         my_check_prototype(aTHX_ sen, declarator, proto);
1122                         lex_read_space(0);
1123                         c = lex_peek_unichar(0);
1124                         if (!(c == ':' || c == '{')) {
1125                                 lex_stuff_pvs(":", 0);
1126                                 c = ':';
1127                         }
1128                 }
1129         }
1130
1131         /* attributes */
1132         Newx(attrs_sentinel, 1, OP *);
1133         *attrs_sentinel = NULL;
1134         sentinel_register(sen, attrs_sentinel, free_ptr_op);
1135
1136         if (c == ':' || c == '{') /* '}' - hi, vim */ {
1137
1138                 /* kludge default attributes in */
1139                 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
1140                         lex_stuff_sv(spec->attrs, 0);
1141                         c = ':';
1142                 }
1143
1144                 if (c == ':') {
1145                         lex_read_unichar(0);
1146                         lex_read_space(0);
1147                         c = lex_peek_unichar(0);
1148
1149                         for (;;) {
1150                                 SV *attr;
1151
1152                                 if (!(attr = my_scan_word(aTHX_ sen, FALSE))) {
1153                                         break;
1154                                 }
1155
1156                                 lex_read_space(0);
1157                                 c = lex_peek_unichar(0);
1158
1159                                 if (c != '(') {
1160                                         if (sv_eq_pvs(attr, "lvalue")) {
1161                                                 builtin_attrs |= MY_ATTR_LVALUE;
1162                                                 attr = NULL;
1163                                         } else if (sv_eq_pvs(attr, "method")) {
1164                                                 builtin_attrs |= MY_ATTR_METHOD;
1165                                                 attr = NULL;
1166                                         }
1167                                 } else {
1168                                         SV *sv;
1169                                         lex_read_unichar(0);
1170                                         if (!(sv = my_scan_parens_tail(aTHX_ sen, TRUE))) {
1171                                                 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
1172                                         }
1173                                         sv_catpvs(attr, "(");
1174                                         sv_catsv(attr, sv);
1175                                         sv_catpvs(attr, ")");
1176
1177                                         lex_read_space(0);
1178                                         c = lex_peek_unichar(0);
1179                                 }
1180
1181                                 if (attr) {
1182                                         *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(attr)));
1183                                 }
1184
1185                                 if (c == ':') {
1186                                         lex_read_unichar(0);
1187                                         lex_read_space(0);
1188                                         c = lex_peek_unichar(0);
1189                                 }
1190                         }
1191                 }
1192         }
1193
1194         /* body */
1195         if (c != '{') /* '}' - hi, vim */ {
1196                 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
1197         }
1198
1199         /* surprise predeclaration! */
1200         if (saw_name) {
1201                 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
1202                    starts parsing the body */
1203                 const I32 sub_ix = start_subparse(FALSE, 0);
1204                 SAVEFREESV(PL_compcv);
1205
1206                 SvREFCNT_inc_simple_void(PL_compcv);
1207
1208                 newATTRSUB(
1209                         sub_ix,
1210                         mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(saw_name)),
1211                         proto ? mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(proto)) : NULL,
1212                         NULL,
1213                         NULL
1214                 );
1215         }
1216
1217         if (builtin_attrs & MY_ATTR_LVALUE) {
1218                 CvLVALUE_on(PL_compcv);
1219         }
1220         if (builtin_attrs & MY_ATTR_METHOD) {
1221                 CvMETHOD_on(PL_compcv);
1222         }
1223         if (builtin_attrs & MY_ATTR_SPECIAL) {
1224                 CvSPECIAL_on(PL_compcv);
1225         }
1226
1227         /* check number of arguments */
1228         if (spec->flags & FLAG_CHECK_NARGS) {
1229                 int amin, amax;
1230                 size_t named;
1231
1232                 amin = args_min(aTHX_ param_spec, spec);
1233                 if (amin > 0) {
1234                         OP *chk, *cond, *err, *croak;
1235
1236                         err = mkconstsv(aTHX_ newSVpvf("Not enough arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amin));
1237                         err = newBINOP(
1238                                 OP_CONCAT, 0,
1239                                 err,
1240                                 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1241                         );
1242                         err = newBINOP(
1243                                 OP_CONCAT, 0,
1244                                 err,
1245                                 mkconstpvs(")")
1246                         );
1247
1248                         croak = newCVREF(OPf_WANT_SCALAR,
1249                                          newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1250                         err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1251                                       op_append_elem(OP_LIST, err, croak));
1252
1253                         cond = newBINOP(OP_LT, 0,
1254                                         newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1255                                         mkconstiv(aTHX_ amin));
1256                         chk = newLOGOP(OP_AND, 0, cond, err);
1257
1258                         *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1259                 }
1260
1261                 amax = args_max(param_spec);
1262                 if (amax >= 0) {
1263                         OP *chk, *cond, *err, *croak;
1264
1265                         err = mkconstsv(aTHX_ newSVpvf("Too many arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amax));
1266                         err = newBINOP(
1267                                 OP_CONCAT, 0,
1268                                 err,
1269                                 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1270                         );
1271                         err = newBINOP(
1272                                 OP_CONCAT, 0,
1273                                 err,
1274                                 mkconstpvs(")")
1275                         );
1276
1277                         croak = newCVREF(
1278                                 OPf_WANT_SCALAR,
1279                                 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1280                         );
1281                         err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1282                         op_append_elem(OP_LIST, err, croak));
1283
1284                         cond = newBINOP(
1285                                 OP_GT, 0,
1286                                 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1287                                 mkconstiv(aTHX_ amax)
1288                         );
1289                         chk = newLOGOP(OP_AND, 0, cond, err);
1290
1291                         *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1292                 }
1293
1294                 if (param_spec && (count_named_params(param_spec) || (param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%'))) {
1295                         OP *chk, *cond, *err, *croak;
1296                         const UV fixed = count_positional_params(param_spec) + !!param_spec->invocant.name;
1297
1298                         err = mkconstsv(aTHX_ newSVpvf("Odd number of paired arguments for %"SVf"", SVfARG(declarator)));
1299
1300                         croak = newCVREF(
1301                                 OPf_WANT_SCALAR,
1302                                 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1303                         );
1304                         err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1305                         op_append_elem(OP_LIST, err, croak));
1306
1307                         cond = newBINOP(OP_GT, 0,
1308                                         newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1309                                         mkconstiv(aTHX_ fixed));
1310                         cond = newLOGOP(OP_AND, 0,
1311                                         cond,
1312                                         newBINOP(OP_MODULO, 0,
1313                                                  fixed
1314                                                  ? newBINOP(OP_SUBTRACT, 0,
1315                                                             newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1316                                                             mkconstiv(aTHX_ fixed))
1317                                                  : newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1318                                                  mkconstiv(aTHX_ 2)));
1319                         chk = newLOGOP(OP_AND, 0, cond, err);
1320
1321                         *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1322                 }
1323         }
1324
1325         if (!param_spec) {
1326                 /* my $invocant = shift; */
1327                 if (SvTRUE(spec->shift)) {
1328                         OP *var;
1329
1330                         var = my_var(
1331                                 aTHX_
1332                                 OPf_MOD | (OPpLVAL_INTRO << 8),
1333                                 pad_add_name_sv(spec->shift, 0, NULL, NULL)
1334                         );
1335                         var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1336
1337                         *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1338                 }
1339         } else {
1340                 /* my $invocant = shift; */
1341                 if (param_spec->invocant.name) {
1342                         OP *var;
1343
1344                         var = my_var(
1345                                 aTHX_
1346                                 OPf_MOD | (OPpLVAL_INTRO << 8),
1347                                 param_spec->invocant.padoff
1348                         );
1349                         var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1350
1351                         *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1352                 }
1353
1354                 /* my (...) = @_; */
1355                 {
1356                         OP *lhs;
1357                         size_t i, lim;
1358
1359                         lhs = NULL;
1360
1361                         for (i = 0, lim = param_spec->positional_required.used; i < lim; i++) {
1362                                 OP *const var = my_var(
1363                                         aTHX_
1364                                         OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1365                                         param_spec->positional_required.data[i].padoff
1366                                 );
1367                                 lhs = op_append_elem(OP_LIST, lhs, var);
1368                         }
1369
1370                         for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1371                                 OP *const var = my_var(
1372                                         aTHX_
1373                                         OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1374                                         param_spec->positional_optional.data[i].param.padoff
1375                                 );
1376                                 lhs = op_append_elem(OP_LIST, lhs, var);
1377                         }
1378
1379                         {
1380                                 PADOFFSET padoff;
1381                                 I32 type;
1382                                 bool slurpy_hash;
1383
1384                                 /*
1385                                  * cases:
1386                                  *  1) no named params
1387                                  *   1.1) slurpy
1388                                  *       => put it in
1389                                  *   1.2) no slurpy
1390                                  *       => nop
1391                                  *  2) named params
1392                                  *   2.1) no slurpy
1393                                  *       => synthetic %{rest}
1394                                  *   2.2) slurpy is a hash
1395                                  *       => put it in
1396                                  *   2.3) slurpy is an array
1397                                  *       => synthetic %{rest}
1398                                  *          remember to declare array later
1399                                  */
1400
1401                                 slurpy_hash = param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%';
1402                                 if (!count_named_params(param_spec)) {
1403                                         if (param_spec->slurpy.name) {
1404                                                 padoff = param_spec->slurpy.padoff;
1405                                                 type = slurpy_hash ? OP_PADHV : OP_PADAV;
1406                                         } else {
1407                                                 padoff = NOT_IN_PAD;
1408                                                 type = OP_PADSV;
1409                                         }
1410                                 } else if (slurpy_hash) {
1411                                         padoff = param_spec->slurpy.padoff;
1412                                         type = OP_PADHV;
1413                                 } else {
1414                                         padoff = param_spec->rest_hash = pad_add_name_pvs("%{rest}", 0, NULL, NULL);
1415                                         type = OP_PADHV;
1416                                 }
1417
1418                                 if (padoff != NOT_IN_PAD) {
1419                                         OP *const var = my_var_g(
1420                                                 aTHX_
1421                                                 type,
1422                                                 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1423                                                 padoff
1424                                         );
1425
1426                                         lhs = op_append_elem(OP_LIST, lhs, var);
1427
1428                                         if (type == OP_PADHV) {
1429                                                 param_spec->rest_hash = padoff;
1430                                         }
1431                                 }
1432                         }
1433
1434                         if (lhs) {
1435                                 OP *rhs;
1436                                 lhs->op_flags |= OPf_PARENS;
1437                                 rhs = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
1438
1439                                 *prelude_sentinel = op_append_list(
1440                                         OP_LINESEQ, *prelude_sentinel,
1441                                         newSTATEOP(
1442                                                 0, NULL,
1443                                                 newASSIGNOP(OPf_STACKED, lhs, 0, rhs)
1444                                         )
1445                                 );
1446                         }
1447                 }
1448
1449                 /* default positional arguments */
1450                 {
1451                         size_t i, lim, req;
1452                         OP *nest;
1453
1454                         nest = NULL;
1455
1456                         req = param_spec->positional_required.used;
1457                         for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1458                                 ParamInit *cur = &param_spec->positional_optional.data[i];
1459                                 OP *var, *cond;
1460
1461                                 cond = newBINOP(
1462                                         OP_LT, 0,
1463                                         newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1464                                         mkconstiv(aTHX_ req + i + 1)
1465                                 );
1466
1467                                 var = my_var(aTHX_ 0, cur->param.padoff);
1468
1469                                 nest = op_append_list(
1470                                         OP_LINESEQ, nest,
1471                                         newASSIGNOP(OPf_STACKED, var, 0, cur->init)
1472                                 );
1473                                 cur->init = NULL;
1474                                 nest = newCONDOP(
1475                                         0,
1476                                         cond,
1477                                         nest,
1478                                         NULL
1479                                 );
1480                         }
1481
1482                         *prelude_sentinel = op_append_list(
1483                                 OP_LINESEQ, *prelude_sentinel,
1484                                 nest
1485                         );
1486                 }
1487
1488                 /* named parameters */
1489                 if (count_named_params(param_spec)) {
1490                         size_t i, lim;
1491
1492                         assert(param_spec->rest_hash != NOT_IN_PAD);
1493
1494                         for (i = 0, lim = param_spec->named_required.used; i < lim; i++) {
1495                                 Param *cur = &param_spec->named_required.data[i];
1496                                 size_t n;
1497                                 char *p = SvPV(cur->name, n);
1498                                 OP *var, *cond;
1499
1500                                 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1501
1502                                 if (spec->flags & FLAG_CHECK_NARGS) {
1503                                         OP *croak, *msg;
1504
1505                                         var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1506                                         var = newUNOP(OP_DELETE, 0, var);
1507
1508                                         msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": missing named parameter: %.*s", SVfARG(declarator), (int)(n - 1), p + 1));
1509                                         croak = newCVREF(
1510                                                 OPf_WANT_SCALAR,
1511                                                 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1512                                         );
1513                                         croak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, croak));
1514
1515                                         cond = newUNOP(OP_EXISTS, 0, cond);
1516
1517                                         cond = newCONDOP(0, cond, var, croak);
1518                                 }
1519
1520                                 var = my_var(
1521                                         aTHX_
1522                                         OPf_MOD | (OPpLVAL_INTRO << 8),
1523                                         cur->padoff
1524                                 );
1525                                 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1526
1527                                 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1528                         }
1529
1530                         for (i = 0, lim = param_spec->named_optional.used; i < lim; i++) {
1531                                 ParamInit *cur = &param_spec->named_optional.data[i];
1532                                 size_t n;
1533                                 char *p = SvPV(cur->param.name, n);
1534                                 OP *var, *cond;
1535
1536                                 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1537                                 var = newUNOP(OP_DELETE, 0, var);
1538
1539                                 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1540                                 cond = newUNOP(OP_EXISTS, 0, cond);
1541
1542                                 cond = newCONDOP(0, cond, var, cur->init);
1543                                 cur->init = NULL;
1544
1545                                 var = my_var(
1546                                         aTHX_
1547                                         OPf_MOD | (OPpLVAL_INTRO << 8),
1548                                         cur->param.padoff
1549                                 );
1550                                 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1551
1552                                 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1553                         }
1554
1555                         if (!param_spec->slurpy.name) {
1556                                 if (spec->flags & FLAG_CHECK_NARGS) {
1557                                         /* croak if %{rest} */
1558                                         OP *croak, *cond, *keys, *msg;
1559
1560                                         keys = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1561                                         keys = newLISTOP(OP_SORT, 0, newOP(OP_PUSHMARK, 0), keys);
1562                                         {
1563                                                 OP *first, *mid, *last;
1564
1565                                                 last = keys;
1566
1567                                                 mid = mkconstpvs(", ");
1568                                                 mid->op_sibling = last;
1569
1570                                                 first = newOP(OP_PUSHMARK, 0);
1571
1572                                                 keys = newLISTOP(OP_JOIN, 0, first, mid);
1573                                                 keys->op_targ = pad_alloc(OP_JOIN, SVs_PADTMP);
1574                                                 ((LISTOP *)keys)->op_last = last;
1575                                         }
1576
1577                                         msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": no such named parameter: ", SVfARG(declarator)));
1578                                         msg = newBINOP(OP_CONCAT, 0, msg, keys);
1579
1580                                         croak = newCVREF(
1581                                                 OPf_WANT_SCALAR,
1582                                                 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1583                                         );
1584                                         croak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, croak));
1585
1586                                         cond = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1587                                         croak = newCONDOP(0, cond, croak, NULL);
1588
1589                                         *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, croak));
1590                                 } else {
1591                                         OP *clear;
1592
1593                                         clear = newASSIGNOP(
1594                                                 OPf_STACKED,
1595                                                 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1596                                                 0,
1597                                                 newNULLLIST()
1598                                         );
1599
1600                                         *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1601                                 }
1602                         } else if (param_spec->slurpy.padoff != param_spec->rest_hash) {
1603                                 OP *var, *clear;
1604
1605                                 assert(SvPV_nolen(param_spec->slurpy.name)[0] == '@');
1606
1607                                 var = my_var_g(
1608                                         aTHX_
1609                                         OP_PADAV,
1610                                         OPf_MOD | (OPpLVAL_INTRO << 8),
1611                                         param_spec->slurpy.padoff
1612                                 );
1613
1614                                 var = newASSIGNOP(OPf_STACKED, var, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1615
1616                                 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1617
1618                                 clear = newASSIGNOP(
1619                                         OPf_STACKED,
1620                                         my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1621                                         0,
1622                                         newNULLLIST()
1623                                 );
1624
1625                                 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1626                         }
1627                 }
1628         }
1629
1630         /* finally let perl parse the actual subroutine body */
1631         body = parse_block(0);
1632
1633         /* add '();' to make function return nothing by default */
1634         /* (otherwise the invisible parameter initialization can "leak" into
1635            the return value: fun ($x) {}->("asdf", 0) == 2) */
1636         if (*prelude_sentinel) {
1637                 body = newSTATEOP(0, NULL, body);
1638         }
1639
1640         body = op_append_list(OP_LINESEQ, *prelude_sentinel, body);
1641         *prelude_sentinel = NULL;
1642
1643         /* it's go time. */
1644         {
1645                 CV *cv;
1646                 OP *const attrs = *attrs_sentinel;
1647                 *attrs_sentinel = NULL;
1648
1649                 SvREFCNT_inc_simple_void(PL_compcv);
1650
1651                 /* close outer block: '}' */
1652                 S_block_end(aTHX_ save_ix, body);
1653
1654                 cv = newATTRSUB(
1655                         floor_ix,
1656                         saw_name ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)) : NULL,
1657                         proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1658                         attrs,
1659                         body
1660                 );
1661
1662                 register_info(aTHX_ PTR2UV(CvROOT(cv)), declarator, spec, param_spec);
1663
1664                 if (saw_name) {
1665                         *pop = newOP(OP_NULL, 0);
1666                         return KEYWORD_PLUGIN_STMT;
1667                 }
1668
1669                 *pop = newUNOP(
1670                         OP_REFGEN, 0,
1671                         newSVOP(
1672                                 OP_ANONCODE, 0,
1673                                 (SV *)cv
1674                         )
1675                 );
1676                 return KEYWORD_PLUGIN_EXPR;
1677         }
1678 }
1679
1680 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
1681         KWSpec spec;
1682         int ret;
1683         Sentinel sen = { NULL };
1684
1685         ENTER;
1686         SAVETMPS;
1687
1688         SAVEDESTRUCTOR_X(sentinel_clear_void, sen);
1689
1690         if (kw_flags(aTHX_ sen, keyword_ptr, keyword_len, &spec)) {
1691                 ret = parse_fun(aTHX_ sen, op_ptr, keyword_ptr, keyword_len, &spec);
1692         } else {
1693                 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
1694         }
1695
1696         FREETMPS;
1697         LEAVE;
1698
1699         return ret;
1700 }
1701
1702 WARNINGS_RESET
1703
1704 MODULE = Function::Parameters   PACKAGE = Function::Parameters   PREFIX = fp_
1705 PROTOTYPES: ENABLE
1706
1707 UV
1708 fp__cv_root(sv)
1709         SV * sv
1710         PREINIT:
1711                 CV *cv;
1712                 HV *hv;
1713                 GV *gv;
1714         CODE:
1715                 cv = sv_2cv(sv, &hv, &gv, 0);
1716                 RETVAL = PTR2UV(cv ? CvROOT(cv) : NULL);
1717         OUTPUT:
1718                 RETVAL
1719
1720 BOOT:
1721 WARNINGS_ENABLE {
1722         HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
1723         /**/
1724         newCONSTSUB(stash, "FLAG_NAME_OK",      newSViv(FLAG_NAME_OK));
1725         newCONSTSUB(stash, "FLAG_ANON_OK",      newSViv(FLAG_ANON_OK));
1726         newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
1727         newCONSTSUB(stash, "FLAG_CHECK_NARGS",  newSViv(FLAG_CHECK_NARGS));
1728         newCONSTSUB(stash, "FLAG_INVOCANT",     newSViv(FLAG_INVOCANT));
1729         newCONSTSUB(stash, "FLAG_NAMED_PARAMS", newSViv(FLAG_NAMED_PARAMS));
1730         newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
1731         newCONSTSUB(stash, "HINTK_FLAGS_",   newSVpvs(HINTK_FLAGS_));
1732         newCONSTSUB(stash, "HINTK_SHIFT_",   newSVpvs(HINTK_SHIFT_));
1733         newCONSTSUB(stash, "HINTK_ATTRS_",   newSVpvs(HINTK_ATTRS_));
1734         /**/
1735         next_keyword_plugin = PL_keyword_plugin;
1736         PL_keyword_plugin = my_keyword_plugin;
1737 } WARNINGS_RESET