1 ################################################################################
3 ## Version 3.x, Copyright (C) 2004-2013, Marcus Holland-Moritz.
4 ## Version 2.x, Copyright (C) 2001, Paul Marquess.
5 ## Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
7 ## This program is free software; you can redistribute it and/or
8 ## modify it under the same terms as Perl itself.
10 ################################################################################
13 # BEWARE: This number and SKIP_SLOW_TESTS must be the same!!!
16 if ($ENV{'SKIP_SLOW_TESTS'}) {
17 skip("skip: SKIP_SLOW_TESTS", 235);
22 use File::Path qw/rmtree mkpath/;
27 my $isVMS = $^O eq 'VMS';
28 my $isMAC = $^O eq 'MacOS';
29 my $perl = find_perl();
31 rmtree($tmp) if -d $tmp;
32 mkpath($tmp) or die "mkpath $tmp: $!\n";
33 chdir($tmp) or die "chdir $tmp: $!\n";
35 if ($ENV{'PERL_CORE'}) {
38 $inc = '"-I../../lib"';
46 unshift @INC, '../../lib';
49 if ($perl =~ m!^\./!) {
54 chdir('..') if !-d $tmp && -d "../$tmp";
55 rmtree($tmp) if -d $tmp;
58 ok(&Devel::PPPort::WriteFile("ppport.h"));
60 # Check GetFileContents()
65 open(F, "<ppport.h") or die "Failed to open ppport.h: $!";
71 is(Devel::PPPort::GetFileContents("ppport.h"), $data);
72 is(Devel::PPPort::GetFileContents(), $data);
78 $c =~ s/^/sprintf("# %2d| ", ++$x)/meg;
79 $c .= "\n" unless $c =~ /[\r\n]$/;
85 my @args = ('ppport.h', @_);
86 unshift @args, $inc if $inc;
87 my $run = $perl =~ m/\s/ ? qq("$perl") : $perl;
88 $run .= ' -MMac::err=unix' if $isMAC;
90 $_ = qq("$_") if $isVMS && /^[^"]/;
93 print "# *** running $run ***\n";
94 $run .= ' 2>&1' unless $isMAC;
96 my $out = join '', @out;
98 return wantarray ? @out : $out;
103 my($str, $re, $mod) = @_;
105 eval "\@n = \$str =~ /$re/g$mod;";
108 $err =~ s/^/# *** /mg;
109 print "# *** ERROR ***\n$err\n";
111 return $@ ? -42 : scalar @n;
117 return 0 unless -e $f1 && -e $f2;
120 print "# File: $_\n";
121 unless (open F, $_) {
122 print "# couldn't open $_: $!\n";
125 $_ = do { local $/; <F> };
134 for (split /\s*={70,}\s*/, do { local $/; <DATA> }) {
137 ($c, @f{m/-{20,}\s+(\S+)\s+-{20,}/g}) = split /\s*-{20,}\s+\S+\s+-{20,}\s*/;
138 push @tests, { code => $c, files => \%f };
143 print "#\n", ('# ', '-'x70, "\n")x3, "#\n";
145 for $f (keys %{$t->{files}}) {
146 my @f = split /\//, $f;
149 my $path = join '/', @f;
150 mkpath($path) or die "mkpath('$path'): $!\n";
152 my $txt = $t->{files}{$f};
154 open F, ">$f" or die "open $f: $!\n";
157 print "# *** writing $f ***\n";
161 print "# *** evaluating test code ***\n";
167 $err =~ s/^/# *** /mg;
168 print "# *** ERROR ***\n$err\n";
172 for (keys %{$t->{files}}) {
173 unlink $_ or die "unlink('$_'): $!\n";
181 return $perl if $isVMS;
183 my $exe = $Config{'_exe'} || '';
185 if ($perl =~ /^perl\Q$exe\E$/i) {
187 eval "require File::Spec";
191 $perl = File::Spec->catfile(File::Spec->curdir(), $perl);
195 if ($perl !~ /\Q$exe\E$/i) {
199 warn "find_perl: cannot find $perl from $^X" unless -f $perl;
206 my $o = ppport(qw(--help));
207 ok($o =~ /^Usage:.*ppport\.h/m);
210 $o = ppport(qw(--version));
211 ok($o =~ /^This is.*ppport.*\d+\.\d+(?:_?\d+)?\.$/);
213 $o = ppport(qw(--nochanges));
214 ok($o =~ /^Scanning.*test\.xs/mi);
215 ok($o =~ /Analyzing.*test\.xs/mi);
216 is(matches($o, '^Scanning', 'm'), 1);
217 is(matches($o, 'Analyzing', 'm'), 1);
218 ok($o =~ /Uses Perl_newSViv instead of newSViv/);
220 $o = ppport(qw(--quiet --nochanges));
223 ---------------------------- test.xs ------------------------------------------
227 ===============================================================================
229 # check if C and C++ comments are filtered correctly
231 my $o = ppport(qw(--copy=a));
232 ok($o =~ /^Scanning.*MyExt\.xs/mi);
233 ok($o =~ /Analyzing.*MyExt\.xs/mi);
234 is(matches($o, '^Scanning', 'm'), 1);
235 ok($o =~ /^Needs to include.*ppport\.h/m);
236 ok($o !~ /^Uses grok_bin/m);
237 ok($o !~ /^Uses newSVpv/m);
238 ok($o =~ /Uses 1 C\+\+ style comment/m);
239 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
241 # check if C++ are left untouched with --cplusplus
243 $o = ppport(qw(--copy=b --cplusplus));
244 ok($o =~ /^Scanning.*MyExt\.xs/mi);
245 ok($o =~ /Analyzing.*MyExt\.xs/mi);
246 is(matches($o, '^Scanning', 'm'), 1);
247 ok($o =~ /^Needs to include.*ppport\.h/m);
248 ok($o !~ /^Uses grok_bin/m);
249 ok($o !~ /^Uses newSVpv/m);
250 ok($o !~ /Uses \d+ C\+\+ style comment/m);
251 ok(eq_files('MyExt.xsb', 'MyExt.rb'));
253 unlink qw(MyExt.xsa MyExt.xsb);
255 ---------------------------- MyExt.xs -----------------------------------------
262 ---------------------------- MyExt.ra -----------------------------------------
270 ---------------------------- MyExt.rb -----------------------------------------
278 ===============================================================================
280 my $o = ppport(qw(--nochanges file1.xs));
281 ok($o =~ /^Scanning.*file1\.xs/mi);
282 ok($o =~ /Analyzing.*file1\.xs/mi);
283 ok($o !~ /^Scanning.*file2\.xs/mi);
284 ok($o =~ /^Uses newCONSTSUB/m);
285 ok($o =~ /^Uses PL_expect/m);
286 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_flags/m);
287 ok($o =~ /WARNING: PL_expect/m);
288 ok($o =~ /^Analysis completed \(1 warning\)/m);
289 ok($o =~ /^Looks good/m);
291 $o = ppport(qw(--nochanges --nohints file1.xs));
292 ok($o =~ /^Scanning.*file1\.xs/mi);
293 ok($o =~ /Analyzing.*file1\.xs/mi);
294 ok($o !~ /^Scanning.*file2\.xs/mi);
295 ok($o =~ /^Uses newCONSTSUB/m);
296 ok($o =~ /^Uses PL_expect/m);
297 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_flags/m);
298 ok($o =~ /WARNING: PL_expect/m);
299 ok($o =~ /^Analysis completed \(1 warning\)/m);
300 ok($o =~ /^Looks good/m);
302 $o = ppport(qw(--nochanges --nohints --nodiag file1.xs));
303 ok($o =~ /^Scanning.*file1\.xs/mi);
304 ok($o =~ /Analyzing.*file1\.xs/mi);
305 ok($o !~ /^Scanning.*file2\.xs/mi);
306 ok($o !~ /^Uses newCONSTSUB/m);
307 ok($o !~ /^Uses PL_expect/m);
308 ok($o !~ /^Uses SvPV_nolen/m);
309 ok($o =~ /WARNING: PL_expect/m);
310 ok($o =~ /^Analysis completed \(1 warning\)/m);
311 ok($o =~ /^Looks good/m);
313 $o = ppport(qw(--nochanges --quiet file1.xs));
316 $o = ppport(qw(--nochanges file2.xs));
317 ok($o =~ /^Scanning.*file2\.xs/mi);
318 ok($o =~ /Analyzing.*file2\.xs/mi);
319 ok($o !~ /^Scanning.*file1\.xs/mi);
320 ok($o =~ /^Uses mXPUSHp/m);
321 ok($o =~ /^Needs to include.*ppport\.h/m);
322 ok($o !~ /^Looks good/m);
323 ok($o =~ /^1 potentially required change detected/m);
325 $o = ppport(qw(--nochanges --nohints file2.xs));
326 ok($o =~ /^Scanning.*file2\.xs/mi);
327 ok($o =~ /Analyzing.*file2\.xs/mi);
328 ok($o !~ /^Scanning.*file1\.xs/mi);
329 ok($o =~ /^Uses mXPUSHp/m);
330 ok($o =~ /^Needs to include.*ppport\.h/m);
331 ok($o !~ /^Looks good/m);
332 ok($o =~ /^1 potentially required change detected/m);
334 $o = ppport(qw(--nochanges --nohints --nodiag file2.xs));
335 ok($o =~ /^Scanning.*file2\.xs/mi);
336 ok($o =~ /Analyzing.*file2\.xs/mi);
337 ok($o !~ /^Scanning.*file1\.xs/mi);
338 ok($o !~ /^Uses mXPUSHp/m);
339 ok($o !~ /^Needs to include.*ppport\.h/m);
340 ok($o !~ /^Looks good/m);
341 ok($o =~ /^1 potentially required change detected/m);
343 $o = ppport(qw(--nochanges --quiet file2.xs));
346 ---------------------------- file1.xs -----------------------------------------
348 #define NEED_newCONSTSUB
349 #define NEED_PL_parser
356 ---------------------------- file2.xs -----------------------------------------
360 ===============================================================================
362 my $o = ppport(qw(--nochanges));
363 ok($o =~ /^Scanning.*FooBar\.xs/mi);
364 ok($o =~ /Analyzing.*FooBar\.xs/mi);
365 is(matches($o, '^Scanning', 'm'), 1);
366 ok($o !~ /^Looks good/m);
367 ok($o =~ /^Uses grok_bin/m);
369 ---------------------------- FooBar.xs ----------------------------------------
375 ===============================================================================
377 my $o = ppport(qw(--nochanges));
378 ok($o =~ /^Scanning.*First\.xs/mi);
379 ok($o =~ /Analyzing.*First\.xs/mi);
380 ok($o =~ /^Scanning.*second\.h/mi);
381 ok($o =~ /Analyzing.*second\.h/mi);
382 ok($o =~ /^Scanning.*sub.*third\.c/mi);
383 ok($o =~ /Analyzing.*sub.*third\.c/mi);
384 ok($o !~ /^Scanning.*foobar/mi);
385 is(matches($o, '^Scanning', 'm'), 3);
387 ---------------------------- First.xs -----------------------------------------
391 ---------------------------- foobar.xyz ---------------------------------------
395 ---------------------------- second.h -----------------------------------------
399 ---------------------------- sub/third.c --------------------------------------
403 ===============================================================================
405 my $o = ppport(qw(--nochanges));
406 ok($o =~ /Possibly wrong #define NEED_foobar in.*test.xs/i);
408 ---------------------------- test.xs ------------------------------------------
412 ===============================================================================
414 # And now some complex "real-world" example
416 my $o = ppport(qw(--copy=f));
417 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c mod5.c)) {
418 ok($o =~ /^Scanning.*\Q$_\E/mi);
419 ok($o =~ /Analyzing.*\Q$_\E/i);
421 is(matches($o, '^Scanning', 'm'), 6);
423 is(matches($o, '^Writing copy of', 'm'), 5);
426 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c)) {
427 ok($o =~ /^Writing copy of.*\Q$_\E.*with changes/mi);
429 ok(eq_files("${_}f", "${_}r"));
433 ---------------------------- main.xs ------------------------------------------
439 #define NEED_newCONSTSUB
440 #define NEED_grok_hex_GLOBAL
445 Perl_grok_bin(aTHX_ foo, bar);
451 Perl_grok_bin(bar, sv_no);
453 ---------------------------- mod1.c -------------------------------------------
459 #define NEED_grok_bin_GLOBAL
460 #define NEED_newCONSTSUB
467 Perl_sv_catpvf(); /* I know it's wrong ;-) */
470 ---------------------------- mod2.c -------------------------------------------
485 ---------------------------- mod3.c -------------------------------------------
494 ---------------------------- mod4.c -------------------------------------------
502 ---------------------------- mod5.c -------------------------------------------
511 ---------------------------- main.xsr -----------------------------------------
517 #define NEED_eval_pv_GLOBAL
518 #define NEED_grok_hex
519 #define NEED_newCONSTSUB_GLOBAL
530 grok_bin(bar, PL_sv_no);
532 ---------------------------- mod1.cr ------------------------------------------
538 #define NEED_grok_bin_GLOBAL
544 Perl_croak (aTHX_ "foo");
545 Perl_sv_catpvf(aTHX); /* I know it's wrong ;-) */
548 ---------------------------- mod2.cr ------------------------------------------
561 ---------------------------- mod3.cr ------------------------------------------
566 #define NEED_grok_oct
572 ---------------------------- mod4.cr ------------------------------------------
581 ===============================================================================
583 my $o = ppport(qw(--nochanges));
584 ok($o =~ /Uses grok_hex/m);
585 ok($o !~ /Looks good/m);
587 $o = ppport(qw(--nochanges --compat-version=5.8.0));
588 ok($o !~ /Uses grok_hex/m);
589 ok($o =~ /Looks good/m);
591 ---------------------------- FooBar.xs ----------------------------------------
595 ===============================================================================
597 my $o = ppport(qw(--nochanges));
598 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
600 $o = ppport(qw(--nochanges --compat-version=5.5.3));
601 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
603 $o = ppport(qw(--nochanges --compat-version=5.005_03));
604 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
606 $o = ppport(qw(--nochanges --compat-version=5.6.0));
607 ok($o !~ /Uses SvPVutf8_force/m);
609 $o = ppport(qw(--nochanges --compat-version=5.006));
610 ok($o !~ /Uses SvPVutf8_force/m);
612 $o = ppport(qw(--nochanges --compat-version=5.999.999));
613 ok($o !~ /Uses SvPVutf8_force/m);
615 $o = ppport(qw(--nochanges --compat-version=8.0.0));
616 ok($o =~ /Only Perl \[57\] are supported/m);
618 $o = ppport(qw(--nochanges --compat-version=5.1000.999));
619 ok($o =~ /Invalid version number: 5.1000.999/m);
621 $o = ppport(qw(--nochanges --compat-version=5.999.1000));
622 ok($o =~ /Invalid version number: 5.999.1000/m);
624 ---------------------------- FooBar.xs ----------------------------------------
628 ===============================================================================
630 my $o = ppport(qw(--nochanges));
631 ok($o !~ /potentially required change/);
632 is(matches($o, '^Looks good', 'm'), 2);
634 ---------------------------- FooBar.xs ----------------------------------------
636 #define NEED_grok_numeric_radix
637 #define NEED_grok_number
640 GROK_NUMERIC_RADIX();
643 ---------------------------- foo.c --------------------------------------------
649 ===============================================================================
651 # check --api-info option
653 my $o = ppport(qw(--api-info=INT2PTR));
654 my %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
655 is(scalar keys %found, 1, "found 1 key");
656 ok(exists $found{INT2PTR});
657 is(matches($o, '^Supported at least since perl-5\.6\.0', 'm'), 1, "INT2PTR supported without ppport.h to 5.6.0");
658 is(matches($o, '^ppport.h additionally provides support at least back to perl-5\.003', 'm'), 1, "INT2PTR supported with ppport.h to 5.003");
660 $o = ppport(qw(--api-info=Zero));
661 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
662 is(scalar keys %found, 1, "found 1 key");
663 ok(exists $found{Zero});
664 is(matches($o, '^Supported at least since perl-5.003', 'm'), 1, "Zero supported to 5.003");
666 $o = ppport(qw(--api-info=/Zero/));
667 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
668 is(scalar keys %found, 2, "found 2 keys");
669 ok(exists $found{Zero});
670 ok(exists $found{ZeroD});
672 ===============================================================================
674 # check --list-provided option
676 my @o = ppport(qw(--list-provided));
680 my($name, $flags) = /^(\w+)(?:\s+\[(\w+(?:,\s+\w+)*)\])?$/ or $fail++;
682 'warnings'->unimport('uninitialized') if ivers($]) > ivers('5.006');
683 exists $p{$name} and $fail++;
685 $p{$name} = defined $flags ? { map { ($_ => 1) } $flags =~ /(\w+)/g } : '';
690 ok(exists $p{call_pv});
691 ok(not ref $p{call_pv});
693 ok(exists $p{grok_bin});
694 is(ref $p{grok_bin}, 'HASH');
695 is(scalar keys %{$p{grok_bin}}, 2);
696 ok($p{grok_bin}{explicit});
697 ok($p{grok_bin}{depend});
699 ok(exists $p{gv_stashpvn});
700 is(ref $p{gv_stashpvn}, 'HASH');
701 is(scalar keys %{$p{gv_stashpvn}}, 2);
702 ok($p{gv_stashpvn}{depend});
703 ok($p{gv_stashpvn}{hint});
705 ok(exists $p{sv_catpvf_mg});
706 is(ref $p{sv_catpvf_mg}, 'HASH');
707 is(scalar keys %{$p{sv_catpvf_mg}}, 2);
708 ok($p{sv_catpvf_mg}{explicit});
709 ok($p{sv_catpvf_mg}{depend});
711 ok(exists $p{PL_signals});
712 is(ref $p{PL_signals}, 'HASH');
713 is(scalar keys %{$p{PL_signals}}, 1);
714 ok($p{PL_signals}{explicit});
716 ===============================================================================
718 # check --list-unsupported option
720 my @o = ppport(qw(--list-unsupported));
724 my($name, $ver) = /^(\w+)\s*\.*\s*([\d._]+)$/ or $fail++;
725 { exists $p{$name} and $fail++; }
731 ok(exists $p{utf8_distance});
732 is($p{utf8_distance}, '5.6.0');
734 ok(exists $p{save_generic_svref});
735 is($p{save_generic_svref}, '5.005_03');
737 ===============================================================================
739 # check --nofilter option
741 my $o = ppport(qw(--nochanges));
742 ok($o =~ /^Scanning.*foo\.cpp/mi);
743 ok($o =~ /Analyzing.*foo\.cpp/mi);
744 is(matches($o, '^Scanning', 'm'), 1);
745 is(matches($o, 'Analyzing', 'm'), 1);
747 $o = ppport(qw(--nochanges foo.cpp foo.o Makefile.PL));
748 ok($o =~ /Skipping the following files \(use --nofilter to avoid this\):/m);
749 is(matches($o, '^\|\s+foo\.o', 'mi'), 1);
750 is(matches($o, '^\|\s+Makefile\.PL', 'mi'), 1);
751 ok($o =~ /^Scanning.*foo\.cpp/mi);
752 ok($o =~ /Analyzing.*foo\.cpp/mi);
753 is(matches($o, '^Scanning', 'm'), 1);
754 is(matches($o, 'Analyzing', 'm'), 1);
756 $o = ppport(qw(--nochanges --nofilter foo.cpp foo.o Makefile.PL));
757 ok($o =~ /^Scanning.*foo\.cpp/mi);
758 ok($o =~ /Analyzing.*foo\.cpp/mi);
759 ok($o =~ /^Scanning.*foo\.o/mi);
760 ok($o =~ /Analyzing.*foo\.o/mi);
761 ok($o =~ /^Scanning.*Makefile/mi);
762 ok($o =~ /Analyzing.*Makefile/mi);
763 is(matches($o, '^Scanning', 'm'), 3);
764 is(matches($o, 'Analyzing', 'm'), 3);
766 ---------------------------- foo.cpp ------------------------------------------
770 ---------------------------- foo.o --------------------------------------------
774 ---------------------------- Makefile.PL --------------------------------------
778 ===============================================================================
780 # check if explicit variables are handled propery
782 my $o = ppport(qw(--copy=a));
783 ok($o =~ /^Needs to include.*ppport\.h/m);
784 ok($o =~ /^Uses PL_signals/m);
785 ok($o =~ /^File needs PL_signals, adding static request/m);
786 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
788 unlink qw(MyExt.xsa);
790 ---------------------------- MyExt.xs -----------------------------------------
793 if (PL_signals == 42)
796 ---------------------------- MyExt.ra -----------------------------------------
798 #define NEED_PL_signals
801 if (PL_signals == 42)
804 ===============================================================================
806 my $o = ppport(qw(--nochanges file.xs));
807 ok($o =~ /^Uses PL_copline/m);
808 ok($o =~ /WARNING: PL_copline/m);
809 ok($o =~ /^Uses SvUOK/m);
810 ok($o =~ /WARNING: Uses SvUOK, which may not be portable/m);
811 ok($o =~ /^Analysis completed \(2 warnings\)/m);
812 ok($o =~ /^Looks good/m);
814 $o = ppport(qw(--nochanges --compat-version=5.8.0 file.xs));
815 ok($o =~ /^Uses PL_copline/m);
816 ok($o =~ /WARNING: PL_copline/m);
817 ok($o !~ /WARNING: Uses SvUOK, which may not be portable/m);
818 ok($o =~ /^Analysis completed \(1 warning\)/m);
819 ok($o =~ /^Looks good/m);
821 ---------------------------- file.xs -----------------------------------------
823 #define NEED_PL_parser
828 ===============================================================================
830 my $o = ppport(qw(--copy=f));
833 ok($o =~ /^Writing copy of.*\Q$_\E.*with changes/mi);
835 ok(eq_files("${_}f", "${_}r"));
839 ---------------------------- file.xs -----------------------------------------
841 a_string = "sv_undef"
843 #define SOMETHING defgv
844 /* C-comment: sv_tainted */
846 # This is just a big XS comment using sv_no
848 /* The following, is NOT an XS comment! */
849 # define SOMETHING_ELSE defgv + \
852 ---------------------------- file.xsr -----------------------------------------
855 a_string = "sv_undef"
857 #define SOMETHING PL_defgv
858 /* C-comment: sv_tainted */
860 # This is just a big XS comment using sv_no
862 /* The following, is NOT an XS comment! */
863 # define SOMETHING_ELSE PL_defgv + \
866 ===============================================================================
868 my $o = ppport(qw(--copy=f));
871 ok($o =~ /^Writing copy of.*\Q$_\E.*with changes/mi);
873 ok(eq_files("${_}f", "${_}r"));
877 ---------------------------- file.xs -----------------------------------------
881 Perl_croak_nocontext("foo");
884 croak_nocontext("foo");
885 Perl_warner_nocontext("foo");
887 warner_nocontext("foo");
890 ---------------------------- file.xsr -----------------------------------------
894 Perl_croak_nocontext("foo");
895 Perl_croak(aTHX_ "bar");
897 croak_nocontext("foo");
898 Perl_warner_nocontext("foo");
899 Perl_warner(aTHX_ "foo");
900 warner_nocontext("foo");