This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
8a13dd215887091b5e58cc0fda57a36e2ee746ed
[perl5.git] / t / op / regexp.t
1 #!./perl
2
3 # The tests are in a separate file 't/op/re_tests'.
4 # Each line in that file is a separate test.
5 # There are five columns, separated by tabs.
6 #
7 # Column 1 contains the pattern, optionally enclosed in C<''>.
8 # Modifiers can be put after the closing C<'>.
9 #
10 # Column 2 contains the string to be matched.
11 #
12 # Column 3 contains the expected result:
13 #       y       expect a match
14 #       n       expect no match
15 #       c       expect an error
16 #       B       test exposes a known bug in Perl, should be skipped
17 #       b       test exposes a known bug in Perl, should be skipped if noamp
18 #
19 # Columns 4 and 5 are used only if column 3 contains C<y> or C<c>.
20 #
21 # Column 4 contains a string, usually C<$&>.
22 #
23 # Column 5 contains the expected result of double-quote
24 # interpolating that string after the match, or start of error message.
25 #
26 # Column 6, if present, contains a reason why the test is skipped.
27 # This is printed with "skipped", for harness to pick up.
28 #
29 # \n in the tests are interpolated, as are variables of the form ${\w+}.
30 #
31 # Blanks lines are treated as PASSING tests to keep the line numbers
32 # linked to the test number.
33 #
34 # If you want to add a regular expression test that can't be expressed
35 # in this format, don't add it here: put it in op/pat.t instead.
36 #
37 # Note that columns 2,3 and 5 are all enclosed in double quotes and then
38 # evalled; so something like a\"\x{100}$1 has length 3+length($1).
39
40 my $file;
41 BEGIN {
42     $iters = shift || 1;        # Poor man performance suite, 10000 is OK.
43
44     # Do this open before any chdir
45     $file = shift;
46     if (defined $file) {
47         open TESTS, $file or die "Can't open $file";
48     }
49
50     chdir 't' if -d 't';
51     @INC = '../lib';
52 }
53
54 use strict;
55 use warnings FATAL=>"all";
56 use vars qw($iters $numtests $bang $ffff $nulnul $OP);
57 use vars qw($qr $skip_amp $qr_embed); # set by our callers
58
59
60 if (!defined $file) {
61     open(TESTS,'op/re_tests') || open(TESTS,'t/op/re_tests')
62         || open(TESTS,':op:re_tests') || die "Can't open re_tests";
63 }
64
65 my @tests = <TESTS>;
66
67 close TESTS;
68
69 $bang = sprintf "\\%03o", ord "!"; # \41 would not be portable.
70 $ffff  = chr(0xff) x 2;
71 $nulnul = "\0" x 2;
72 $OP = $qr ? 'qr' : 'm';
73
74 $| = 1;
75 printf "1..%d\n# $iters iterations\n", scalar @tests;
76 my $test;
77 TEST:
78 foreach (@tests) {
79     $test++;
80     if (!/\S/ || /^\s*#/ || /^__END__$/) {
81         print "ok $test # (Blank line or comment)\n";
82         if (/#/) { print $_ };
83         next;
84     }
85     chomp;
86     s/\\n/\n/g;
87     my ($pat, $subject, $result, $repl, $expect, $reason) = split(/\t/,$_,6);
88     $reason = '' unless defined $reason;
89     my $input = join(':',$pat,$subject,$result,$repl,$expect);
90     $pat = "'$pat'" unless $pat =~ /^[:'\/]/;
91     $pat =~ s/(\$\{\w+\})/$1/eeg;
92     $pat =~ s/\\n/\n/g;
93     $subject = eval qq("$subject"); die $@ if $@;
94     $expect  = eval qq("$expect"); die $@ if $@;
95     $expect = $repl = '-' if $skip_amp and $input =~ /\$[&\`\']/;
96     my $skip = ($skip_amp ? ($result =~ s/B//i) : ($result =~ s/B//));
97     $reason = 'skipping $&' if $reason eq  '' && $skip_amp;
98     $result =~ s/B//i unless $skip;
99
100     for my $study ('', 'study $subject', 'utf8::upgrade($subject)',
101                    'utf8::upgrade($subject); study $subject') {
102         # Need to make a copy, else the utf8::upgrade of an alreay studied
103         # scalar confuses things.
104         my $subject = $subject;
105         my $c = $iters;
106         my ($code, $match, $got);
107         if ($repl eq 'pos') {
108             $code= <<EOFCODE;
109                 $study;
110                 pos(\$subject)=0;
111                 \$match = ( \$subject =~ m${pat}g );
112                 \$got = pos(\$subject);
113 EOFCODE
114         }
115         elsif ($qr_embed) {
116             $code= <<EOFCODE;
117                 my \$RE = qr$pat;
118                 $study;
119                 \$match = (\$subject =~ /(?:)\$RE(?:)/) while \$c--;
120                 \$got = "$repl";
121 EOFCODE
122         }
123         else {
124             $code= <<EOFCODE;
125                 $study;
126                 \$match = (\$subject =~ $OP$pat) while \$c--;
127                 \$got = "$repl";
128 EOFCODE
129         }
130         #$code.=qq[\n\$expect="$expect";\n];
131         #use Devel::Peek;
132         #die Dump($code) if $pat=~/\\h/ and $subject=~/\x{A0}/;
133         {
134             # Probably we should annotate specific tests with which warnings
135             # categories they're known to trigger, and hence should be
136             # disabled just for that test
137             no warnings qw(uninitialized regexp);
138             eval $code;
139         }
140         chomp( my $err = $@ );
141         if ($result eq 'c') {
142             if ($err !~ m!^\Q$expect!) { print "not ok $test (compile) $input => `$err'\n"; next TEST }
143             last;  # no need to study a syntax error
144         }
145         elsif ( $skip ) {
146             print "ok $test # skipped", length($reason) ? " $reason" : '', "\n";
147             next TEST;
148         }
149         elsif ($@) {
150             print "not ok $test $input => error `$err'\n$code\n$@\n"; next TEST;
151         }
152         elsif ($result eq 'n') {
153             if ($match) { print "not ok $test ($study) $input => false positive\n"; next TEST }
154         }
155         else {
156             if (!$match || $got ne $expect) {
157                 eval { require Data::Dumper };
158                 if ($@) {
159                     print "not ok $test ($study) $input => `$got', match=$match\n$code\n";
160                 }
161                 else { # better diagnostics
162                     my $s = Data::Dumper->new([$subject],['subject'])->Useqq(1)->Dump;
163                     my $g = Data::Dumper->new([$got],['got'])->Useqq(1)->Dump;
164                     print "not ok $test ($study) $input => `$got', match=$match\n$s\n$g\n$code\n";
165                 }
166                 next TEST;
167             }
168         }
169     }
170     print "ok $test\n";
171 }
172
173 1;