3 # Test the core keywords.
5 # Initially this test file just checked that CORE::foo got correctly
6 # deparsed as CORE::foo, hence the name. It's since been expanded
7 # to fully test both CORE:: versus none, plus that any arguments
8 # are correctly deparsed. It also cross-checks against regen/keywords.pl
9 # to make sure we've tested all keywords, and with the correct strength.
11 # A keyword can be either weak or strong. Strong keywords can never be
12 # overridden, while weak ones can. So deparsing of weak keywords depends
13 # on whether a sub of that name has been created:
15 # for both: keyword(..) deparsed as keyword(..)
16 # for weak: CORE::keyword(..) deparsed as CORE::keyword(..)
17 # for strong: CORE::keyword(..) deparsed as keyword(..)
19 # Three permutations of lex/nonlex args are checked for:
22 # foo(my $a,$b,$c,...)
23 # my ($a,$b,$c,...); foo($a,$b,$c,...)
25 # Note that tests for prefixing feature.pm-enabled keywords with CORE:: when
26 # feature.pm is not enabled are in deparse.t, as they fit that format better.
31 if (($Config::Config{extensions} !~ /\bB\b/) ){
32 print "1..0 # Skip -- Perl configured without B module\n";
41 use feature (sprintf(":%vd", $^V)); # to avoid relying on the feature
44 my $deparse = new B::Deparse;
49 # for a given keyword, create a sub of that name, then
50 # deparse "() = $expr", and see if it matches $expected_expr
53 my ($keyword, $expr, $expected_expr, $lexsub) = @_;
55 $expected_expr //= $expr;
59 # lex=0: () = foo($a,$b,$c)
60 # lex=1: my ($a,$b); () = foo($a,$b,$c)
61 # lex=2: () = foo(my $a,$b,$c)
62 for my $lex (0, 1, 2) {
64 next if $keyword =~ /local|our|state|my/;
66 my $vars = $lex == 1 ? 'my($a, $b, $c, $d, $e);' . "\n " : "";
70 if ($expr =~ 'CORE::do') {
71 # do foo() is a syntax error, so B::Deparse emits
72 # do (foo()), but does not distinguish between foo and my,
73 # because it is too complicated.
76 s/\$a/$repl/ for $expr, $expected_expr;
79 my $desc = "$keyword: lex=$lex $expr => $expected_expr";
80 $desc .= " (lex sub)" if $lexsub;
86 no warnings 'experimental::lexical_subs';
87 use feature 'lexical_subs';
90 eval "sub { state sub $keyword; ${vars}() = $expr }"
97 $code_ref = eval "no strict 'vars'; sub { ${vars}() = $expr }"
101 my $got_text = $deparse->coderef2text($code_ref);
103 unless ($got_text =~ /
104 package (?:lexsub)?test;
105 (?: BEGIN \{\$\{\^WARNING_BITS\} = "[^"]+"\}
106 )? use strict 'refs', 'subs';
108 (?: (?:CORE::)?state sub \w+;
109 )? \Q$vars\E\(\) = (.*)
112 ::diag("couldn't extract line from boilerplate\n");
118 is $got_expr, $expected_expr, $desc;
123 # Deparse can't distinguish 'and' from '&&' etc
124 my %infix_map = qw(and && or ||);
127 # test a keyword that is a binary infix operator, like 'cmp'.
128 # $parens - "$a op $b" is deparsed as "($a op $b)"
129 # $strong - keyword is strong
131 sub do_infix_keyword {
132 my ($keyword, $parens, $strong) = @_;
133 $SEEN_STRENGH{$keyword} = $strong;
134 my $expr = "(\$a $keyword \$b)";
135 my $nkey = $infix_map{$keyword} // $keyword;
136 my $expr = "(\$a $keyword \$b)";
137 my $exp = "\$a $nkey \$b";
138 $exp = "($exp)" if $parens;
140 # with infix notation, a keyword is always interpreted as core,
141 # so no need for Deparse to disambiguate with CORE::
142 testit $keyword, "(\$a CORE::$keyword \$b)", $exp;
143 testit $keyword, "(\$a $keyword \$b)", $exp;
144 testit $keyword, "(\$a CORE::$keyword \$b)", $exp, 1;
145 testit $keyword, "(\$a $keyword \$b)", $exp, 1;
147 # B::Deparse fully qualifies any sub whose name is a keyword,
148 # imported or not, since the importedness may not be reproduced by
149 # the deparsed code. x is special.
150 my $pre = "test::" x ($keyword ne 'x');
151 testit $keyword, "$keyword(\$a, \$b)", "$pre$keyword(\$a, \$b);";
153 testit $keyword, "$keyword(\$a, \$b)", "$keyword(\$a, \$b);", 1;
156 # test a keyword that is as tandard op/function, like 'index(...)'.
157 # narg - how many args to test it with
158 # $parens - "foo $a, $b" is deparsed as "foo($a, $b)"
159 # $dollar - an extra '$_' arg will appear in the deparsed output
160 # $strong - keyword is strong
164 my ($keyword, $narg, $parens, $dollar, $strong) = @_;
166 $SEEN_STRENGH{$keyword} = $strong;
168 for my $core (0,1) { # if true, add CORE:: to keyword being deparsed
169 for my $lexsub (0,1) { # if true, define lex sub
171 for my $do_exp(0, 1) { # first create expr, then expected-expr
172 my @args = map "\$$_", (undef,"a".."z")[1..$narg];
174 if $dollar && $do_exp && ($strong && !$lexsub or $core);
175 my $args = join(', ', @args);
176 # XXX $lex_parens is temporary, until lex subs are
179 !$core && $do_exp && $lexsub && $keyword ne 'map';
180 $args = ((!$core && !$strong) || $parens || $lex_parens)
182 : @args ? " $args" : "";
183 push @code, (($core && !($do_exp && $strong))
187 : $do_exp && !$core && !$strong ? "test::" : "")
190 # code[0]: to run; code[1]: expected
191 testit $keyword, @code, $lexsub;
203 die "not 3 fields" unless @fields == 3;
204 my ($keyword, $args, $flags) = @fields;
206 $args = '012' if $args eq '@';
208 my $parens = $flags =~ s/p//;
209 my $invert1 = $flags =~ s/1//;
210 my $dollar = $flags =~ s/\$//;
211 my $strong = $flags =~ s/\+//;
212 die "unrecognised flag(s): '$flags'" unless $flags =~ /^-?$/;
214 if ($args eq 'B') { # binary infix
215 die "$keyword: binary (B) op can't have '\$' flag\\n" if $dollar;
216 die "$keyword: binary (B) op can't have '1' flag\\n" if $invert1;
217 do_infix_keyword($keyword, $parens, $strong);
220 my @narg = split //, $args;
221 for my $n (0..$#narg) {
222 my $narg = $narg[$n];
224 $p = !$p if ($n == 0 && $invert1);
225 do_std_keyword($keyword, $narg, $p, (!$n && $dollar), $strong);
233 testit dbmopen => 'CORE::dbmopen(%foo, $bar, $baz);';
234 testit dbmclose => 'CORE::dbmclose %foo;';
236 testit delete => 'CORE::delete $h{\'foo\'};', 'delete $h{\'foo\'};';
237 testit delete => 'CORE::delete $h{\'foo\'};', undef, 1;
238 testit delete => 'CORE::delete @h{\'foo\'};', undef, 1;
239 testit delete => 'CORE::delete $h[0];', undef, 1;
240 testit delete => 'CORE::delete @h[0];', undef, 1;
241 testit delete => 'delete $h{\'foo\'};', 'delete $h{\'foo\'};';
243 # do is listed as strong, but only do { block } is strong;
244 # do $file is weak, so test it separately here
245 testit do => 'CORE::do $a;';
246 testit do => 'do $a;', 'test::do($a);';
247 testit do => 'CORE::do { 1 }',
249 testit do => 'CORE::do { 1 }',
250 "CORE::do {\n 1\n };", 1;
251 testit do => 'do { 1 };',
254 testit each => 'CORE::each %bar;';
255 testit each => 'CORE::each @foo;';
257 testit eof => 'CORE::eof();';
259 testit exists => 'CORE::exists $h{\'foo\'};', 'exists $h{\'foo\'};';
260 testit exists => 'CORE::exists $h{\'foo\'};', undef, 1;
261 testit exists => 'CORE::exists &foo;', undef, 1;
262 testit exists => 'CORE::exists $h[0];', undef, 1;
263 testit exists => 'exists $h{\'foo\'};', 'exists $h{\'foo\'};';
265 testit exec => 'CORE::exec($foo $bar);';
267 testit glob => 'glob;', 'glob($_);';
268 testit glob => 'CORE::glob;', 'CORE::glob($_);';
269 testit glob => 'glob $a;', 'glob($a);';
270 testit glob => 'CORE::glob $a;', 'CORE::glob($a);';
272 testit grep => 'CORE::grep { $a } $b, $c', 'grep({$a;} $b, $c);';
274 testit keys => 'CORE::keys %bar;';
275 testit keys => 'CORE::keys @bar;';
277 testit map => 'CORE::map { $a } $b, $c', 'map({$a;} $b, $c);';
279 testit not => '3 unless CORE::not $a && $b;';
281 testit pop => 'CORE::pop @foo;';
283 testit push => 'CORE::push @foo;', 'CORE::push(@foo);';
284 testit push => 'CORE::push @foo, 1;', 'CORE::push(@foo, 1);';
285 testit push => 'CORE::push @foo, 1, 2;', 'CORE::push(@foo, 1, 2);';
287 testit readline => 'CORE::readline $a . $b;';
289 testit readpipe => 'CORE::readpipe $a + $b;';
291 testit reverse => 'CORE::reverse sort(@foo);';
293 testit shift => 'CORE::shift @foo;';
295 testit splice => q{CORE::splice @foo;}, q{CORE::splice(@foo);};
296 testit splice => q{CORE::splice @foo, 0;}, q{CORE::splice(@foo, 0);};
297 testit splice => q{CORE::splice @foo, 0, 1;}, q{CORE::splice(@foo, 0, 1);};
298 testit splice => q{CORE::splice @foo, 0, 1, 'a';}, q{CORE::splice(@foo, 0, 1, 'a');};
299 testit splice => q{CORE::splice @foo, 0, 1, 'a', 'b';}, q{CORE::splice(@foo, 0, 1, 'a', 'b');};
301 # note that the test does '() = split...' which is why the
302 # limit is optimised to 1
303 testit split => 'split;', q{split(' ', $_, 1);};
304 testit split => 'CORE::split;', q{split(' ', $_, 1);};
305 testit split => 'split $a;', q{split(/$a/u, $_, 1);};
306 testit split => 'CORE::split $a;', q{split(/$a/u, $_, 1);};
307 testit split => 'split $a, $b;', q{split(/$a/u, $b, 1);};
308 testit split => 'CORE::split $a, $b;', q{split(/$a/u, $b, 1);};
309 testit split => 'split $a, $b, $c;', q{split(/$a/u, $b, $c);};
310 testit split => 'CORE::split $a, $b, $c;', q{split(/$a/u, $b, $c);};
312 testit sub => 'CORE::sub { $a, $b }',
313 "sub {\n \$a, \$b;\n }\n ;";
315 testit system => 'CORE::system($foo $bar);';
317 testit unshift => 'CORE::unshift @foo;', 'CORE::unshift(@foo);';
318 testit unshift => 'CORE::unshift @foo, 1;', 'CORE::unshift(@foo, 1);';
319 testit unshift => 'CORE::unshift @foo, 1, 2;', 'CORE::unshift(@foo, 1, 2);';
321 testit values => 'CORE::values %bar;';
322 testit values => 'CORE::values @foo;';
325 # XXX These are deparsed wrapped in parens.
326 # whether they should be, I don't know!
328 testit dump => '(CORE::dump);';
329 testit dump => '(CORE::dump FOO);';
330 testit goto => '(CORE::goto);', '(goto);';
331 testit goto => '(CORE::goto FOO);', '(goto FOO);';
332 testit last => '(CORE::last);', '(last);';
333 testit last => '(CORE::last FOO);', '(last FOO);';
334 testit next => '(CORE::next);', '(next);';
335 testit next => '(CORE::next FOO);', '(next FOO);';
336 testit redo => '(CORE::redo);', '(redo);';
337 testit redo => '(CORE::redo FOO);', '(redo FOO);';
338 testit redo => '(CORE::redo);', '(redo);';
339 testit redo => '(CORE::redo FOO);', '(redo FOO);';
340 testit return => '(return);', '(return);';
341 testit return => '(CORE::return);', '(return);';
343 # these are the keywords I couldn't think how to test within this framework
345 my %not_tested = map { $_ => 1} qw(
388 # Sanity check against keyword data:
389 # make sure we haven't missed any keywords,
390 # and that we got the strength right.
394 skip "sanity checks when not PERL_CORE", 1 unless defined $ENV{PERL_CORE};
396 my $file = '../regen/keywords.pl';
398 if (open my $fh, '<', $file) {
403 next unless /^([+\-])(\w+)$/;
404 my ($strength, $key) = ($1, $2);
405 $strength = ($strength eq '+') ? 1 : 0;
407 if (!$SEEN{$key} && !$not_tested{$key}) {
408 diag("keyword '$key' seen in $file, but not tested here!!");
411 if (exists $SEEN_STRENGH{$key} and $SEEN_STRENGH{$key} != $strength) {
412 diag("keyword '$key' strengh as seen in $file doen't match here!!");
418 diag("Can't open $file: $!");
423 diag("Saw $count keywords: less than 200!");
426 ok($pass, "sanity checks");
437 # * one of more digits indictating which lengths of args the function accepts,
438 # * or 'B' to indiate a binary infix operator,
439 # * or '@' to indicate a list function.
441 # Flags consists of the following (or '-' if no flags):
442 # + : strong keyword: can't be overrriden
443 # p : the args are parenthesised on deparsing;
444 # 1 : parenthesising of 1st arg length is inverted
445 # so '234 p1' means: foo a1,a2; foo(a1,a2,a3); foo(a1,a2,a3,a4)
446 # $ : on the first argument length, there is an implicit extra
447 # '$_' arg which will appear on deparsing;
448 # e.g. 12p$ will be tested as: foo(a1); foo(a1,a2);
449 # and deparsed as: foo(a1, $_); foo(a1,a2);
451 # XXX Note that we really should get this data from regen/keywords.pl
452 # and regen/opcodes (augmented if necessary), rather than duplicating it
480 # dbmopen handled specially
481 # dbmclose handled specially
483 # delete handled specially
485 # do handled specially
486 # dump handled specially
487 # each handled specially
494 eof 01 - # also tested specially
498 exec @ p1 # also tested specially
499 # exists handled specially
535 # given handled specially
536 grep 123 p+ # also tested specially
537 # glob handled specially
538 # goto handled specially
546 # keys handled specially
548 # last handled specially
561 map 123 p+ # also tested specially
567 my 123 p+ # skip with 0 args, as my() => ()
569 # next handled specially
570 # not handled specially
576 our 123 p+ # skip with 0 args, as our() => ()
579 pop 0 1 # also tested specially
584 # push handled specially
589 # readline handled specially
591 # readpipe handled specially
593 # redo handled specially
596 # XXX This code prints 'Undefined subroutine &main::require called':
597 # use subs (); import subs 'require';
598 # eval q[no strict 'vars'; sub { () = require; }]; print $@;
602 # return handled specially
603 reverse @ p1 # also tested specially
625 shift 0 1 # also tested specially
636 # split handled specially
637 # splice handled specially
642 state 123 p+ # skip with 0 args, as state() => ()
644 # sub handled specially
651 system @ p1 # also tested specially
666 # unshift handled specially
669 # values handled specially