3 # testsuite for Data::Dumper
9 require Config; import Config;
10 if ($Config{'extensions'} !~ /\bData\/Dumper\b/) {
11 print "1..0 # Skip: Data::Dumper was not built\n";
18 my $Is_ebcdic = defined($Config{'ebcdic'}) && $Config{'ebcdic'} eq 'define';
20 $Data::Dumper::Pad = "#";
31 $t =~ s/([A-Z]+)\(0x[0-9a-f]+\)/$1(0xdeadbeef)/g
32 if ($WANT =~ /deadbeef/);
34 # these data need massaging with non ascii character sets
35 # because of hashing order differences
36 $WANT = join("\n",sort(split(/\n/,$WANT)));
38 $t = join("\n",sort(split(/\n/,$t)));
41 $name = $name ? " - $name" : '';
42 print( ($t eq $WANT and not $@) ? "ok $TNUM$name\n"
43 : "not ok $TNUM$name\n--Expected--\n$WANT\n--Got--\n$@$t\n");
47 print $@ ? "not ok $TNUM\n# \$@ says: $@\n" : "ok $TNUM\n";
51 $t =~ s/([A-Z]+)\(0x[0-9a-f]+\)/$1(0xdeadbeef)/g
52 if ($WANT =~ /deadbeef/);
54 # here too there are hashing order differences
55 $WANT = join("\n",sort(split(/\n/,$WANT)));
57 $t = join("\n",sort(split(/\n/,$t)));
60 print( ($t eq $WANT and not $@) ? "ok $TNUM\n"
61 : "not ok $TNUM\n--Expected--\n$WANT\n--Got--\n$@$t\n");
64 # Force Data::Dumper::Dump to use perl. We test Dumpxs explicitly by calling
65 # it direct. Out here it lets us knobble the next if to test that the perl
66 # only tests do work (and count correctly)
67 $Data::Dumper::Useperl = 1;
68 if (defined &Data::Dumper::Dumpxs) {
69 print "### XS extension loaded, will run XS tests\n";
73 print "### XS extensions not loaded, will NOT run XS tests\n";
109 TEST q(Data::Dumper->Dump([$a,$b,$c], [qw(a b c)]));
110 TEST q(Data::Dumper->Dumpxs([$a,$b,$c], [qw(a b c)])) if $XS;
133 $Data::Dumper::Purity = 1; # fill in the holes for eval
134 TEST q(Data::Dumper->Dump([$a, $b], [qw(*a b)])); # print as @a
135 TEST q(Data::Dumper->Dumpxs([$a, $b], [qw(*a b)])) if $XS;
152 #$b{'a'}[2] = $b{'c'};
157 TEST q(Data::Dumper->Dump([$b, $a], [qw(*b a)])); # print as %b
158 TEST q(Data::Dumper->Dumpxs([$b, $a], [qw(*b a)])) if $XS;
174 #$a->[1]{'b'} = $a->[1];
179 $Data::Dumper::Indent = 1;
181 $d = Data::Dumper->new([$a,$b], [qw(a b)]);
182 $d->Seen({'*c' => $c});
187 $d = Data::Dumper->new([$a,$b], [qw(a b)]);
188 $d->Seen({'*c' => $c});
216 $d->Purity(0)->Quotekeys(0);
217 TEST q( $d->Reset; $d->Dump );
219 TEST q( $d->Reset; $d->Dumpxs ) if $XS;
235 #$VAR1->[1]{'a'} = $VAR1;
236 #$VAR1->[1]{'b'} = $VAR1->[1];
237 #$VAR1->[2] = $VAR1->[1]{'c'};
241 TEST q(Data::Dumper::DumperX($a)) if $XS;
260 local $Data::Dumper::Purity = 0;
261 local $Data::Dumper::Quotekeys = 0;
262 local $Data::Dumper::Terse = 1;
264 TEST q(Data::Dumper::DumperX($a)) if $XS;
273 # "abc\0'\efg" => "mno\0"
277 $foo = { "abc\000\'\efg" => "mno\000",
281 local $Data::Dumper::Useqq = 1;
282 TEST q(Dumper($foo));
287 # 'reftest' => \\\\1,
288 # 'abc\0\\'\efg' => 'mno\0'
293 local $Data::Dumper::Useqq = 1;
294 TEST q(Data::Dumper::DumperX($foo)) if $XS; # cheat
307 %foo = (a=>1,b=>\$foo,c=>\@foo);
329 #*::foo{ARRAY}->[1] = $foo;
330 #*::foo{ARRAY}->[2]{'c'} = *::foo{ARRAY};
331 #*::foo{ARRAY}->[2]{'b'} = *::foo{SCALAR};
332 #*::foo{ARRAY}->[2]{'d'} = *::foo{ARRAY}->[2];
333 #*::foo = *::foo{ARRAY}->[2];
334 #@bar = @{*::foo{ARRAY}};
335 #%baz = %{*::foo{ARRAY}->[2]};
338 $Data::Dumper::Purity = 1;
339 $Data::Dumper::Indent = 3;
340 TEST q(Data::Dumper->Dump([\\*foo, \\@foo, \\%foo], ['*foo', '*bar', '*baz']));
341 TEST q(Data::Dumper->Dumpxs([\\*foo, \\@foo, \\%foo], ['*foo', '*bar', '*baz'])) if $XS;
358 #*::foo{ARRAY}->[1] = $foo;
359 #*::foo{ARRAY}->[2]{'c'} = *::foo{ARRAY};
360 #*::foo{ARRAY}->[2]{'b'} = *::foo{SCALAR};
361 #*::foo{ARRAY}->[2]{'d'} = *::foo{ARRAY}->[2];
362 #*::foo = *::foo{ARRAY}->[2];
363 #$bar = *::foo{ARRAY};
364 #$baz = *::foo{ARRAY}->[2];
367 $Data::Dumper::Indent = 1;
368 TEST q(Data::Dumper->Dump([\\*foo, \\@foo, \\%foo], ['foo', 'bar', 'baz']));
369 TEST q(Data::Dumper->Dumpxs([\\*foo, \\@foo, \\%foo], ['foo', 'bar', 'baz'])) if $XS;
387 #*::foo{HASH}->{'c'} = \@bar;
388 #*::foo{HASH}->{'b'} = *::foo{SCALAR};
389 #*::foo{HASH}->{'d'} = *::foo{HASH};
390 #$bar[2] = *::foo{HASH};
391 #%baz = %{*::foo{HASH}};
395 TEST q(Data::Dumper->Dump([\\@foo, \\%foo, \\*foo], ['*bar', '*baz', '*foo']));
396 TEST q(Data::Dumper->Dumpxs([\\@foo, \\%foo, \\*foo], ['*bar', '*baz', '*foo'])) if $XS;
414 #*::foo{HASH}->{'c'} = $bar;
415 #*::foo{HASH}->{'b'} = *::foo{SCALAR};
416 #*::foo{HASH}->{'d'} = *::foo{HASH};
417 #$bar->[2] = *::foo{HASH};
418 #$baz = *::foo{HASH};
422 TEST q(Data::Dumper->Dump([\\@foo, \\%foo, \\*foo], ['bar', 'baz', 'foo']));
423 TEST q(Data::Dumper->Dumpxs([\\@foo, \\%foo, \\*foo], ['bar', 'baz', 'foo'])) if $XS;
442 $Data::Dumper::Purity = 0;
443 $Data::Dumper::Quotekeys = 0;
444 TEST q(Data::Dumper->Dump([\\*foo, \\@foo, \\%foo], ['*foo', '*bar', '*baz']));
445 TEST q(Data::Dumper->Dumpxs([\\*foo, \\@foo, \\%foo], ['*foo', '*bar', '*baz'])) if $XS;
464 TEST q(Data::Dumper->Dump([\\*foo, \\@foo, \\%foo], ['foo', 'bar', 'baz']));
465 TEST q(Data::Dumper->Dumpxs([\\*foo, \\@foo, \\%foo], ['foo', 'bar', 'baz'])) if $XS;
473 @dogs = ( 'Fido', 'Wags' );
480 $mutts = $mutts; # avoid warning
490 # ${$kennels{First}},
491 # ${$kennels{Second}},
498 $d = Data::Dumper->new([\\%kennel, \\@dogs, $mutts],
499 [qw(*kennels *dogs *mutts)] );
504 $d = Data::Dumper->new([\\%kennel, \\@dogs, $mutts],
505 [qw(*kennels *dogs *mutts)] );
513 #%kennels = %kennels;
519 TEST q($d->Dumpxs) if $XS;
529 # ${$kennels{First}},
530 # ${$kennels{Second}},
537 TEST q($d->Reset; $d->Dump);
539 TEST q($d->Reset; $d->Dumpxs);
549 # Second => \$dogs[1],
553 #%kennels = %{$dogs[2]};
554 #%mutts = %{$dogs[2]};
558 $d = Data::Dumper->new([\\@dogs, \\%kennel, $mutts],
559 [qw(*dogs *kennels *mutts)] );
564 $d = Data::Dumper->new([\\@dogs, \\%kennel, $mutts],
565 [qw(*dogs *kennels *mutts)] );
572 TEST q($d->Reset->Dump);
574 TEST q($d->Reset->Dumpxs);
595 $d = Data::Dumper->new( [\@dogs, \%kennel], [qw(*dogs *kennels)] );
596 $d->Deepcopy(1)->Dump;
599 TEST q($d->Reset->Dumpxs);
606 sub z { print "foo\n" }
618 TEST q(Data::Dumper->new([\&z,$c],['a','c'])->Seen({'b' => \&z})->Dump;);
619 TEST q(Data::Dumper->new([\&z,$c],['a','c'])->Seen({'b' => \&z})->Dumpxs;)
631 TEST q(Data::Dumper->new([\&z,$c],['a','c'])->Seen({'*b' => \&z})->Dump;);
632 TEST q(Data::Dumper->new([\&z,$c],['a','c'])->Seen({'*b' => \&z})->Dumpxs;)
644 TEST q(Data::Dumper->new([\&z,$c],['*a','*c'])->Seen({'*b' => \&z})->Dump;);
645 TEST q(Data::Dumper->new([\&z,$c],['*a','*c'])->Seen({'*b' => \&z})->Dumpxs;)
664 TEST q(Data::Dumper->new([$a],['*a'])->Purity(1)->Dump;);
665 TEST q(Data::Dumper->new([$a],['*a'])->Purity(1)->Dumpxs;)
680 TEST q(Data::Dumper->new([$a,$b],['a','b'])->Purity(1)->Dump;);
681 TEST q(Data::Dumper->new([$a,$b],['a','b'])->Purity(1)->Dumpxs;)
686 $a = [{ a => \$b }, { b => undef }];
687 $b = [{ c => \$b }, { d => \$a }];
707 #${$a->[0]{a}}->[0]->{c} = $a->[0]{a};
708 #${${$a->[0]{a}}->[1]->{d}} = $a;
712 TEST q(Data::Dumper->new([$a,$b],['a','b'])->Purity(1)->Dump;);
713 TEST q(Data::Dumper->new([$a,$b],['a','b'])->Purity(1)->Dumpxs;)
718 $a = [[[[\\\\\'foo']]]];
735 #$c = ${${$a->[0][0][0][0]}};
738 TEST q(Data::Dumper->new([$a,$b,$c],['a','b','c'])->Purity(1)->Dump;);
739 TEST q(Data::Dumper->new([$a,$b,$c],['a','b','c'])->Purity(1)->Dumpxs;)
758 # e => 'ARRAY(0xdeadbeef)'
767 TEST q(Data::Dumper->new([$a,$b,$c],['a','b','c'])->Maxdepth(4)->Dump;);
768 TEST q(Data::Dumper->new([$a,$b,$c],['a','b','c'])->Maxdepth(4)->Dumpxs;)
775 # b => 'HASH(0xdeadbeef)'
783 TEST q(Data::Dumper->new([$a,$b,$c],['a','b','c'])->Maxdepth(1)->Dump;);
784 TEST q(Data::Dumper->new([$a,$b,$c],['a','b','c'])->Maxdepth(1)->Dumpxs;)
800 TEST q(Data::Dumper->new([$b],['b'])->Purity(0)->Dump;);
801 TEST q(Data::Dumper->new([$b],['b'])->Purity(0)->Dumpxs;)
810 #${$b->[0]} = $b->[0];
814 TEST q(Data::Dumper->new([$b],['b'])->Purity(1)->Dump;);
815 TEST q(Data::Dumper->new([$b],['b'])->Purity(1)->Dumpxs;)
822 ## XS code was adding an extra \0
827 TEST q(Data::Dumper->Dump([$a], ['a'])), "\\x{9c10}";
828 TEST q(Data::Dumper->Dumpxs([$a], ['a'])), "XS \\x{9c10}"
835 $a = { map { ("$_$_$_", ++$i) } 'I'..'Q' };
836 local $Data::Dumper::Sortkeys = 1;
854 TEST q(Data::Dumper->new([$a])->Dump;);
855 TEST q(Data::Dumper->new([$a])->Dumpxs;)
861 $c = { map { (++$i, "$_$_$_") } 'I'..'Q' };
862 local $Data::Dumper::Sortkeys = \&sort199;
865 return [ sort { $b <=> $a } keys %$hash ];
884 # perl code does keys and values as numbers if possible
885 TEST q(Data::Dumper->new([$c])->Dump;);
886 # XS code always does them as strings
887 $WANT =~ s/ (\d+)/ '$1'/gs;
888 TEST q(Data::Dumper->new([$c])->Dumpxs;)
894 $c = { map { (++$i, "$_$_$_") } 'I'..'Q' };
895 $d = { reverse %$c };
896 local $Data::Dumper::Sortkeys = \&sort205;
900 $hash eq $c ? (sort { $a <=> $b } keys %$hash)
901 : (reverse sort keys %$hash)
934 TEST q(Data::Dumper->new([[$c, $d]])->Dump;);
935 $WANT =~ s/ (\d+)/ '$1'/gs;
936 TEST q(Data::Dumper->new([[$c, $d]])->Dumpxs;)
941 local $Data::Dumper::Deparse = 1;
942 local $Data::Dumper::Indent = 2;
954 TEST q(Data::Dumper->new([{ foo => sub { print "foo"; } }])->Dump);
961 # The controls (bare numbers) are stored either as integers or floating point.
962 # [depending on whether the tokeniser sees things like ".".
963 # The peephole optimiser only runs for constant folding, not single constants,
964 # so I already have some NVs, some IVs
965 # The string versions are not. They are all PV
967 # This is arguably all far too chummy with the implementation, but I really
968 # want to ensure that we don't go wrong when flags on scalars get as side
969 # effects of reading them.
971 # These tests are actually testing the precise output of the current
972 # implementation, so will most likely fail if the implementation changes,
973 # even if the new implementation produces different but correct results.
974 # It would be nice to test for wrong answers, but I can't see how to do that,
975 # so instead I'm checking for unexpected answers. (ie -2 becoming "-2" is not
976 # wrong, but I can't see an easy, reliable way to code that knowledge)
978 # Numbers (seen by the tokeniser as numbers, stored as numbers.
981 0, +1, -2, 3.0, +4.0, -5.0, 6.5, +7.5, -8.5,
982 9, +10, -11, 12.0, +13.0, -14.0, 15.5, +16.25, -17.75,
987 "0", "+1", "-2", "3.0", "+4.0", "-5.0", "6.5", "+7.5", "-8.5", " 9",
988 " +10", " -11", " 12.0", " +13.0", " -14.0", " 15.5", " +16.25", " -17.75",
991 # The perl code always does things the same way for numbers.
992 $WANT_PL_N = <<'EOT';
1012 # The perl code knows that 0 and -2 stringify exactly back to the strings,
1013 # so it dumps them as numbers, not strings.
1014 $WANT_PL_S = <<'EOT';
1031 #$VAR17 = ' +16.25';
1032 #$VAR18 = ' -17.75';
1035 # The XS code differs.
1036 # These are the numbers as seen by the tokeniser. Constants aren't folded
1037 # (which makes IVs where possible) so values the tokeniser thought were
1038 # floating point are stored as NVs. The XS code outputs these as strings,
1039 # but as it has converted them from NVs, leading + signs will not be there.
1040 $WANT_XS_N = <<'EOT';
1061 # These are the strings as seen by the tokeniser. The XS code will output
1062 # these for all cases except where the scalar has been used in integer context
1063 $WANT_XS_S = <<'EOT';
1080 #$VAR17 = ' +16.25';
1081 #$VAR18 = ' -17.75';
1084 # These are the numbers as IV-ized by &
1085 # These will differ from WANT_XS_N because now IV flags will be set on all
1086 # values that were actually integer, and the XS code will then output these
1087 # as numbers not strings.
1088 $WANT_XS_I = <<'EOT';
1109 # Some of these tests will be redundant.
1110 @numbers_s = @numbers_i = @numbers_is = @numbers_n = @numbers_ns = @numbers_ni
1111 = @numbers_nis = @numbers;
1112 @strings_s = @strings_i = @strings_is = @strings_n = @strings_ns = @strings_ni
1113 = @strings_nis = @strings;
1114 # Use them in an integer context
1115 foreach (@numbers_i, @numbers_ni, @numbers_nis, @numbers_is,
1116 @strings_i, @strings_ni, @strings_nis, @strings_is) {
1117 my $b = sprintf "%d", $_;
1119 # Use them in a floating point context
1120 foreach (@numbers_n, @numbers_ni, @numbers_nis, @numbers_ns,
1121 @strings_n, @strings_ni, @strings_nis, @strings_ns) {
1122 my $b = sprintf "%e", $_;
1124 # Use them in a string context
1125 foreach (@numbers_s, @numbers_is, @numbers_nis, @numbers_ns,
1126 @strings_s, @strings_is, @strings_nis, @strings_ns) {
1127 my $b = sprintf "%s", $_;
1130 # use Devel::Peek; Dump ($_) foreach @vanilla_c;
1133 TEST q(Data::Dumper->new(\@numbers)->Dump), 'Numbers';
1134 TEST q(Data::Dumper->new(\@numbers_s)->Dump), 'Numbers PV';
1135 TEST q(Data::Dumper->new(\@numbers_i)->Dump), 'Numbers IV';
1136 TEST q(Data::Dumper->new(\@numbers_is)->Dump), 'Numbers IV,PV';
1137 TEST q(Data::Dumper->new(\@numbers_n)->Dump), 'Numbers NV';
1138 TEST q(Data::Dumper->new(\@numbers_ns)->Dump), 'Numbers NV,PV';
1139 TEST q(Data::Dumper->new(\@numbers_ni)->Dump), 'Numbers NV,IV';
1140 TEST q(Data::Dumper->new(\@numbers_nis)->Dump), 'Numbers NV,IV,PV';
1142 TEST q(Data::Dumper->new(\@strings)->Dump), 'Strings';
1143 TEST q(Data::Dumper->new(\@strings_s)->Dump), 'Strings PV';
1144 TEST q(Data::Dumper->new(\@strings_i)->Dump), 'Strings IV';
1145 TEST q(Data::Dumper->new(\@strings_is)->Dump), 'Strings IV,PV';
1146 TEST q(Data::Dumper->new(\@strings_n)->Dump), 'Strings NV';
1147 TEST q(Data::Dumper->new(\@strings_ns)->Dump), 'Strings NV,PV';
1148 TEST q(Data::Dumper->new(\@strings_ni)->Dump), 'Strings NV,IV';
1149 TEST q(Data::Dumper->new(\@strings_nis)->Dump), 'Strings NV,IV,PV';
1152 TEST q(Data::Dumper->new(\@numbers)->Dumpxs), 'XS Numbers';
1153 TEST q(Data::Dumper->new(\@numbers_s)->Dumpxs), 'XS Numbers PV';
1155 TEST q(Data::Dumper->new(\@numbers_i)->Dumpxs), 'XS Numbers IV';
1156 TEST q(Data::Dumper->new(\@numbers_is)->Dumpxs), 'XS Numbers IV,PV';
1158 TEST q(Data::Dumper->new(\@numbers_n)->Dumpxs), 'XS Numbers NV';
1159 TEST q(Data::Dumper->new(\@numbers_ns)->Dumpxs), 'XS Numbers NV,PV';
1161 TEST q(Data::Dumper->new(\@numbers_ni)->Dumpxs), 'XS Numbers NV,IV';
1162 TEST q(Data::Dumper->new(\@numbers_nis)->Dumpxs), 'XS Numbers NV,IV,PV';
1165 TEST q(Data::Dumper->new(\@strings)->Dumpxs), 'XS Strings';
1166 TEST q(Data::Dumper->new(\@strings_s)->Dumpxs), 'XS Strings PV';
1167 # This one used to really mess up. New code actually emulates the .pm code
1169 TEST q(Data::Dumper->new(\@strings_i)->Dumpxs), 'XS Strings IV';
1170 TEST q(Data::Dumper->new(\@strings_is)->Dumpxs), 'XS Strings IV,PV';
1172 TEST q(Data::Dumper->new(\@strings_n)->Dumpxs), 'XS Strings NV';
1173 TEST q(Data::Dumper->new(\@strings_ns)->Dumpxs), 'XS Strings NV,PV';
1174 # This one used to really mess up. New code actually emulates the .pm code
1176 TEST q(Data::Dumper->new(\@strings_ni)->Dumpxs), 'XS Strings NV,IV';
1177 TEST q(Data::Dumper->new(\@strings_nis)->Dumpxs), 'XS Strings NV,IV,PV';
1183 ## Perl code was using /...$/ and hence missing the \n.
1189 # Can't pad with # as the output has an embedded newline.
1190 local $Data::Dumper::Pad = "my ";
1191 TEST q(Data::Dumper->Dump(["42\n"])), "number with trailing newline";
1192 TEST q(Data::Dumper->Dumpxs(["42\n"])), "XS number with trailing newline"
1212 ## Perl code flips over at 10 digits.
1215 #$VAR2 = '1000000000';
1216 #$VAR3 = '9999999999';
1217 #$VAR4 = '10000000000';
1218 #$VAR5 = -999999999;
1219 #$VAR6 = '-1000000000';
1220 #$VAR7 = '-9999999999';
1221 #$VAR8 = '-10000000000';
1222 #$VAR9 = '4294967295';
1223 #$VAR10 = '4294967296';
1224 #$VAR11 = '-2147483648';
1225 #$VAR12 = '-2147483649';
1228 TEST q(Data::Dumper->Dump(\@a)), "long integers";
1231 ## XS code flips over at 11 characters ("-" is a char) or larger than int.
1232 if (~0 == 0xFFFFFFFF) {
1236 #$VAR2 = 1000000000;
1237 #$VAR3 = '9999999999';
1238 #$VAR4 = '10000000000';
1239 #$VAR5 = -999999999;
1240 #$VAR6 = '-1000000000';
1241 #$VAR7 = '-9999999999';
1242 #$VAR8 = '-10000000000';
1243 #$VAR9 = 4294967295;
1244 #$VAR10 = '4294967296';
1245 #$VAR11 = '-2147483648';
1246 #$VAR12 = '-2147483649';
1251 #$VAR2 = 1000000000;
1252 #$VAR3 = 9999999999;
1253 #$VAR4 = '10000000000';
1254 #$VAR5 = -999999999;
1255 #$VAR6 = '-1000000000';
1256 #$VAR7 = '-9999999999';
1257 #$VAR8 = '-10000000000';
1258 #$VAR9 = 4294967295;
1259 #$VAR10 = 4294967296;
1260 #$VAR11 = '-2147483648';
1261 #$VAR12 = '-2147483649';
1264 TEST q(Data::Dumper->Dumpxs(\@a)), "XS long integers";
1270 $b = "Bad. XS didn't escape dollar sign";
1272 $WANT = <<"EOT"; # Careful. This is '' string written inside '' here doc
1273 #\$VAR1 = '\$b\"\@\\\\\xA3';
1276 $a = "\$b\"\@\\\xA3\x{100}";
1278 TEST q(Data::Dumper->Dump([$a])), "utf8 flag with \" and \$";
1280 $WANT = <<'EOT'; # While this is "" string written inside "" here doc
1281 #$VAR1 = "\$b\"\@\\\x{a3}";
1283 TEST q(Data::Dumper->Dumpxs([$a])), "XS utf8 flag with \" and \$";
1285 # XS used to produce "$b\"' which is 4 chars, not 3. [ie wrongly qq(\$b\\\")]
1291 $a = "\$b\"\x{100}";
1293 TEST q(Data::Dumper->Dump([$a])), "utf8 flag with \" and \$";
1295 TEST q(Data::Dumper->Dumpxs([$a])), "XS utf8 flag with \" and \$";
1299 # XS used to produce 'D'oh!' which is well, D'oh!
1300 # Andreas found this one, which in turn discovered the previous two.
1306 $a = "D'oh!\x{100}";
1308 TEST q(Data::Dumper->Dump([$a])), "utf8 flag with '";
1310 TEST q(Data::Dumper->Dumpxs([$a])), "XS utf8 flag with '";