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 #define MY_PKG "Function::Parameters"
68 #define HINTK_KEYWORDS MY_PKG "/keywords"
69 #define HINTK_FLAGS_ MY_PKG "/flags:"
70 #define HINTK_SHIFT_ MY_PKG "/shift:"
71 #define HINTK_ATTRS_ MY_PKG "/attrs:"
73 #define DEFSTRUCT(T) typedef struct T T; struct T
75 DEFSTRUCT(DefaultParamSpec) {
76 DefaultParamSpec *next;
85 FLAG_DEFAULT_ARGS = 0x04,
86 FLAG_CHECK_NARGS = 0x08
95 static int (*next_keyword_plugin)(pTHX_ char *, STRLEN, OP **);
97 static int kw_flags(pTHX_ const char *kw_ptr, STRLEN kw_len, KWSpec *spec) {
100 const char *p, *kw_active;
101 STRLEN kw_active_len;
104 spec->shift = sv_2mortal(newSVpvs(""));
105 spec->attrs = sv_2mortal(newSVpvs(""));
107 if (!(hints = GvHV(PL_hintgv))) {
110 if (!(psv = hv_fetchs(hints, HINTK_KEYWORDS, 0))) {
114 kw_active = SvPV(sv, kw_active_len);
115 if (kw_active_len <= kw_len) {
120 (p = strchr(p, *kw_ptr)) &&
121 p < kw_active + kw_active_len - kw_len;
125 (p == kw_active || p[-1] == ' ') &&
127 memcmp(kw_ptr, p, kw_len) == 0
130 #define FETCH_HINTK_INTO(NAME, PTR, LEN, X) STMT_START { \
131 const char *fk_ptr_; \
134 fk_sv_ = sv_2mortal(newSVpvs(HINTK_ ## NAME)); \
135 sv_catpvn(fk_sv_, PTR, LEN); \
136 fk_ptr_ = SvPV(fk_sv_, fk_len_); \
137 if (!((X) = hv_fetch(hints, fk_ptr_, fk_len_, 0))) { \
138 croak("%s: internal error: $^H{'%.*s'} not set", MY_PKG, (int)fk_len_, fk_ptr_); \
142 FETCH_HINTK_INTO(FLAGS_, kw_ptr, kw_len, psv);
143 spec->flags = SvIV(*psv);
145 FETCH_HINTK_INTO(SHIFT_, kw_ptr, kw_len, psv);
146 SvSetSV(spec->shift, *psv);
148 FETCH_HINTK_INTO(ATTRS_, kw_ptr, kw_len, psv);
149 SvSetSV(spec->attrs, *psv);
151 #undef FETCH_HINTK_INTO
159 static void free_defspec(pTHX_ void *vp) {
160 DefaultParamSpec *dp = vp;
165 static void free_ptr_op(pTHX_ void *vp) {
171 #define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
173 static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
175 const char *sv_p = SvPV(sv, sv_len);
176 return memcmp(sv_p, p, n) == 0;
180 #include "padop_on_crack.c.inc"
184 static PADOFFSET pad_add_my_sv(SV *name) {
191 myvar = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, 1);
192 offset = AvFILLp(PL_comppad);
195 SvUPGRADE(myvar, SVt_PVAV);
196 } else if (*p == '%') {
197 SvUPGRADE(myvar, SVt_PVHV);
199 PL_curpad = AvARRAY(PL_comppad);
200 namesv = newSV_type(SVt_PVMG);
201 sv_setpvn(namesv, p, len);
202 COP_SEQ_RANGE_LOW_set(namesv, PL_cop_seqmax);
203 COP_SEQ_RANGE_HIGH_set(namesv, PERL_PADSEQ_INTRO);
205 av_store(PL_comppad_name, offset, namesv);
211 MY_ATTR_LVALUE = 0x01,
212 MY_ATTR_METHOD = 0x02,
213 MY_ATTR_SPECIAL = 0x04
216 static void my_sv_cat_c(pTHX_ SV *sv, U32 c) {
217 char ds[UTF8_MAXBYTES + 1], *d;
218 d = uvchr_to_utf8(ds, c);
222 sv_catpvn(sv, ds, d - ds);
225 static bool my_is_uni_xidfirst(pTHX_ UV c) {
226 U8 tmpbuf[UTF8_MAXBYTES + 1];
227 uvchr_to_utf8(tmpbuf, c);
228 return is_utf8_xidfirst(tmpbuf);
231 static bool my_is_uni_xidcont(pTHX_ UV c) {
232 U8 tmpbuf[UTF8_MAXBYTES + 1];
233 uvchr_to_utf8(tmpbuf, c);
234 return is_utf8_xidcont(tmpbuf);
237 static SV *my_scan_word(pTHX_ bool allow_package) {
238 bool at_start, at_substart;
240 SV *sv = sv_2mortal(newSVpvs(""));
245 at_start = at_substart = TRUE;
246 c = lex_peek_unichar(0);
249 if (at_substart ? my_is_uni_xidfirst(aTHX_ c) : my_is_uni_xidcont(aTHX_ c)) {
251 my_sv_cat_c(aTHX_ sv, c);
253 c = lex_peek_unichar(0);
254 } else if (allow_package && !at_substart && c == '\'') {
256 c = lex_peek_unichar(0);
257 if (!my_is_uni_xidfirst(aTHX_ c)) {
258 lex_stuff_pvs("'", 0);
263 } else if (allow_package && (at_start || !at_substart) && c == ':') {
265 if (lex_peek_unichar(0) != ':') {
266 lex_stuff_pvs(":", 0);
270 c = lex_peek_unichar(0);
271 if (!my_is_uni_xidfirst(aTHX_ c)) {
272 lex_stuff_pvs("::", 0);
283 return SvCUR(sv) ? sv : NULL;
286 static SV *my_scan_parens_tail(pTHX_ bool keep_backslash) {
291 start = CopLINE(PL_curcop);
293 sv = sv_2mortal(newSVpvs(""));
300 c = lex_read_unichar(0);
302 CopLINE_set(PL_curcop, start);
307 c = lex_read_unichar(0);
309 CopLINE_set(PL_curcop, start);
312 if (keep_backslash || (c != '(' && c != ')')) {
315 } else if (c == '(') {
317 } else if (c == ')') {
324 my_sv_cat_c(aTHX_ sv, c);
330 static void my_check_prototype(pTHX_ const SV *declarator, SV *proto) {
331 char *start, *r, *w, *end;
335 start = SvPV(proto, len);
338 for (w = r = start; r < end; r++) {
344 SvCUR_set(proto, w - start);
348 if (!ckWARN(WARN_ILLEGALPROTO)) {
352 /* check for bad characters */
353 if (strspn(start, "$@%*;[]&\\_+") != len) {
354 SV *dsv = newSVpvs_flags("", SVs_TEMP);
356 packWARN(WARN_ILLEGALPROTO),
357 "Illegal character in prototype for %"SVf" : %s",
366 : pv_pretty(dsv, start, len, 60, NULL, NULL,
367 PERL_PV_ESCAPE_NONASCII
373 for (r = start; r < end; r++) {
377 packWARN(WARN_ILLEGALPROTO),
378 "Illegal character in prototype for %"SVf" : %s",
379 SVfARG(declarator), r
384 if (r[1] && !strchr(";@%", *r)) {
386 packWARN(WARN_ILLEGALPROTO),
387 "Illegal character after '_' in prototype for %"SVf" : %s",
388 SVfARG(declarator), r
398 packWARN(WARN_ILLEGALPROTO),
399 "prototype after '%c' for %"SVf": %s",
400 *r, SVfARG(declarator), r + 1
408 if (strchr("$@%&*", *r)) {
413 for (; r < end && *r != ']'; r++) {
414 if (!strchr("$@%&*", *r)) {
418 if (*r == ']' && r[-1] != '[') {
423 packWARN(WARN_ILLEGALPROTO),
424 "Illegal character after '\\' in prototype for %"SVf" : %s",
425 SVfARG(declarator), r
439 static int parse_fun(pTHX_ OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
444 OP **prelude_sentinel;
446 DefaultParamSpec *defaults;
447 int args_min, args_max;
449 OP **attrs_sentinel, *body;
450 unsigned builtin_attrs;
454 declarator = sv_2mortal(newSVpvn(keyword_ptr, keyword_len));
462 if ((spec->flags & FLAG_NAME_OK) && (saw_name = my_scan_word(aTHX_ TRUE))) {
464 if (PL_parser->expect != XSTATE) {
465 /* bail out early so we don't predeclare $saw_name */
466 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
469 sv_catpvs(declarator, " ");
470 sv_catsv(declarator, saw_name);
473 sv_eq_pvs(saw_name, "BEGIN") ||
474 sv_eq_pvs(saw_name, "END") ||
475 sv_eq_pvs(saw_name, "INIT") ||
476 sv_eq_pvs(saw_name, "CHECK") ||
477 sv_eq_pvs(saw_name, "UNITCHECK")
479 builtin_attrs |= MY_ATTR_SPECIAL;
483 } else if (!(spec->flags & FLAG_ANON_OK)) {
484 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - PL_parser->bufptr), PL_parser->bufptr);
486 sv_catpvs(declarator, " (anon)");
489 /* we're a subroutine declaration */
490 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
491 SAVEFREESV(PL_compcv);
493 /* create outer block: '{' */
494 save_ix = S_block_start(aTHX_ TRUE);
496 /* initialize synthetic optree */
497 Newx(prelude_sentinel, 1, OP *);
498 *prelude_sentinel = NULL;
499 SAVEDESTRUCTOR_X(free_ptr_op, prelude_sentinel);
508 if (SvTRUE(spec->shift)) {
511 var = newOP(OP_PADSV, OPf_MOD | (OPpLVAL_INTRO << 8));
512 var->op_targ = pad_add_name_sv(spec->shift, 0, NULL, NULL);
514 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
517 c = lex_peek_unichar(0);
519 DefaultParamSpec **pdefaults_tail = &defaults;
520 SV *saw_slurpy = NULL;
528 sv_2mortal((SV *)params);
531 c = lex_peek_unichar(0);
532 if (c == '$' || c == '@' || c == '%') {
533 const char sigil = c;
541 if (!(param = my_scan_word(aTHX_ FALSE))) {
542 croak("In %"SVf": missing identifier", SVfARG(declarator));
544 sv_insert(param, 0, 0, &sigil, 1);
546 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_slurpy), SVfARG(param));
554 av_push(params, SvREFCNT_inc_simple_NN(param));
557 c = lex_peek_unichar(0);
559 if (!(c == '=' && (spec->flags & FLAG_DEFAULT_ARGS))) {
560 if (sigil == '$' && !defaults) {
563 } else if (sigil != '$') {
564 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(saw_slurpy));
566 DefaultParamSpec *curdef;
571 Newx(curdef, 1, DefaultParamSpec);
573 curdef->limit = param_count;
574 curdef->name = param;
576 SAVEDESTRUCTOR_X(free_defspec, curdef);
578 curdef->next = *pdefaults_tail;
579 *pdefaults_tail = curdef;
580 pdefaults_tail = &curdef->next;
582 /* let perl parse the default parameter value */
583 curdef->init = parse_termexpr(0);
586 c = lex_peek_unichar(0);
593 var = newOP(OP_PADSV, OPf_MOD | (OPpLVAL_INTRO << 8));
594 var->op_targ = pad_add_name_sv(param, 0, NULL, NULL);
596 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
613 croak("In %"SVf": unexpected EOF in parameter list", SVfARG(declarator));
615 croak("In %"SVf": unexpected '%c' in parameter list", SVfARG(declarator), (int)c);
621 c = lex_peek_unichar(0);
626 c = lex_peek_unichar(0);
628 lex_stuff_pvs(":", 0);
632 if (!(proto = my_scan_parens_tail(aTHX_ FALSE))) {
633 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
635 my_check_prototype(aTHX_ declarator, proto);
637 c = lex_peek_unichar(0);
642 Newx(attrs_sentinel, 1, OP *);
643 *attrs_sentinel = NULL;
644 SAVEDESTRUCTOR_X(free_ptr_op, attrs_sentinel);
646 if (c == ':' || c == '{') /* '}' - hi, vim */ {
648 /* kludge default attributes in */
649 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
650 lex_stuff_sv(spec->attrs, 0);
657 c = lex_peek_unichar(0);
662 if (!(attr = my_scan_word(aTHX_ FALSE))) {
667 c = lex_peek_unichar(0);
670 if (sv_eq_pvs(attr, "lvalue")) {
671 builtin_attrs |= MY_ATTR_LVALUE;
673 } else if (sv_eq_pvs(attr, "method")) {
674 builtin_attrs |= MY_ATTR_METHOD;
680 if (!(sv = my_scan_parens_tail(aTHX_ TRUE))) {
681 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
683 sv_catpvs(attr, "(");
685 sv_catpvs(attr, ")");
688 c = lex_peek_unichar(0);
692 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(attr)));
698 c = lex_peek_unichar(0);
705 if (c != '{') /* '}' - hi, vim */ {
706 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
709 /* surprise predeclaration! */
711 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
712 starts parsing the body */
713 const I32 sub_ix = start_subparse(FALSE, 0);
714 SAVEFREESV(PL_compcv);
716 SvREFCNT_inc_simple_void(PL_compcv);
720 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
721 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
727 if (builtin_attrs & MY_ATTR_LVALUE) {
728 CvLVALUE_on(PL_compcv);
730 if (builtin_attrs & MY_ATTR_METHOD) {
731 CvMETHOD_on(PL_compcv);
733 if (builtin_attrs & MY_ATTR_SPECIAL) {
734 CvSPECIAL_on(PL_compcv);
737 /* min/max argument count checks */
738 if (spec->flags & FLAG_CHECK_NARGS) {
739 if (SvTRUE(spec->shift)) {
741 if (args_max != -1) {
747 OP *chk, *cond, *err, *croak;
749 err = newSVOP(OP_CONST, 0,
750 newSVpvf("Not enough arguments for %"SVf, SVfARG(declarator)));
752 croak = newCVREF(OPf_WANT_SCALAR,
753 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
754 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
755 op_append_elem(OP_LIST, err, croak));
757 cond = newBINOP(OP_LT, 0,
758 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
759 newSVOP(OP_CONST, 0, newSViv(args_min)));
760 chk = newLOGOP(OP_AND, 0, cond, err);
762 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
764 if (args_max != -1) {
765 OP *chk, *cond, *err, *croak;
767 err = newSVOP(OP_CONST, 0,
768 newSVpvf("Too many arguments for %"SVf, SVfARG(declarator)));
770 croak = newCVREF(OPf_WANT_SCALAR,
771 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
772 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
773 op_append_elem(OP_LIST, err, croak));
775 cond = newBINOP(OP_GT, 0,
776 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
777 newSVOP(OP_CONST, 0, newSViv(args_max)));
778 chk = newLOGOP(OP_AND, 0, cond, err);
780 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
785 if (SvTRUE(spec->shift)) {
788 var = newOP(OP_PADSV, OPf_WANT_SCALAR);
789 var->op_targ = pad_findmy_sv(spec->shift, 0);
791 shift = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
792 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, shift));
796 if (params && av_len(params) > -1) {
798 OP *init_param, *left, *right;
801 while ((param = av_shift(params)) != &PL_sv_undef) {
802 OP *const var = newOP(OP_PADSV, OPf_WANT_LIST);
803 var->op_targ = pad_findmy_sv(param, 0);
805 left = op_append_elem(OP_LIST, left, var);
808 left->op_flags |= OPf_PARENS;
809 right = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
810 init_param = newASSIGNOP(OPf_STACKED, left, 0, right);
811 init_param = newSTATEOP(0, NULL, init_param);
813 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, init_param);
819 DefaultParamSpec *dp;
821 for (dp = defaults; dp; dp = dp->next) {
823 OP *var, *args, *cond;
826 var = newOP(OP_PADSV, 0);
827 var->op_targ = pad_findmy_sv(dp->name, 0);
829 /* init = `,var = ,init */
830 init = newASSIGNOP(OPf_STACKED, var, 0, init);
833 args = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
835 /* cond = `,args < ,index */
836 cond = newBINOP(OP_LT, 0, args, newSVOP(OP_CONST, 0, newSViv(dp->limit)));
838 /* init = `,init if ,cond */
839 init = newLOGOP(OP_AND, 0, cond, init);
841 /* gen = `,gen ; ,init */
842 gen = op_append_list(OP_LINESEQ, gen, newSTATEOP(0, NULL, init));
847 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, gen);
850 /* finally let perl parse the actual subroutine body */
851 body = parse_block(0);
853 /* add '();' to make function return nothing by default */
854 /* (otherwise the invisible parameter initialization can "leak" into
855 the return value: fun ($x) {}->("asdf", 0) == 2) */
856 if (*prelude_sentinel) {
857 body = newSTATEOP(0, NULL, body);
860 body = op_append_list(OP_LINESEQ, *prelude_sentinel, body);
861 *prelude_sentinel = NULL;
865 OP *const attrs = *attrs_sentinel;
866 *attrs_sentinel = NULL;
867 SvREFCNT_inc_simple_void(PL_compcv);
869 /* close outer block: '}' */
870 S_block_end(aTHX_ save_ix, body);
873 *pop = newANONATTRSUB(
875 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
879 return KEYWORD_PLUGIN_EXPR;
884 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
885 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
890 return KEYWORD_PLUGIN_STMT;
894 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
900 if (kw_flags(aTHX_ keyword_ptr, keyword_len, &spec)) {
901 ret = parse_fun(aTHX_ op_ptr, keyword_ptr, keyword_len, &spec);
903 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
913 MODULE = Function::Parameters PACKAGE = Function::Parameters
918 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
920 newCONSTSUB(stash, "FLAG_NAME_OK", newSViv(FLAG_NAME_OK));
921 newCONSTSUB(stash, "FLAG_ANON_OK", newSViv(FLAG_ANON_OK));
922 newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
923 newCONSTSUB(stash, "FLAG_CHECK_NARGS", newSViv(FLAG_CHECK_NARGS));
924 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
925 newCONSTSUB(stash, "HINTK_FLAGS_", newSVpvs(HINTK_FLAGS_));
926 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
927 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
929 next_keyword_plugin = PL_keyword_plugin;
930 PL_keyword_plugin = my_keyword_plugin;