Merge branch 'master' into metadata
[p5sagit/Function-Parameters.git] / Parameters.xs
CommitLineData
db81d362 1/*
2Copyright 2012 Lukas Mai.
3
4This program is free software; you can redistribute it and/or modify it
5under the terms of either: the GNU General Public License as published
6by the Free Software Foundation; or the Artistic License.
7
8See http://dev.perl.org/licenses/ for more information.
9 */
10
11#ifdef __GNUC__
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)
15 #endif
16#endif
17
18#ifndef PRAGMA_GCC
19 #define PRAGMA_GCC(X)
20#endif
21
22#ifdef DEVEL
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) \
c3e72f35 29 /* WARNINGS_ENABLEW(-Wshadow) :-( */ \
db81d362 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)
38
39#else
40 #define WARNINGS_RESET
1bc47886 41 #define WARNINGS_ENABLE
db81d362 42#endif
43
44
7dd35535 45#define PERL_NO_GET_CONTEXT
db81d362 46#include "EXTERN.h"
47#include "perl.h"
48#include "XSUB.h"
49
50#include <string.h>
51
63915d26 52
db81d362 53WARNINGS_ENABLE
54
db81d362 55
7dd35535 56#define HAVE_PERL_VERSION(R, V, S) \
57 (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
58
de013990 59#if HAVE_PERL_VERSION(5, 16, 0)
60 #define IF_HAVE_PERL_5_16(YES, NO) YES
61#else
62 #define IF_HAVE_PERL_5_16(YES, NO) NO
63#endif
64
e158cf8f 65#if 0
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)
69 #define S_KEY_my 134
70 #elif HAVE_PERL_VERSION(5, 15, 6)
71 #define S_KEY_my 133
72 #elif HAVE_PERL_VERSION(5, 15, 5)
73 #define S_KEY_my 132
74 #elif HAVE_PERL_VERSION(5, 13, 0)
75 #define S_KEY_my 131
76 #else
77 #error "internal error: missing definition of KEY_my (your perl is too old)"
78 #endif
79#endif
80
63915d26 81
82#define MY_PKG "Function::Parameters"
83
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:"
88
89#define DEFSTRUCT(T) typedef struct T T; struct T
90
0f875412 91#define UV_BITS (sizeof (UV) * CHAR_BIT)
63915d26 92
93enum {
94 FLAG_NAME_OK = 0x01,
95 FLAG_ANON_OK = 0x02,
96 FLAG_DEFAULT_ARGS = 0x04,
d8e5d540 97 FLAG_CHECK_NARGS = 0x08,
e158cf8f 98 FLAG_INVOCANT = 0x10,
99 FLAG_NAMED_PARAMS = 0x20
63915d26 100};
101
102DEFSTRUCT(KWSpec) {
103 unsigned flags;
b72eb6ee 104 SV *shift;
105 SV *attrs;
63915d26 106};
db81d362 107
108static int (*next_keyword_plugin)(pTHX_ char *, STRLEN, OP **);
109
e4648f19 110DEFSTRUCT(Resource) {
111 Resource *next;
112 void *data;
113 void (*destroy)(pTHX_ void *);
114};
115
116typedef Resource *Sentinel[1];
117
118static void sentinel_clear_void(pTHX_ void *p) {
119 Resource **pp = p;
120 while (*pp) {
121 Resource *cur = *pp;
122 cur->destroy(aTHX_ cur->data);
123 cur->data = (void *)"no";
124 cur->destroy = NULL;
125 *pp = cur->next;
126 Safefree(cur);
127 }
128}
129
130static void sentinel_register(Sentinel sen, void *data, void (*destroy)(pTHX_ void *)) {
131 Resource *cur;
132
133 Newx(cur, 1, Resource);
134 cur->data = data;
135 cur->destroy = destroy;
136 cur->next = *sen;
137 *sen = cur;
138}
139
140static void my_sv_refcnt_dec_void(pTHX_ void *p) {
141 SV *sv = p;
142 SvREFCNT_dec(sv);
143}
144
145static SV *sentinel_mortalize(Sentinel sen, SV *sv) {
146 sentinel_register(sen, sv, my_sv_refcnt_dec_void);
147 return sv;
148}
149
e4648f19 150static int kw_flags(pTHX_ Sentinel sen, const char *kw_ptr, STRLEN kw_len, KWSpec *spec) {
db81d362 151 HV *hints;
152 SV *sv, **psv;
153 const char *p, *kw_active;
154 STRLEN kw_active_len;
155
63915d26 156 spec->flags = 0;
e4648f19 157 spec->shift = sentinel_mortalize(sen, newSVpvs(""));
158 spec->attrs = sentinel_mortalize(sen, newSVpvs(""));
db81d362 159
160 if (!(hints = GvHV(PL_hintgv))) {
161 return FALSE;
162 }
163 if (!(psv = hv_fetchs(hints, HINTK_KEYWORDS, 0))) {
164 return FALSE;
165 }
166 sv = *psv;
167 kw_active = SvPV(sv, kw_active_len);
168 if (kw_active_len <= kw_len) {
169 return FALSE;
170 }
e88490f6 171 for (
172 p = kw_active;
173 (p = strchr(p, *kw_ptr)) &&
174 p < kw_active + kw_active_len - kw_len;
175 p++
176 ) {
db81d362 177 if (
178 (p == kw_active || p[-1] == ' ') &&
179 p[kw_len] == ' ' &&
180 memcmp(kw_ptr, p, kw_len) == 0
181 ) {
b72eb6ee 182
d970c3e7 183#define FETCH_HINTK_INTO(NAME, PTR, LEN, X) STMT_START { \
b72eb6ee 184 const char *fk_ptr_; \
185 STRLEN fk_len_; \
186 SV *fk_sv_; \
e4648f19 187 fk_sv_ = sentinel_mortalize(sen, newSVpvs(HINTK_ ## NAME)); \
b72eb6ee 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_); \
192 } \
d970c3e7 193} STMT_END
b72eb6ee 194
63915d26 195 FETCH_HINTK_INTO(FLAGS_, kw_ptr, kw_len, psv);
196 spec->flags = SvIV(*psv);
db81d362 197
b72eb6ee 198 FETCH_HINTK_INTO(SHIFT_, kw_ptr, kw_len, psv);
199 SvSetSV(spec->shift, *psv);
db81d362 200
b72eb6ee 201 FETCH_HINTK_INTO(ATTRS_, kw_ptr, kw_len, psv);
202 SvSetSV(spec->attrs, *psv);
203
204#undef FETCH_HINTK_INTO
db81d362 205 return TRUE;
206 }
207 }
208 return FALSE;
209}
210
211
311ced6f 212static void free_ptr_op(pTHX_ void *vp) {
c311cef3 213 OP **pp = vp;
214 op_free(*pp);
215 Safefree(pp);
216}
217
59016bfb 218#define sv_eq_pvs(SV, S) my_sv_eq_pvn(aTHX_ SV, "" S "", sizeof (S) - 1)
c311cef3 219
59016bfb 220static int my_sv_eq_pvn(pTHX_ SV *sv, const char *p, STRLEN n) {
c311cef3 221 STRLEN sv_len;
222 const char *sv_p = SvPV(sv, sv_len);
59016bfb 223 return memcmp(sv_p, p, n) == 0;
c311cef3 224}
225
226
227#include "padop_on_crack.c.inc"
228
229
c311cef3 230enum {
231 MY_ATTR_LVALUE = 0x01,
232 MY_ATTR_METHOD = 0x02,
233 MY_ATTR_SPECIAL = 0x04
234};
235
31534187 236static void my_sv_cat_c(pTHX_ SV *sv, U32 c) {
237 char ds[UTF8_MAXBYTES + 1], *d;
67fc1ddb 238 d = (char *)uvchr_to_utf8((U8 *)ds, c);
31534187 239 if (d - ds > 1) {
240 sv_utf8_upgrade(sv);
241 }
242 sv_catpvn(sv, ds, d - ds);
243}
244
245static 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);
249}
250
251static 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);
255}
256
e4648f19 257static SV *my_scan_word(pTHX_ Sentinel sen, bool allow_package) {
31534187 258 bool at_start, at_substart;
259 I32 c;
e4648f19 260 SV *sv = sentinel_mortalize(sen, newSVpvs(""));
31534187 261 if (lex_bufutf8()) {
262 SvUTF8_on(sv);
263 }
264
265 at_start = at_substart = TRUE;
266 c = lex_peek_unichar(0);
267
268 while (c != -1) {
269 if (at_substart ? my_is_uni_xidfirst(aTHX_ c) : my_is_uni_xidcont(aTHX_ c)) {
270 lex_read_unichar(0);
271 my_sv_cat_c(aTHX_ sv, c);
272 at_substart = FALSE;
273 c = lex_peek_unichar(0);
274 } else if (allow_package && !at_substart && c == '\'') {
275 lex_read_unichar(0);
276 c = lex_peek_unichar(0);
277 if (!my_is_uni_xidfirst(aTHX_ c)) {
278 lex_stuff_pvs("'", 0);
279 break;
280 }
281 sv_catpvs(sv, "'");
282 at_substart = TRUE;
283 } else if (allow_package && (at_start || !at_substart) && c == ':') {
284 lex_read_unichar(0);
285 if (lex_peek_unichar(0) != ':') {
286 lex_stuff_pvs(":", 0);
287 break;
288 }
289 lex_read_unichar(0);
290 c = lex_peek_unichar(0);
291 if (!my_is_uni_xidfirst(aTHX_ c)) {
292 lex_stuff_pvs("::", 0);
293 break;
294 }
295 sv_catpvs(sv, "::");
296 at_substart = TRUE;
297 } else {
298 break;
299 }
300 at_start = FALSE;
301 }
302
303 return SvCUR(sv) ? sv : NULL;
304}
305
e4648f19 306static SV *my_scan_parens_tail(pTHX_ Sentinel sen, bool keep_backslash) {
31534187 307 I32 c, nesting;
308 SV *sv;
309 line_t start;
310
311 start = CopLINE(PL_curcop);
312
e4648f19 313 sv = sentinel_mortalize(sen, newSVpvs(""));
31534187 314 if (lex_bufutf8()) {
315 SvUTF8_on(sv);
316 }
317
318 nesting = 0;
319 for (;;) {
320 c = lex_read_unichar(0);
321 if (c == EOF) {
322 CopLINE_set(PL_curcop, start);
323 return NULL;
324 }
325
326 if (c == '\\') {
327 c = lex_read_unichar(0);
328 if (c == EOF) {
329 CopLINE_set(PL_curcop, start);
330 return NULL;
331 }
332 if (keep_backslash || (c != '(' && c != ')')) {
333 sv_catpvs(sv, "\\");
334 }
335 } else if (c == '(') {
336 nesting++;
337 } else if (c == ')') {
338 if (!nesting) {
339 break;
340 }
341 nesting--;
342 }
343
344 my_sv_cat_c(aTHX_ sv, c);
345 }
346
347 return sv;
348}
349
e4648f19 350static void my_check_prototype(pTHX_ Sentinel sen, const SV *declarator, SV *proto) {
31534187 351 char *start, *r, *w, *end;
352 STRLEN len;
353
354 /* strip spaces */
355 start = SvPV(proto, len);
356 end = start + len;
357
358 for (w = r = start; r < end; r++) {
359 if (!isSPACE(*r)) {
360 *w++ = *r;
361 }
362 }
363 *w = '\0';
364 SvCUR_set(proto, w - start);
365 end = w;
366 len = end - start;
367
368 if (!ckWARN(WARN_ILLEGALPROTO)) {
369 return;
370 }
371
372 /* check for bad characters */
373 if (strspn(start, "$@%*;[]&\\_+") != len) {
e4648f19 374 SV *dsv = sentinel_mortalize(sen, newSVpvs(""));
31534187 375 warner(
376 packWARN(WARN_ILLEGALPROTO),
377 "Illegal character in prototype for %"SVf" : %s",
378 SVfARG(declarator),
379 SvUTF8(proto)
380 ? sv_uni_display(
381 dsv,
382 proto,
383 len,
384 UNI_DISPLAY_ISPRINT
385 )
386 : pv_pretty(dsv, start, len, 60, NULL, NULL,
387 PERL_PV_ESCAPE_NONASCII
388 )
389 );
390 return;
391 }
392
393 for (r = start; r < end; r++) {
394 switch (*r) {
395 default:
396 warner(
397 packWARN(WARN_ILLEGALPROTO),
398 "Illegal character in prototype for %"SVf" : %s",
399 SVfARG(declarator), r
400 );
401 return;
402
403 case '_':
404 if (r[1] && !strchr(";@%", *r)) {
405 warner(
406 packWARN(WARN_ILLEGALPROTO),
407 "Illegal character after '_' in prototype for %"SVf" : %s",
408 SVfARG(declarator), r
409 );
410 return;
411 }
412 break;
413
414 case '@':
415 case '%':
416 if (r[1]) {
417 warner(
418 packWARN(WARN_ILLEGALPROTO),
419 "prototype after '%c' for %"SVf": %s",
420 *r, SVfARG(declarator), r + 1
421 );
422 return;
423 }
424 break;
425
426 case '\\':
427 r++;
428 if (strchr("$@%&*", *r)) {
429 break;
430 }
431 if (*r == '[') {
432 r++;
433 for (; r < end && *r != ']'; r++) {
434 if (!strchr("$@%&*", *r)) {
435 break;
436 }
437 }
438 if (*r == ']' && r[-1] != '[') {
439 break;
440 }
441 }
442 warner(
443 packWARN(WARN_ILLEGALPROTO),
444 "Illegal character after '\\' in prototype for %"SVf" : %s",
445 SVfARG(declarator), r
446 );
447 return;
448
449 case '$':
450 case '*':
451 case '&':
452 case ';':
453 case '+':
454 break;
455 }
456 }
457}
458
e158cf8f 459
460DEFSTRUCT(Param) {
461 SV *name;
462 PADOFFSET padoff;
463};
464
465DEFSTRUCT(ParamInit) {
466 Param param;
467 OP *init;
468};
469
470#define VEC(B) B ## _Vec
471
472#define DEFVECTOR(B) DEFSTRUCT(VEC(B)) { \
473 B (*data); \
474 size_t used, size; \
475}
476
477DEFVECTOR(Param);
478DEFVECTOR(ParamInit);
479
480#define DEFVECTOR_INIT(N, B) static void N(VEC(B) *p) { \
481 p->used = 0; \
482 p->size = 23; \
483 Newx(p->data, p->size, B); \
484} static void N(VEC(B) *)
485
486DEFSTRUCT(ParamSpec) {
487 Param invocant;
488 VEC(Param) positional_required;
489 VEC(ParamInit) positional_optional;
490 VEC(Param) named_required;
491 VEC(ParamInit) named_optional;
492 Param slurpy;
fc634bba 493 PADOFFSET rest_hash;
e158cf8f 494};
495
496DEFVECTOR_INIT(pv_init, Param);
497DEFVECTOR_INIT(piv_init, ParamInit);
498
499static void p_init(Param *p) {
500 p->name = NULL;
501 p->padoff = NOT_IN_PAD;
502}
503
504static 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);
510 p_init(&ps->slurpy);
fc634bba 511 ps->rest_hash = NOT_IN_PAD;
e158cf8f 512}
513
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); \
519 p->size = n; \
520 } \
521 return &p->data[p->used]; \
522} static B (*N(VEC(B) *))
523
524DEFVECTOR_EXTEND(pv_extend, Param);
525DEFVECTOR_EXTEND(piv_extend, ParamInit);
526
527#define DEFVECTOR_CLEAR(N, B, F) static void N(pTHX_ VEC(B) *p) { \
528 while (p->used) { \
529 p->used--; \
530 F(aTHX_ &p->data[p->used]); \
531 } \
532 Safefree(p->data); \
533 p->data = NULL; \
534 p->size = 0; \
535} static void N(pTHX_ VEC(B) *)
536
537static void p_clear(pTHX_ Param *p) {
538 p->name = NULL;
539 p->padoff = NOT_IN_PAD;
540}
541
542static void pi_clear(pTHX_ ParamInit *pi) {
543 p_clear(aTHX_ &pi->param);
544 if (pi->init) {
545 op_free(pi->init);
546 pi->init = NULL;
547 }
548}
549
550DEFVECTOR_CLEAR(pv_clear, Param, p_clear);
551DEFVECTOR_CLEAR(piv_clear, ParamInit, pi_clear);
552
553static void ps_clear(pTHX_ ParamSpec *ps) {
554 p_clear(aTHX_ &ps->invocant);
555
556 pv_clear(aTHX_ &ps->positional_required);
557 piv_clear(aTHX_ &ps->positional_optional);
558
559 pv_clear(aTHX_ &ps->named_required);
560 piv_clear(aTHX_ &ps->named_optional);
561
562 p_clear(aTHX_ &ps->slurpy);
563}
564
565static int ps_contains(pTHX_ const ParamSpec *ps, SV *sv) {
566 size_t i, lim;
567
568 if (ps->invocant.name && sv_eq(sv, ps->invocant.name)) {
569 return 1;
570 }
571
572 for (i = 0, lim = ps->positional_required.used; i < lim; i++) {
573 if (sv_eq(sv, ps->positional_required.data[i].name)) {
574 return 1;
575 }
576 }
577
578 for (i = 0, lim = ps->positional_optional.used; i < lim; i++) {
579 if (sv_eq(sv, ps->positional_optional.data[i].param.name)) {
580 return 1;
581 }
582 }
583
584 for (i = 0, lim = ps->named_required.used; i < lim; i++) {
585 if (sv_eq(sv, ps->named_required.data[i].name)) {
586 return 1;
587 }
588 }
589
590 for (i = 0, lim = ps->named_optional.used; i < lim; i++) {
591 if (sv_eq(sv, ps->named_optional.data[i].param.name)) {
592 return 1;
593 }
594 }
595
596 return 0;
597}
598
599static void ps_free_void(pTHX_ void *p) {
600 ps_clear(aTHX_ p);
601 Safefree(p);
602}
603
604static int args_min(pTHX_ const ParamSpec *ps, const KWSpec *ks) {
605 int n = 0;
606 if (!ps) {
607 return SvTRUE(ks->shift) ? 1 : 0;
608 }
609 if (ps->invocant.name) {
610 n++;
611 }
612 n += ps->positional_required.used;
613 n += ps->named_required.used * 2;
614 return n;
615}
616
617static int args_max(const ParamSpec *ps) {
618 int n = 0;
619 if (!ps) {
620 return -1;
621 }
622 if (ps->invocant.name) {
623 n++;
624 }
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) {
628 n = -1;
629 }
630 return n;
631}
632
633static size_t count_positional_params(const ParamSpec *ps) {
634 return ps->positional_required.used + ps->positional_optional.used;
635}
636
637static size_t count_named_params(const ParamSpec *ps) {
638 return ps->named_required.used + ps->named_optional.used;
639}
640
641enum {
642 PARAM_INVOCANT = 0x01,
643 PARAM_NAMED = 0x02
644};
645
646/* *pinit must be NULL on entry.
647 * caller must free *pinit on error.
648 */
649static PADOFFSET parse_param(
650 pTHX_
e4648f19 651 Sentinel sen,
e158cf8f 652 const SV *declarator, const KWSpec *spec, ParamSpec *param_spec,
653 int *pflags, SV **pname, OP **pinit
654) {
655 I32 c;
656 char sigil;
657 SV *name;
658
659 assert(!*pinit);
660 *pflags = 0;
661
662 c = lex_peek_unichar(0);
663
664 if (c == ':') {
665 lex_read_unichar(0);
666 lex_read_space(0);
667
668 *pflags |= PARAM_NAMED;
669
670 c = lex_peek_unichar(0);
671 }
672
673 if (c == -1) {
674 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
675 }
676 if (!(c == '$' || c == '@' || c == '%')) {
677 croak("In %"SVf": unexpected '%c' in parameter list (expecting a sigil)", SVfARG(declarator), (int)c);
678 }
679
680 sigil = c;
681
682 lex_read_unichar(0);
683 lex_read_space(0);
684
e4648f19 685 if (!(name = my_scan_word(aTHX_ sen, FALSE))) {
e158cf8f 686 croak("In %"SVf": missing identifier after '%c'", SVfARG(declarator), sigil);
687 }
688 sv_insert(name, 0, 0, &sigil, 1);
689 *pname = name;
690
691 lex_read_space(0);
692 c = lex_peek_unichar(0);
693
694 if (c == '=') {
695 lex_read_unichar(0);
696 lex_read_space(0);
697
698
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);
702 }
703
704 *pinit = parse_termexpr(0);
705
706 lex_read_space(0);
707 c = lex_peek_unichar(0);
708 }
709
710 if (c == ':') {
711 *pflags |= PARAM_INVOCANT;
712 lex_read_unichar(0);
713 lex_read_space(0);
714 } else if (c == ',') {
715 lex_read_unichar(0);
716 lex_read_space(0);
717 } else if (c != ')') {
718 if (c == -1) {
719 croak("In %"SVf": unterminated parameter list", SVfARG(declarator));
720 }
721 croak("In %"SVf": unexpected '%c' in parameter list (expecting ',')", SVfARG(declarator), (int)c);
722 }
723
724 return pad_add_name_sv(*pname, IF_HAVE_PERL_5_16(padadd_NO_DUP_CHECK, 0), NULL, NULL);
725}
726
727static OP *my_var_g(pTHX_ I32 type, I32 flags, PADOFFSET padoff) {
728 OP *var = newOP(type, flags);
729 var->op_targ = padoff;
730 return var;
731}
732
733static OP *my_var(pTHX_ I32 flags, PADOFFSET padoff) {
734 return my_var_g(aTHX_ OP_PADSV, flags, padoff);
735}
736
fc634bba 737static 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);
740}
741
742static OP *mkconstsv(pTHX_ SV *sv) {
743 return newSVOP(OP_CONST, 0, sv);
744}
745
746static OP *mkconstiv(pTHX_ IV i) {
747 return mkconstsv(aTHX_ newSViv(i));
748}
749
750static OP *mkconstpv(pTHX_ const char *p, size_t n) {
751 return mkconstsv(aTHX_ newSVpv(p, n));
752}
753
754#define mkconstpvs(S) mkconstpv(aTHX_ "" S "", sizeof S - 1)
755
53c979f0 756static void register_info(pTHX_ UV key, SV *declarator, const KWSpec *kws, const ParamSpec *ps) {
757 dSP;
758
759 ENTER;
760 SAVETMPS;
761
762 PUSHMARK(SP);
763 EXTEND(SP, 8);
764
765 /* 0 */ {
766 mPUSHu(key);
767 }
768 /* 1 */ {
769 size_t n;
770 char *p = SvPV(declarator, n);
771 char *q = memchr(p, ' ', n);
79bce2d4 772 mPUSHp(p, q ? (size_t)(q - p) : n);
53c979f0 773 }
774 if (!ps) {
775 if (SvTRUE(kws->shift)) {
776 PUSHs(kws->shift);
777 } else {
778 PUSHmortal;
779 }
780 mPUSHs(newRV_noinc((SV *)newAV()));
781 mPUSHs(newRV_noinc((SV *)newAV()));
782 mPUSHs(newRV_noinc((SV *)newAV()));
783 mPUSHs(newRV_noinc((SV *)newAV()));
784 mPUSHp("@_", 2);
785 } else {
786 /* 2 */ {
787 if (ps->invocant.name) {
788 PUSHs(ps->invocant.name);
789 } else {
790 PUSHmortal;
791 }
792 }
793 /* 3 */ {
794 size_t i, lim;
795 AV *av;
796
797 lim = ps->positional_required.used;
798
799 av = newAV();
800 if (lim) {
801 av_extend(av, lim - 1);
802 for (i = 0; i < lim; i++) {
803 av_push(av, SvREFCNT_inc_simple_NN(ps->positional_required.data[i].name));
804 }
805 }
806
807 mPUSHs(newRV_noinc((SV *)av));
808 }
809 /* 4 */ {
810 size_t i, lim;
811 AV *av;
812
813 lim = ps->positional_optional.used;
814
815 av = newAV();
816 if (lim) {
817 av_extend(av, lim - 1);
818 for (i = 0; i < lim; i++) {
819 av_push(av, SvREFCNT_inc_simple_NN(ps->positional_optional.data[i].param.name));
820 }
821 }
822
823 mPUSHs(newRV_noinc((SV *)av));
824 }
825 /* 5 */ {
826 size_t i, lim;
827 AV *av;
828
829 lim = ps->named_required.used;
830
831 av = newAV();
832 if (lim) {
833 av_extend(av, lim - 1);
834 for (i = 0; i < lim; i++) {
835 av_push(av, SvREFCNT_inc_simple_NN(ps->named_required.data[i].name));
836 }
837 }
838
839 mPUSHs(newRV_noinc((SV *)av));
840 }
841 /* 6 */ {
842 size_t i, lim;
843 AV *av;
844
845 lim = ps->named_optional.used;
846
847 av = newAV();
848 if (lim) {
849 av_extend(av, lim - 1);
850 for (i = 0; i < lim; i++) {
851 av_push(av, SvREFCNT_inc_simple_NN(ps->named_optional.data[i].param.name));
852 }
853 }
854
855 mPUSHs(newRV_noinc((SV *)av));
856 }
857 /* 7 */ {
858 if (ps->slurpy.name) {
859 PUSHs(ps->slurpy.name);
860 } else {
861 PUSHmortal;
862 }
863 }
864 }
865 PUTBACK;
866
867 call_pv(MY_PKG "::_register_info", G_VOID);
868
869 FREETMPS;
870 LEAVE;
871}
872
e4648f19 873static int parse_fun(pTHX_ Sentinel sen, OP **pop, const char *keyword_ptr, STRLEN keyword_len, const KWSpec *spec) {
e158cf8f 874 ParamSpec *param_spec;
c311cef3 875 SV *declarator;
876 I32 floor_ix;
63915d26 877 int save_ix;
c311cef3 878 SV *saw_name;
1e0f1595 879 OP **prelude_sentinel;
c311cef3 880 SV *proto;
881 OP **attrs_sentinel, *body;
882 unsigned builtin_attrs;
db81d362 883 I32 c;
884
e4648f19 885 declarator = sentinel_mortalize(sen, newSVpvn(keyword_ptr, keyword_len));
db81d362 886
db81d362 887 lex_read_space(0);
888
c311cef3 889 builtin_attrs = 0;
890
db81d362 891 /* function name */
c311cef3 892 saw_name = NULL;
e4648f19 893 if ((spec->flags & FLAG_NAME_OK) && (saw_name = my_scan_word(aTHX_ sen, TRUE))) {
c311cef3 894
895 if (PL_parser->expect != XSTATE) {
896 /* bail out early so we don't predeclare $saw_name */
897 croak("In %"SVf": I was expecting a function body, not \"%"SVf"\"", SVfARG(declarator), SVfARG(saw_name));
898 }
899
db81d362 900 sv_catpvs(declarator, " ");
c311cef3 901 sv_catsv(declarator, saw_name);
902
903 if (
904 sv_eq_pvs(saw_name, "BEGIN") ||
905 sv_eq_pvs(saw_name, "END") ||
906 sv_eq_pvs(saw_name, "INIT") ||
907 sv_eq_pvs(saw_name, "CHECK") ||
908 sv_eq_pvs(saw_name, "UNITCHECK")
909 ) {
910 builtin_attrs |= MY_ATTR_SPECIAL;
911 }
912
db81d362 913 lex_read_space(0);
63915d26 914 } else if (!(spec->flags & FLAG_ANON_OK)) {
31534187 915 croak("I was expecting a function name, not \"%.*s\"", (int)(PL_parser->bufend - PL_parser->bufptr), PL_parser->bufptr);
db81d362 916 } else {
917 sv_catpvs(declarator, " (anon)");
918 }
919
63915d26 920 /* we're a subroutine declaration */
c311cef3 921 floor_ix = start_subparse(FALSE, saw_name ? 0 : CVf_ANON);
922 SAVEFREESV(PL_compcv);
923
63915d26 924 /* create outer block: '{' */
925 save_ix = S_block_start(aTHX_ TRUE);
926
1e0f1595 927 /* initialize synthetic optree */
928 Newx(prelude_sentinel, 1, OP *);
929 *prelude_sentinel = NULL;
e4648f19 930 sentinel_register(sen, prelude_sentinel, free_ptr_op);
1e0f1595 931
db81d362 932 /* parameters */
e158cf8f 933 param_spec = NULL;
63915d26 934
db81d362 935 c = lex_peek_unichar(0);
936 if (c == '(') {
e158cf8f 937 OP **init_sentinel;
938
939 Newx(init_sentinel, 1, OP *);
940 *init_sentinel = NULL;
e4648f19 941 sentinel_register(sen, init_sentinel, free_ptr_op);
e158cf8f 942
943 Newx(param_spec, 1, ParamSpec);
944 ps_init(param_spec);
e4648f19 945 sentinel_register(sen, param_spec, ps_free_void);
db81d362 946
947 lex_read_unichar(0);
948 lex_read_space(0);
949
e158cf8f 950 while ((c = lex_peek_unichar(0)) != ')') {
951 int flags;
952 SV *name;
953 char sigil;
954 PADOFFSET padoff;
c311cef3 955
e4648f19 956 padoff = parse_param(aTHX_ sen, declarator, spec, param_spec, &flags, &name, init_sentinel);
c311cef3 957
e158cf8f 958 S_intro_my(aTHX);
63915d26 959
e158cf8f 960 sigil = SvPV_nolen(name)[0];
db81d362 961
e158cf8f 962 /* internal consistency */
963 if (flags & PARAM_NAMED) {
964 if (flags & PARAM_INVOCANT) {
965 croak("In %"SVf": invocant %"SVf" can't be a named parameter", SVfARG(declarator), SVfARG(name));
db81d362 966 }
e158cf8f 967 if (sigil != '$') {
968 croak("In %"SVf": named parameter %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
db81d362 969 }
e158cf8f 970 } else if (flags & PARAM_INVOCANT) {
971 if (*init_sentinel) {
972 croak("In %"SVf": invocant %"SVf" can't have a default value", SVfARG(declarator), SVfARG(name));
db81d362 973 }
e158cf8f 974 if (sigil != '$') {
975 croak("In %"SVf": invocant %"SVf" can't be a%s", SVfARG(declarator), SVfARG(name), sigil == '@' ? "n array" : " hash");
976 }
977 } else if (sigil != '$' && *init_sentinel) {
978 croak("In %"SVf": %s %"SVf" can't have a default value", SVfARG(declarator), sigil == '@' ? "array" : "hash", SVfARG(name));
979 }
db81d362 980
e158cf8f 981 /* external constraints */
982 if (param_spec->slurpy.name) {
983 croak("In %"SVf": I was expecting \")\" after \"%"SVf"\", not \"%"SVf"\"", SVfARG(declarator), SVfARG(param_spec->slurpy.name), SVfARG(name));
984 }
985 if (sigil != '$') {
986 assert(!*init_sentinel);
987 param_spec->slurpy.name = name;
988 param_spec->slurpy.padoff = padoff;
989 continue;
990 }
d8e5d540 991
e158cf8f 992 if (!(flags & PARAM_NAMED) && count_named_params(param_spec)) {
993 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));
994 }
d8e5d540 995
e158cf8f 996 if (flags & PARAM_INVOCANT) {
997 if (param_spec->invocant.name) {
998 croak("In %"SVf": invalid double invocants %"SVf", %"SVf"", SVfARG(declarator), SVfARG(param_spec->invocant.name), SVfARG(name));
999 }
1000 if (count_positional_params(param_spec) || count_named_params(param_spec)) {
1001 croak("In %"SVf": invocant %"SVf" must be first in parameter list", SVfARG(declarator), SVfARG(name));
63915d26 1002 }
e158cf8f 1003 if (!(spec->flags & FLAG_INVOCANT)) {
1004 croak("In %"SVf": invocant %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
1005 }
1006 param_spec->invocant.name = name;
1007 param_spec->invocant.padoff = padoff;
1008 continue;
1009 }
63915d26 1010
e158cf8f 1011 if (*init_sentinel && !(spec->flags & FLAG_DEFAULT_ARGS)) {
1012 croak("In %"SVf": default argument for %"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
1013 }
1e0f1595 1014
e158cf8f 1015 if (ps_contains(aTHX_ param_spec, name)) {
1016 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(name));
1017 }
1e0f1595 1018
e158cf8f 1019 if (flags & PARAM_NAMED) {
1020 if (!(spec->flags & FLAG_NAMED_PARAMS)) {
1021 croak("In %"SVf": named parameter :%"SVf" not allowed here", SVfARG(declarator), SVfARG(name));
1e0f1595 1022 }
1023
e158cf8f 1024 if (*init_sentinel) {
1025 ParamInit *pi = piv_extend(&param_spec->named_optional);
1026 pi->param.name = name;
1027 pi->param.padoff = padoff;
1028 pi->init = *init_sentinel;
1029 *init_sentinel = NULL;
1030 param_spec->named_optional.used++;
1031 } else {
67fc1ddb 1032 Param *p;
1033
e158cf8f 1034 if (param_spec->positional_optional.used) {
1035 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));
1036 }
d8e5d540 1037
67fc1ddb 1038 p = pv_extend(&param_spec->named_required);
e158cf8f 1039 p->name = name;
1040 p->padoff = padoff;
1041 param_spec->named_required.used++;
1042 }
1043 } else {
1044 if (*init_sentinel || param_spec->positional_optional.used) {
1045 ParamInit *pi = piv_extend(&param_spec->positional_optional);
1046 pi->param.name = name;
1047 pi->param.padoff = padoff;
1048 pi->init = *init_sentinel;
1049 *init_sentinel = NULL;
1050 param_spec->positional_optional.used++;
1051 } else {
1052 Param *p = pv_extend(&param_spec->positional_required);
1053 p->name = name;
1054 p->padoff = padoff;
1055 param_spec->positional_required.used++;
db81d362 1056 }
1057 }
1058
e158cf8f 1059 }
1060 lex_read_unichar(0);
1061 lex_read_space(0);
1062 *init_sentinel = NULL;
db81d362 1063
e158cf8f 1064 if (!param_spec->invocant.name && SvTRUE(spec->shift)) {
1065 if (ps_contains(aTHX_ param_spec, spec->shift)) {
1066 croak("In %"SVf": %"SVf" can't appear twice in the same parameter list", SVfARG(declarator), SVfARG(spec->shift));
db81d362 1067 }
e158cf8f 1068
1069 param_spec->invocant.name = spec->shift;
1070 param_spec->invocant.padoff = pad_add_name_sv(param_spec->invocant.name, 0, NULL, NULL);
db81d362 1071 }
1072 }
1073
1074 /* prototype */
c311cef3 1075 proto = NULL;
db81d362 1076 c = lex_peek_unichar(0);
1077 if (c == ':') {
1078 lex_read_unichar(0);
1079 lex_read_space(0);
1080
1081 c = lex_peek_unichar(0);
1082 if (c != '(') {
c311cef3 1083 lex_stuff_pvs(":", 0);
1084 c = ':';
db81d362 1085 } else {
31534187 1086 lex_read_unichar(0);
e4648f19 1087 if (!(proto = my_scan_parens_tail(aTHX_ sen, FALSE))) {
f34187b8 1088 croak("In %"SVf": prototype not terminated", SVfARG(declarator));
db81d362 1089 }
e4648f19 1090 my_check_prototype(aTHX_ sen, declarator, proto);
db81d362 1091 lex_read_space(0);
c311cef3 1092 c = lex_peek_unichar(0);
514bcaa6 1093 if (!(c == ':' || c == '{')) {
1094 lex_stuff_pvs(":", 0);
1095 c = ':';
1096 }
db81d362 1097 }
1098 }
1099
db81d362 1100 /* attributes */
c311cef3 1101 Newx(attrs_sentinel, 1, OP *);
1102 *attrs_sentinel = NULL;
e4648f19 1103 sentinel_register(sen, attrs_sentinel, free_ptr_op);
c311cef3 1104
63915d26 1105 if (c == ':' || c == '{') /* '}' - hi, vim */ {
c311cef3 1106
1107 /* kludge default attributes in */
1108 if (SvTRUE(spec->attrs) && SvPV_nolen(spec->attrs)[0] == ':') {
1109 lex_stuff_sv(spec->attrs, 0);
1110 c = ':';
1111 }
b72eb6ee 1112
db81d362 1113 if (c == ':') {
db81d362 1114 lex_read_unichar(0);
1115 lex_read_space(0);
db81d362 1116 c = lex_peek_unichar(0);
c311cef3 1117
1118 for (;;) {
1119 SV *attr;
1120
e4648f19 1121 if (!(attr = my_scan_word(aTHX_ sen, FALSE))) {
c311cef3 1122 break;
db81d362 1123 }
c311cef3 1124
db81d362 1125 lex_read_space(0);
1126 c = lex_peek_unichar(0);
c311cef3 1127
1128 if (c != '(') {
1129 if (sv_eq_pvs(attr, "lvalue")) {
1130 builtin_attrs |= MY_ATTR_LVALUE;
1131 attr = NULL;
1132 } else if (sv_eq_pvs(attr, "method")) {
1133 builtin_attrs |= MY_ATTR_METHOD;
1134 attr = NULL;
1135 }
1136 } else {
31534187 1137 SV *sv;
1138 lex_read_unichar(0);
e4648f19 1139 if (!(sv = my_scan_parens_tail(aTHX_ sen, TRUE))) {
c311cef3 1140 croak("In %"SVf": unterminated attribute parameter in attribute list", SVfARG(declarator));
1141 }
31534187 1142 sv_catpvs(attr, "(");
c311cef3 1143 sv_catsv(attr, sv);
31534187 1144 sv_catpvs(attr, ")");
c311cef3 1145
1146 lex_read_space(0);
1147 c = lex_peek_unichar(0);
1148 }
1149
1150 if (attr) {
fc634bba 1151 *attrs_sentinel = op_append_elem(OP_LIST, *attrs_sentinel, mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(attr)));
c311cef3 1152 }
1153
1154 if (c == ':') {
1155 lex_read_unichar(0);
1156 lex_read_space(0);
1157 c = lex_peek_unichar(0);
1158 }
db81d362 1159 }
1160 }
1161 }
1162
1163 /* body */
63915d26 1164 if (c != '{') /* '}' - hi, vim */ {
85bc3fbd 1165 croak("In %"SVf": I was expecting a function body, not \"%c\"", SVfARG(declarator), (int)c);
db81d362 1166 }
c311cef3 1167
63915d26 1168 /* surprise predeclaration! */
1169 if (saw_name) {
1170 /* 'sub NAME (PROTO);' to make name/proto known to perl before it
1171 starts parsing the body */
1172 const I32 sub_ix = start_subparse(FALSE, 0);
1173 SAVEFREESV(PL_compcv);
1174
1175 SvREFCNT_inc_simple_void(PL_compcv);
1176
1177 newATTRSUB(
1178 sub_ix,
fc634bba 1179 mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(saw_name)),
1180 proto ? mkconstsv(aTHX_ SvREFCNT_inc_simple_NN(proto)) : NULL,
63915d26 1181 NULL,
1182 NULL
1183 );
1184 }
1185
c311cef3 1186 if (builtin_attrs & MY_ATTR_LVALUE) {
1187 CvLVALUE_on(PL_compcv);
db81d362 1188 }
c311cef3 1189 if (builtin_attrs & MY_ATTR_METHOD) {
1190 CvMETHOD_on(PL_compcv);
1191 }
1192 if (builtin_attrs & MY_ATTR_SPECIAL) {
1193 CvSPECIAL_on(PL_compcv);
db81d362 1194 }
1195
e158cf8f 1196 /* check number of arguments */
1e0f1595 1197 if (spec->flags & FLAG_CHECK_NARGS) {
e158cf8f 1198 int amin, amax;
abccbe86 1199
e158cf8f 1200 amin = args_min(aTHX_ param_spec, spec);
1201 if (amin > 0) {
67fc1ddb 1202 OP *chk, *cond, *err, *xcroak;
63915d26 1203
fc634bba 1204 err = mkconstsv(aTHX_ newSVpvf("Not enough arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amin));
1205 err = newBINOP(
1206 OP_CONCAT, 0,
1207 err,
1208 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1209 );
1210 err = newBINOP(
1211 OP_CONCAT, 0,
1212 err,
1213 mkconstpvs(")")
1214 );
63915d26 1215
67fc1ddb 1216 xcroak = newCVREF(OPf_WANT_SCALAR,
1217 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV)));
1e0f1595 1218 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
67fc1ddb 1219 op_append_elem(OP_LIST, err, xcroak));
63915d26 1220
1e0f1595 1221 cond = newBINOP(OP_LT, 0,
5f50e017 1222 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
fc634bba 1223 mkconstiv(aTHX_ amin));
1e0f1595 1224 chk = newLOGOP(OP_AND, 0, cond, err);
63915d26 1225
1e0f1595 1226 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1227 }
abccbe86 1228
e158cf8f 1229 amax = args_max(param_spec);
1230 if (amax >= 0) {
67fc1ddb 1231 OP *chk, *cond, *err, *xcroak;
63915d26 1232
fc634bba 1233 err = mkconstsv(aTHX_ newSVpvf("Too many arguments for %"SVf" (expected %d, got ", SVfARG(declarator), amax));
1234 err = newBINOP(
1235 OP_CONCAT, 0,
1236 err,
1237 newAVREF(newGVOP(OP_GV, 0, PL_defgv))
1238 );
1239 err = newBINOP(
1240 OP_CONCAT, 0,
1241 err,
1242 mkconstpvs(")")
1243 );
63915d26 1244
67fc1ddb 1245 xcroak = newCVREF(
fc634bba 1246 OPf_WANT_SCALAR,
1247 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1248 );
1e0f1595 1249 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
67fc1ddb 1250 op_append_elem(OP_LIST, err, xcroak));
63915d26 1251
fc634bba 1252 cond = newBINOP(
1253 OP_GT, 0,
1254 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1255 mkconstiv(aTHX_ amax)
1256 );
1e0f1595 1257 chk = newLOGOP(OP_AND, 0, cond, err);
63915d26 1258
1e0f1595 1259 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
1260 }
e158cf8f 1261
1262 if (param_spec && (count_named_params(param_spec) || (param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%'))) {
67fc1ddb 1263 OP *chk, *cond, *err, *xcroak;
e158cf8f 1264 const UV fixed = count_positional_params(param_spec) + !!param_spec->invocant.name;
63915d26 1265
fc634bba 1266 err = mkconstsv(aTHX_ newSVpvf("Odd number of paired arguments for %"SVf"", SVfARG(declarator)));
63915d26 1267
67fc1ddb 1268 xcroak = newCVREF(
fc634bba 1269 OPf_WANT_SCALAR,
1270 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1271 );
1e0f1595 1272 err = newUNOP(OP_ENTERSUB, OPf_STACKED,
67fc1ddb 1273 op_append_elem(OP_LIST, err, xcroak));
63915d26 1274
1e0f1595 1275 cond = newBINOP(OP_GT, 0,
5f50e017 1276 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
fc634bba 1277 mkconstiv(aTHX_ fixed));
e158cf8f 1278 cond = newLOGOP(OP_AND, 0,
fc634bba 1279 cond,
1280 newBINOP(OP_MODULO, 0,
1281 fixed
1282 ? newBINOP(OP_SUBTRACT, 0,
1283 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1284 mkconstiv(aTHX_ fixed))
1285 : newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
1286 mkconstiv(aTHX_ 2)));
1e0f1595 1287 chk = newLOGOP(OP_AND, 0, cond, err);
63915d26 1288
1e0f1595 1289 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, chk));
c311cef3 1290 }
1e0f1595 1291 }
c311cef3 1292
e158cf8f 1293 if (!param_spec) {
1294 /* my $invocant = shift; */
1295 if (SvTRUE(spec->shift)) {
1296 OP *var;
abccbe86 1297
e158cf8f 1298 var = my_var(
1299 aTHX_
1300 OPf_MOD | (OPpLVAL_INTRO << 8),
1301 pad_add_name_sv(spec->shift, 0, NULL, NULL)
1302 );
1303 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
c311cef3 1304
e158cf8f 1305 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1306 }
1307 } else {
1308 /* my $invocant = shift; */
1309 if (param_spec->invocant.name) {
1310 OP *var;
c311cef3 1311
e158cf8f 1312 var = my_var(
1313 aTHX_
1314 OPf_MOD | (OPpLVAL_INTRO << 8),
1315 param_spec->invocant.padoff
1316 );
1317 var = newASSIGNOP(OPf_STACKED, var, 0, newOP(OP_SHIFT, 0));
1e0f1595 1318
e158cf8f 1319 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
c311cef3 1320 }
1321
e158cf8f 1322 /* my (...) = @_; */
1323 {
1324 OP *lhs;
1325 size_t i, lim;
63915d26 1326
e158cf8f 1327 lhs = NULL;
63915d26 1328
e158cf8f 1329 for (i = 0, lim = param_spec->positional_required.used; i < lim; i++) {
1330 OP *const var = my_var(
1331 aTHX_
1332 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1333 param_spec->positional_required.data[i].padoff
1334 );
1335 lhs = op_append_elem(OP_LIST, lhs, var);
1336 }
63915d26 1337
e158cf8f 1338 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1339 OP *const var = my_var(
1340 aTHX_
1341 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
1342 param_spec->positional_optional.data[i].param.padoff
1343 );
1344 lhs = op_append_elem(OP_LIST, lhs, var);
1345 }
63915d26 1346
fc634bba 1347 {
1348 PADOFFSET padoff;
1349 I32 type;
1350 bool slurpy_hash;
1351
1352 /*
1353 * cases:
1354 * 1) no named params
1355 * 1.1) slurpy
1356 * => put it in
1357 * 1.2) no slurpy
1358 * => nop
1359 * 2) named params
1360 * 2.1) no slurpy
1361 * => synthetic %{rest}
1362 * 2.2) slurpy is a hash
1363 * => put it in
1364 * 2.3) slurpy is an array
1365 * => synthetic %{rest}
1366 * remember to declare array later
1367 */
1368
1369 slurpy_hash = param_spec->slurpy.name && SvPV_nolen(param_spec->slurpy.name)[0] == '%';
1370 if (!count_named_params(param_spec)) {
1371 if (param_spec->slurpy.name) {
1372 padoff = param_spec->slurpy.padoff;
1373 type = slurpy_hash ? OP_PADHV : OP_PADAV;
1374 } else {
1375 padoff = NOT_IN_PAD;
1376 type = OP_PADSV;
1377 }
1378 } else if (slurpy_hash) {
1379 padoff = param_spec->slurpy.padoff;
1380 type = OP_PADHV;
e158cf8f 1381 } else {
fc634bba 1382 padoff = param_spec->rest_hash = pad_add_name_pvs("%{rest}", 0, NULL, NULL);
1383 type = OP_PADHV;
1384 }
1385
1386 if (padoff != NOT_IN_PAD) {
e158cf8f 1387 OP *const var = my_var_g(
1388 aTHX_
fc634bba 1389 type,
e158cf8f 1390 OPf_WANT_LIST | (OPpLVAL_INTRO << 8),
fc634bba 1391 padoff
e158cf8f 1392 );
fc634bba 1393
e158cf8f 1394 lhs = op_append_elem(OP_LIST, lhs, var);
fc634bba 1395
1396 if (type == OP_PADHV) {
1397 param_spec->rest_hash = padoff;
1398 }
e158cf8f 1399 }
1400 }
63915d26 1401
e158cf8f 1402 if (lhs) {
1403 OP *rhs;
1404 lhs->op_flags |= OPf_PARENS;
1405 rhs = newAVREF(newGVOP(OP_GV, 0, PL_defgv));
1406
1407 *prelude_sentinel = op_append_list(
1408 OP_LINESEQ, *prelude_sentinel,
1409 newSTATEOP(
1410 0, NULL,
1411 newASSIGNOP(OPf_STACKED, lhs, 0, rhs)
1412 )
1413 );
1414 }
1415 }
63915d26 1416
fc634bba 1417 /* default positional arguments */
e158cf8f 1418 {
1419 size_t i, lim, req;
1420 OP *nest;
63915d26 1421
e158cf8f 1422 nest = NULL;
63915d26 1423
e158cf8f 1424 req = param_spec->positional_required.used;
1425 for (i = 0, lim = param_spec->positional_optional.used; i < lim; i++) {
1426 ParamInit *cur = &param_spec->positional_optional.data[i];
1427 OP *var, *cond;
63915d26 1428
e158cf8f 1429 cond = newBINOP(
1430 OP_LT, 0,
1431 newAVREF(newGVOP(OP_GV, 0, PL_defgv)),
fc634bba 1432 mkconstiv(aTHX_ req + i + 1)
e158cf8f 1433 );
63915d26 1434
e158cf8f 1435 var = my_var(aTHX_ 0, cur->param.padoff);
63915d26 1436
e158cf8f 1437 nest = op_append_list(
1438 OP_LINESEQ, nest,
1439 newASSIGNOP(OPf_STACKED, var, 0, cur->init)
1440 );
1441 cur->init = NULL;
1442 nest = newCONDOP(
1443 0,
1444 cond,
1445 nest,
1446 NULL
1447 );
1448 }
1e0f1595 1449
e158cf8f 1450 *prelude_sentinel = op_append_list(
1451 OP_LINESEQ, *prelude_sentinel,
1452 nest
1453 );
c311cef3 1454 }
1455
e158cf8f 1456 /* named parameters */
1457 if (count_named_params(param_spec)) {
fc634bba 1458 size_t i, lim;
1459
1460 assert(param_spec->rest_hash != NOT_IN_PAD);
1461
1462 for (i = 0, lim = param_spec->named_required.used; i < lim; i++) {
1463 Param *cur = &param_spec->named_required.data[i];
1464 size_t n;
1465 char *p = SvPV(cur->name, n);
1466 OP *var, *cond;
1467
1468 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1469
1470 if (spec->flags & FLAG_CHECK_NARGS) {
67fc1ddb 1471 OP *xcroak, *msg;
fc634bba 1472
1473 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1474 var = newUNOP(OP_DELETE, 0, var);
1475
1476 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": missing named parameter: %.*s", SVfARG(declarator), (int)(n - 1), p + 1));
67fc1ddb 1477 xcroak = newCVREF(
fc634bba 1478 OPf_WANT_SCALAR,
1479 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1480 );
67fc1ddb 1481 xcroak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, xcroak));
fc634bba 1482
1483 cond = newUNOP(OP_EXISTS, 0, cond);
1484
67fc1ddb 1485 cond = newCONDOP(0, cond, var, xcroak);
fc634bba 1486 }
1487
1488 var = my_var(
1489 aTHX_
1490 OPf_MOD | (OPpLVAL_INTRO << 8),
1491 cur->padoff
1492 );
1493 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1494
1495 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1496 }
1497
1498 for (i = 0, lim = param_spec->named_optional.used; i < lim; i++) {
1499 ParamInit *cur = &param_spec->named_optional.data[i];
1500 size_t n;
1501 char *p = SvPV(cur->param.name, n);
1502 OP *var, *cond;
1503
1504 var = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1505 var = newUNOP(OP_DELETE, 0, var);
1506
1507 cond = mkhvelem(aTHX_ param_spec->rest_hash, mkconstpv(aTHX_ p + 1, n - 1));
1508 cond = newUNOP(OP_EXISTS, 0, cond);
1509
1510 cond = newCONDOP(0, cond, var, cur->init);
1511 cur->init = NULL;
1512
1513 var = my_var(
1514 aTHX_
1515 OPf_MOD | (OPpLVAL_INTRO << 8),
1516 cur->param.padoff
1517 );
1518 var = newASSIGNOP(OPf_STACKED, var, 0, cond);
1519
1520 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1521 }
1522
1523 if (!param_spec->slurpy.name) {
1524 if (spec->flags & FLAG_CHECK_NARGS) {
1525 /* croak if %{rest} */
67fc1ddb 1526 OP *xcroak, *cond, *keys, *msg;
fc634bba 1527
1528 keys = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1529 keys = newLISTOP(OP_SORT, 0, newOP(OP_PUSHMARK, 0), keys);
1530 {
1531 OP *first, *mid, *last;
1532
1533 last = keys;
1534
1535 mid = mkconstpvs(", ");
1536 mid->op_sibling = last;
1537
1538 first = newOP(OP_PUSHMARK, 0);
1539
1540 keys = newLISTOP(OP_JOIN, 0, first, mid);
1541 keys->op_targ = pad_alloc(OP_JOIN, SVs_PADTMP);
1542 ((LISTOP *)keys)->op_last = last;
1543 }
1544
1545 msg = mkconstsv(aTHX_ newSVpvf("In %"SVf": no such named parameter: ", SVfARG(declarator)));
1546 msg = newBINOP(OP_CONCAT, 0, msg, keys);
1547
67fc1ddb 1548 xcroak = newCVREF(
fc634bba 1549 OPf_WANT_SCALAR,
1550 newGVOP(OP_GV, 0, gv_fetchpvs("Carp::croak", 0, SVt_PVCV))
1551 );
67fc1ddb 1552 xcroak = newUNOP(OP_ENTERSUB, OPf_STACKED, op_append_elem(OP_LIST, msg, xcroak));
fc634bba 1553
1554 cond = newUNOP(OP_KEYS, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
67fc1ddb 1555 xcroak = newCONDOP(0, cond, xcroak, NULL);
fc634bba 1556
67fc1ddb 1557 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, xcroak));
fc634bba 1558 } else {
1559 OP *clear;
1560
1561 clear = newASSIGNOP(
1562 OPf_STACKED,
1563 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1564 0,
1565 newNULLLIST()
1566 );
1567
1568 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1569 }
1570 } else if (param_spec->slurpy.padoff != param_spec->rest_hash) {
1571 OP *var, *clear;
1572
1573 assert(SvPV_nolen(param_spec->slurpy.name)[0] == '@');
1574
1575 var = my_var_g(
1576 aTHX_
1577 OP_PADAV,
1578 OPf_MOD | (OPpLVAL_INTRO << 8),
1579 param_spec->slurpy.padoff
1580 );
1581
1582 var = newASSIGNOP(OPf_STACKED, var, 0, my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash));
1583
1584 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, var));
1585
1586 clear = newASSIGNOP(
1587 OPf_STACKED,
1588 my_var_g(aTHX_ OP_PADHV, 0, param_spec->rest_hash),
1589 0,
1590 newNULLLIST()
1591 );
1592
1593 *prelude_sentinel = op_append_list(OP_LINESEQ, *prelude_sentinel, newSTATEOP(0, NULL, clear));
1594 }
1595 }
1e0f1595 1596 }
c311cef3 1597
1e0f1595 1598 /* finally let perl parse the actual subroutine body */
1599 body = parse_block(0);
c311cef3 1600
1e0f1595 1601 /* add '();' to make function return nothing by default */
1602 /* (otherwise the invisible parameter initialization can "leak" into
1603 the return value: fun ($x) {}->("asdf", 0) == 2) */
1604 if (*prelude_sentinel) {
1605 body = newSTATEOP(0, NULL, body);
db81d362 1606 }
1607
1e0f1595 1608 body = op_append_list(OP_LINESEQ, *prelude_sentinel, body);
1609 *prelude_sentinel = NULL;
1610
c311cef3 1611 /* it's go time. */
1612 {
53c979f0 1613 CV *cv;
c311cef3 1614 OP *const attrs = *attrs_sentinel;
1615 *attrs_sentinel = NULL;
53c979f0 1616
c311cef3 1617 SvREFCNT_inc_simple_void(PL_compcv);
1618
63915d26 1619 /* close outer block: '}' */
1620 S_block_end(aTHX_ save_ix, body);
1621
53c979f0 1622 cv = newATTRSUB(
c311cef3 1623 floor_ix,
53c979f0 1624 saw_name ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(saw_name)) : NULL,
c311cef3 1625 proto ? newSVOP(OP_CONST, 0, SvREFCNT_inc_simple_NN(proto)) : NULL,
1626 attrs,
1627 body
1628 );
53c979f0 1629
1630 register_info(aTHX_ PTR2UV(CvROOT(cv)), declarator, spec, param_spec);
1631
1632 if (saw_name) {
1633 *pop = newOP(OP_NULL, 0);
1634 return KEYWORD_PLUGIN_STMT;
1635 }
1636
1637 *pop = newUNOP(
1638 OP_REFGEN, 0,
1639 newSVOP(
1640 OP_ANONCODE, 0,
1641 (SV *)cv
1642 )
1643 );
1644 return KEYWORD_PLUGIN_EXPR;
db81d362 1645 }
db81d362 1646}
1647
1648static int my_keyword_plugin(pTHX_ char *keyword_ptr, STRLEN keyword_len, OP **op_ptr) {
63915d26 1649 KWSpec spec;
db81d362 1650 int ret;
e4648f19 1651 Sentinel sen = { NULL };
db81d362 1652
e4648f19 1653 ENTER;
db81d362 1654 SAVETMPS;
1655
e4648f19 1656 SAVEDESTRUCTOR_X(sentinel_clear_void, sen);
1657
1658 if (kw_flags(aTHX_ sen, keyword_ptr, keyword_len, &spec)) {
1659 ret = parse_fun(aTHX_ sen, op_ptr, keyword_ptr, keyword_len, &spec);
db81d362 1660 } else {
7dd35535 1661 ret = next_keyword_plugin(aTHX_ keyword_ptr, keyword_len, op_ptr);
db81d362 1662 }
1663
1664 FREETMPS;
e4648f19 1665 LEAVE;
db81d362 1666
1667 return ret;
1668}
1669
1670WARNINGS_RESET
1671
53c979f0 1672MODULE = Function::Parameters PACKAGE = Function::Parameters PREFIX = fp_
db81d362 1673PROTOTYPES: ENABLE
1674
53c979f0 1675UV
1676fp__cv_root(sv)
1677 SV * sv
1678 PREINIT:
79bce2d4 1679 CV *xcv;
53c979f0 1680 HV *hv;
1681 GV *gv;
1682 CODE:
79bce2d4 1683 xcv = sv_2cv(sv, &hv, &gv, 0);
1684 RETVAL = PTR2UV(xcv ? CvROOT(xcv) : NULL);
53c979f0 1685 OUTPUT:
1686 RETVAL
1687
db81d362 1688BOOT:
1689WARNINGS_ENABLE {
1690 HV *const stash = gv_stashpvs(MY_PKG, GV_ADD);
426a4d69 1691 /**/
d8e5d540 1692 newCONSTSUB(stash, "FLAG_NAME_OK", newSViv(FLAG_NAME_OK));
1693 newCONSTSUB(stash, "FLAG_ANON_OK", newSViv(FLAG_ANON_OK));
63915d26 1694 newCONSTSUB(stash, "FLAG_DEFAULT_ARGS", newSViv(FLAG_DEFAULT_ARGS));
d8e5d540 1695 newCONSTSUB(stash, "FLAG_CHECK_NARGS", newSViv(FLAG_CHECK_NARGS));
1696 newCONSTSUB(stash, "FLAG_INVOCANT", newSViv(FLAG_INVOCANT));
e158cf8f 1697 newCONSTSUB(stash, "FLAG_NAMED_PARAMS", newSViv(FLAG_NAMED_PARAMS));
db81d362 1698 newCONSTSUB(stash, "HINTK_KEYWORDS", newSVpvs(HINTK_KEYWORDS));
d8e5d540 1699 newCONSTSUB(stash, "HINTK_FLAGS_", newSVpvs(HINTK_FLAGS_));
1700 newCONSTSUB(stash, "HINTK_SHIFT_", newSVpvs(HINTK_SHIFT_));
1701 newCONSTSUB(stash, "HINTK_ATTRS_", newSVpvs(HINTK_ATTRS_));
426a4d69 1702 /**/
db81d362 1703 next_keyword_plugin = PL_keyword_plugin;
1704 PL_keyword_plugin = my_keyword_plugin;
1705} WARNINGS_RESET