1 ################################################################################
5 ## $Date: 2006/07/03 22:54:26 +0200 $
7 ################################################################################
9 ## Version 3.x, Copyright (C) 2004-2006, Marcus Holland-Moritz.
10 ## Version 2.x, Copyright (C) 2001, Paul Marquess.
11 ## Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
13 ## This program is free software; you can redistribute it and/or
14 ## modify it under the same terms as Perl itself.
16 ################################################################################
21 if ($ENV{'SKIP_SLOW_TESTS'}) {
23 skip("skip: SKIP_SLOW_TESTS", 0);
29 use File::Path qw/rmtree mkpath/;
34 my $isVMS = $^O eq 'VMS';
35 my $isMAC = $^O eq 'MacOS';
36 my $perl = find_perl();
38 rmtree($tmp) if -d $tmp;
39 mkpath($tmp) or die "mkpath $tmp: $!\n";
40 chdir($tmp) or die "chdir $tmp: $!\n";
42 if ($ENV{'PERL_CORE'}) {
45 $inc = '"-I../../lib"';
53 unshift @INC, '../../lib';
56 if ($perl =~ m!^\./!) {
61 chdir('..') if !-d $tmp && -d "../$tmp";
62 rmtree($tmp) if -d $tmp;
65 ok(&Devel::PPPort::WriteFile("ppport.h"));
71 $c .= "\n" unless $c =~ /[\r\n]$/;
77 my @args = ('ppport.h', @_);
78 unshift @args, $inc if $inc;
79 my $run = $perl =~ m/\s/ ? qq("$perl") : $perl;
80 $run .= ' -MMac::err=unix' if $isMAC;
82 $_ = qq("$_") if $isVMS && /^[^"]/;
85 print "# *** running $run ***\n";
86 $run .= ' 2>&1' unless $isMAC;
88 my $out = join '', @out;
90 return wantarray ? @out : $out;
95 my($str, $re, $mod) = @_;
97 eval "\@n = \$str =~ /$re/g$mod;";
100 $err =~ s/^/# *** /mg;
101 print "# *** ERROR ***\n$err\n";
103 return $@ ? -42 : scalar @n;
109 return 0 unless -e $f1 && -e $f2;
112 print "# File: $_\n";
113 unless (open F, $_) {
114 print "# couldn't open $_: $!\n";
117 $_ = do { local $/; <F> };
126 for (split /\s*={70,}\s*/, do { local $/; <DATA> }) {
129 ($c, @f{m/-{20,}\s+(\S+)\s+-{20,}/g}) = split /\s*-{20,}\s+\S+\s+-{20,}\s*/;
130 push @tests, { code => $c, files => \%f };
136 for $f (keys %{$t->{files}}) {
137 my @f = split /\//, $f;
140 my $path = join '/', @f;
141 mkpath($path) or die "mkpath('$path'): $!\n";
143 my $txt = $t->{files}{$f};
145 open F, ">$f" or die "open $f: $!\n";
149 print "# *** writing $f ***\n$txt\n";
155 $err =~ s/^/# *** /mg;
156 print "# *** ERROR ***\n$err\n";
160 for (keys %{$t->{files}}) {
161 unlink $_ or die "unlink('$_'): $!\n";
169 return $perl if $isVMS;
171 my $exe = $Config{'_exe'} || '';
173 if ($perl =~ /^perl\Q$exe\E$/i) {
175 eval "require File::Spec";
179 $perl = File::Spec->catfile(File::Spec->curdir(), $perl);
183 if ($perl !~ /\Q$exe\E$/i) {
187 warn "find_perl: cannot find $perl from $^X" unless -f $perl;
194 my $o = ppport(qw(--help));
195 ok($o =~ /^Usage:.*ppport\.h/m);
198 $o = ppport(qw(--version));
199 ok($o =~ /^This is.*ppport.*\d+\.\d+(?:_?\d+)?\.$/);
201 $o = ppport(qw(--nochanges));
202 ok($o =~ /^Scanning.*test\.xs/mi);
203 ok($o =~ /Analyzing.*test\.xs/mi);
204 ok(matches($o, '^Scanning', 'm'), 1);
205 ok(matches($o, 'Analyzing', 'm'), 1);
206 ok($o =~ /Uses Perl_newSViv instead of newSViv/);
208 $o = ppport(qw(--quiet --nochanges));
211 ---------------------------- test.xs ------------------------------------------
215 ===============================================================================
217 # check if C and C++ comments are filtered correctly
219 my $o = ppport(qw(--copy=a));
220 ok($o =~ /^Scanning.*MyExt\.xs/mi);
221 ok($o =~ /Analyzing.*MyExt\.xs/mi);
222 ok(matches($o, '^Scanning', 'm'), 1);
223 ok($o =~ /^Needs to include.*ppport\.h/m);
224 ok($o !~ /^Uses grok_bin/m);
225 ok($o !~ /^Uses newSVpv/m);
226 ok($o =~ /Uses 1 C\+\+ style comment/m);
227 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
229 # check if C++ are left untouched with --cplusplus
231 $o = ppport(qw(--copy=b --cplusplus));
232 ok($o =~ /^Scanning.*MyExt\.xs/mi);
233 ok($o =~ /Analyzing.*MyExt\.xs/mi);
234 ok(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 \d+ C\+\+ style comment/m);
239 ok(eq_files('MyExt.xsb', 'MyExt.rb'));
241 unlink qw(MyExt.xsa MyExt.xsb);
243 ---------------------------- MyExt.xs -----------------------------------------
250 ---------------------------- MyExt.ra -----------------------------------------
258 ---------------------------- MyExt.rb -----------------------------------------
266 ===============================================================================
268 my $o = ppport(qw(--nochanges file1.xs));
269 ok($o =~ /^Scanning.*file1\.xs/mi);
270 ok($o =~ /Analyzing.*file1\.xs/mi);
271 ok($o !~ /^Scanning.*file2\.xs/mi);
272 ok($o =~ /^Uses newCONSTSUB/m);
273 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
274 ok($o =~ /hint for newCONSTSUB/m);
275 ok($o !~ /hint for sv_2pv_nolen/m);
276 ok($o =~ /^Looks good/m);
278 $o = ppport(qw(--nochanges --nohints file1.xs));
279 ok($o =~ /^Scanning.*file1\.xs/mi);
280 ok($o =~ /Analyzing.*file1\.xs/mi);
281 ok($o !~ /^Scanning.*file2\.xs/mi);
282 ok($o =~ /^Uses newCONSTSUB/m);
283 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
284 ok($o !~ /hint for newCONSTSUB/m);
285 ok($o !~ /hint for sv_2pv_nolen/m);
286 ok($o =~ /^Looks good/m);
288 $o = ppport(qw(--nochanges --nohints --nodiag file1.xs));
289 ok($o =~ /^Scanning.*file1\.xs/mi);
290 ok($o =~ /Analyzing.*file1\.xs/mi);
291 ok($o !~ /^Scanning.*file2\.xs/mi);
292 ok($o !~ /^Uses newCONSTSUB/m);
293 ok($o !~ /^Uses SvPV_nolen/m);
294 ok($o !~ /hint for newCONSTSUB/m);
295 ok($o !~ /hint for sv_2pv_nolen/m);
296 ok($o =~ /^Looks good/m);
298 $o = ppport(qw(--nochanges --quiet file1.xs));
301 $o = ppport(qw(--nochanges file2.xs));
302 ok($o =~ /^Scanning.*file2\.xs/mi);
303 ok($o =~ /Analyzing.*file2\.xs/mi);
304 ok($o !~ /^Scanning.*file1\.xs/mi);
305 ok($o =~ /^Uses mXPUSHp/m);
306 ok($o =~ /^Needs to include.*ppport\.h/m);
307 ok($o !~ /^Looks good/m);
308 ok($o =~ /^1 potentially required change detected/m);
310 $o = ppport(qw(--nochanges --nohints file2.xs));
311 ok($o =~ /^Scanning.*file2\.xs/mi);
312 ok($o =~ /Analyzing.*file2\.xs/mi);
313 ok($o !~ /^Scanning.*file1\.xs/mi);
314 ok($o =~ /^Uses mXPUSHp/m);
315 ok($o =~ /^Needs to include.*ppport\.h/m);
316 ok($o !~ /^Looks good/m);
317 ok($o =~ /^1 potentially required change detected/m);
319 $o = ppport(qw(--nochanges --nohints --nodiag file2.xs));
320 ok($o =~ /^Scanning.*file2\.xs/mi);
321 ok($o =~ /Analyzing.*file2\.xs/mi);
322 ok($o !~ /^Scanning.*file1\.xs/mi);
323 ok($o !~ /^Uses mXPUSHp/m);
324 ok($o !~ /^Needs to include.*ppport\.h/m);
325 ok($o !~ /^Looks good/m);
326 ok($o =~ /^1 potentially required change detected/m);
328 $o = ppport(qw(--nochanges --quiet file2.xs));
331 ---------------------------- file1.xs -----------------------------------------
333 #define NEED_newCONSTSUB
334 #define NEED_sv_2pv_nolen
340 ---------------------------- file2.xs -----------------------------------------
344 ===============================================================================
346 my $o = ppport(qw(--nochanges));
347 ok($o =~ /^Scanning.*FooBar\.xs/mi);
348 ok($o =~ /Analyzing.*FooBar\.xs/mi);
349 ok(matches($o, '^Scanning', 'm'), 1);
350 ok($o !~ /^Looks good/m);
351 ok($o =~ /^Uses grok_bin/m);
353 ---------------------------- FooBar.xs ----------------------------------------
359 ===============================================================================
361 my $o = ppport(qw(--nochanges));
362 ok($o =~ /^Scanning.*First\.xs/mi);
363 ok($o =~ /Analyzing.*First\.xs/mi);
364 ok($o =~ /^Scanning.*second\.h/mi);
365 ok($o =~ /Analyzing.*second\.h/mi);
366 ok($o =~ /^Scanning.*sub.*third\.c/mi);
367 ok($o =~ /Analyzing.*sub.*third\.c/mi);
368 ok($o !~ /^Scanning.*foobar/mi);
369 ok(matches($o, '^Scanning', 'm'), 3);
371 ---------------------------- First.xs -----------------------------------------
375 ---------------------------- foobar.xyz ---------------------------------------
379 ---------------------------- second.h -----------------------------------------
383 ---------------------------- sub/third.c --------------------------------------
387 ===============================================================================
389 my $o = ppport(qw(--nochanges));
390 ok($o =~ /Possibly wrong #define NEED_foobar in.*test.xs/i);
392 ---------------------------- test.xs ------------------------------------------
396 ===============================================================================
398 # And now some complex "real-world" example
400 my $o = ppport(qw(--copy=f));
401 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c mod5.c)) {
402 ok($o =~ /^Scanning.*\Q$_\E/mi);
403 ok($o =~ /Analyzing.*\Q$_\E/i);
405 ok(matches($o, '^Scanning', 'm'), 6);
407 ok(matches($o, '^Writing copy of', 'm'), 5);
410 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c)) {
411 ok($o =~ /^Writing copy of.*\Q$_\E.*with changes/mi);
413 ok(eq_files("${_}f", "${_}r"));
417 ---------------------------- main.xs ------------------------------------------
423 #define NEED_newCONSTSUB
424 #define NEED_grok_hex_GLOBAL
429 Perl_grok_bin(aTHX_ foo, bar);
435 Perl_grok_bin(bar, sv_no);
437 ---------------------------- mod1.c -------------------------------------------
443 #define NEED_grok_bin_GLOBAL
444 #define NEED_newCONSTSUB
451 Perl_sv_catpvf(); /* I know it's wrong ;-) */
454 ---------------------------- mod2.c -------------------------------------------
469 ---------------------------- mod3.c -------------------------------------------
478 ---------------------------- mod4.c -------------------------------------------
486 ---------------------------- mod5.c -------------------------------------------
495 ---------------------------- main.xsr -----------------------------------------
501 #define NEED_eval_pv_GLOBAL
502 #define NEED_grok_hex
503 #define NEED_newCONSTSUB_GLOBAL
514 grok_bin(bar, PL_sv_no);
516 ---------------------------- mod1.cr ------------------------------------------
522 #define NEED_grok_bin_GLOBAL
528 Perl_croak (aTHX_ "foo");
529 Perl_sv_catpvf(aTHX); /* I know it's wrong ;-) */
532 ---------------------------- mod2.cr ------------------------------------------
545 ---------------------------- mod3.cr ------------------------------------------
550 #define NEED_grok_oct
556 ---------------------------- mod4.cr ------------------------------------------
565 ===============================================================================
567 my $o = ppport(qw(--nochanges));
568 ok($o =~ /Uses grok_hex/m);
569 ok($o !~ /Looks good/m);
571 $o = ppport(qw(--nochanges --compat-version=5.8.0));
572 ok($o !~ /Uses grok_hex/m);
573 ok($o =~ /Looks good/m);
575 ---------------------------- FooBar.xs ----------------------------------------
579 ===============================================================================
581 my $o = ppport(qw(--nochanges));
582 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
584 $o = ppport(qw(--nochanges --compat-version=5.5.3));
585 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
587 $o = ppport(qw(--nochanges --compat-version=5.005_03));
588 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
590 $o = ppport(qw(--nochanges --compat-version=5.6.0));
591 ok($o !~ /Uses SvPVutf8_force/m);
593 $o = ppport(qw(--nochanges --compat-version=5.006));
594 ok($o !~ /Uses SvPVutf8_force/m);
596 $o = ppport(qw(--nochanges --compat-version=5.999.999));
597 ok($o !~ /Uses SvPVutf8_force/m);
599 $o = ppport(qw(--nochanges --compat-version=6.0.0));
600 ok($o =~ /Only Perl 5 is supported/m);
602 $o = ppport(qw(--nochanges --compat-version=5.1000.999));
603 ok($o =~ /Invalid version number: 5.1000.999/m);
605 $o = ppport(qw(--nochanges --compat-version=5.999.1000));
606 ok($o =~ /Invalid version number: 5.999.1000/m);
608 ---------------------------- FooBar.xs ----------------------------------------
612 ===============================================================================
614 my $o = ppport(qw(--nochanges));
615 ok($o !~ /potentially required change/);
616 ok(matches($o, '^Looks good', 'm'), 2);
618 ---------------------------- FooBar.xs ----------------------------------------
620 #define NEED_grok_numeric_radix
621 #define NEED_grok_number
624 GROK_NUMERIC_RADIX();
627 ---------------------------- foo.c --------------------------------------------
633 ===============================================================================
635 # check --api-info option
637 my $o = ppport(qw(--api-info=INT2PTR));
638 my %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
639 ok(scalar keys %found, 1);
640 ok(exists $found{INT2PTR});
641 ok(matches($o, '^Supported at least starting from perl-5\.6\.0\.', 'm'), 1);
642 ok(matches($o, '^Support by .*ppport.* provided back to perl-5\.003\.', 'm'), 1);
644 $o = ppport(qw(--api-info=Zero));
645 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
646 ok(scalar keys %found, 1);
647 ok(exists $found{Zero});
648 ok(matches($o, '^No portability information available\.', 'm'), 1);
650 $o = ppport(qw(--api-info=/Zero/));
651 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
652 ok(scalar keys %found, 2);
653 ok(exists $found{Zero});
654 ok(exists $found{ZeroD});
656 ===============================================================================
658 # check --list-provided option
660 my @o = ppport(qw(--list-provided));
664 my($name, $flags) = /^(\w+)(?:\s+\[(\w+(?:,\s+\w+)*)\])?$/ or $fail++;
665 exists $p{$name} and $fail++;
666 $p{$name} = defined $flags ? { map { ($_ => 1) } $flags =~ /(\w+)/g } : '';
671 ok(exists $p{call_sv});
672 ok(not ref $p{call_sv});
674 ok(exists $p{grok_bin});
675 ok(ref $p{grok_bin}, 'HASH');
676 ok(scalar keys %{$p{grok_bin}}, 1);
677 ok($p{grok_bin}{explicit});
679 ok(exists $p{gv_stashpvn});
680 ok(ref $p{gv_stashpvn}, 'HASH');
681 ok(scalar keys %{$p{gv_stashpvn}}, 1);
682 ok($p{gv_stashpvn}{hint});
684 ok(exists $p{sv_catpvf_mg});
685 ok(ref $p{sv_catpvf_mg}, 'HASH');
686 ok(scalar keys %{$p{sv_catpvf_mg}}, 2);
687 ok($p{sv_catpvf_mg}{explicit});
688 ok($p{sv_catpvf_mg}{depend});
690 ===============================================================================
692 # check --list-unsupported option
694 my @o = ppport(qw(--list-unsupported));
698 my($name, $ver) = /^(\w+)\s*\.+\s*([\d._]+)$/ or $fail++;
699 exists $p{$name} and $fail++;
705 ok(exists $p{utf8_distance});
706 ok($p{utf8_distance}, '5.6.0');
708 ok(exists $p{save_generic_svref});
709 ok($p{save_generic_svref}, '5.005_03');
711 ===============================================================================
713 # check --nofilter option
715 my $o = ppport(qw(--nochanges));
716 ok($o =~ /^Scanning.*foo\.cpp/mi);
717 ok($o =~ /Analyzing.*foo\.cpp/mi);
718 ok(matches($o, '^Scanning', 'm'), 1);
719 ok(matches($o, 'Analyzing', 'm'), 1);
721 $o = ppport(qw(--nochanges foo.cpp foo.o Makefile.PL));
722 ok($o =~ /Skipping the following files \(use --nofilter to avoid this\):/m);
723 ok(matches($o, '^\|\s+foo\.o', 'mi'), 1);
724 ok(matches($o, '^\|\s+Makefile\.PL', 'mi'), 1);
725 ok($o =~ /^Scanning.*foo\.cpp/mi);
726 ok($o =~ /Analyzing.*foo\.cpp/mi);
727 ok(matches($o, '^Scanning', 'm'), 1);
728 ok(matches($o, 'Analyzing', 'm'), 1);
730 $o = ppport(qw(--nochanges --nofilter foo.cpp foo.o Makefile.PL));
731 ok($o =~ /^Scanning.*foo\.cpp/mi);
732 ok($o =~ /Analyzing.*foo\.cpp/mi);
733 ok($o =~ /^Scanning.*foo\.o/mi);
734 ok($o =~ /Analyzing.*foo\.o/mi);
735 ok($o =~ /^Scanning.*Makefile/mi);
736 ok($o =~ /Analyzing.*Makefile/mi);
737 ok(matches($o, '^Scanning', 'm'), 3);
738 ok(matches($o, 'Analyzing', 'm'), 3);
740 ---------------------------- foo.cpp ------------------------------------------
744 ---------------------------- foo.o --------------------------------------------
748 ---------------------------- Makefile.PL --------------------------------------
752 ===============================================================================
754 # check if explicit variables are handled propery
756 my $o = ppport(qw(--copy=a));
757 ok($o =~ /^Needs to include.*ppport\.h/m);
758 ok($o =~ /^Uses PL_signals/m);
759 ok($o =~ /^File needs PL_signals, adding static request/m);
760 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
762 unlink qw(MyExt.xsa);
764 ---------------------------- MyExt.xs -----------------------------------------
767 if (PL_signals == 42)
770 ---------------------------- MyExt.ra -----------------------------------------
772 #define NEED_PL_signals
775 if (PL_signals == 42)