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 void my_safefree(void *p) {
154 #define SENTINEL_ALLOC(SEN, P, N, T) STMT_START { \
156 sentinel_register(SEN, P, my_safefree); \
159 #define SENTINEL_MDUP(SEN, P, O, N, T) STMT_START { \
160 void *const _sentinel_mdup_tmp_ = (P); \
161 SENTINEL_ALLOC(SEN, P, N, T); \
162 memcpy(P, _sentinel_mdup_tmp_, O * sizeof (T)); \
165 #define SENTINEL_REALLOC(SEN, P, N, T) STMT_START { \
168 SENTINEL_ALLOC(SEN, P, N, T); \
170 Resource **_sentinel_realloc_tmp_ = (SEN); \
172 assert(*_sentinel_realloc_tmp_ != NULL); \
173 if ((*_sentinel_realloc_tmp_)->data == (P)) { \
174 Renew((*_sentinel_realloc_tmp_)->data, N, T); \
175 (P) = (*_sentinel_realloc_tmp_)->data; \
178 _sentinel_realloc_tmp_ = &(*_sentinel_realloc_tmp_)->next; \
183 static int kw_flags(pTHX_ Sentinel sen, const char *kw_ptr, STRLEN kw_len, KWSpec *spec) {
186 const char *p, *kw_active;
187 STRLEN kw_active_len;
190 spec->shift = sentinel_mortalize(sen, newSVpvs(""));
191 spec->attrs = sentinel_mortalize(sen, newSVpvs(""));
193 if (!(hints = GvHV(PL_hintgv))) {
196 if (!(psv = hv_fetchs(hints, HINTK_KEYWORDS, 0))) {
200 kw_active = SvPV(sv, kw_active_len);
201 if (kw_active_len <= kw_len) {
206 (p = strchr(p, *kw_ptr)) &&
207 p < kw_active + kw_active_len - kw_len;
211 (p == kw_active || p[-1] == ' ') &&
213 memcmp(kw_ptr, p, kw_len) == 0
216 #define FETCH_HINTK_INTO(NAME, PTR, LEN, X) STMT_START { \
217 const char *fk_ptr_; \
220 fk_sv_ = sentinel_mortalize(sen, newSVpvs(HINTK_ ## NAME)); \
221 sv_catpvn(fk_sv_, PTR, LEN); \
222 fk_ptr_ = SvPV(fk_sv_, fk_len_); \
223 if (!((X) = hv_fetch(hints, fk_ptr_, fk_len_, 0))) { \
224 croak("%s: internal error: $^H{'%.*s'} not set", MY_PKG, (int)fk_len_, fk_ptr_); \
228 FETCH_HINTK_INTO(FLAGS_, kw_ptr, kw_len, psv);
229 spec->flags = SvIV(*psv);
231 FETCH_HINTK_INTO(SHIFT_, kw_ptr, kw_len, psv);
232 SvSetSV(spec->shift, *psv);
234 FETCH_HINTK_INTO(ATTRS_, kw_ptr, kw_len, psv);
235 SvSetSV(spec->attrs, *psv);
237 #undef FETCH_HINTK_INTO
245 static void free_ptr_op(pTHX_ void *vp) {
251 #define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
253 static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
255 const char *sv_p = SvPV(sv, sv_len);
256 return memcmp(sv_p, p, n) == 0;
260 #include "padop_on_crack.c.inc"
264 MY_ATTR_LVALUE = 0x01,
265 MY_ATTR_METHOD = 0x02,
266 MY_ATTR_SPECIAL = 0x04
269 static void my_sv_cat_c(pTHX_ SV *sv, U32 c) {
270 char ds[UTF8_MAXBYTES + 1], *d;
271 d = (char *)uvchr_to_utf8((U8 *)ds, c);
275 sv_catpvn(sv, ds, d - ds);
278 static bool my_is_uni_xidfirst(pTHX_ UV c) {
279 U8 tmpbuf[UTF8_MAXBYTES + 1];
280 uvchr_to_utf8(tmpbuf, c);
281 return is_utf8_xidfirst(tmpbuf);
284 static bool my_is_uni_xidcont(pTHX_ UV c) {
285 U8 tmpbuf[UTF8_MAXBYTES + 1];
286 uvchr_to_utf8(tmpbuf, c);
287 return is_utf8_xidcont(tmpbuf);
290 static SV *my_scan_word(pTHX_ Sentinel sen, bool allow_package) {
291 bool at_start, at_substart;
293 SV *sv = sentinel_mortalize(sen, newSVpvs(""));
298 at_start = at_substart = TRUE;
299 c = lex_peek_unichar(0);
302 if (at_substart ? my_is_uni_xidfirst(aTHX_ c) : my_is_uni_xidcont(aTHX_ c)) {
304 my_sv_cat_c(aTHX_ sv, c);
306 c = lex_peek_unichar(0);
307 } else if (allow_package && !at_substart && c == '\'') {
309 c = lex_peek_unichar(0);
310 if (!my_is_uni_xidfirst(aTHX_ c)) {
311 lex_stuff_pvs("'", 0);
316 } else if (allow_package && (at_start || !at_substart) && c == ':') {
318 if (lex_peek_unichar(0) != ':') {
319 lex_stuff_pvs(":", 0);
323 c = lex_peek_unichar(0);
324 if (!my_is_uni_xidfirst(aTHX_ c)) {
325 lex_stuff_pvs("::", 0);
336 return SvCUR(sv) ? sv : NULL;
339 static SV *my_scan_parens_tail(pTHX_ Sentinel sen, bool keep_backslash) {
344 start = CopLINE(PL_curcop);
346 sv = sentinel_mortalize(sen, newSVpvs(""));
353 c = lex_read_unichar(0);
355 CopLINE_set(PL_curcop, start);
360 c = lex_read_unichar(0);
362 CopLINE_set(PL_curcop, start);
365 if (keep_backslash || (c != '(' && c != ')')) {
368 } else if (c == '(') {
370 } else if (c == ')') {
377 my_sv_cat_c(aTHX_ sv, c);
383 static void my_check_prototype(pTHX_ Sentinel sen, const SV *declarator, SV *proto) {
384 char *start, *r, *w, *end;
388 start = SvPV(proto, len);
391 for (w = r = start; r < end; r++) {
397 SvCUR_set(proto, w - start);
401 if (!ckWARN(WARN_ILLEGALPROTO)) {
405 /* check for bad characters */
406 if (strspn(start, "$@%*;[]&\\_+") != len) {
407 SV *dsv = sentinel_mortalize(sen, newSVpvs(""));
409 packWARN(WARN_ILLEGALPROTO),
410 "Illegal character in prototype for %"SVf" : %s",
419 : pv_pretty(dsv, start, len, 60, NULL, NULL,
420 PERL_PV_ESCAPE_NONASCII
426 for (r = start; r < end; r++) {
430 packWARN(WARN_ILLEGALPROTO),
431 "Illegal character in prototype for %"SVf" : %s",
432 SVfARG(declarator), r
437 if (r[1] && !strchr(";@%", *r)) {
439 packWARN(WARN_ILLEGALPROTO),
440 "Illegal character after '_' in prototype for %"SVf" : %s",
441 SVfARG(declarator), r
451 packWARN(WARN_ILLEGALPROTO),
452 "prototype after '%c' for %"SVf": %s",
453 *r, SVfARG(declarator), r + 1
461 if (strchr("$@%&*", *r)) {
466 for (; r < end && *r != ']'; r++) {
467 if (!strchr("$@%&*", *r)) {
471 if (*r == ']' && r[-1] != '[') {
476 packWARN(WARN_ILLEGALPROTO),
477 "Illegal character after '\\' in prototype for %"SVf" : %s",
478 SVfARG(declarator), r
498 DEFSTRUCT(ParamInit) {
503 #define VEC(B) B ## _Vec
505 #define DEFVECTOR(B) DEFSTRUCT(VEC(B)) { \
511 DEFVECTOR(ParamInit);
513 #define DEFVECTOR_INIT(N, B) static void N(VEC(B) *p) { \
516 Newx(p->data, p->size, B); \
517 } static void N(VEC(B) *)
519 DEFSTRUCT(ParamSpec) {
521 VEC(Param) positional_required;
522 VEC(ParamInit) positional_optional;
523 VEC(Param) named_required;
524 VEC(ParamInit) named_optional;
529 DEFVECTOR_INIT(pv_init, Param);
530 DEFVECTOR_INIT(piv_init, ParamInit);
532 static void p_init(Param *p) {
534 p->padoff = NOT_IN_PAD;
537 static void ps_init(ParamSpec *ps) {
538 p_init(&ps->invocant);
539 pv_init(&ps->positional_required);
540 piv_init(&ps->positional_optional);
541 pv_init(&ps->named_required);
542 piv_init(&ps->named_optional);
544 ps->rest_hash = NOT_IN_PAD;
547 #define DEFVECTOR_EXTEND(N, B) static B (*N(VEC(B) *p)) { \
548 assert(p->used <= p->size); \
549 if (p->used == p->size) { \
550 const size_t n = p->size / 2 * 3 + 1; \
551 Renew(p->data, n, B); \
554 return &p->data[p->used]; \
555 } static B (*N(VEC(B) *))
557 DEFVECTOR_EXTEND(pv_extend, Param);
558 DEFVECTOR_EXTEND(piv_extend, ParamInit);
560 #define DEFVECTOR_CLEAR(N, B, F) static void N(pTHX_ VEC(B) *p) { \
563 F(aTHX_ &p->data[p->used]); \
568 } static void N(pTHX_ VEC(B) *)
570 static void p_clear(pTHX_ Param *p) {
572 p->padoff = NOT_IN_PAD;
575 static void pi_clear(pTHX_ ParamInit *pi) {
576 p_clear(aTHX_ &pi->param);
583 DEFVECTOR_CLEAR(pv_clear, Param, p_clear);
584 DEFVECTOR_CLEAR(piv_clear, ParamInit, pi_clear);
586 static void ps_clear(pTHX_ ParamSpec *ps) {
587 p_clear(aTHX_ &ps->invocant);
589 pv_clear(aTHX_ &ps->positional_required);
590 piv_clear(aTHX_ &ps->positional_optional);
592 pv_clear(aTHX_ &ps->named_required);
593 piv_clear(aTHX_ &ps->named_optional);
595 p_clear(aTHX_ &ps->slurpy);
598 static int ps_contains(pTHX_ const ParamSpec *ps, SV *sv) {
601 if (ps->invocant.name && sv_eq(sv, ps->invocant.name)) {
605 for (i = 0, lim = ps->positional_required.used; i < lim; i++) {
606 if (sv_eq(sv, ps->positional_required.data[i].name)) {
611 for (i = 0, lim = ps->positional_optional.used; i < lim; i++) {
612 if (sv_eq(sv, ps->positional_optional.data[i].param.name)) {
617 for (i = 0, lim = ps->named_required.used; i < lim; i++) {
618 if (sv_eq(sv, ps->named_required.data[i].name)) {
623 for (i = 0, lim = ps->named_optional.used; i < lim; i++) {
624 if (sv_eq(sv, ps->named_optional.data[i].param.name)) {
632 static void ps_free_void(pTHX_ void *p) {
637 static int args_min(pTHX_ const ParamSpec *ps, const KWSpec *ks) {
640 return SvTRUE(ks->shift) ? 1 : 0;
642 if (ps->invocant.name) {
645 n += ps->positional_required.used;
646 n += ps->named_required.used * 2;
650 static int args_max(const ParamSpec *ps) {
655 if (ps->invocant.name) {
658 n += ps->positional_required.used;
659 n += ps->positional_optional.used;
660 if (ps->named_required.used || ps->named_optional.used || ps->slurpy.name) {
666 static size_t count_positional_params(const ParamSpec *ps) {
667 return ps->positional_required.used + ps->positional_optional.used;
670 static size_t count_named_params(const ParamSpec *ps) {
671 return ps->named_required.used + ps->named_optional.used;
675 PARAM_INVOCANT = 0x01,
679 /* *pinit must be NULL on entry.
680 * caller must free *pinit on error.
682 static PADOFFSET parse_param(
685 const SV *declarator, const KWSpec *spec, ParamSpec *param_spec,
686 int *pflags, SV **pname, OP **pinit
695 c = lex_peek_unichar(0);
701 *pflags |= PARAM_NAMED;
703 c = lex_peek_unichar(0);
707 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
709 if (!(c == '$' || c == '@' || c == '%')) {
710 croak("In %"SVf": unexpected '%c' in parameter list (expecting a sigil)", SVfARG(declarator), (int)c);
718 if (!(name = my_scan_word(aTHX_ sen, FALSE))) {
719 croak("In %"SVf": missing identifier after '%c'", SVfARG(declarator), sigil);
721 sv_insert(name, 0, 0, &sigil, 1);
725 c = lex_peek_unichar(0);
732 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
733 param_spec->invocant.name = spec->shift;
734 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
737 *pinit = parse_termexpr(0);
740 c = lex_peek_unichar(0);
744 *pflags |= PARAM_INVOCANT;
747 } else if (c == ',') {
750 } else if (c != ')') {
752 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
754 croak("In %"SVf": unexpected '%c' in parameter list (expecting ',')", SVfARG(declarator), (int)c);
757 return pad_add_name_sv(*pname, IF_HAVE_PERL_5_16(padadd_NO_DUP_CHECK, 0), NULL, NULL);
760 static OP *my_var_g(pTHX_ I32 type, I32 flags, PADOFFSET padoff) {
761 OP *var = newOP(type, flags);
762 var->op_targ = padoff;
766 static OP *my_var(pTHX_ I32 flags, PADOFFSET padoff) {
767 return my_var_g(aTHX_ OP_PADSV, flags, padoff);
770 static OP *mkhvelem(pTHX_ PADOFFSET h, OP *k) {
771 OP *hv = my_var_g(aTHX_ OP_PADHV, OPf_REF, h);
772 return newBINOP(OP_HELEM, 0, hv, k);
775 static OP *mkconstsv(pTHX_ SV *sv) {
776 return newSVOP(OP_CONST, 0, sv);
779 static OP *mkconstiv(pTHX_ IV i) {
780 return mkconstsv(aTHX_ newSViv(i));
783 static OP *mkconstpv(pTHX_ const char *p, size_t n) {
784 return mkconstsv(aTHX_ newSVpv(p, n));
787 #define mkconstpvs(S) mkconstpv(aTHX_ "" S "", sizeof S - 1)
789 static int parse_fun(pTHX_ Sentinel sen, OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
790 ParamSpec *param_spec;
795 OP **prelude_sentinel;
797 OP **attrs_sentinel, *body;
798 unsigned builtin_attrs;
801 declarator = sentinel_mortalize(sen, newSVpvn(keyword_ptr, keyword_len));
809 if ((spec->flags & FLAG_NAME_OK) && (saw_name = my_scan_word(aTHX_ sen, TRUE))) {
811 if (PL_parser->expect != XSTATE) {
812 /* bail out early so we don't predeclare $saw_name */
813 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
816 sv_catpvs(declarator, " ");
817 sv_catsv(declarator, saw_name);
820 sv_eq_pvs(saw_name, "BEGIN") ||
821 sv_eq_pvs(saw_name, "END") ||
822 sv_eq_pvs(saw_name, "INIT") ||
823 sv_eq_pvs(saw_name, "CHECK") ||
824 sv_eq_pvs(saw_name, "UNITCHECK")
826 builtin_attrs |= MY_ATTR_SPECIAL;
830 } else if (!(spec->flags & FLAG_ANON_OK)) {
831 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - PL_parser->bufptr), PL_parser->bufptr);
833 sv_catpvs(declarator, " (anon)");
836 /* we're a subroutine declaration */
837 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
838 SAVEFREESV(PL_compcv);
840 /* create outer block: '{' */
841 save_ix = S_block_start(aTHX_ TRUE);
843 /* initialize synthetic optree */
844 Newx(prelude_sentinel, 1, OP *);
845 *prelude_sentinel = NULL;
846 sentinel_register(sen, prelude_sentinel, free_ptr_op);
851 c = lex_peek_unichar(0);
855 Newx(init_sentinel, 1, OP *);
856 *init_sentinel = NULL;
857 sentinel_register(sen, init_sentinel, free_ptr_op);
859 Newx(param_spec, 1, ParamSpec);
861 sentinel_register(sen, param_spec, ps_free_void);
866 while ((c = lex_peek_unichar(0)) != ')') {
872 padoff = parse_param(aTHX_ sen, declarator, spec, param_spec, &flags, &name, init_sentinel);
876 sigil = SvPV_nolen(name)[0];
878 /* internal consistency */
879 if (flags & PARAM_NAMED) {
880 if (flags & PARAM_INVOCANT) {
881 croak("In %"SVf": invocant %"SVf" can't be a named parameter", SVfARG(declarator), SVfARG(name));
884 croak("In %"SVf": named parameter %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
886 } else if (flags & PARAM_INVOCANT) {
887 if (*init_sentinel) {
888 croak("In %"SVf": invocant %"SVf" can't have a default value", SVfARG(declarator), SVfARG(name));
891 croak("In %"SVf": invocant %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
893 } else if (sigil != '$' && *init_sentinel) {
894 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(name));
897 /* external constraints */
898 if (param_spec->slurpy.name) {
899 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(param_spec->slurpy.name), SVfARG(name));
902 assert(!*init_sentinel);
903 param_spec->slurpy.name = name;
904 param_spec->slurpy.padoff = padoff;
908 if (!(flags & PARAM_NAMED) && count_named_params(param_spec)) {
909 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));
912 if (flags & PARAM_INVOCANT) {
913 if (param_spec->invocant.name) {
914 croak("In %"SVf": invalid double invocants %"SVf", %"SVf"", SVfARG(declarator), SVfARG(param_spec->invocant.name), SVfARG(name));
916 if (count_positional_params(param_spec) || count_named_params(param_spec)) {
917 croak("In %"SVf": invocant %"SVf" must be first in parameter list", SVfARG(declarator), SVfARG(name));
919 if (!(spec->flags & FLAG_INVOCANT)) {
920 croak("In %"SVf": invocant %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
922 param_spec->invocant.name = name;
923 param_spec->invocant.padoff = padoff;
927 if (*init_sentinel && !(spec->flags & FLAG_DEFAULT_ARGS)) {
928 croak("In %"SVf": default argument for %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
931 if (ps_contains(aTHX_ param_spec, name)) {
932 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(name));
935 if (flags & PARAM_NAMED) {
936 if (!(spec->flags & FLAG_NAMED_PARAMS)) {
937 croak("In %"SVf": named parameter :%"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
940 if (*init_sentinel) {
941 ParamInit *pi = piv_extend(¶m_spec->named_optional);
942 pi->param.name = name;
943 pi->param.padoff = padoff;
944 pi->init = *init_sentinel;
945 *init_sentinel = NULL;
946 param_spec->named_optional.used++;
950 if (param_spec->positional_optional.used) {
951 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));
954 p = pv_extend(¶m_spec->named_required);
957 param_spec->named_required.used++;
960 if (*init_sentinel || param_spec->positional_optional.used) {
961 ParamInit *pi = piv_extend(¶m_spec->positional_optional);
962 pi->param.name = name;
963 pi->param.padoff = padoff;
964 pi->init = *init_sentinel;
965 *init_sentinel = NULL;
966 param_spec->positional_optional.used++;
968 Param *p = pv_extend(¶m_spec->positional_required);
971 param_spec->positional_required.used++;
978 *init_sentinel = NULL;
980 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
981 if (ps_contains(aTHX_ param_spec, spec->shift)) {
982 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(spec->shift));
985 param_spec->invocant.name = spec->shift;
986 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
992 c = lex_peek_unichar(0);
997 c = lex_peek_unichar(0);
999 lex_stuff_pvs(":", 0);
1002 lex_read_unichar(0);
1003 if (!(proto = my_scan_parens_tail(aTHX_ sen, FALSE))) {
1004 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
1006 my_check_prototype(aTHX_ sen, declarator, proto);
1008 c = lex_peek_unichar(0);
1009 if (!(c == ':' || c == '{')) {
1010 lex_stuff_pvs(":", 0);
1017 Newx(attrs_sentinel, 1, OP *);
1018 *attrs_sentinel = NULL;
1019 sentinel_register(sen, attrs_sentinel, free_ptr_op);
1021 if (c == ':' || c == '{') /* '}' - hi, vim */ {
1023 /* kludge default attributes in */
1024 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
1025 lex_stuff_sv(spec->attrs, 0);
1030 lex_read_unichar(0);
1032 c = lex_peek_unichar(0);
1037 if (!(attr = my_scan_word(aTHX_ sen, FALSE))) {
1042 c = lex_peek_unichar(0);
1045 if (sv_eq_pvs(attr, "lvalue")) {
1046 builtin_attrs |= MY_ATTR_LVALUE;
1048 } else if (sv_eq_pvs(attr, "method")) {
1049 builtin_attrs |= MY_ATTR_METHOD;
1054 lex_read_unichar(0);
1055 if (!(sv = my_scan_parens_tail(aTHX_ sen, TRUE))) {
1056 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
1058 sv_catpvs(attr, "(");
1060 sv_catpvs(attr, ")");
1063 c = lex_peek_unichar(0);
1067 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(attr)));
1071 lex_read_unichar(0);
1073 c = lex_peek_unichar(0);
1080 if (c != '{') /* '}' - hi, vim */ {
1081 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
1084 /* surprise predeclaration! */
1086 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
1087 starts parsing the body */
1088 const I32 sub_ix = start_subparse(FALSE, 0);
1089 SAVEFREESV(PL_compcv);
1091 SvREFCNT_inc_simple_void(PL_compcv);
1095 mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(saw_name)),
1096 proto ? mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(proto)) : NULL,
1102 if (builtin_attrs & MY_ATTR_LVALUE) {
1103 CvLVALUE_on(PL_compcv);
1105 if (builtin_attrs & MY_ATTR_METHOD) {
1106 CvMETHOD_on(PL_compcv);
1108 if (builtin_attrs & MY_ATTR_SPECIAL) {
1109 CvSPECIAL_on(PL_compcv);
1112 /* check number of arguments */
1113 if (spec->flags & FLAG_CHECK_NARGS) {
1116 amin = args_min(aTHX_ param_spec, spec);
1118 OP *chk, *cond, *err, *xcroak;
1120 err = mkconstsv(aTHX_ newSVpvf("Not enough arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amin));
1124 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1132 xcroak = newCVREF(OPf_WANT_SCALAR,
1133 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1134 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1135 op_append_elem(OP_LIST, err, xcroak));
1137 cond = newBINOP(OP_LT, 0,
1138 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1139 mkconstiv(aTHX_ amin));
1140 chk = newLOGOP(OP_AND, 0, cond, err);
1142 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1145 amax = args_max(param_spec);
1147 OP *chk, *cond, *err, *xcroak;
1149 err = mkconstsv(aTHX_ newSVpvf("Too many arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amax));
1153 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1163 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1165 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1166 op_append_elem(OP_LIST, err, xcroak));
1170 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1171 mkconstiv(aTHX_ amax)
1173 chk = newLOGOP(OP_AND, 0, cond, err);
1175 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1178 if (param_spec && (count_named_params(param_spec) || (param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%'))) {
1179 OP *chk, *cond, *err, *xcroak;
1180 const UV fixed = count_positional_params(param_spec) + !!param_spec->invocant.name;
1182 err = mkconstsv(aTHX_ newSVpvf("Odd number of paired arguments for %"SVf"", SVfARG(declarator)));
1186 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1188 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
1189 op_append_elem(OP_LIST, err, xcroak));
1191 cond = newBINOP(OP_GT, 0,
1192 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1193 mkconstiv(aTHX_ fixed));
1194 cond = newLOGOP(OP_AND, 0,
1196 newBINOP(OP_MODULO, 0,
1198 ? newBINOP(OP_SUBTRACT, 0,
1199 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1200 mkconstiv(aTHX_ fixed))
1201 : newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1202 mkconstiv(aTHX_ 2)));
1203 chk = newLOGOP(OP_AND, 0, cond, err);
1205 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1210 /* my $invocant = shift; */
1211 if (SvTRUE(spec->shift)) {
1216 OPf_MOD | (OPpLVAL_INTRO << 8),
1217 pad_add_name_sv(spec->shift, 0, NULL, NULL)
1219 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1221 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1224 /* my $invocant = shift; */
1225 if (param_spec->invocant.name) {
1230 OPf_MOD | (OPpLVAL_INTRO << 8),
1231 param_spec->invocant.padoff
1233 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1235 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1238 /* my (...) = @_; */
1245 for (i = 0, lim = param_spec->positional_required.used; i < lim; i++) {
1246 OP *const var = my_var(
1248 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1249 param_spec->positional_required.data[i].padoff
1251 lhs = op_append_elem(OP_LIST, lhs, var);
1254 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1255 OP *const var = my_var(
1257 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1258 param_spec->positional_optional.data[i].param.padoff
1260 lhs = op_append_elem(OP_LIST, lhs, var);
1270 * 1) no named params
1277 * => synthetic %{rest}
1278 * 2.2) slurpy is a hash
1280 * 2.3) slurpy is an array
1281 * => synthetic %{rest}
1282 * remember to declare array later
1285 slurpy_hash = param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%';
1286 if (!count_named_params(param_spec)) {
1287 if (param_spec->slurpy.name) {
1288 padoff = param_spec->slurpy.padoff;
1289 type = slurpy_hash ? OP_PADHV : OP_PADAV;
1291 padoff = NOT_IN_PAD;
1294 } else if (slurpy_hash) {
1295 padoff = param_spec->slurpy.padoff;
1298 padoff = param_spec->rest_hash = pad_add_name_pvs("%{rest}", 0, NULL, NULL);
1302 if (padoff != NOT_IN_PAD) {
1303 OP *const var = my_var_g(
1306 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1310 lhs = op_append_elem(OP_LIST, lhs, var);
1312 if (type == OP_PADHV) {
1313 param_spec->rest_hash = padoff;
1320 lhs->op_flags |= OPf_PARENS;
1321 rhs = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
1323 *prelude_sentinel = op_append_list(
1324 OP_LINESEQ, *prelude_sentinel,
1327 newASSIGNOP(OPf_STACKED, lhs, 0, rhs)
1333 /* default positional arguments */
1340 req = param_spec->positional_required.used;
1341 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1342 ParamInit *cur = ¶m_spec->positional_optional.data[i];
1347 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1348 mkconstiv(aTHX_ req + i + 1)
1351 var = my_var(aTHX_ 0, cur->param.padoff);
1353 nest = op_append_list(
1355 newASSIGNOP(OPf_STACKED, var, 0, cur->init)
1366 *prelude_sentinel = op_append_list(
1367 OP_LINESEQ, *prelude_sentinel,
1372 /* named parameters */
1373 if (count_named_params(param_spec)) {
1376 assert(param_spec->rest_hash != NOT_IN_PAD);
1378 for (i = 0, lim = param_spec->named_required.used; i < lim; i++) {
1379 Param *cur = ¶m_spec->named_required.data[i];
1381 char *p = SvPV(cur->name, n);
1384 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1386 if (spec->flags & FLAG_CHECK_NARGS) {
1389 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1390 var = newUNOP(OP_DELETE, 0, var);
1392 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": missing named parameter: %.*s", SVfARG(declarator), (int)(n - 1), p + 1));
1395 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1397 xcroak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, xcroak));
1399 cond = newUNOP(OP_EXISTS, 0, cond);
1401 cond = newCONDOP(0, cond, var, xcroak);
1406 OPf_MOD | (OPpLVAL_INTRO << 8),
1409 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1411 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1414 for (i = 0, lim = param_spec->named_optional.used; i < lim; i++) {
1415 ParamInit *cur = ¶m_spec->named_optional.data[i];
1417 char *p = SvPV(cur->param.name, n);
1420 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1421 var = newUNOP(OP_DELETE, 0, var);
1423 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1424 cond = newUNOP(OP_EXISTS, 0, cond);
1426 cond = newCONDOP(0, cond, var, cur->init);
1431 OPf_MOD | (OPpLVAL_INTRO << 8),
1434 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1436 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1439 if (!param_spec->slurpy.name) {
1440 if (spec->flags & FLAG_CHECK_NARGS) {
1441 /* croak if %{rest} */
1442 OP *xcroak, *cond, *keys, *msg;
1444 keys = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1445 keys = newLISTOP(OP_SORT, 0, newOP(OP_PUSHMARK, 0), keys);
1447 OP *first, *mid, *last;
1451 mid = mkconstpvs(", ");
1452 mid->op_sibling = last;
1454 first = newOP(OP_PUSHMARK, 0);
1456 keys = newLISTOP(OP_JOIN, 0, first, mid);
1457 keys->op_targ = pad_alloc(OP_JOIN, SVs_PADTMP);
1458 ((LISTOP *)keys)->op_last = last;
1461 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": no such named parameter: ", SVfARG(declarator)));
1462 msg = newBINOP(OP_CONCAT, 0, msg, keys);
1466 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1468 xcroak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, xcroak));
1470 cond = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1471 xcroak = newCONDOP(0, cond, xcroak, NULL);
1473 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, xcroak));
1477 clear = newASSIGNOP(
1479 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1484 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1486 } else if (param_spec->slurpy.padoff != param_spec->rest_hash) {
1489 assert(SvPV_nolen(param_spec->slurpy.name)[0] == '@');
1494 OPf_MOD | (OPpLVAL_INTRO << 8),
1495 param_spec->slurpy.padoff
1498 var = newASSIGNOP(OPf_STACKED, var, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1500 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1502 clear = newASSIGNOP(
1504 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1509 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1514 /* finally let perl parse the actual subroutine body */
1515 body = parse_block(0);
1517 /* add '();' to make function return nothing by default */
1518 /* (otherwise the invisible parameter initialization can "leak" into
1519 the return value: fun ($x) {}->("asdf", 0) == 2) */
1520 if (*prelude_sentinel) {
1521 body = newSTATEOP(0, NULL, body);
1524 body = op_append_list(OP_LINESEQ, *prelude_sentinel, body);
1525 *prelude_sentinel = NULL;
1529 OP *const attrs = *attrs_sentinel;
1530 *attrs_sentinel = NULL;
1531 SvREFCNT_inc_simple_void(PL_compcv);
1533 /* close outer block: '}' */
1534 S_block_end(aTHX_ save_ix, body);
1537 *pop = newANONATTRSUB(
1539 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1543 return KEYWORD_PLUGIN_EXPR;
1548 newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)),
1549 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1553 *pop = newOP(OP_NULL, 0);
1554 return KEYWORD_PLUGIN_STMT;
1558 static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
1561 Sentinel sen = { NULL };
1566 SAVEDESTRUCTOR_X(sentinel_clear_void, sen);
1568 if (kw_flags(aTHX_ sen, keyword_ptr, keyword_len, &spec)) {
1569 ret = parse_fun(aTHX_ sen, op_ptr, keyword_ptr, keyword_len, &spec);
1571 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
1582 MODULE = Function::Parameters PACKAGE = Function::Parameters
1587 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
1589 newCONSTSUB(stash, "FLAG_NAME_OK", newSViv(FLAG_NAME_OK));
1590 newCONSTSUB(stash, "FLAG_ANON_OK", newSViv(FLAG_ANON_OK));
1591 newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
1592 newCONSTSUB(stash, "FLAG_CHECK_NARGS", newSViv(FLAG_CHECK_NARGS));
1593 newCONSTSUB(stash, "FLAG_INVOCANT", newSViv(FLAG_INVOCANT));
1594 newCONSTSUB(stash, "FLAG_NAMED_PARAMS", newSViv(FLAG_NAMED_PARAMS));
1595 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
1596 newCONSTSUB(stash, "HINTK_FLAGS_", newSVpvs(HINTK_FLAGS_));
1597 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
1598 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
1600 next_keyword_plugin = PL_keyword_plugin;
1601 PL_keyword_plugin = my_keyword_plugin;