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 #include "toke_on_crack.c.inc"
162 static void free_defspec(pTHX_ void *vp) {
163 DefaultParamSpec *dp = vp;
168 static void free_ptr_op(pTHX_ void *vp) {
174 #define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
176 static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
178 const char *sv_p = SvPV(sv, sv_len);
179 return memcmp(sv_p, p, n) == 0;
183 #include "padop_on_crack.c.inc"
187 static PADOFFSET pad_add_my_sv(SV *name) {
194 myvar = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, 1);
195 offset = AvFILLp(PL_comppad);
198 SvUPGRADE(myvar, SVt_PVAV);
199 } else if (*p == '%') {
200 SvUPGRADE(myvar, SVt_PVHV);
202 PL_curpad = AvARRAY(PL_comppad);
203 namesv = newSV_type(SVt_PVMG);
204 sv_setpvn(namesv, p, len);
205 COP_SEQ_RANGE_LOW_set(namesv, PL_cop_seqmax);
206 COP_SEQ_RANGE_HIGH_set(namesv, PERL_PADSEQ_INTRO);
208 av_store(PL_comppad_name, offset, namesv);
214 MY_ATTR_LVALUE = 0x01,
215 MY_ATTR_METHOD = 0x02,
216 MY_ATTR_SPECIAL = 0x04
219 static int parse_fun(pTHX_ OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
225 DefaultParamSpec *defaults;
226 int args_min, args_max;
228 OP **attrs_sentinel, *body;
229 unsigned builtin_attrs;
234 declarator = sv_2mortal(newSVpvn(keyword_ptr, keyword_len));
242 s = PL_parser->bufptr;
243 if ((spec->flags & FLAG_NAME_OK) && (len = S_scan_word(aTHX_ s, TRUE))) {
244 saw_name = sv_2mortal(newSVpvn_flags(s, len, PARSING_UTF ? SVf_UTF8 : 0));
246 if (PL_parser->expect != XSTATE) {
247 /* bail out early so we don't predeclare $saw_name */
248 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
251 sv_catpvs(declarator, " ");
252 sv_catsv(declarator, saw_name);
255 sv_eq_pvs(saw_name, "BEGIN") ||
256 sv_eq_pvs(saw_name, "END") ||
257 sv_eq_pvs(saw_name, "INIT") ||
258 sv_eq_pvs(saw_name, "CHECK") ||
259 sv_eq_pvs(saw_name, "UNITCHECK")
261 builtin_attrs |= MY_ATTR_SPECIAL;
264 lex_read_to(s + len);
266 } else if (!(spec->flags & FLAG_ANON_OK)) {
267 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - s), s);
269 sv_catpvs(declarator, " (anon)");
272 /* we're a subroutine declaration */
273 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
274 SAVEFREESV(PL_compcv);
276 /* create outer block: '{' */
277 save_ix = S_block_start(aTHX_ TRUE);
285 c = lex_peek_unichar(0);
287 DefaultParamSpec **pdefaults_tail = &defaults;
288 SV *saw_slurpy = NULL;
296 sv_2mortal((SV *)params);
299 c = lex_peek_unichar(0);
300 if (c == '$' || c == '@' || c == '%') {
301 const char sigil = c;
309 s = PL_parser->bufptr;
310 if (!(len = S_scan_word(aTHX_ s, FALSE))) {
311 croak("In %"SVf": missing identifier", SVfARG(declarator));
313 param = sv_2mortal(newSVpvf("%c%.*s", sigil, (int)len, s));
315 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_slurpy), SVfARG(param));
323 av_push(params, SvREFCNT_inc_simple_NN(param));
324 lex_read_to(s + len);
327 c = lex_peek_unichar(0);
329 if (!(c == '=' && (spec->flags & FLAG_DEFAULT_ARGS))) {
330 if (sigil == '$' && !defaults) {
333 } else if (sigil != '$') {
334 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(saw_slurpy));
336 DefaultParamSpec *curdef;
341 Newx(curdef, 1, DefaultParamSpec);
343 curdef->limit = param_count;
344 curdef->name = param;
346 SAVEDESTRUCTOR_X(free_defspec, curdef);
348 curdef->next = *pdefaults_tail;
349 *pdefaults_tail = curdef;
350 pdefaults_tail = &curdef->next;
352 /* let perl parse the default parameter value */
353 curdef->init = parse_termexpr(0);
356 c = lex_peek_unichar(0);
373 croak("In %"SVf": unexpected EOF in parameter list", SVfARG(declarator));
375 croak("In %"SVf": unexpected '%c' in parameter list", SVfARG(declarator), (int)c);
381 c = lex_peek_unichar(0);
386 c = lex_peek_unichar(0);
388 lex_stuff_pvs(":", 0);
391 proto = sv_2mortal(newSVpvs(""));
392 if (!S_scan_str(aTHX_ proto, FALSE, FALSE)) {
393 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
395 S_check_prototype(aTHX_ declarator, proto);
397 c = lex_peek_unichar(0);
402 Newx(attrs_sentinel, 1, OP *);
403 *attrs_sentinel = NULL;
404 SAVEDESTRUCTOR_X(free_ptr_op, attrs_sentinel);
406 if (c == ':' || c == '{') /* '}' - hi, vim */ {
408 /* kludge default attributes in */
409 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
410 lex_stuff_sv(spec->attrs, 0);
417 c = lex_peek_unichar(0);
422 s = PL_parser->bufptr;
423 if (!(len = S_scan_word(aTHX_ s, FALSE))) {
427 attr = sv_2mortal(newSVpvn_flags(s, len, PARSING_UTF ? SVf_UTF8 : 0));
429 lex_read_to(s + len);
431 c = lex_peek_unichar(0);
434 if (sv_eq_pvs(attr, "lvalue")) {
435 builtin_attrs |= MY_ATTR_LVALUE;
437 } else if (sv_eq_pvs(attr, "method")) {
438 builtin_attrs |= MY_ATTR_METHOD;
442 SV *sv = sv_2mortal(newSVpvs(""));
443 if (!S_scan_str(aTHX_ sv, TRUE, TRUE)) {
444 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
449 c = lex_peek_unichar(0);
453 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(attr)));
459 c = lex_peek_unichar(0);
466 if (c != '{') /* '}' - hi, vim */ {
467 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
470 /* surprise predeclaration! */
472 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
473 starts parsing the body */
474 const I32 sub_ix = start_subparse(FALSE, 0);
475 SAVEFREESV(PL_compcv);
477 SvREFCNT_inc_simple_void(PL_compcv);
481 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
482 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
489 if (builtin_attrs & MY_ATTR_LVALUE) {
490 CvLVALUE_on(PL_compcv);
492 if (builtin_attrs & MY_ATTR_METHOD) {
493 CvMETHOD_on(PL_compcv);
495 if (builtin_attrs & MY_ATTR_SPECIAL) {
496 CvSPECIAL_on(PL_compcv);
503 /* min/max argument count checks */
504 if (spec->flags & FLAG_CHECK_NARGS) {
505 if (SvTRUE(spec->shift)) {
507 if (args_max != -1) {
513 OP *chk, *cond, *err, *croak;
515 err = newSVOP(OP_CONST, 0,
516 newSVpvf("Not enough arguments for %"SVf, SVfARG(declarator)));
518 croak = newCVREF(OPf_WANT_SCALAR,
519 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
520 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
521 op_append_elem(OP_LIST, err, croak));
523 cond = newBINOP(OP_LT, 0,
524 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
525 newSVOP(OP_CONST, 0, newSViv(args_min)));
526 chk = newLOGOP(OP_AND, 0, cond, err);
528 prelude = op_append_list(OP_LINESEQ, prelude, newSTATEOP(0, NULL, chk));
530 if (args_max != -1) {
531 OP *chk, *cond, *err, *croak;
533 err = newSVOP(OP_CONST, 0,
534 newSVpvf("Too many arguments for %"SVf, SVfARG(declarator)));
536 croak = newCVREF(OPf_WANT_SCALAR,
537 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
538 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
539 op_append_elem(OP_LIST, err, croak));
541 cond = newBINOP(OP_GT, 0,
542 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
543 newSVOP(OP_CONST, 0, newSViv(args_max)));
544 chk = newLOGOP(OP_AND, 0, cond, err);
546 prelude = op_append_list(OP_LINESEQ, prelude, newSTATEOP(0, NULL, chk));
550 /* my $self = shift; */
551 if (SvTRUE(spec->shift)) {
554 var = newOP(OP_PADSV, OPf_WANT_SCALAR | (OPpLVAL_INTRO << 8));
555 var->op_targ = pad_add_name_sv(spec->shift, 0, NULL, NULL);
557 shift = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
558 prelude = op_append_list(OP_LINESEQ, prelude, newSTATEOP(0, NULL, shift));
561 /* my (PARAMS) = @_; */
562 if (params && av_len(params) > -1) {
564 OP *init_param, *left, *right;
567 while ((param = av_shift(params)) != &PL_sv_undef) {
568 OP *const var = newOP(OP_PADSV, OPf_WANT_LIST | (OPpLVAL_INTRO << 8));
569 var->op_targ = pad_add_name_sv(param, 0, NULL, NULL);
571 left = op_append_elem(OP_LIST, left, var);
574 left->op_flags |= OPf_PARENS;
575 right = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
576 init_param = newASSIGNOP(OPf_STACKED, left, 0, right);
577 init_param = newSTATEOP(0, NULL, init_param);
579 prelude = op_append_list(OP_LINESEQ, prelude, init_param);
585 DefaultParamSpec *dp;
587 for (dp = defaults; dp; dp = dp->next) {
589 OP *var, *args, *cond;
592 var = newOP(OP_PADSV, 0);
593 var->op_targ = pad_findmy_sv(dp->name, 0);
595 /* init = `,var = ,init */
596 init = newASSIGNOP(OPf_STACKED, var, 0, init);
599 args = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
601 /* cond = `,args < ,index */
602 cond = newBINOP(OP_LT, 0, args, newSVOP(OP_CONST, 0, newSViv(dp->limit)));
604 /* init = `,init if ,cond */
605 init = newLOGOP(OP_AND, 0, cond, init);
607 /* gen = `,gen ; ,init */
608 gen = op_append_list(OP_LINESEQ, gen, newSTATEOP(0, NULL, init));
613 prelude = op_append_list(OP_LINESEQ, prelude, gen);
616 /* finally let perl parse the actual subroutine body */
617 body = parse_block(0);
619 /* add '();' to make function return nothing by default */
620 /* (otherwise the invisible parameter initialization can "leak" into
621 the return value: fun ($x) {}->("asdf", 0) == 2) */
623 body = newSTATEOP(0, NULL, body);
626 body = op_append_list(OP_LINESEQ, prelude, body);
631 OP *const attrs = *attrs_sentinel;
632 *attrs_sentinel = NULL;
633 SvREFCNT_inc_simple_void(PL_compcv);
635 /* close outer block: '}' */
636 S_block_end(aTHX_ save_ix, body);
639 *pop = newANONATTRSUB(
641 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
645 return KEYWORD_PLUGIN_EXPR;
650 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
651 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
656 return KEYWORD_PLUGIN_STMT;
660 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
666 if (kw_flags(aTHX_ keyword_ptr, keyword_len, &spec)) {
667 ret = parse_fun(aTHX_ op_ptr, keyword_ptr, keyword_len, &spec);
669 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
679 MODULE = Function::Parameters PACKAGE = Function::Parameters
684 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
686 newCONSTSUB(stash, "FLAG_NAME_OK", newSViv(FLAG_NAME_OK));
687 newCONSTSUB(stash, "FLAG_ANON_OK", newSViv(FLAG_ANON_OK));
688 newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
689 newCONSTSUB(stash, "FLAG_CHECK_NARGS", newSViv(FLAG_CHECK_NARGS));
690 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
691 newCONSTSUB(stash, "HINTK_FLAGS_", newSVpvs(HINTK_FLAGS_));
692 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
693 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
695 next_keyword_plugin = PL_keyword_plugin;
696 PL_keyword_plugin = my_keyword_plugin;