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
54 #define MY_PKG "Function::Parameters"
56 #define HINTK_KEYWORDS MY_PKG "/keywords"
57 #define HINTK_NAME_ MY_PKG "/name:"
58 #define HINTK_SHIFT_ MY_PKG "/shift:"
59 #define HINTK_ATTRS_ MY_PKG "/attrs:"
61 #define HAVE_PERL_VERSION(R, V, S) \
62 (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
64 #if HAVE_PERL_VERSION(5, 16, 0)
65 #define IF_HAVE_PERL_5_16(YES, NO) YES
67 #define IF_HAVE_PERL_5_16(YES, NO) NO
72 FLAG_NAME_OPTIONAL = 1,
80 static int (*next_keyword_plugin)(pTHX_ char *, STRLEN, OP **);
82 static int kw_flags(pTHX_ const char *kw_ptr, STRLEN kw_len, Spec *spec) {
85 const char *p, *kw_active;
89 spec->shift = sv_2mortal(newSVpvs(""));
90 spec->attrs = sv_2mortal(newSVpvs(""));
92 if (!(hints = GvHV(PL_hintgv))) {
95 if (!(psv = hv_fetchs(hints, HINTK_KEYWORDS, 0))) {
99 kw_active = SvPV(sv, kw_active_len);
100 if (kw_active_len <= kw_len) {
105 (p = strchr(p, *kw_ptr)) &&
106 p < kw_active + kw_active_len - kw_len;
110 (p == kw_active || p[-1] == ' ') &&
112 memcmp(kw_ptr, p, kw_len) == 0
115 #define FETCH_HINTK_INTO(NAME, PTR, LEN, X) STMT_START { \
116 const char *fk_ptr_; \
119 fk_sv_ = sv_2mortal(newSVpvs(HINTK_ ## NAME)); \
120 sv_catpvn(fk_sv_, PTR, LEN); \
121 fk_ptr_ = SvPV(fk_sv_, fk_len_); \
122 if (!((X) = hv_fetch(hints, fk_ptr_, fk_len_, 0))) { \
123 croak("%s: internal error: $^H{'%.*s'} not set", MY_PKG, (int)fk_len_, fk_ptr_); \
127 FETCH_HINTK_INTO(NAME_, kw_ptr, kw_len, psv);
128 spec->name = SvIV(*psv);
130 FETCH_HINTK_INTO(SHIFT_, kw_ptr, kw_len, psv);
131 SvSetSV(spec->shift, *psv);
133 FETCH_HINTK_INTO(ATTRS_, kw_ptr, kw_len, psv);
134 SvSetSV(spec->attrs, *psv);
136 #undef FETCH_HINTK_INTO
144 #include "toke_on_crack.c.inc"
147 static void free_ptr_op(pTHX_ void *vp) {
153 #define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
155 static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
157 const char *sv_p = SvPV(sv, sv_len);
158 return memcmp(sv_p, p, n) == 0;
162 #include "padop_on_crack.c.inc"
166 static PADOFFSET pad_add_my_sv(SV *name) {
173 myvar = *av_fetch(PL_comppad, AvFILLp(PL_comppad) + 1, 1);
174 offset = AvFILLp(PL_comppad);
177 SvUPGRADE(myvar, SVt_PVAV);
178 } else if (*p == '%') {
179 SvUPGRADE(myvar, SVt_PVHV);
181 PL_curpad = AvARRAY(PL_comppad);
182 namesv = newSV_type(SVt_PVMG);
183 sv_setpvn(namesv, p, len);
184 COP_SEQ_RANGE_LOW_set(namesv, PL_cop_seqmax);
185 COP_SEQ_RANGE_HIGH_set(namesv, PERL_PADSEQ_INTRO);
187 av_store(PL_comppad_name, offset, namesv);
193 MY_ATTR_LVALUE = 0x01,
194 MY_ATTR_METHOD = 0x02,
195 MY_ATTR_SPECIAL = 0x04
198 static int parse_fun(pTHX_ OP **pop, const char *keyword_ptr, STRLEN keyword_len, const Spec *spec) {
204 OP **attrs_sentinel, *body;
205 unsigned builtin_attrs;
210 declarator = sv_2mortal(newSVpvn(keyword_ptr, keyword_len));
218 s = PL_parser->bufptr;
219 if (spec->name != FLAG_NAME_PROHIBITED && (len = S_scan_word(aTHX_ s, TRUE))) {
220 saw_name = sv_2mortal(newSVpvn_flags(s, len, PARSING_UTF ? SVf_UTF8 : 0));
222 if (PL_parser->expect != XSTATE) {
223 /* bail out early so we don't predeclare $saw_name */
224 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
227 sv_catpvs(declarator, " ");
228 sv_catsv(declarator, saw_name);
231 sv_eq_pvs(saw_name, "BEGIN") ||
232 sv_eq_pvs(saw_name, "END") ||
233 sv_eq_pvs(saw_name, "INIT") ||
234 sv_eq_pvs(saw_name, "CHECK") ||
235 sv_eq_pvs(saw_name, "UNITCHECK")
237 builtin_attrs |= MY_ATTR_SPECIAL;
240 lex_read_to(s + len);
242 } else if (spec->name == FLAG_NAME_REQUIRED) {
243 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - s), s);
245 sv_catpvs(declarator, " (anon)");
248 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
249 SAVEFREESV(PL_compcv);
253 c = lex_peek_unichar(0);
255 SV *saw_slurpy = NULL;
261 sv_2mortal((SV *)params);
264 c = lex_peek_unichar(0);
265 if (c == '$' || c == '@' || c == '%') {
271 s = PL_parser->bufptr;
272 if (!(len = S_scan_word(aTHX_ s, FALSE))) {
273 croak("In %"SVf": missing identifier", SVfARG(declarator));
275 param = sv_2mortal(newSVpvf("%c%.*s", (int)c, (int)len, s));
277 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_slurpy), SVfARG(param));
282 av_push(params, SvREFCNT_inc_simple_NN(param));
283 lex_read_to(s + len);
286 c = lex_peek_unichar(0);
301 croak("In %"SVf": unexpected EOF in parameter list", SVfARG(declarator));
303 croak("In %"SVf": unexpected '%c' in parameter list", SVfARG(declarator), (int)c);
309 c = lex_peek_unichar(0);
314 c = lex_peek_unichar(0);
316 lex_stuff_pvs(":", 0);
319 proto = sv_2mortal(newSVpvs(""));
320 if (!S_scan_str(aTHX_ proto, FALSE, FALSE)) {
321 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
323 S_check_prototype(aTHX_ declarator, proto);
325 c = lex_peek_unichar(0);
329 /* surprise predeclaration! */
331 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
332 starts parsing the body */
333 SvREFCNT_inc_simple_void(PL_compcv);
337 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
338 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
343 floor_ix = start_subparse(FALSE, 0);
344 SAVEFREESV(PL_compcv);
349 Newx(attrs_sentinel, 1, OP *);
350 *attrs_sentinel = NULL;
351 SAVEDESTRUCTOR_X(free_ptr_op, attrs_sentinel);
353 if (c == ':' || c == '{') {
355 /* kludge default attributes in */
356 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
357 lex_stuff_sv(spec->attrs, 0);
364 c = lex_peek_unichar(0);
369 s = PL_parser->bufptr;
370 if (!(len = S_scan_word(aTHX_ s, FALSE))) {
374 attr = sv_2mortal(newSVpvn_flags(s, len, PARSING_UTF ? SVf_UTF8 : 0));
376 lex_read_to(s + len);
378 c = lex_peek_unichar(0);
381 if (sv_eq_pvs(attr, "lvalue")) {
382 builtin_attrs |= MY_ATTR_LVALUE;
384 } else if (sv_eq_pvs(attr, "method")) {
385 builtin_attrs |= MY_ATTR_METHOD;
389 SV *sv = sv_2mortal(newSVpvs(""));
390 if (!S_scan_str(aTHX_ sv, TRUE, TRUE)) {
391 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
396 c = lex_peek_unichar(0);
400 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(attr)));
406 c = lex_peek_unichar(0);
414 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
417 if (builtin_attrs & MY_ATTR_LVALUE) {
418 CvLVALUE_on(PL_compcv);
420 if (builtin_attrs & MY_ATTR_METHOD) {
421 CvMETHOD_on(PL_compcv);
423 if (builtin_attrs & MY_ATTR_SPECIAL) {
424 CvSPECIAL_on(PL_compcv);
429 /* create outer block: '{' */
430 const int save_ix = S_block_start(aTHX_ TRUE);
433 /* my $self = shift; */
434 if (SvTRUE(spec->shift)) {
435 OP *const var = newOP(OP_PADSV, OPf_WANT_SCALAR | (OPpLVAL_INTRO << 8));
436 var->op_targ = pad_add_name_sv(spec->shift, 0, NULL, NULL);
438 init = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
439 init = newSTATEOP(0, NULL, init);
442 /* my (PARAMS) = @_; */
443 if (params && av_len(params) > -1) {
445 OP *init_param, *left, *right;
448 while ((param = av_shift(params)) != &PL_sv_undef) {
449 OP *const var = newOP(OP_PADSV, OPf_WANT_LIST | (OPpLVAL_INTRO << 8));
450 var->op_targ = pad_add_name_sv(param, 0, NULL, NULL);
452 left = op_append_elem(OP_LIST, left, var);
455 left->op_flags |= OPf_PARENS;
456 right = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
457 init_param = newASSIGNOP(OPf_STACKED, left, 0, right);
458 init_param = newSTATEOP(0, NULL, init_param);
460 init = op_append_list(OP_LINESEQ, init, init_param);
463 /* add '();' to make function return nothing by default */
464 /* (otherwise the invisible parameter initialization can "leak" into
465 the return value: fun ($x) {}->("asdf", 0) == 2) */
467 init = op_append_list(OP_LINESEQ, init, newSTATEOP(0, NULL, newOP(OP_STUB, OPf_PARENS)));
470 /* finally let perl parse the actual subroutine body */
471 body = parse_block(0);
473 body = op_append_list(OP_LINESEQ, init, body);
475 /* close outer block: '}' */
476 S_block_end(aTHX_ save_ix, body);
481 OP *const attrs = *attrs_sentinel;
482 *attrs_sentinel = NULL;
483 SvREFCNT_inc_simple_void(PL_compcv);
486 *pop = newANONATTRSUB(
488 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
492 return KEYWORD_PLUGIN_EXPR;
497 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
498 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
503 return KEYWORD_PLUGIN_STMT;
507 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
513 if (kw_flags(aTHX_ keyword_ptr, keyword_len, &spec)) {
514 ret = parse_fun(aTHX_ op_ptr, keyword_ptr, keyword_len, &spec);
516 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
526 MODULE = Function::Parameters PACKAGE = Function::Parameters
531 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
533 newCONSTSUB(stash, "FLAG_NAME_OPTIONAL", newSViv(FLAG_NAME_OPTIONAL));
534 newCONSTSUB(stash, "FLAG_NAME_REQUIRED", newSViv(FLAG_NAME_REQUIRED));
535 newCONSTSUB(stash, "FLAG_NAME_PROHIBITED", newSViv(FLAG_NAME_PROHIBITED));
536 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
537 newCONSTSUB(stash, "HINTK_NAME_", newSVpvs(HINTK_NAME_));
538 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
539 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
541 next_keyword_plugin = PL_keyword_plugin;
542 PL_keyword_plugin = my_keyword_plugin;