2 Copyright 2012 Lukas Mai.
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.
8 See http://dev.perl.org/licenses/ for more information.
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)
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)
40 #define WARNINGS_RESET
41 #define WARNINGS_ENABLE
45 #define PERL_NO_GET_CONTEXT
56 #define HAVE_PERL_VERSION(R, V, S) \
57 (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
59 #if HAVE_PERL_VERSION(5, 16, 0)
60 #define IF_HAVE_PERL_5_16(YES, NO) YES
62 #define IF_HAVE_PERL_5_16(YES, NO) NO
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)
70 #elif HAVE_PERL_VERSION(5, 15, 6)
72 #elif HAVE_PERL_VERSION(5, 15, 5)
74 #elif HAVE_PERL_VERSION(5, 13, 0)
77 #error "internal error: missing definition of KEY_my (your perl is too old)"
82 #define MY_PKG "Function::Parameters"
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:"
89 #define DEFSTRUCT(T) typedef struct T T; struct T
91 #define UV_BITS (sizeof (UV) * CHAR_BIT)
96 FLAG_DEFAULT_ARGS = 0x04,
97 FLAG_CHECK_NARGS = 0x08,
99 FLAG_NAMED_PARAMS = 0x20
108 static int (*next_keyword_plugin)(pTHX_ char *, STRLEN, OP **);
110 static int kw_flags(pTHX_ const char *kw_ptr, STRLEN kw_len, KWSpec *spec) {
113 const char *p, *kw_active;
114 STRLEN kw_active_len;
117 spec->shift = sv_2mortal(newSVpvs(""));
118 spec->attrs = sv_2mortal(newSVpvs(""));
120 if (!(hints = GvHV(PL_hintgv))) {
123 if (!(psv = hv_fetchs(hints, HINTK_KEYWORDS, 0))) {
127 kw_active = SvPV(sv, kw_active_len);
128 if (kw_active_len <= kw_len) {
133 (p = strchr(p, *kw_ptr)) &&
134 p < kw_active + kw_active_len - kw_len;
138 (p == kw_active || p[-1] == ' ') &&
140 memcmp(kw_ptr, p, kw_len) == 0
143 #define FETCH_HINTK_INTO(NAME, PTR, LEN, X) STMT_START { \
144 const char *fk_ptr_; \
147 fk_sv_ = sv_2mortal(newSVpvs(HINTK_ ## NAME)); \
148 sv_catpvn(fk_sv_, PTR, LEN); \
149 fk_ptr_ = SvPV(fk_sv_, fk_len_); \
150 if (!((X) = hv_fetch(hints, fk_ptr_, fk_len_, 0))) { \
151 croak("%s: internal error: $^H{'%.*s'} not set", MY_PKG, (int)fk_len_, fk_ptr_); \
155 FETCH_HINTK_INTO(FLAGS_, kw_ptr, kw_len, psv);
156 spec->flags = SvIV(*psv);
158 FETCH_HINTK_INTO(SHIFT_, kw_ptr, kw_len, psv);
159 SvSetSV(spec->shift, *psv);
161 FETCH_HINTK_INTO(ATTRS_, kw_ptr, kw_len, psv);
162 SvSetSV(spec->attrs, *psv);
164 #undef FETCH_HINTK_INTO
172 static void free_ptr_op(pTHX_ void *vp) {
178 #define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
180 static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
182 const char *sv_p = SvPV(sv, sv_len);
183 return memcmp(sv_p, p, n) == 0;
187 #include "padop_on_crack.c.inc"
191 MY_ATTR_LVALUE = 0x01,
192 MY_ATTR_METHOD = 0x02,
193 MY_ATTR_SPECIAL = 0x04
196 static void my_sv_cat_c(pTHX_ SV *sv, U32 c) {
197 char ds[UTF8_MAXBYTES + 1], *d;
198 d = uvchr_to_utf8(ds, c);
202 sv_catpvn(sv, ds, d - ds);
205 static bool my_is_uni_xidfirst(pTHX_ UV c) {
206 U8 tmpbuf[UTF8_MAXBYTES + 1];
207 uvchr_to_utf8(tmpbuf, c);
208 return is_utf8_xidfirst(tmpbuf);
211 static bool my_is_uni_xidcont(pTHX_ UV c) {
212 U8 tmpbuf[UTF8_MAXBYTES + 1];
213 uvchr_to_utf8(tmpbuf, c);
214 return is_utf8_xidcont(tmpbuf);
217 static SV *my_scan_word(pTHX_ bool allow_package) {
218 bool at_start, at_substart;
220 SV *sv = sv_2mortal(newSVpvs(""));
225 at_start = at_substart = TRUE;
226 c = lex_peek_unichar(0);
229 if (at_substart ? my_is_uni_xidfirst(aTHX_ c) : my_is_uni_xidcont(aTHX_ c)) {
231 my_sv_cat_c(aTHX_ sv, c);
233 c = lex_peek_unichar(0);
234 } else if (allow_package && !at_substart && c == '\'') {
236 c = lex_peek_unichar(0);
237 if (!my_is_uni_xidfirst(aTHX_ c)) {
238 lex_stuff_pvs("'", 0);
243 } else if (allow_package && (at_start || !at_substart) && c == ':') {
245 if (lex_peek_unichar(0) != ':') {
246 lex_stuff_pvs(":", 0);
250 c = lex_peek_unichar(0);
251 if (!my_is_uni_xidfirst(aTHX_ c)) {
252 lex_stuff_pvs("::", 0);
263 return SvCUR(sv) ? sv : NULL;
266 static SV *my_scan_parens_tail(pTHX_ bool keep_backslash) {
271 start = CopLINE(PL_curcop);
273 sv = sv_2mortal(newSVpvs(""));
280 c = lex_read_unichar(0);
282 CopLINE_set(PL_curcop, start);
287 c = lex_read_unichar(0);
289 CopLINE_set(PL_curcop, start);
292 if (keep_backslash || (c != '(' && c != ')')) {
295 } else if (c == '(') {
297 } else if (c == ')') {
304 my_sv_cat_c(aTHX_ sv, c);
310 static void my_check_prototype(pTHX_ const SV *declarator, SV *proto) {
311 char *start, *r, *w, *end;
315 start = SvPV(proto, len);
318 for (w = r = start; r < end; r++) {
324 SvCUR_set(proto, w - start);
328 if (!ckWARN(WARN_ILLEGALPROTO)) {
332 /* check for bad characters */
333 if (strspn(start, "$@%*;[]&\\_+") != len) {
334 SV *dsv = newSVpvs_flags("", SVs_TEMP);
336 packWARN(WARN_ILLEGALPROTO),
337 "Illegal character in prototype for %"SVf" : %s",
346 : pv_pretty(dsv, start, len, 60, NULL, NULL,
347 PERL_PV_ESCAPE_NONASCII
353 for (r = start; r < end; r++) {
357 packWARN(WARN_ILLEGALPROTO),
358 "Illegal character in prototype for %"SVf" : %s",
359 SVfARG(declarator), r
364 if (r[1] && !strchr(";@%", *r)) {
366 packWARN(WARN_ILLEGALPROTO),
367 "Illegal character after '_' in prototype for %"SVf" : %s",
368 SVfARG(declarator), r
378 packWARN(WARN_ILLEGALPROTO),
379 "prototype after '%c' for %"SVf": %s",
380 *r, SVfARG(declarator), r + 1
388 if (strchr("$@%&*", *r)) {
393 for (; r < end && *r != ']'; r++) {
394 if (!strchr("$@%&*", *r)) {
398 if (*r == ']' && r[-1] != '[') {
403 packWARN(WARN_ILLEGALPROTO),
404 "Illegal character after '\\' in prototype for %"SVf" : %s",
405 SVfARG(declarator), r
425 DEFSTRUCT(ParamInit) {
430 #define VEC(B) B ## _Vec
432 #define DEFVECTOR(B) DEFSTRUCT(VEC(B)) { \
438 DEFVECTOR(ParamInit);
440 #define DEFVECTOR_INIT(N, B) static void N(VEC(B) *p) { \
443 Newx(p->data, p->size, B); \
444 } static void N(VEC(B) *)
446 DEFSTRUCT(ParamSpec) {
448 VEC(Param) positional_required;
449 VEC(ParamInit) positional_optional;
450 VEC(Param) named_required;
451 VEC(ParamInit) named_optional;
455 DEFVECTOR_INIT(pv_init, Param);
456 DEFVECTOR_INIT(piv_init, ParamInit);
458 static void p_init(Param *p) {
460 p->padoff = NOT_IN_PAD;
463 static void ps_init(ParamSpec *ps) {
464 p_init(&ps->invocant);
465 pv_init(&ps->positional_required);
466 piv_init(&ps->positional_optional);
467 pv_init(&ps->named_required);
468 piv_init(&ps->named_optional);
472 #define DEFVECTOR_EXTEND(N, B) static B (*N(VEC(B) *p)) { \
473 assert(p->used <= p->size); \
474 if (p->used == p->size) { \
475 const size_t n = p->size / 2 * 3 + 1; \
476 Renew(p->data, n, B); \
479 return &p->data[p->used]; \
480 } static B (*N(VEC(B) *))
482 DEFVECTOR_EXTEND(pv_extend, Param);
483 DEFVECTOR_EXTEND(piv_extend, ParamInit);
485 #define DEFVECTOR_CLEAR(N, B, F) static void N(pTHX_ VEC(B) *p) { \
488 F(aTHX_ &p->data[p->used]); \
493 } static void N(pTHX_ VEC(B) *)
495 static void p_clear(pTHX_ Param *p) {
497 p->padoff = NOT_IN_PAD;
500 static void pi_clear(pTHX_ ParamInit *pi) {
501 p_clear(aTHX_ &pi->param);
508 DEFVECTOR_CLEAR(pv_clear, Param, p_clear);
509 DEFVECTOR_CLEAR(piv_clear, ParamInit, pi_clear);
511 static void ps_clear(pTHX_ ParamSpec *ps) {
512 p_clear(aTHX_ &ps->invocant);
514 pv_clear(aTHX_ &ps->positional_required);
515 piv_clear(aTHX_ &ps->positional_optional);
517 pv_clear(aTHX_ &ps->named_required);
518 piv_clear(aTHX_ &ps->named_optional);
520 p_clear(aTHX_ &ps->slurpy);
523 static int ps_contains(pTHX_ const ParamSpec *ps, SV *sv) {
526 if (ps->invocant.name && sv_eq(sv, ps->invocant.name)) {
530 for (i = 0, lim = ps->positional_required.used; i < lim; i++) {
531 if (sv_eq(sv, ps->positional_required.data[i].name)) {
536 for (i = 0, lim = ps->positional_optional.used; i < lim; i++) {
537 if (sv_eq(sv, ps->positional_optional.data[i].param.name)) {
542 for (i = 0, lim = ps->named_required.used; i < lim; i++) {
543 if (sv_eq(sv, ps->named_required.data[i].name)) {
548 for (i = 0, lim = ps->named_optional.used; i < lim; i++) {
549 if (sv_eq(sv, ps->named_optional.data[i].param.name)) {
557 static void ps_free_void(pTHX_ void *p) {
562 static int args_min(pTHX_ const ParamSpec *ps, const KWSpec *ks) {
565 return SvTRUE(ks->shift) ? 1 : 0;
567 if (ps->invocant.name) {
570 n += ps->positional_required.used;
571 n += ps->named_required.used * 2;
575 static int args_max(const ParamSpec *ps) {
580 if (ps->invocant.name) {
583 n += ps->positional_required.used;
584 n += ps->positional_optional.used;
585 if (ps->named_required.used || ps->named_optional.used || ps->slurpy.name) {
591 static size_t count_positional_params(const ParamSpec *ps) {
592 return ps->positional_required.used + ps->positional_optional.used;
595 static size_t count_named_params(const ParamSpec *ps) {
596 return ps->named_required.used + ps->named_optional.used;
600 PARAM_INVOCANT = 0x01,
604 /* *pinit must be NULL on entry.
605 * caller must free *pinit on error.
607 static PADOFFSET parse_param(
609 const SV *declarator, const KWSpec *spec, ParamSpec *param_spec,
610 int *pflags, SV **pname, OP **pinit
619 c = lex_peek_unichar(0);
625 *pflags |= PARAM_NAMED;
627 c = lex_peek_unichar(0);
631 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
633 if (!(c == '$' || c == '@' || c == '%')) {
634 croak("In %"SVf": unexpected '%c' in parameter list (expecting a sigil)", SVfARG(declarator), (int)c);
642 if (!(name = my_scan_word(aTHX_ FALSE))) {
643 croak("In %"SVf": missing identifier after '%c'", SVfARG(declarator), sigil);
645 sv_insert(name, 0, 0, &sigil, 1);
649 c = lex_peek_unichar(0);
656 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
657 param_spec->invocant.name = spec->shift;
658 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
661 *pinit = parse_termexpr(0);
664 c = lex_peek_unichar(0);
668 *pflags |= PARAM_INVOCANT;
671 } else if (c == ',') {
674 } else if (c != ')') {
676 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
678 croak("In %"SVf": unexpected '%c' in parameter list (expecting ',')", SVfARG(declarator), (int)c);
681 return pad_add_name_sv(*pname, IF_HAVE_PERL_5_16(padadd_NO_DUP_CHECK, 0), NULL, NULL);
684 static OP *my_var_g(pTHX_ I32 type, I32 flags, PADOFFSET padoff) {
685 OP *var = newOP(type, flags);
686 var->op_targ = padoff;
690 static OP *my_var(pTHX_ I32 flags, PADOFFSET padoff) {
691 return my_var_g(aTHX_ OP_PADSV, flags, padoff);
694 static SV *mkbits1(pTHX_ size_t n) {
695 size_t bytes = n / 8, bits = n % 8;
696 SV *sv = newSV(bytes + !!bits);
697 char *p = SvPVX(sv), *q = p;
702 *p++ = (1u << bits) - 1;
705 SvCUR_set(sv, p - q);
710 static OP *mkvecbits(pTHX_ PADOFFSET padoff, size_t i) {
711 OP *first, *mid, *last, *vec;
713 last = newSVOP(OP_CONST, 0, newSViv(1));
716 mid = newSVOP(OP_CONST, 0, newSViv(i));
717 mid->op_sibling = first;
720 mid = my_var(aTHX_ 0, padoff);
721 mid->op_sibling = first;
723 first = newOP(OP_PUSHMARK, 0);
725 vec = newLISTOP(OP_VEC, 0, first, mid);
726 vec->op_targ = pad_alloc(OP_VEC, SVs_PADTMP);
727 ((LISTOP *)vec)->op_last = last;
728 op_null(((LISTOP *)vec)->op_first);
733 static OP *mkargselem(pTHX_ OP *index) {
734 OP *args = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
735 args->op_flags |= OPf_REF;
737 return newBINOP(OP_AELEM, 0, args, index);
740 static OP *mkargselemv(pTHX_ PADOFFSET v) {
741 return mkargselem(aTHX_ my_var(aTHX_ 0, v));
744 static int parse_fun(pTHX_ OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
745 ParamSpec *param_spec;
750 OP **prelude_sentinel;
752 OP **attrs_sentinel, *body;
753 unsigned builtin_attrs;
756 declarator = sv_2mortal(newSVpvn(keyword_ptr, keyword_len));
764 if ((spec->flags & FLAG_NAME_OK) && (saw_name = my_scan_word(aTHX_ TRUE))) {
766 if (PL_parser->expect != XSTATE) {
767 /* bail out early so we don't predeclare $saw_name */
768 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
771 sv_catpvs(declarator, " ");
772 sv_catsv(declarator, saw_name);
775 sv_eq_pvs(saw_name, "BEGIN") ||
776 sv_eq_pvs(saw_name, "END") ||
777 sv_eq_pvs(saw_name, "INIT") ||
778 sv_eq_pvs(saw_name, "CHECK") ||
779 sv_eq_pvs(saw_name, "UNITCHECK")
781 builtin_attrs |= MY_ATTR_SPECIAL;
785 } else if (!(spec->flags & FLAG_ANON_OK)) {
786 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - PL_parser->bufptr), PL_parser->bufptr);
788 sv_catpvs(declarator, " (anon)");
791 /* we're a subroutine declaration */
792 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
793 SAVEFREESV(PL_compcv);
795 /* create outer block: '{' */
796 save_ix = S_block_start(aTHX_ TRUE);
798 /* initialize synthetic optree */
799 Newx(prelude_sentinel, 1, OP *);
800 *prelude_sentinel = NULL;
801 SAVEDESTRUCTOR_X(free_ptr_op, prelude_sentinel);
806 c = lex_peek_unichar(0);
810 Newx(init_sentinel, 1, OP *);
811 *init_sentinel = NULL;
812 SAVEDESTRUCTOR_X(free_ptr_op, init_sentinel);
814 Newx(param_spec, 1, ParamSpec);
816 SAVEDESTRUCTOR_X(ps_free_void, param_spec);
821 while ((c = lex_peek_unichar(0)) != ')') {
827 padoff = parse_param(aTHX_ declarator, spec, param_spec, &flags, &name, init_sentinel);
831 sigil = SvPV_nolen(name)[0];
833 /* internal consistency */
834 if (flags & PARAM_NAMED) {
835 if (flags & PARAM_INVOCANT) {
836 croak("In %"SVf": invocant %"SVf" can't be a named parameter", SVfARG(declarator), SVfARG(name));
839 croak("In %"SVf": named parameter %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
841 } else if (flags & PARAM_INVOCANT) {
842 if (*init_sentinel) {
843 croak("In %"SVf": invocant %"SVf" can't have a default value", SVfARG(declarator), SVfARG(name));
846 croak("In %"SVf": invocant %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
848 } else if (sigil != '$' && *init_sentinel) {
849 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(name));
852 /* external constraints */
853 if (param_spec->slurpy.name) {
854 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(param_spec->slurpy.name), SVfARG(name));
857 assert(!*init_sentinel);
858 param_spec->slurpy.name = name;
859 param_spec->slurpy.padoff = padoff;
863 if (!(flags & PARAM_NAMED) && count_named_params(param_spec)) {
864 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));
867 if (flags & PARAM_INVOCANT) {
868 if (param_spec->invocant.name) {
869 croak("In %"SVf": invalid double invocants %"SVf", %"SVf"", SVfARG(declarator), SVfARG(param_spec->invocant.name), SVfARG(name));
871 if (count_positional_params(param_spec) || count_named_params(param_spec)) {
872 croak("In %"SVf": invocant %"SVf" must be first in parameter list", SVfARG(declarator), SVfARG(name));
874 if (!(spec->flags & FLAG_INVOCANT)) {
875 croak("In %"SVf": invocant %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
877 param_spec->invocant.name = name;
878 param_spec->invocant.padoff = padoff;
882 if (*init_sentinel && !(spec->flags & FLAG_DEFAULT_ARGS)) {
883 croak("In %"SVf": default argument for %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
886 if (ps_contains(aTHX_ param_spec, name)) {
887 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(name));
890 if (flags & PARAM_NAMED) {
891 if (!(spec->flags & FLAG_NAMED_PARAMS)) {
892 croak("In %"SVf": named parameter :%"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
895 if (*init_sentinel) {
896 ParamInit *pi = piv_extend(¶m_spec->named_optional);
897 pi->param.name = name;
898 pi->param.padoff = padoff;
899 pi->init = *init_sentinel;
900 *init_sentinel = NULL;
901 param_spec->named_optional.used++;
903 if (param_spec->positional_optional.used) {
904 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));
907 Param *p = pv_extend(¶m_spec->named_required);
910 param_spec->named_required.used++;
913 if (*init_sentinel || param_spec->positional_optional.used) {
914 ParamInit *pi = piv_extend(¶m_spec->positional_optional);
915 pi->param.name = name;
916 pi->param.padoff = padoff;
917 pi->init = *init_sentinel;
918 *init_sentinel = NULL;
919 param_spec->positional_optional.used++;
921 Param *p = pv_extend(¶m_spec->positional_required);
924 param_spec->positional_required.used++;
931 *init_sentinel = NULL;
933 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
934 if (ps_contains(aTHX_ param_spec, spec->shift)) {
935 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(spec->shift));
938 param_spec->invocant.name = spec->shift;
939 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
945 c = lex_peek_unichar(0);
950 c = lex_peek_unichar(0);
952 lex_stuff_pvs(":", 0);
956 if (!(proto = my_scan_parens_tail(aTHX_ FALSE))) {
957 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
959 my_check_prototype(aTHX_ declarator, proto);
961 c = lex_peek_unichar(0);
966 Newx(attrs_sentinel, 1, OP *);
967 *attrs_sentinel = NULL;
968 SAVEDESTRUCTOR_X(free_ptr_op, attrs_sentinel);
970 if (c == ':' || c == '{') /* '}' - hi, vim */ {
972 /* kludge default attributes in */
973 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
974 lex_stuff_sv(spec->attrs, 0);
981 c = lex_peek_unichar(0);
986 if (!(attr = my_scan_word(aTHX_ FALSE))) {
991 c = lex_peek_unichar(0);
994 if (sv_eq_pvs(attr, "lvalue")) {
995 builtin_attrs |= MY_ATTR_LVALUE;
997 } else if (sv_eq_pvs(attr, "method")) {
998 builtin_attrs |= MY_ATTR_METHOD;
1003 lex_read_unichar(0);
1004 if (!(sv = my_scan_parens_tail(aTHX_ TRUE))) {
1005 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
1007 sv_catpvs(attr, "(");
1009 sv_catpvs(attr, ")");
1012 c = lex_peek_unichar(0);
1016 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(attr)));
1020 lex_read_unichar(0);
1022 c = lex_peek_unichar(0);
1029 if (c != '{') /* '}' - hi, vim */ {
1030 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
1033 /* surprise predeclaration! */
1035 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
1036 starts parsing the body */
1037 const I32 sub_ix = start_subparse(FALSE, 0);
1038 SAVEFREESV(PL_compcv);
1040 SvREFCNT_inc_simple_void(PL_compcv);
1044 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
1045 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1051 if (builtin_attrs & MY_ATTR_LVALUE) {
1052 CvLVALUE_on(PL_compcv);
1054 if (builtin_attrs & MY_ATTR_METHOD) {
1055 CvMETHOD_on(PL_compcv);
1057 if (builtin_attrs & MY_ATTR_SPECIAL) {
1058 CvSPECIAL_on(PL_compcv);
1061 /* check number of arguments */
1062 if (spec->flags & FLAG_CHECK_NARGS) {
1066 amin = args_min(aTHX_ param_spec, spec);
1068 OP *chk, *cond, *err, *croak;
1070 err = newSVOP(OP_CONST, 0,
1071 newSVpvf("Not enough arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amin));
1072 err = newBINOP(OP_CONCAT, 0,
1074 newAVREF(newGVOP(OP_GV, 0, PL_defgv)));
1075 err = newBINOP(OP_CONCAT, 0,
1077 newSVOP(OP_CONST, 0, newSVpvs(")")));
1079 croak = newCVREF(OPf_WANT_SCALAR,
1080 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1081 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1082 op_append_elem(OP_LIST, err, croak));
1084 cond = newBINOP(OP_LT, 0,
1085 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1086 newSVOP(OP_CONST, 0, newSViv(amin)));
1087 chk = newLOGOP(OP_AND, 0, cond, err);
1089 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1092 amax = args_max(param_spec);
1094 OP *chk, *cond, *err, *croak;
1096 err = newSVOP(OP_CONST, 0,
1097 newSVpvf("Too many arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amax));
1098 err = newBINOP(OP_CONCAT, 0,
1100 newAVREF(newGVOP(OP_GV, 0, PL_defgv)));
1101 err = newBINOP(OP_CONCAT, 0,
1103 newSVOP(OP_CONST, 0, newSVpvs(")")));
1105 croak = newCVREF(OPf_WANT_SCALAR,
1106 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1107 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1108 op_append_elem(OP_LIST, err, croak));
1110 cond = newBINOP(OP_GT, 0,
1111 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1112 newSVOP(OP_CONST, 0, newSViv(amax)));
1113 chk = newLOGOP(OP_AND, 0, cond, err);
1115 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1118 if (param_spec && (count_named_params(param_spec) || (param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%'))) {
1119 OP *chk, *cond, *err, *croak;
1120 const UV fixed = count_positional_params(param_spec) + !!param_spec->invocant.name;
1122 err = newSVOP(OP_CONST, 0,
1123 newSVpvf("Odd number of paired arguments for %"SVf"", SVfARG(declarator)));
1125 croak = newCVREF(OPf_WANT_SCALAR,
1126 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1127 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1128 op_append_elem(OP_LIST, err, croak));
1130 cond = newBINOP(OP_GT, 0,
1132 ? newBINOP(OP_SUBTRACT, 0,
1133 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1134 newSVOP(OP_CONST, 0, newSVuv(fixed)))
1135 : newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1136 newSVOP(OP_CONST, 0, newSViv(0)));
1137 cond = newLOGOP(OP_AND, 0,
1139 newBINOP(OP_MODULO, 0,
1141 ? newBINOP(OP_SUBTRACT, 0,
1142 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1143 newSVOP(OP_CONST, 0, newSVuv(fixed)))
1144 : newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1145 newSVOP(OP_CONST, 0, newSViv(2))));
1146 chk = newLOGOP(OP_AND, 0, cond, err);
1148 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1153 /* my $invocant = shift; */
1154 if (SvTRUE(spec->shift)) {
1159 OPf_MOD | (OPpLVAL_INTRO << 8),
1160 pad_add_name_sv(spec->shift, 0, NULL, NULL)
1162 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1164 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1167 /* my $invocant = shift; */
1168 if (param_spec->invocant.name) {
1173 OPf_MOD | (OPpLVAL_INTRO << 8),
1174 param_spec->invocant.padoff
1176 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1178 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1181 /* my (...) = @_; */
1188 for (i = 0, lim = param_spec->positional_required.used; i < lim; i++) {
1189 OP *const var = my_var(
1191 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1192 param_spec->positional_required.data[i].padoff
1194 lhs = op_append_elem(OP_LIST, lhs, var);
1197 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1198 OP *const var = my_var(
1200 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1201 param_spec->positional_optional.data[i].param.padoff
1203 lhs = op_append_elem(OP_LIST, lhs, var);
1206 if (param_spec->slurpy.name) {
1207 if (count_named_params(param_spec)) {
1208 OP *const var = my_var_g(
1210 SvPV_nolen(param_spec->slurpy.name)[0] == '@' ? OP_PADAV : OP_PADHV,
1211 OPf_MOD | (OPpLVAL_INTRO << 8),
1212 param_spec->slurpy.padoff
1214 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1216 OP *const var = my_var_g(
1218 SvPV_nolen(param_spec->slurpy.name)[0] == '@' ? OP_PADAV : OP_PADHV,
1219 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1220 param_spec->slurpy.padoff
1222 lhs = op_append_elem(OP_LIST, lhs, var);
1228 lhs->op_flags |= OPf_PARENS;
1229 rhs = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
1231 *prelude_sentinel = op_append_list(
1232 OP_LINESEQ, *prelude_sentinel,
1235 newASSIGNOP(OPf_STACKED, lhs, 0, rhs)
1241 /* default arguments */
1248 req = param_spec->positional_required.used;
1249 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1250 ParamInit *cur = ¶m_spec->positional_optional.data[i];
1255 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1256 newSVOP(OP_CONST, 0, newSViv(req + i + 1))
1259 var = my_var(aTHX_ 0, cur->param.padoff);
1261 nest = op_append_list(
1263 newASSIGNOP(OPf_STACKED, var, 0, cur->init)
1274 *prelude_sentinel = op_append_list(
1275 OP_LINESEQ, *prelude_sentinel,
1280 /* named parameters */
1281 if (count_named_params(param_spec)) {
1284 PADOFFSET vb, vc, vi, vk;
1285 int vb_is_str, vc_is_str;
1286 const size_t pos = count_positional_params(param_spec);
1289 nameblock_ix = S_block_start(aTHX_ TRUE);
1296 vb_is_str = param_spec->named_required.used > UV_BITS;
1297 if (!param_spec->named_required.used || !(spec->flags & FLAG_CHECK_NARGS)) {
1300 var = newOP(OP_PADSV, OPf_MOD | (OPpLVAL_INTRO << 8));
1301 var->op_targ = vb = pad_add_name_pvs("$__B", 0, NULL, NULL);
1302 var = newASSIGNOP(OPf_STACKED, var, 0, newSVOP(OP_CONST, 0, vb_is_str ? newSVpvs("") : newSVuv(0)));
1303 decl = op_append_list(OP_LINESEQ, decl, newSTATEOP(0, NULL, var));
1306 vc_is_str = param_spec->named_optional.used > UV_BITS;
1307 if (!param_spec->named_optional.used) {
1310 var = newOP(OP_PADSV, OPf_MOD | (OPpLVAL_INTRO << 8));
1311 var->op_targ = vc = pad_add_name_pvs("$__C", 0, NULL, NULL);
1312 var = newASSIGNOP(OPf_STACKED, var, 0, newSVOP(OP_CONST, 0, vc_is_str ? newSVpvs("") : newSVuv(0)));
1313 decl = op_append_list(OP_LINESEQ, decl, newSTATEOP(0, NULL, var));
1316 var = newOP(OP_PADSV, OPf_MOD | (OPpLVAL_INTRO << 8));
1317 var->op_targ = vk = pad_add_name_pvs("$__K", 0, NULL, NULL);
1318 decl = op_append_list(OP_LINESEQ, decl, newSTATEOP(0, NULL, var));
1320 var = newOP(OP_PADSV, OPf_MOD | (OPpLVAL_INTRO << 8));
1321 var->op_targ = vi = pad_add_name_pvs("$__I", 0, NULL, NULL);
1322 var = newASSIGNOP(OPf_STACKED, var, 0, newSVOP(OP_CONST, 0, newSViv(pos)));
1323 decl = op_append_list(OP_LINESEQ, decl, newSTATEOP(0, NULL, var));
1326 nameblock = op_append_list(OP_LINESEQ, nameblock, decl);
1334 loop = op_append_list(
1341 my_var(aTHX_ 0, vk),
1343 mkargselemv(aTHX_ vi)
1352 if (param_spec->slurpy.name) {
1353 if (SvPV_nolen(param_spec->slurpy.name)[0] == '@') {
1354 OP *first, *mid, *last;
1360 my_var(aTHX_ 0, vi),
1361 newSVOP(OP_CONST, 0, newSViv(1))
1366 first = my_var(aTHX_ 0, vk);
1367 first->op_sibling = mid;
1370 first = my_var_g(aTHX_ OP_PADAV, 0, param_spec->slurpy.padoff);
1371 first->op_sibling = mid;
1374 first = newOP(OP_PUSHMARK, 0);
1375 nest = newLISTOP(OP_PUSH, 0, first, mid);
1376 nest->op_targ = pad_alloc(OP_PUSH, SVs_PADTMP);
1377 ((LISTOP *)nest)->op_last = last;
1383 my_var_g(aTHX_ OP_PADHV, 0, param_spec->slurpy.padoff),
1391 my_var(aTHX_ 0, vi),
1392 newSVOP(OP_CONST, 0, newSViv(1))
1397 } else if (spec->flags & FLAG_CHECK_NARGS) {
1400 err = newSVOP(OP_CONST, 0,
1401 newSVpvf("In %"SVf": no such named parameter: ", SVfARG(declarator)));
1408 croak = newCVREF(OPf_WANT_SCALAR,
1409 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1410 nest = newUNOP(OP_ENTERSUB, OPf_STACKED,
1411 op_append_elem(OP_LIST, err, croak));
1416 for (i = param_spec->named_optional.used; i--; ) {
1417 Param *cur = ¶m_spec->named_optional.data[i].param;
1419 char *dp = SvPV(cur->name, dn);
1422 if (!(spec->flags & FLAG_CHECK_NARGS)) {
1424 } else if (vc_is_str) {
1427 mkvecbits(aTHX_ vc, i),
1429 newSVOP(OP_CONST, 0, newSViv(1))
1436 newSVOP(OP_CONST, 0, newSVuv((UV)1 << i))
1444 my_var(aTHX_ 0, vk),
1445 newSVOP(OP_CONST, 0, newSVpvn_utf8(dp + 1, dn - 1, SvUTF8(cur->name)))
1451 my_var(aTHX_ 0, cur->padoff),
1457 my_var(aTHX_ 0, vi),
1458 newSVOP(OP_CONST, 0, newSViv(1))
1468 for (i = param_spec->named_required.used; i--; ) {
1469 Param *cur = ¶m_spec->named_required.data[i];
1471 char *dp = SvPV(cur->name, dn);
1474 if (!(spec->flags & FLAG_CHECK_NARGS)) {
1476 } else if (vb_is_str) {
1479 mkvecbits(aTHX_ vb, i),
1481 newSVOP(OP_CONST, 0, newSViv(1))
1488 newSVOP(OP_CONST, 0, newSVuv((UV)1 << i))
1496 my_var(aTHX_ 0, vk),
1497 newSVOP(OP_CONST, 0, newSVpvn_utf8(dp + 1, dn - 1, SvUTF8(cur->name)))
1503 my_var(aTHX_ 0, cur->padoff),
1509 my_var(aTHX_ 0, vi),
1510 newSVOP(OP_CONST, 0, newSViv(1))
1520 loop = op_append_elem(OP_LINESEQ, loop, newSTATEOP(0, NULL, nest));
1528 my_var(aTHX_ 0, vi),
1529 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1534 my_var(aTHX_ 0, vi),
1536 newSVOP(OP_CONST, 0, newSViv(2))
1541 nameblock = op_append_list(OP_LINESEQ, nameblock, newSTATEOP(0, NULL, loop));
1544 if (param_spec->named_required.used && (spec->flags & FLAG_CHECK_NARGS)) {
1545 OP *cond, *err, *croak, *join;
1549 OP *first, *mid, *last;
1551 last = newNULLLIST();
1554 for (i = param_spec->named_required.used; i--; ) {
1556 SV *sv = param_spec->named_required.data[i].name;
1558 char *p = SvPV(sv, n);
1562 ? mkvecbits(aTHX_ vb, i)
1563 : newBINOP(OP_BIT_AND, 0, my_var(0, vb), newSVOP(OP_CONST, 0, newSVuv((UV)1 << i)))
1566 newSVOP(OP_CONST, 0, newSVpvn_utf8(p + 1, n - 1, SvUTF8(sv)))
1568 cur->op_sibling = mid;
1572 first = newSVOP(OP_CONST, 0, newSVpvs(", "));
1573 first->op_sibling = mid;
1576 first = newOP(OP_PUSHMARK, 0);
1578 join = newLISTOP(OP_JOIN, 0, first, mid);
1579 join->op_targ = pad_alloc(OP_JOIN, SVs_PADTMP);
1580 ((LISTOP *)join)->op_last = last;
1585 newSVpvf("In %"SVf": missing named parameter(s): ", SVfARG(declarator))
1587 err = newBINOP(OP_CONCAT, 0, err, join);
1590 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1595 op_append_elem(OP_LIST, err, croak)
1600 my_var(aTHX_ 0, vb),
1601 newSVOP(OP_CONST, 0, mkbits1(aTHX_ param_spec->named_required.used))
1606 my_var(aTHX_ 0, vb),
1610 param_spec->named_required.used == UV_BITS
1612 : ((UV)1 << param_spec->named_required.used) - 1
1624 nameblock = op_append_list(OP_LINESEQ, nameblock, err);
1627 if (param_spec->named_optional.used) {
1630 for (i = 0, lim = param_spec->named_optional.used; i < lim; i++) {
1631 ParamInit *const cur = ¶m_spec->named_optional.data[i];
1636 my_var(aTHX_ 0, cur->param.padoff),
1643 OP_NOT, OPf_SPECIAL,
1645 ? mkvecbits(aTHX_ vc, i)
1646 : newBINOP(OP_BIT_AND, 0, my_var(0, vc), newSVOP(OP_CONST, 0, newSVuv((UV)1 << i)))
1649 init = newCONDOP(0, cond, init, NULL);
1651 nameblock = op_append_list(OP_LINESEQ, nameblock, newSTATEOP(0, NULL, init));
1655 nameblock = S_block_end(aTHX_ nameblock_ix, nameblock);
1656 nameblock = op_scope(nameblock);
1658 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, nameblock);
1662 /* finally let perl parse the actual subroutine body */
1663 body = parse_block(0);
1665 /* add '();' to make function return nothing by default */
1666 /* (otherwise the invisible parameter initialization can "leak" into
1667 the return value: fun ($x) {}->("asdf", 0) == 2) */
1668 if (*prelude_sentinel) {
1669 body = newSTATEOP(0, NULL, body);
1672 body = op_append_list(OP_LINESEQ, *prelude_sentinel, body);
1673 *prelude_sentinel = NULL;
1677 OP *const attrs = *attrs_sentinel;
1678 *attrs_sentinel = NULL;
1679 SvREFCNT_inc_simple_void(PL_compcv);
1681 /* close outer block: '}' */
1682 S_block_end(aTHX_ save_ix, body);
1685 *pop = newANONATTRSUB(
1687 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1691 return KEYWORD_PLUGIN_EXPR;
1696 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
1697 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1701 *pop = newOP(OP_NULL, 0);
1702 return KEYWORD_PLUGIN_STMT;
1706 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
1712 if (kw_flags(aTHX_ keyword_ptr, keyword_len, &spec)) {
1713 ret = parse_fun(aTHX_ op_ptr, keyword_ptr, keyword_len, &spec);
1715 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
1725 MODULE = Function::Parameters PACKAGE = Function::Parameters
1730 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
1732 newCONSTSUB(stash, "FLAG_NAME_OK", newSViv(FLAG_NAME_OK));
1733 newCONSTSUB(stash, "FLAG_ANON_OK", newSViv(FLAG_ANON_OK));
1734 newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
1735 newCONSTSUB(stash, "FLAG_CHECK_NARGS", newSViv(FLAG_CHECK_NARGS));
1736 newCONSTSUB(stash, "FLAG_INVOCANT", newSViv(FLAG_INVOCANT));
1737 newCONSTSUB(stash, "FLAG_NAMED_PARAMS", newSViv(FLAG_NAMED_PARAMS));
1738 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
1739 newCONSTSUB(stash, "HINTK_FLAGS_", newSVpvs(HINTK_FLAGS_));
1740 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
1741 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
1743 next_keyword_plugin = PL_keyword_plugin;
1744 PL_keyword_plugin = my_keyword_plugin;