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;
456 DEFVECTOR_INIT(pv_init, Param);
457 DEFVECTOR_INIT(piv_init, ParamInit);
459 static void p_init(Param *p) {
461 p->padoff = NOT_IN_PAD;
464 static void ps_init(ParamSpec *ps) {
465 p_init(&ps->invocant);
466 pv_init(&ps->positional_required);
467 piv_init(&ps->positional_optional);
468 pv_init(&ps->named_required);
469 piv_init(&ps->named_optional);
471 ps->rest_hash = NOT_IN_PAD;
474 #define DEFVECTOR_EXTEND(N, B) static B (*N(VEC(B) *p)) { \
475 assert(p->used <= p->size); \
476 if (p->used == p->size) { \
477 const size_t n = p->size / 2 * 3 + 1; \
478 Renew(p->data, n, B); \
481 return &p->data[p->used]; \
482 } static B (*N(VEC(B) *))
484 DEFVECTOR_EXTEND(pv_extend, Param);
485 DEFVECTOR_EXTEND(piv_extend, ParamInit);
487 #define DEFVECTOR_CLEAR(N, B, F) static void N(pTHX_ VEC(B) *p) { \
490 F(aTHX_ &p->data[p->used]); \
495 } static void N(pTHX_ VEC(B) *)
497 static void p_clear(pTHX_ Param *p) {
499 p->padoff = NOT_IN_PAD;
502 static void pi_clear(pTHX_ ParamInit *pi) {
503 p_clear(aTHX_ &pi->param);
510 DEFVECTOR_CLEAR(pv_clear, Param, p_clear);
511 DEFVECTOR_CLEAR(piv_clear, ParamInit, pi_clear);
513 static void ps_clear(pTHX_ ParamSpec *ps) {
514 p_clear(aTHX_ &ps->invocant);
516 pv_clear(aTHX_ &ps->positional_required);
517 piv_clear(aTHX_ &ps->positional_optional);
519 pv_clear(aTHX_ &ps->named_required);
520 piv_clear(aTHX_ &ps->named_optional);
522 p_clear(aTHX_ &ps->slurpy);
525 static int ps_contains(pTHX_ const ParamSpec *ps, SV *sv) {
528 if (ps->invocant.name && sv_eq(sv, ps->invocant.name)) {
532 for (i = 0, lim = ps->positional_required.used; i < lim; i++) {
533 if (sv_eq(sv, ps->positional_required.data[i].name)) {
538 for (i = 0, lim = ps->positional_optional.used; i < lim; i++) {
539 if (sv_eq(sv, ps->positional_optional.data[i].param.name)) {
544 for (i = 0, lim = ps->named_required.used; i < lim; i++) {
545 if (sv_eq(sv, ps->named_required.data[i].name)) {
550 for (i = 0, lim = ps->named_optional.used; i < lim; i++) {
551 if (sv_eq(sv, ps->named_optional.data[i].param.name)) {
559 static void ps_free_void(pTHX_ void *p) {
564 static int args_min(pTHX_ const ParamSpec *ps, const KWSpec *ks) {
567 return SvTRUE(ks->shift) ? 1 : 0;
569 if (ps->invocant.name) {
572 n += ps->positional_required.used;
573 n += ps->named_required.used * 2;
577 static int args_max(const ParamSpec *ps) {
582 if (ps->invocant.name) {
585 n += ps->positional_required.used;
586 n += ps->positional_optional.used;
587 if (ps->named_required.used || ps->named_optional.used || ps->slurpy.name) {
593 static size_t count_positional_params(const ParamSpec *ps) {
594 return ps->positional_required.used + ps->positional_optional.used;
597 static size_t count_named_params(const ParamSpec *ps) {
598 return ps->named_required.used + ps->named_optional.used;
602 PARAM_INVOCANT = 0x01,
606 /* *pinit must be NULL on entry.
607 * caller must free *pinit on error.
609 static PADOFFSET parse_param(
611 const SV *declarator, const KWSpec *spec, ParamSpec *param_spec,
612 int *pflags, SV **pname, OP **pinit
621 c = lex_peek_unichar(0);
627 *pflags |= PARAM_NAMED;
629 c = lex_peek_unichar(0);
633 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
635 if (!(c == '$' || c == '@' || c == '%')) {
636 croak("In %"SVf": unexpected '%c' in parameter list (expecting a sigil)", SVfARG(declarator), (int)c);
644 if (!(name = my_scan_word(aTHX_ FALSE))) {
645 croak("In %"SVf": missing identifier after '%c'", SVfARG(declarator), sigil);
647 sv_insert(name, 0, 0, &sigil, 1);
651 c = lex_peek_unichar(0);
658 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
659 param_spec->invocant.name = spec->shift;
660 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
663 *pinit = parse_termexpr(0);
666 c = lex_peek_unichar(0);
670 *pflags |= PARAM_INVOCANT;
673 } else if (c == ',') {
676 } else if (c != ')') {
678 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
680 croak("In %"SVf": unexpected '%c' in parameter list (expecting ',')", SVfARG(declarator), (int)c);
683 return pad_add_name_sv(*pname, IF_HAVE_PERL_5_16(padadd_NO_DUP_CHECK, 0), NULL, NULL);
686 static OP *my_var_g(pTHX_ I32 type, I32 flags, PADOFFSET padoff) {
687 OP *var = newOP(type, flags);
688 var->op_targ = padoff;
692 static OP *my_var(pTHX_ I32 flags, PADOFFSET padoff) {
693 return my_var_g(aTHX_ OP_PADSV, flags, padoff);
696 static OP *mkhvelem(pTHX_ PADOFFSET h, OP *k) {
697 OP *hv = my_var_g(aTHX_ OP_PADHV, OPf_REF, h);
698 return newBINOP(OP_HELEM, 0, hv, k);
701 static OP *mkconstsv(pTHX_ SV *sv) {
702 return newSVOP(OP_CONST, 0, sv);
705 static OP *mkconstiv(pTHX_ IV i) {
706 return mkconstsv(aTHX_ newSViv(i));
709 static OP *mkconstpv(pTHX_ const char *p, size_t n) {
710 return mkconstsv(aTHX_ newSVpv(p, n));
713 #define mkconstpvs(S) mkconstpv(aTHX_ "" S "", sizeof S - 1)
715 static int parse_fun(pTHX_ OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
716 ParamSpec *param_spec;
721 OP **prelude_sentinel;
723 OP **attrs_sentinel, *body;
724 unsigned builtin_attrs;
727 declarator = sv_2mortal(newSVpvn(keyword_ptr, keyword_len));
735 if ((spec->flags & FLAG_NAME_OK) && (saw_name = my_scan_word(aTHX_ TRUE))) {
737 if (PL_parser->expect != XSTATE) {
738 /* bail out early so we don't predeclare $saw_name */
739 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
742 sv_catpvs(declarator, " ");
743 sv_catsv(declarator, saw_name);
746 sv_eq_pvs(saw_name, "BEGIN") ||
747 sv_eq_pvs(saw_name, "END") ||
748 sv_eq_pvs(saw_name, "INIT") ||
749 sv_eq_pvs(saw_name, "CHECK") ||
750 sv_eq_pvs(saw_name, "UNITCHECK")
752 builtin_attrs |= MY_ATTR_SPECIAL;
756 } else if (!(spec->flags & FLAG_ANON_OK)) {
757 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - PL_parser->bufptr), PL_parser->bufptr);
759 sv_catpvs(declarator, " (anon)");
762 /* we're a subroutine declaration */
763 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
764 SAVEFREESV(PL_compcv);
766 /* create outer block: '{' */
767 save_ix = S_block_start(aTHX_ TRUE);
769 /* initialize synthetic optree */
770 Newx(prelude_sentinel, 1, OP *);
771 *prelude_sentinel = NULL;
772 SAVEDESTRUCTOR_X(free_ptr_op, prelude_sentinel);
777 c = lex_peek_unichar(0);
781 Newx(init_sentinel, 1, OP *);
782 *init_sentinel = NULL;
783 SAVEDESTRUCTOR_X(free_ptr_op, init_sentinel);
785 Newx(param_spec, 1, ParamSpec);
787 SAVEDESTRUCTOR_X(ps_free_void, param_spec);
792 while ((c = lex_peek_unichar(0)) != ')') {
798 padoff = parse_param(aTHX_ declarator, spec, param_spec, &flags, &name, init_sentinel);
802 sigil = SvPV_nolen(name)[0];
804 /* internal consistency */
805 if (flags & PARAM_NAMED) {
806 if (flags & PARAM_INVOCANT) {
807 croak("In %"SVf": invocant %"SVf" can't be a named parameter", SVfARG(declarator), SVfARG(name));
810 croak("In %"SVf": named parameter %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
812 } else if (flags & PARAM_INVOCANT) {
813 if (*init_sentinel) {
814 croak("In %"SVf": invocant %"SVf" can't have a default value", SVfARG(declarator), SVfARG(name));
817 croak("In %"SVf": invocant %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
819 } else if (sigil != '$' && *init_sentinel) {
820 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(name));
823 /* external constraints */
824 if (param_spec->slurpy.name) {
825 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(param_spec->slurpy.name), SVfARG(name));
828 assert(!*init_sentinel);
829 param_spec->slurpy.name = name;
830 param_spec->slurpy.padoff = padoff;
834 if (!(flags & PARAM_NAMED) && count_named_params(param_spec)) {
835 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));
838 if (flags & PARAM_INVOCANT) {
839 if (param_spec->invocant.name) {
840 croak("In %"SVf": invalid double invocants %"SVf", %"SVf"", SVfARG(declarator), SVfARG(param_spec->invocant.name), SVfARG(name));
842 if (count_positional_params(param_spec) || count_named_params(param_spec)) {
843 croak("In %"SVf": invocant %"SVf" must be first in parameter list", SVfARG(declarator), SVfARG(name));
845 if (!(spec->flags & FLAG_INVOCANT)) {
846 croak("In %"SVf": invocant %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
848 param_spec->invocant.name = name;
849 param_spec->invocant.padoff = padoff;
853 if (*init_sentinel && !(spec->flags & FLAG_DEFAULT_ARGS)) {
854 croak("In %"SVf": default argument for %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
857 if (ps_contains(aTHX_ param_spec, name)) {
858 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(name));
861 if (flags & PARAM_NAMED) {
862 if (!(spec->flags & FLAG_NAMED_PARAMS)) {
863 croak("In %"SVf": named parameter :%"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
866 if (*init_sentinel) {
867 ParamInit *pi = piv_extend(¶m_spec->named_optional);
868 pi->param.name = name;
869 pi->param.padoff = padoff;
870 pi->init = *init_sentinel;
871 *init_sentinel = NULL;
872 param_spec->named_optional.used++;
874 if (param_spec->positional_optional.used) {
875 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));
878 Param *p = pv_extend(¶m_spec->named_required);
881 param_spec->named_required.used++;
884 if (*init_sentinel || param_spec->positional_optional.used) {
885 ParamInit *pi = piv_extend(¶m_spec->positional_optional);
886 pi->param.name = name;
887 pi->param.padoff = padoff;
888 pi->init = *init_sentinel;
889 *init_sentinel = NULL;
890 param_spec->positional_optional.used++;
892 Param *p = pv_extend(¶m_spec->positional_required);
895 param_spec->positional_required.used++;
902 *init_sentinel = NULL;
904 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
905 if (ps_contains(aTHX_ param_spec, spec->shift)) {
906 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(spec->shift));
909 param_spec->invocant.name = spec->shift;
910 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
916 c = lex_peek_unichar(0);
921 c = lex_peek_unichar(0);
923 lex_stuff_pvs(":", 0);
927 if (!(proto = my_scan_parens_tail(aTHX_ FALSE))) {
928 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
930 my_check_prototype(aTHX_ declarator, proto);
932 c = lex_peek_unichar(0);
933 if (!(c == ':' || c == '{')) {
934 lex_stuff_pvs(":", 0);
941 Newx(attrs_sentinel, 1, OP *);
942 *attrs_sentinel = NULL;
943 SAVEDESTRUCTOR_X(free_ptr_op, attrs_sentinel);
945 if (c == ':' || c == '{') /* '}' - hi, vim */ {
947 /* kludge default attributes in */
948 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
949 lex_stuff_sv(spec->attrs, 0);
956 c = lex_peek_unichar(0);
961 if (!(attr = my_scan_word(aTHX_ FALSE))) {
966 c = lex_peek_unichar(0);
969 if (sv_eq_pvs(attr, "lvalue")) {
970 builtin_attrs |= MY_ATTR_LVALUE;
972 } else if (sv_eq_pvs(attr, "method")) {
973 builtin_attrs |= MY_ATTR_METHOD;
979 if (!(sv = my_scan_parens_tail(aTHX_ TRUE))) {
980 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
982 sv_catpvs(attr, "(");
984 sv_catpvs(attr, ")");
987 c = lex_peek_unichar(0);
991 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(attr)));
997 c = lex_peek_unichar(0);
1004 if (c != '{') /* '}' - hi, vim */ {
1005 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
1008 /* surprise predeclaration! */
1010 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
1011 starts parsing the body */
1012 const I32 sub_ix = start_subparse(FALSE, 0);
1013 SAVEFREESV(PL_compcv);
1015 SvREFCNT_inc_simple_void(PL_compcv);
1019 mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(saw_name)),
1020 proto ? mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(proto)) : NULL,
1026 if (builtin_attrs & MY_ATTR_LVALUE) {
1027 CvLVALUE_on(PL_compcv);
1029 if (builtin_attrs & MY_ATTR_METHOD) {
1030 CvMETHOD_on(PL_compcv);
1032 if (builtin_attrs & MY_ATTR_SPECIAL) {
1033 CvSPECIAL_on(PL_compcv);
1036 /* check number of arguments */
1037 if (spec->flags & FLAG_CHECK_NARGS) {
1041 amin = args_min(aTHX_ param_spec, spec);
1043 OP *chk, *cond, *err, *croak;
1045 err = mkconstsv(aTHX_ newSVpvf("Not enough arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amin));
1049 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1057 croak = newCVREF(OPf_WANT_SCALAR,
1058 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1059 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1060 op_append_elem(OP_LIST, err, croak));
1062 cond = newBINOP(OP_LT, 0,
1063 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1064 mkconstiv(aTHX_ amin));
1065 chk = newLOGOP(OP_AND, 0, cond, err);
1067 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1070 amax = args_max(param_spec);
1072 OP *chk, *cond, *err, *croak;
1074 err = mkconstsv(aTHX_ newSVpvf("Too many arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amax));
1078 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1088 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1090 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1091 op_append_elem(OP_LIST, err, croak));
1095 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1096 mkconstiv(aTHX_ amax)
1098 chk = newLOGOP(OP_AND, 0, cond, err);
1100 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1103 if (param_spec && (count_named_params(param_spec) || (param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%'))) {
1104 OP *chk, *cond, *err, *croak;
1105 const UV fixed = count_positional_params(param_spec) + !!param_spec->invocant.name;
1107 err = mkconstsv(aTHX_ newSVpvf("Odd number of paired arguments for %"SVf"", SVfARG(declarator)));
1111 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1113 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1114 op_append_elem(OP_LIST, err, croak));
1116 cond = newBINOP(OP_GT, 0,
1117 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1118 mkconstiv(aTHX_ fixed));
1119 cond = newLOGOP(OP_AND, 0,
1121 newBINOP(OP_MODULO, 0,
1123 ? newBINOP(OP_SUBTRACT, 0,
1124 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1125 mkconstiv(aTHX_ fixed))
1126 : newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1127 mkconstiv(aTHX_ 2)));
1128 chk = newLOGOP(OP_AND, 0, cond, err);
1130 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1135 /* my $invocant = shift; */
1136 if (SvTRUE(spec->shift)) {
1141 OPf_MOD | (OPpLVAL_INTRO << 8),
1142 pad_add_name_sv(spec->shift, 0, NULL, NULL)
1144 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1146 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1149 /* my $invocant = shift; */
1150 if (param_spec->invocant.name) {
1155 OPf_MOD | (OPpLVAL_INTRO << 8),
1156 param_spec->invocant.padoff
1158 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1160 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1163 /* my (...) = @_; */
1170 for (i = 0, lim = param_spec->positional_required.used; i < lim; i++) {
1171 OP *const var = my_var(
1173 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1174 param_spec->positional_required.data[i].padoff
1176 lhs = op_append_elem(OP_LIST, lhs, var);
1179 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1180 OP *const var = my_var(
1182 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1183 param_spec->positional_optional.data[i].param.padoff
1185 lhs = op_append_elem(OP_LIST, lhs, var);
1195 * 1) no named params
1202 * => synthetic %{rest}
1203 * 2.2) slurpy is a hash
1205 * 2.3) slurpy is an array
1206 * => synthetic %{rest}
1207 * remember to declare array later
1210 slurpy_hash = param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%';
1211 if (!count_named_params(param_spec)) {
1212 if (param_spec->slurpy.name) {
1213 padoff = param_spec->slurpy.padoff;
1214 type = slurpy_hash ? OP_PADHV : OP_PADAV;
1216 padoff = NOT_IN_PAD;
1219 } else if (slurpy_hash) {
1220 padoff = param_spec->slurpy.padoff;
1223 padoff = param_spec->rest_hash = pad_add_name_pvs("%{rest}", 0, NULL, NULL);
1227 if (padoff != NOT_IN_PAD) {
1228 OP *const var = my_var_g(
1231 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1235 lhs = op_append_elem(OP_LIST, lhs, var);
1237 if (type == OP_PADHV) {
1238 param_spec->rest_hash = padoff;
1245 lhs->op_flags |= OPf_PARENS;
1246 rhs = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
1248 *prelude_sentinel = op_append_list(
1249 OP_LINESEQ, *prelude_sentinel,
1252 newASSIGNOP(OPf_STACKED, lhs, 0, rhs)
1258 /* default positional arguments */
1265 req = param_spec->positional_required.used;
1266 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1267 ParamInit *cur = ¶m_spec->positional_optional.data[i];
1272 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1273 mkconstiv(aTHX_ req + i + 1)
1276 var = my_var(aTHX_ 0, cur->param.padoff);
1278 nest = op_append_list(
1280 newASSIGNOP(OPf_STACKED, var, 0, cur->init)
1291 *prelude_sentinel = op_append_list(
1292 OP_LINESEQ, *prelude_sentinel,
1297 /* named parameters */
1298 if (count_named_params(param_spec)) {
1301 assert(param_spec->rest_hash != NOT_IN_PAD);
1303 for (i = 0, lim = param_spec->named_required.used; i < lim; i++) {
1304 Param *cur = ¶m_spec->named_required.data[i];
1306 char *p = SvPV(cur->name, n);
1309 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1311 if (spec->flags & FLAG_CHECK_NARGS) {
1314 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1315 var = newUNOP(OP_DELETE, 0, var);
1317 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": missing named parameter: %.*s", SVfARG(declarator), (int)(n - 1), p + 1));
1320 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1322 croak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, croak));
1324 cond = newUNOP(OP_EXISTS, 0, cond);
1326 cond = newCONDOP(0, cond, var, croak);
1331 OPf_MOD | (OPpLVAL_INTRO << 8),
1334 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1336 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1339 for (i = 0, lim = param_spec->named_optional.used; i < lim; i++) {
1340 ParamInit *cur = ¶m_spec->named_optional.data[i];
1342 char *p = SvPV(cur->param.name, n);
1345 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1346 var = newUNOP(OP_DELETE, 0, var);
1348 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1349 cond = newUNOP(OP_EXISTS, 0, cond);
1351 cond = newCONDOP(0, cond, var, cur->init);
1356 OPf_MOD | (OPpLVAL_INTRO << 8),
1359 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1361 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1364 if (!param_spec->slurpy.name) {
1365 if (spec->flags & FLAG_CHECK_NARGS) {
1366 /* croak if %{rest} */
1367 OP *croak, *cond, *keys, *msg;
1369 keys = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1370 keys = newLISTOP(OP_SORT, 0, newOP(OP_PUSHMARK, 0), keys);
1372 OP *first, *mid, *last;
1376 mid = mkconstpvs(", ");
1377 mid->op_sibling = last;
1379 first = newOP(OP_PUSHMARK, 0);
1381 keys = newLISTOP(OP_JOIN, 0, first, mid);
1382 keys->op_targ = pad_alloc(OP_JOIN, SVs_PADTMP);
1383 ((LISTOP *)keys)->op_last = last;
1386 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": no such named parameter: ", SVfARG(declarator)));
1387 msg = newBINOP(OP_CONCAT, 0, msg, keys);
1391 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1393 croak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, croak));
1395 cond = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1396 croak = newCONDOP(0, cond, croak, NULL);
1398 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, croak));
1402 clear = newASSIGNOP(
1404 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1409 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1411 } else if (param_spec->slurpy.padoff != param_spec->rest_hash) {
1414 assert(SvPV_nolen(param_spec->slurpy.name)[0] == '@');
1419 OPf_MOD | (OPpLVAL_INTRO << 8),
1420 param_spec->slurpy.padoff
1423 var = newASSIGNOP(OPf_STACKED, var, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1425 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1427 clear = newASSIGNOP(
1429 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1434 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1439 /* finally let perl parse the actual subroutine body */
1440 body = parse_block(0);
1442 /* add '();' to make function return nothing by default */
1443 /* (otherwise the invisible parameter initialization can "leak" into
1444 the return value: fun ($x) {}->("asdf", 0) == 2) */
1445 if (*prelude_sentinel) {
1446 body = newSTATEOP(0, NULL, body);
1449 body = op_append_list(OP_LINESEQ, *prelude_sentinel, body);
1450 *prelude_sentinel = NULL;
1454 OP *const attrs = *attrs_sentinel;
1455 *attrs_sentinel = NULL;
1456 SvREFCNT_inc_simple_void(PL_compcv);
1458 /* close outer block: '}' */
1459 S_block_end(aTHX_ save_ix, body);
1462 *pop = newANONATTRSUB(
1464 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1468 return KEYWORD_PLUGIN_EXPR;
1473 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
1474 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1478 *pop = newOP(OP_NULL, 0);
1479 return KEYWORD_PLUGIN_STMT;
1483 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
1489 if (kw_flags(aTHX_ keyword_ptr, keyword_len, &spec)) {
1490 ret = parse_fun(aTHX_ op_ptr, keyword_ptr, keyword_len, &spec);
1492 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
1502 MODULE = Function::Parameters PACKAGE = Function::Parameters
1507 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
1509 newCONSTSUB(stash, "FLAG_NAME_OK", newSViv(FLAG_NAME_OK));
1510 newCONSTSUB(stash, "FLAG_ANON_OK", newSViv(FLAG_ANON_OK));
1511 newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
1512 newCONSTSUB(stash, "FLAG_CHECK_NARGS", newSViv(FLAG_CHECK_NARGS));
1513 newCONSTSUB(stash, "FLAG_INVOCANT", newSViv(FLAG_INVOCANT));
1514 newCONSTSUB(stash, "FLAG_NAMED_PARAMS", newSViv(FLAG_NAMED_PARAMS));
1515 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
1516 newCONSTSUB(stash, "HINTK_FLAGS_", newSVpvs(HINTK_FLAGS_));
1517 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
1518 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
1520 next_keyword_plugin = PL_keyword_plugin;
1521 PL_keyword_plugin = my_keyword_plugin;