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 DEFSTRUCT(Resource) {
113 void (*destroy)(pTHX_ void *);
116 typedef Resource *Sentinel[1];
118 static void sentinel_clear_void(pTHX_ void *p) {
122 cur->destroy(aTHX_ cur->data);
123 cur->data = (void *)"no";
130 static void sentinel_register(Sentinel sen, void *data, void (*destroy)(pTHX_ void *)) {
133 Newx(cur, 1, Resource);
135 cur->destroy = destroy;
140 static void my_sv_refcnt_dec_void(pTHX_ void *p) {
145 static SV *sentinel_mortalize(Sentinel sen, SV *sv) {
146 sentinel_register(sen, sv, my_sv_refcnt_dec_void);
150 static int kw_flags(pTHX_ Sentinel sen, const char *kw_ptr, STRLEN kw_len, KWSpec *spec) {
153 const char *p, *kw_active;
154 STRLEN kw_active_len;
157 spec->shift = sentinel_mortalize(sen, newSVpvs(""));
158 spec->attrs = sentinel_mortalize(sen, newSVpvs(""));
160 if (!(hints = GvHV(PL_hintgv))) {
163 if (!(psv = hv_fetchs(hints, HINTK_KEYWORDS, 0))) {
167 kw_active = SvPV(sv, kw_active_len);
168 if (kw_active_len <= kw_len) {
173 (p = strchr(p, *kw_ptr)) &&
174 p < kw_active + kw_active_len - kw_len;
178 (p == kw_active || p[-1] == ' ') &&
180 memcmp(kw_ptr, p, kw_len) == 0
183 #define FETCH_HINTK_INTO(NAME, PTR, LEN, X) STMT_START { \
184 const char *fk_ptr_; \
187 fk_sv_ = sentinel_mortalize(sen, newSVpvs(HINTK_ ## NAME)); \
188 sv_catpvn(fk_sv_, PTR, LEN); \
189 fk_ptr_ = SvPV(fk_sv_, fk_len_); \
190 if (!((X) = hv_fetch(hints, fk_ptr_, fk_len_, 0))) { \
191 croak("%s: internal error: $^H{'%.*s'} not set", MY_PKG, (int)fk_len_, fk_ptr_); \
195 FETCH_HINTK_INTO(FLAGS_, kw_ptr, kw_len, psv);
196 spec->flags = SvIV(*psv);
198 FETCH_HINTK_INTO(SHIFT_, kw_ptr, kw_len, psv);
199 SvSetSV(spec->shift, *psv);
201 FETCH_HINTK_INTO(ATTRS_, kw_ptr, kw_len, psv);
202 SvSetSV(spec->attrs, *psv);
204 #undef FETCH_HINTK_INTO
212 static void free_ptr_op(pTHX_ void *vp) {
218 #define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
220 static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
222 const char *sv_p = SvPV(sv, sv_len);
223 return memcmp(sv_p, p, n) == 0;
227 #include "padop_on_crack.c.inc"
231 MY_ATTR_LVALUE = 0x01,
232 MY_ATTR_METHOD = 0x02,
233 MY_ATTR_SPECIAL = 0x04
236 static void my_sv_cat_c(pTHX_ SV *sv, U32 c) {
237 char ds[UTF8_MAXBYTES + 1], *d;
238 d = (char *)uvchr_to_utf8((U8 *)ds, c);
242 sv_catpvn(sv, ds, d - ds);
245 static bool my_is_uni_xidfirst(pTHX_ UV c) {
246 U8 tmpbuf[UTF8_MAXBYTES + 1];
247 uvchr_to_utf8(tmpbuf, c);
248 return is_utf8_xidfirst(tmpbuf);
251 static bool my_is_uni_xidcont(pTHX_ UV c) {
252 U8 tmpbuf[UTF8_MAXBYTES + 1];
253 uvchr_to_utf8(tmpbuf, c);
254 return is_utf8_xidcont(tmpbuf);
257 static SV *my_scan_word(pTHX_ Sentinel sen, bool allow_package) {
258 bool at_start, at_substart;
260 SV *sv = sentinel_mortalize(sen, newSVpvs(""));
265 at_start = at_substart = TRUE;
266 c = lex_peek_unichar(0);
269 if (at_substart ? my_is_uni_xidfirst(aTHX_ c) : my_is_uni_xidcont(aTHX_ c)) {
271 my_sv_cat_c(aTHX_ sv, c);
273 c = lex_peek_unichar(0);
274 } else if (allow_package && !at_substart && c == '\'') {
276 c = lex_peek_unichar(0);
277 if (!my_is_uni_xidfirst(aTHX_ c)) {
278 lex_stuff_pvs("'", 0);
283 } else if (allow_package && (at_start || !at_substart) && c == ':') {
285 if (lex_peek_unichar(0) != ':') {
286 lex_stuff_pvs(":", 0);
290 c = lex_peek_unichar(0);
291 if (!my_is_uni_xidfirst(aTHX_ c)) {
292 lex_stuff_pvs("::", 0);
303 return SvCUR(sv) ? sv : NULL;
306 static SV *my_scan_parens_tail(pTHX_ Sentinel sen, bool keep_backslash) {
311 start = CopLINE(PL_curcop);
313 sv = sentinel_mortalize(sen, newSVpvs(""));
320 c = lex_read_unichar(0);
322 CopLINE_set(PL_curcop, start);
327 c = lex_read_unichar(0);
329 CopLINE_set(PL_curcop, start);
332 if (keep_backslash || (c != '(' && c != ')')) {
335 } else if (c == '(') {
337 } else if (c == ')') {
344 my_sv_cat_c(aTHX_ sv, c);
350 static void my_check_prototype(pTHX_ Sentinel sen, const SV *declarator, SV *proto) {
351 char *start, *r, *w, *end;
355 start = SvPV(proto, len);
358 for (w = r = start; r < end; r++) {
364 SvCUR_set(proto, w - start);
368 if (!ckWARN(WARN_ILLEGALPROTO)) {
372 /* check for bad characters */
373 if (strspn(start, "$@%*;[]&\\_+") != len) {
374 SV *dsv = sentinel_mortalize(sen, newSVpvs(""));
376 packWARN(WARN_ILLEGALPROTO),
377 "Illegal character in prototype for %"SVf" : %s",
386 : pv_pretty(dsv, start, len, 60, NULL, NULL,
387 PERL_PV_ESCAPE_NONASCII
393 for (r = start; r < end; r++) {
397 packWARN(WARN_ILLEGALPROTO),
398 "Illegal character in prototype for %"SVf" : %s",
399 SVfARG(declarator), r
404 if (r[1] && !strchr(";@%", *r)) {
406 packWARN(WARN_ILLEGALPROTO),
407 "Illegal character after '_' in prototype for %"SVf" : %s",
408 SVfARG(declarator), r
418 packWARN(WARN_ILLEGALPROTO),
419 "prototype after '%c' for %"SVf": %s",
420 *r, SVfARG(declarator), r + 1
428 if (strchr("$@%&*", *r)) {
433 for (; r < end && *r != ']'; r++) {
434 if (!strchr("$@%&*", *r)) {
438 if (*r == ']' && r[-1] != '[') {
443 packWARN(WARN_ILLEGALPROTO),
444 "Illegal character after '\\' in prototype for %"SVf" : %s",
445 SVfARG(declarator), r
465 DEFSTRUCT(ParamInit) {
470 #define VEC(B) B ## _Vec
472 #define DEFVECTOR(B) DEFSTRUCT(VEC(B)) { \
478 DEFVECTOR(ParamInit);
480 #define DEFVECTOR_INIT(N, B) static void N(VEC(B) *p) { \
483 Newx(p->data, p->size, B); \
484 } static void N(VEC(B) *)
486 DEFSTRUCT(ParamSpec) {
488 VEC(Param) positional_required;
489 VEC(ParamInit) positional_optional;
490 VEC(Param) named_required;
491 VEC(ParamInit) named_optional;
496 DEFVECTOR_INIT(pv_init, Param);
497 DEFVECTOR_INIT(piv_init, ParamInit);
499 static void p_init(Param *p) {
501 p->padoff = NOT_IN_PAD;
504 static void ps_init(ParamSpec *ps) {
505 p_init(&ps->invocant);
506 pv_init(&ps->positional_required);
507 piv_init(&ps->positional_optional);
508 pv_init(&ps->named_required);
509 piv_init(&ps->named_optional);
511 ps->rest_hash = NOT_IN_PAD;
514 #define DEFVECTOR_EXTEND(N, B) static B (*N(VEC(B) *p)) { \
515 assert(p->used <= p->size); \
516 if (p->used == p->size) { \
517 const size_t n = p->size / 2 * 3 + 1; \
518 Renew(p->data, n, B); \
521 return &p->data[p->used]; \
522 } static B (*N(VEC(B) *))
524 DEFVECTOR_EXTEND(pv_extend, Param);
525 DEFVECTOR_EXTEND(piv_extend, ParamInit);
527 #define DEFVECTOR_CLEAR(N, B, F) static void N(pTHX_ VEC(B) *p) { \
530 F(aTHX_ &p->data[p->used]); \
535 } static void N(pTHX_ VEC(B) *)
537 static void p_clear(pTHX_ Param *p) {
539 p->padoff = NOT_IN_PAD;
542 static void pi_clear(pTHX_ ParamInit *pi) {
543 p_clear(aTHX_ &pi->param);
550 DEFVECTOR_CLEAR(pv_clear, Param, p_clear);
551 DEFVECTOR_CLEAR(piv_clear, ParamInit, pi_clear);
553 static void ps_clear(pTHX_ ParamSpec *ps) {
554 p_clear(aTHX_ &ps->invocant);
556 pv_clear(aTHX_ &ps->positional_required);
557 piv_clear(aTHX_ &ps->positional_optional);
559 pv_clear(aTHX_ &ps->named_required);
560 piv_clear(aTHX_ &ps->named_optional);
562 p_clear(aTHX_ &ps->slurpy);
565 static int ps_contains(pTHX_ const ParamSpec *ps, SV *sv) {
568 if (ps->invocant.name && sv_eq(sv, ps->invocant.name)) {
572 for (i = 0, lim = ps->positional_required.used; i < lim; i++) {
573 if (sv_eq(sv, ps->positional_required.data[i].name)) {
578 for (i = 0, lim = ps->positional_optional.used; i < lim; i++) {
579 if (sv_eq(sv, ps->positional_optional.data[i].param.name)) {
584 for (i = 0, lim = ps->named_required.used; i < lim; i++) {
585 if (sv_eq(sv, ps->named_required.data[i].name)) {
590 for (i = 0, lim = ps->named_optional.used; i < lim; i++) {
591 if (sv_eq(sv, ps->named_optional.data[i].param.name)) {
599 static void ps_free_void(pTHX_ void *p) {
604 static int args_min(pTHX_ const ParamSpec *ps, const KWSpec *ks) {
607 return SvTRUE(ks->shift) ? 1 : 0;
609 if (ps->invocant.name) {
612 n += ps->positional_required.used;
613 n += ps->named_required.used * 2;
617 static int args_max(const ParamSpec *ps) {
622 if (ps->invocant.name) {
625 n += ps->positional_required.used;
626 n += ps->positional_optional.used;
627 if (ps->named_required.used || ps->named_optional.used || ps->slurpy.name) {
633 static size_t count_positional_params(const ParamSpec *ps) {
634 return ps->positional_required.used + ps->positional_optional.used;
637 static size_t count_named_params(const ParamSpec *ps) {
638 return ps->named_required.used + ps->named_optional.used;
642 PARAM_INVOCANT = 0x01,
646 /* *pinit must be NULL on entry.
647 * caller must free *pinit on error.
649 static PADOFFSET parse_param(
652 const SV *declarator, const KWSpec *spec, ParamSpec *param_spec,
653 int *pflags, SV **pname, OP **pinit
662 c = lex_peek_unichar(0);
668 *pflags |= PARAM_NAMED;
670 c = lex_peek_unichar(0);
674 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
676 if (!(c == '$' || c == '@' || c == '%')) {
677 croak("In %"SVf": unexpected '%c' in parameter list (expecting a sigil)", SVfARG(declarator), (int)c);
685 if (!(name = my_scan_word(aTHX_ sen, FALSE))) {
686 croak("In %"SVf": missing identifier after '%c'", SVfARG(declarator), sigil);
688 sv_insert(name, 0, 0, &sigil, 1);
692 c = lex_peek_unichar(0);
699 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
700 param_spec->invocant.name = spec->shift;
701 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
704 *pinit = parse_termexpr(0);
707 c = lex_peek_unichar(0);
711 *pflags |= PARAM_INVOCANT;
714 } else if (c == ',') {
717 } else if (c != ')') {
719 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
721 croak("In %"SVf": unexpected '%c' in parameter list (expecting ',')", SVfARG(declarator), (int)c);
724 return pad_add_name_sv(*pname, IF_HAVE_PERL_5_16(padadd_NO_DUP_CHECK, 0), NULL, NULL);
727 static OP *my_var_g(pTHX_ I32 type, I32 flags, PADOFFSET padoff) {
728 OP *var = newOP(type, flags);
729 var->op_targ = padoff;
733 static OP *my_var(pTHX_ I32 flags, PADOFFSET padoff) {
734 return my_var_g(aTHX_ OP_PADSV, flags, padoff);
737 static OP *mkhvelem(pTHX_ PADOFFSET h, OP *k) {
738 OP *hv = my_var_g(aTHX_ OP_PADHV, OPf_REF, h);
739 return newBINOP(OP_HELEM, 0, hv, k);
742 static OP *mkconstsv(pTHX_ SV *sv) {
743 return newSVOP(OP_CONST, 0, sv);
746 static OP *mkconstiv(pTHX_ IV i) {
747 return mkconstsv(aTHX_ newSViv(i));
750 static OP *mkconstpv(pTHX_ const char *p, size_t n) {
751 return mkconstsv(aTHX_ newSVpv(p, n));
754 #define mkconstpvs(S) mkconstpv(aTHX_ "" S "", sizeof S - 1)
756 static int parse_fun(pTHX_ Sentinel sen, OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
757 ParamSpec *param_spec;
762 OP **prelude_sentinel;
764 OP **attrs_sentinel, *body;
765 unsigned builtin_attrs;
768 declarator = sentinel_mortalize(sen, newSVpvn(keyword_ptr, keyword_len));
776 if ((spec->flags & FLAG_NAME_OK) && (saw_name = my_scan_word(aTHX_ sen, TRUE))) {
778 if (PL_parser->expect != XSTATE) {
779 /* bail out early so we don't predeclare $saw_name */
780 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
783 sv_catpvs(declarator, " ");
784 sv_catsv(declarator, saw_name);
787 sv_eq_pvs(saw_name, "BEGIN") ||
788 sv_eq_pvs(saw_name, "END") ||
789 sv_eq_pvs(saw_name, "INIT") ||
790 sv_eq_pvs(saw_name, "CHECK") ||
791 sv_eq_pvs(saw_name, "UNITCHECK")
793 builtin_attrs |= MY_ATTR_SPECIAL;
797 } else if (!(spec->flags & FLAG_ANON_OK)) {
798 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - PL_parser->bufptr), PL_parser->bufptr);
800 sv_catpvs(declarator, " (anon)");
803 /* we're a subroutine declaration */
804 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
805 SAVEFREESV(PL_compcv);
807 /* create outer block: '{' */
808 save_ix = S_block_start(aTHX_ TRUE);
810 /* initialize synthetic optree */
811 Newx(prelude_sentinel, 1, OP *);
812 *prelude_sentinel = NULL;
813 sentinel_register(sen, prelude_sentinel, free_ptr_op);
818 c = lex_peek_unichar(0);
822 Newx(init_sentinel, 1, OP *);
823 *init_sentinel = NULL;
824 sentinel_register(sen, init_sentinel, free_ptr_op);
826 Newx(param_spec, 1, ParamSpec);
828 sentinel_register(sen, param_spec, ps_free_void);
833 while ((c = lex_peek_unichar(0)) != ')') {
839 padoff = parse_param(aTHX_ sen, declarator, spec, param_spec, &flags, &name, init_sentinel);
843 sigil = SvPV_nolen(name)[0];
845 /* internal consistency */
846 if (flags & PARAM_NAMED) {
847 if (flags & PARAM_INVOCANT) {
848 croak("In %"SVf": invocant %"SVf" can't be a named parameter", SVfARG(declarator), SVfARG(name));
851 croak("In %"SVf": named parameter %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
853 } else if (flags & PARAM_INVOCANT) {
854 if (*init_sentinel) {
855 croak("In %"SVf": invocant %"SVf" can't have a default value", SVfARG(declarator), SVfARG(name));
858 croak("In %"SVf": invocant %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
860 } else if (sigil != '$' && *init_sentinel) {
861 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(name));
864 /* external constraints */
865 if (param_spec->slurpy.name) {
866 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(param_spec->slurpy.name), SVfARG(name));
869 assert(!*init_sentinel);
870 param_spec->slurpy.name = name;
871 param_spec->slurpy.padoff = padoff;
875 if (!(flags & PARAM_NAMED) && count_named_params(param_spec)) {
876 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));
879 if (flags & PARAM_INVOCANT) {
880 if (param_spec->invocant.name) {
881 croak("In %"SVf": invalid double invocants %"SVf", %"SVf"", SVfARG(declarator), SVfARG(param_spec->invocant.name), SVfARG(name));
883 if (count_positional_params(param_spec) || count_named_params(param_spec)) {
884 croak("In %"SVf": invocant %"SVf" must be first in parameter list", SVfARG(declarator), SVfARG(name));
886 if (!(spec->flags & FLAG_INVOCANT)) {
887 croak("In %"SVf": invocant %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
889 param_spec->invocant.name = name;
890 param_spec->invocant.padoff = padoff;
894 if (*init_sentinel && !(spec->flags & FLAG_DEFAULT_ARGS)) {
895 croak("In %"SVf": default argument for %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
898 if (ps_contains(aTHX_ param_spec, name)) {
899 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(name));
902 if (flags & PARAM_NAMED) {
903 if (!(spec->flags & FLAG_NAMED_PARAMS)) {
904 croak("In %"SVf": named parameter :%"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
907 if (*init_sentinel) {
908 ParamInit *pi = piv_extend(¶m_spec->named_optional);
909 pi->param.name = name;
910 pi->param.padoff = padoff;
911 pi->init = *init_sentinel;
912 *init_sentinel = NULL;
913 param_spec->named_optional.used++;
917 if (param_spec->positional_optional.used) {
918 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));
921 p = pv_extend(¶m_spec->named_required);
924 param_spec->named_required.used++;
927 if (*init_sentinel || param_spec->positional_optional.used) {
928 ParamInit *pi = piv_extend(¶m_spec->positional_optional);
929 pi->param.name = name;
930 pi->param.padoff = padoff;
931 pi->init = *init_sentinel;
932 *init_sentinel = NULL;
933 param_spec->positional_optional.used++;
935 Param *p = pv_extend(¶m_spec->positional_required);
938 param_spec->positional_required.used++;
945 *init_sentinel = NULL;
947 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
948 if (ps_contains(aTHX_ param_spec, spec->shift)) {
949 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(spec->shift));
952 param_spec->invocant.name = spec->shift;
953 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
959 c = lex_peek_unichar(0);
964 c = lex_peek_unichar(0);
966 lex_stuff_pvs(":", 0);
970 if (!(proto = my_scan_parens_tail(aTHX_ sen, FALSE))) {
971 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
973 my_check_prototype(aTHX_ sen, declarator, proto);
975 c = lex_peek_unichar(0);
976 if (!(c == ':' || c == '{')) {
977 lex_stuff_pvs(":", 0);
984 Newx(attrs_sentinel, 1, OP *);
985 *attrs_sentinel = NULL;
986 sentinel_register(sen, attrs_sentinel, free_ptr_op);
988 if (c == ':' || c == '{') /* '}' - hi, vim */ {
990 /* kludge default attributes in */
991 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
992 lex_stuff_sv(spec->attrs, 0);
999 c = lex_peek_unichar(0);
1004 if (!(attr = my_scan_word(aTHX_ sen, FALSE))) {
1009 c = lex_peek_unichar(0);
1012 if (sv_eq_pvs(attr, "lvalue")) {
1013 builtin_attrs |= MY_ATTR_LVALUE;
1015 } else if (sv_eq_pvs(attr, "method")) {
1016 builtin_attrs |= MY_ATTR_METHOD;
1021 lex_read_unichar(0);
1022 if (!(sv = my_scan_parens_tail(aTHX_ sen, TRUE))) {
1023 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
1025 sv_catpvs(attr, "(");
1027 sv_catpvs(attr, ")");
1030 c = lex_peek_unichar(0);
1034 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(attr)));
1038 lex_read_unichar(0);
1040 c = lex_peek_unichar(0);
1047 if (c != '{') /* '}' - hi, vim */ {
1048 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
1051 /* surprise predeclaration! */
1053 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
1054 starts parsing the body */
1055 const I32 sub_ix = start_subparse(FALSE, 0);
1056 SAVEFREESV(PL_compcv);
1058 SvREFCNT_inc_simple_void(PL_compcv);
1062 mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(saw_name)),
1063 proto ? mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(proto)) : NULL,
1069 if (builtin_attrs & MY_ATTR_LVALUE) {
1070 CvLVALUE_on(PL_compcv);
1072 if (builtin_attrs & MY_ATTR_METHOD) {
1073 CvMETHOD_on(PL_compcv);
1075 if (builtin_attrs & MY_ATTR_SPECIAL) {
1076 CvSPECIAL_on(PL_compcv);
1079 /* check number of arguments */
1080 if (spec->flags & FLAG_CHECK_NARGS) {
1083 amin = args_min(aTHX_ param_spec, spec);
1085 OP *chk, *cond, *err, *xcroak;
1087 err = mkconstsv(aTHX_ newSVpvf("Not enough arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amin));
1091 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1099 xcroak = newCVREF(OPf_WANT_SCALAR,
1100 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1101 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1102 op_append_elem(OP_LIST, err, xcroak));
1104 cond = newBINOP(OP_LT, 0,
1105 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1106 mkconstiv(aTHX_ amin));
1107 chk = newLOGOP(OP_AND, 0, cond, err);
1109 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1112 amax = args_max(param_spec);
1114 OP *chk, *cond, *err, *xcroak;
1116 err = mkconstsv(aTHX_ newSVpvf("Too many arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amax));
1120 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1130 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1132 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1133 op_append_elem(OP_LIST, err, xcroak));
1137 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1138 mkconstiv(aTHX_ amax)
1140 chk = newLOGOP(OP_AND, 0, cond, err);
1142 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1145 if (param_spec && (count_named_params(param_spec) || (param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%'))) {
1146 OP *chk, *cond, *err, *xcroak;
1147 const UV fixed = count_positional_params(param_spec) + !!param_spec->invocant.name;
1149 err = mkconstsv(aTHX_ newSVpvf("Odd number of paired arguments for %"SVf"", SVfARG(declarator)));
1153 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1155 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1156 op_append_elem(OP_LIST, err, xcroak));
1158 cond = newBINOP(OP_GT, 0,
1159 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1160 mkconstiv(aTHX_ fixed));
1161 cond = newLOGOP(OP_AND, 0,
1163 newBINOP(OP_MODULO, 0,
1165 ? newBINOP(OP_SUBTRACT, 0,
1166 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1167 mkconstiv(aTHX_ fixed))
1168 : newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1169 mkconstiv(aTHX_ 2)));
1170 chk = newLOGOP(OP_AND, 0, cond, err);
1172 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1177 /* my $invocant = shift; */
1178 if (SvTRUE(spec->shift)) {
1183 OPf_MOD | (OPpLVAL_INTRO << 8),
1184 pad_add_name_sv(spec->shift, 0, NULL, NULL)
1186 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1188 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1191 /* my $invocant = shift; */
1192 if (param_spec->invocant.name) {
1197 OPf_MOD | (OPpLVAL_INTRO << 8),
1198 param_spec->invocant.padoff
1200 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1202 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1205 /* my (...) = @_; */
1212 for (i = 0, lim = param_spec->positional_required.used; i < lim; i++) {
1213 OP *const var = my_var(
1215 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1216 param_spec->positional_required.data[i].padoff
1218 lhs = op_append_elem(OP_LIST, lhs, var);
1221 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1222 OP *const var = my_var(
1224 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1225 param_spec->positional_optional.data[i].param.padoff
1227 lhs = op_append_elem(OP_LIST, lhs, var);
1237 * 1) no named params
1244 * => synthetic %{rest}
1245 * 2.2) slurpy is a hash
1247 * 2.3) slurpy is an array
1248 * => synthetic %{rest}
1249 * remember to declare array later
1252 slurpy_hash = param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%';
1253 if (!count_named_params(param_spec)) {
1254 if (param_spec->slurpy.name) {
1255 padoff = param_spec->slurpy.padoff;
1256 type = slurpy_hash ? OP_PADHV : OP_PADAV;
1258 padoff = NOT_IN_PAD;
1261 } else if (slurpy_hash) {
1262 padoff = param_spec->slurpy.padoff;
1265 padoff = param_spec->rest_hash = pad_add_name_pvs("%{rest}", 0, NULL, NULL);
1269 if (padoff != NOT_IN_PAD) {
1270 OP *const var = my_var_g(
1273 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1277 lhs = op_append_elem(OP_LIST, lhs, var);
1279 if (type == OP_PADHV) {
1280 param_spec->rest_hash = padoff;
1287 lhs->op_flags |= OPf_PARENS;
1288 rhs = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
1290 *prelude_sentinel = op_append_list(
1291 OP_LINESEQ, *prelude_sentinel,
1294 newASSIGNOP(OPf_STACKED, lhs, 0, rhs)
1300 /* default positional arguments */
1307 req = param_spec->positional_required.used;
1308 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1309 ParamInit *cur = ¶m_spec->positional_optional.data[i];
1314 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1315 mkconstiv(aTHX_ req + i + 1)
1318 var = my_var(aTHX_ 0, cur->param.padoff);
1320 nest = op_append_list(
1322 newASSIGNOP(OPf_STACKED, var, 0, cur->init)
1333 *prelude_sentinel = op_append_list(
1334 OP_LINESEQ, *prelude_sentinel,
1339 /* named parameters */
1340 if (count_named_params(param_spec)) {
1343 assert(param_spec->rest_hash != NOT_IN_PAD);
1345 for (i = 0, lim = param_spec->named_required.used; i < lim; i++) {
1346 Param *cur = ¶m_spec->named_required.data[i];
1348 char *p = SvPV(cur->name, n);
1351 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1353 if (spec->flags & FLAG_CHECK_NARGS) {
1356 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1357 var = newUNOP(OP_DELETE, 0, var);
1359 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": missing named parameter: %.*s", SVfARG(declarator), (int)(n - 1), p + 1));
1362 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1364 xcroak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, xcroak));
1366 cond = newUNOP(OP_EXISTS, 0, cond);
1368 cond = newCONDOP(0, cond, var, xcroak);
1373 OPf_MOD | (OPpLVAL_INTRO << 8),
1376 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1378 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1381 for (i = 0, lim = param_spec->named_optional.used; i < lim; i++) {
1382 ParamInit *cur = ¶m_spec->named_optional.data[i];
1384 char *p = SvPV(cur->param.name, n);
1387 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1388 var = newUNOP(OP_DELETE, 0, var);
1390 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1391 cond = newUNOP(OP_EXISTS, 0, cond);
1393 cond = newCONDOP(0, cond, var, cur->init);
1398 OPf_MOD | (OPpLVAL_INTRO << 8),
1401 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1403 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1406 if (!param_spec->slurpy.name) {
1407 if (spec->flags & FLAG_CHECK_NARGS) {
1408 /* croak if %{rest} */
1409 OP *xcroak, *cond, *keys, *msg;
1411 keys = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1412 keys = newLISTOP(OP_SORT, 0, newOP(OP_PUSHMARK, 0), keys);
1414 OP *first, *mid, *last;
1418 mid = mkconstpvs(", ");
1419 mid->op_sibling = last;
1421 first = newOP(OP_PUSHMARK, 0);
1423 keys = newLISTOP(OP_JOIN, 0, first, mid);
1424 keys->op_targ = pad_alloc(OP_JOIN, SVs_PADTMP);
1425 ((LISTOP *)keys)->op_last = last;
1428 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": no such named parameter: ", SVfARG(declarator)));
1429 msg = newBINOP(OP_CONCAT, 0, msg, keys);
1433 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1435 xcroak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, xcroak));
1437 cond = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1438 xcroak = newCONDOP(0, cond, xcroak, NULL);
1440 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, xcroak));
1444 clear = newASSIGNOP(
1446 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1451 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1453 } else if (param_spec->slurpy.padoff != param_spec->rest_hash) {
1456 assert(SvPV_nolen(param_spec->slurpy.name)[0] == '@');
1461 OPf_MOD | (OPpLVAL_INTRO << 8),
1462 param_spec->slurpy.padoff
1465 var = newASSIGNOP(OPf_STACKED, var, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1467 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1469 clear = newASSIGNOP(
1471 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1476 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1481 /* finally let perl parse the actual subroutine body */
1482 body = parse_block(0);
1484 /* add '();' to make function return nothing by default */
1485 /* (otherwise the invisible parameter initialization can "leak" into
1486 the return value: fun ($x) {}->("asdf", 0) == 2) */
1487 if (*prelude_sentinel) {
1488 body = newSTATEOP(0, NULL, body);
1491 body = op_append_list(OP_LINESEQ, *prelude_sentinel, body);
1492 *prelude_sentinel = NULL;
1496 OP *const attrs = *attrs_sentinel;
1497 *attrs_sentinel = NULL;
1498 SvREFCNT_inc_simple_void(PL_compcv);
1500 /* close outer block: '}' */
1501 S_block_end(aTHX_ save_ix, body);
1504 *pop = newANONATTRSUB(
1506 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1510 return KEYWORD_PLUGIN_EXPR;
1515 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
1516 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1520 *pop = newOP(OP_NULL, 0);
1521 return KEYWORD_PLUGIN_STMT;
1525 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
1528 Sentinel sen = { NULL };
1533 SAVEDESTRUCTOR_X(sentinel_clear_void, sen);
1535 if (kw_flags(aTHX_ sen, keyword_ptr, keyword_len, &spec)) {
1536 ret = parse_fun(aTHX_ sen, op_ptr, keyword_ptr, keyword_len, &spec);
1538 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
1549 MODULE = Function::Parameters PACKAGE = Function::Parameters
1554 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
1556 newCONSTSUB(stash, "FLAG_NAME_OK", newSViv(FLAG_NAME_OK));
1557 newCONSTSUB(stash, "FLAG_ANON_OK", newSViv(FLAG_ANON_OK));
1558 newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
1559 newCONSTSUB(stash, "FLAG_CHECK_NARGS", newSViv(FLAG_CHECK_NARGS));
1560 newCONSTSUB(stash, "FLAG_INVOCANT", newSViv(FLAG_INVOCANT));
1561 newCONSTSUB(stash, "FLAG_NAMED_PARAMS", newSViv(FLAG_NAMED_PARAMS));
1562 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
1563 newCONSTSUB(stash, "HINTK_FLAGS_", newSVpvs(HINTK_FLAGS_));
1564 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
1565 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
1567 next_keyword_plugin = PL_keyword_plugin;
1568 PL_keyword_plugin = my_keyword_plugin;