1 ################################################################################
5 ## $Date: 2006/05/24 09:25:00 +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(--nochanges));
199 ok($o =~ /^Scanning.*test\.xs/mi);
200 ok($o =~ /Analyzing.*test\.xs/mi);
201 ok(matches($o, '^Scanning', 'm'), 1);
202 ok(matches($o, 'Analyzing', 'm'), 1);
203 ok($o =~ /Uses Perl_newSViv instead of newSViv/);
205 $o = ppport(qw(--quiet --nochanges));
208 ---------------------------- test.xs ------------------------------------------
212 ===============================================================================
214 # check if C and C++ comments are filtered correctly
216 my $o = ppport(qw(--copy=a));
217 ok($o =~ /^Scanning.*MyExt\.xs/mi);
218 ok($o =~ /Analyzing.*MyExt\.xs/mi);
219 ok(matches($o, '^Scanning', 'm'), 1);
220 ok($o =~ /^Needs to include.*ppport\.h/m);
221 ok($o !~ /^Uses grok_bin/m);
222 ok($o !~ /^Uses newSVpv/m);
223 ok($o =~ /Uses 1 C\+\+ style comment/m);
224 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
226 # check if C++ are left untouched with --cplusplus
228 $o = ppport(qw(--copy=b --cplusplus));
229 ok($o =~ /^Scanning.*MyExt\.xs/mi);
230 ok($o =~ /Analyzing.*MyExt\.xs/mi);
231 ok(matches($o, '^Scanning', 'm'), 1);
232 ok($o =~ /^Needs to include.*ppport\.h/m);
233 ok($o !~ /^Uses grok_bin/m);
234 ok($o !~ /^Uses newSVpv/m);
235 ok($o !~ /Uses \d+ C\+\+ style comment/m);
236 ok(eq_files('MyExt.xsb', 'MyExt.rb'));
238 unlink qw(MyExt.xsa MyExt.xsb);
240 ---------------------------- MyExt.xs -----------------------------------------
247 ---------------------------- MyExt.ra -----------------------------------------
255 ---------------------------- MyExt.rb -----------------------------------------
263 ===============================================================================
265 my $o = ppport(qw(--nochanges file1.xs));
266 ok($o =~ /^Scanning.*file1\.xs/mi);
267 ok($o =~ /Analyzing.*file1\.xs/mi);
268 ok($o !~ /^Scanning.*file2\.xs/mi);
269 ok($o =~ /^Uses newCONSTSUB/m);
270 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
271 ok($o =~ /hint for newCONSTSUB/m);
272 ok($o !~ /hint for sv_2pv_nolen/m);
273 ok($o =~ /^Looks good/m);
275 $o = ppport(qw(--nochanges --nohints file1.xs));
276 ok($o =~ /^Scanning.*file1\.xs/mi);
277 ok($o =~ /Analyzing.*file1\.xs/mi);
278 ok($o !~ /^Scanning.*file2\.xs/mi);
279 ok($o =~ /^Uses newCONSTSUB/m);
280 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
281 ok($o !~ /hint for newCONSTSUB/m);
282 ok($o !~ /hint for sv_2pv_nolen/m);
283 ok($o =~ /^Looks good/m);
285 $o = ppport(qw(--nochanges --nohints --nodiag file1.xs));
286 ok($o =~ /^Scanning.*file1\.xs/mi);
287 ok($o =~ /Analyzing.*file1\.xs/mi);
288 ok($o !~ /^Scanning.*file2\.xs/mi);
289 ok($o !~ /^Uses newCONSTSUB/m);
290 ok($o !~ /^Uses SvPV_nolen/m);
291 ok($o !~ /hint for newCONSTSUB/m);
292 ok($o !~ /hint for sv_2pv_nolen/m);
293 ok($o =~ /^Looks good/m);
295 $o = ppport(qw(--nochanges --quiet file1.xs));
298 $o = ppport(qw(--nochanges file2.xs));
299 ok($o =~ /^Scanning.*file2\.xs/mi);
300 ok($o =~ /Analyzing.*file2\.xs/mi);
301 ok($o !~ /^Scanning.*file1\.xs/mi);
302 ok($o =~ /^Uses mXPUSHp/m);
303 ok($o =~ /^Needs to include.*ppport\.h/m);
304 ok($o !~ /^Looks good/m);
305 ok($o =~ /^1 potentially required change detected/m);
307 $o = ppport(qw(--nochanges --nohints file2.xs));
308 ok($o =~ /^Scanning.*file2\.xs/mi);
309 ok($o =~ /Analyzing.*file2\.xs/mi);
310 ok($o !~ /^Scanning.*file1\.xs/mi);
311 ok($o =~ /^Uses mXPUSHp/m);
312 ok($o =~ /^Needs to include.*ppport\.h/m);
313 ok($o !~ /^Looks good/m);
314 ok($o =~ /^1 potentially required change detected/m);
316 $o = ppport(qw(--nochanges --nohints --nodiag 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 --quiet file2.xs));
328 ---------------------------- file1.xs -----------------------------------------
330 #define NEED_newCONSTSUB
331 #define NEED_sv_2pv_nolen
337 ---------------------------- file2.xs -----------------------------------------
341 ===============================================================================
343 my $o = ppport(qw(--nochanges));
344 ok($o =~ /^Scanning.*FooBar\.xs/mi);
345 ok($o =~ /Analyzing.*FooBar\.xs/mi);
346 ok(matches($o, '^Scanning', 'm'), 1);
347 ok($o !~ /^Looks good/m);
348 ok($o =~ /^Uses grok_bin/m);
350 ---------------------------- FooBar.xs ----------------------------------------
356 ===============================================================================
358 my $o = ppport(qw(--nochanges));
359 ok($o =~ /^Scanning.*First\.xs/mi);
360 ok($o =~ /Analyzing.*First\.xs/mi);
361 ok($o =~ /^Scanning.*second\.h/mi);
362 ok($o =~ /Analyzing.*second\.h/mi);
363 ok($o =~ /^Scanning.*sub.*third\.c/mi);
364 ok($o =~ /Analyzing.*sub.*third\.c/mi);
365 ok($o !~ /^Scanning.*foobar/mi);
366 ok(matches($o, '^Scanning', 'm'), 3);
368 ---------------------------- First.xs -----------------------------------------
372 ---------------------------- foobar.xyz ---------------------------------------
376 ---------------------------- second.h -----------------------------------------
380 ---------------------------- sub/third.c --------------------------------------
384 ===============================================================================
386 my $o = ppport(qw(--nochanges));
387 ok($o =~ /Possibly wrong #define NEED_foobar in.*test.xs/i);
389 ---------------------------- test.xs ------------------------------------------
393 ===============================================================================
395 # And now some complex "real-world" example
397 my $o = ppport(qw(--copy=f));
398 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c mod5.c)) {
399 ok($o =~ /^Scanning.*\Q$_\E/mi);
400 ok($o =~ /Analyzing.*\Q$_\E/i);
402 ok(matches($o, '^Scanning', 'm'), 6);
404 ok(matches($o, '^Writing copy of', 'm'), 5);
407 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c)) {
408 ok($o =~ /^Writing copy of.*\Q$_\E.*with changes/mi);
410 ok(eq_files("${_}f", "${_}r"));
414 ---------------------------- main.xs ------------------------------------------
420 #define NEED_newCONSTSUB
421 #define NEED_grok_hex_GLOBAL
426 Perl_grok_bin(aTHX_ foo, bar);
432 Perl_grok_bin(bar, sv_no);
434 ---------------------------- mod1.c -------------------------------------------
440 #define NEED_grok_bin_GLOBAL
441 #define NEED_newCONSTSUB
448 Perl_sv_catpvf(); /* I know it's wrong ;-) */
451 ---------------------------- mod2.c -------------------------------------------
466 ---------------------------- mod3.c -------------------------------------------
475 ---------------------------- mod4.c -------------------------------------------
483 ---------------------------- mod5.c -------------------------------------------
492 ---------------------------- main.xsr -----------------------------------------
498 #define NEED_eval_pv_GLOBAL
499 #define NEED_grok_hex
500 #define NEED_newCONSTSUB_GLOBAL
511 grok_bin(bar, PL_sv_no);
513 ---------------------------- mod1.cr ------------------------------------------
519 #define NEED_grok_bin_GLOBAL
525 Perl_croak (aTHX_ "foo");
526 Perl_sv_catpvf(aTHX); /* I know it's wrong ;-) */
529 ---------------------------- mod2.cr ------------------------------------------
542 ---------------------------- mod3.cr ------------------------------------------
547 #define NEED_grok_oct
553 ---------------------------- mod4.cr ------------------------------------------
562 ===============================================================================
564 my $o = ppport(qw(--nochanges));
565 ok($o =~ /Uses grok_hex/m);
566 ok($o !~ /Looks good/m);
568 $o = ppport(qw(--nochanges --compat-version=5.8.0));
569 ok($o !~ /Uses grok_hex/m);
570 ok($o =~ /Looks good/m);
572 ---------------------------- FooBar.xs ----------------------------------------
576 ===============================================================================
578 my $o = ppport(qw(--nochanges));
579 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
581 $o = ppport(qw(--nochanges --compat-version=5.5.3));
582 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
584 $o = ppport(qw(--nochanges --compat-version=5.005_03));
585 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
587 $o = ppport(qw(--nochanges --compat-version=5.6.0));
588 ok($o !~ /Uses SvPVutf8_force/m);
590 $o = ppport(qw(--nochanges --compat-version=5.006));
591 ok($o !~ /Uses SvPVutf8_force/m);
593 $o = ppport(qw(--nochanges --compat-version=5.999.999));
594 ok($o !~ /Uses SvPVutf8_force/m);
596 $o = ppport(qw(--nochanges --compat-version=6.0.0));
597 ok($o =~ /Only Perl 5 is supported/m);
599 $o = ppport(qw(--nochanges --compat-version=5.1000.999));
600 ok($o =~ /Invalid version number: 5.1000.999/m);
602 $o = ppport(qw(--nochanges --compat-version=5.999.1000));
603 ok($o =~ /Invalid version number: 5.999.1000/m);
605 ---------------------------- FooBar.xs ----------------------------------------
609 ===============================================================================
611 my $o = ppport(qw(--nochanges));
612 ok($o !~ /potentially required change/);
613 ok(matches($o, '^Looks good', 'm'), 2);
615 ---------------------------- FooBar.xs ----------------------------------------
617 #define NEED_grok_numeric_radix
618 #define NEED_grok_number
621 GROK_NUMERIC_RADIX();
624 ---------------------------- foo.c --------------------------------------------
630 ===============================================================================
632 # check --api-info option
634 my $o = ppport(qw(--api-info=INT2PTR));
635 my %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
636 ok(scalar keys %found, 1);
637 ok(exists $found{INT2PTR});
638 ok(matches($o, '^Supported at least starting from perl-5\.6\.0\.', 'm'), 1);
639 ok(matches($o, '^Support by .*ppport.* provided back to perl-5\.003\.', 'm'), 1);
641 $o = ppport(qw(--api-info=Zero));
642 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
643 ok(scalar keys %found, 1);
644 ok(exists $found{Zero});
645 ok(matches($o, '^No portability information available\.', 'm'), 1);
647 $o = ppport(qw(--api-info=/Zero/));
648 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
649 ok(scalar keys %found, 2);
650 ok(exists $found{Zero});
651 ok(exists $found{ZeroD});
653 ===============================================================================
655 # check --list-provided option
657 my @o = ppport(qw(--list-provided));
661 my($name, $flags) = /^(\w+)(?:\s+\[(\w+(?:,\s+\w+)*)\])?$/ or $fail++;
662 exists $p{$name} and $fail++;
663 $p{$name} = defined $flags ? { map { ($_ => 1) } $flags =~ /(\w+)/g } : '';
668 ok(exists $p{call_sv});
669 ok(not ref $p{call_sv});
671 ok(exists $p{grok_bin});
672 ok(ref $p{grok_bin}, 'HASH');
673 ok(scalar keys %{$p{grok_bin}}, 1);
674 ok($p{grok_bin}{explicit});
676 ok(exists $p{gv_stashpvn});
677 ok(ref $p{gv_stashpvn}, 'HASH');
678 ok(scalar keys %{$p{gv_stashpvn}}, 1);
679 ok($p{gv_stashpvn}{hint});
681 ok(exists $p{sv_catpvf_mg});
682 ok(ref $p{sv_catpvf_mg}, 'HASH');
683 ok(scalar keys %{$p{sv_catpvf_mg}}, 2);
684 ok($p{sv_catpvf_mg}{explicit});
685 ok($p{sv_catpvf_mg}{depend});
687 ===============================================================================
689 # check --list-unsupported option
691 my @o = ppport(qw(--list-unsupported));
695 my($name, $ver) = /^(\w+)\s*\.+\s*([\d._]+)$/ or $fail++;
696 exists $p{$name} and $fail++;
702 ok(exists $p{utf8_distance});
703 ok($p{utf8_distance}, '5.6.0');
705 ok(exists $p{save_generic_svref});
706 ok($p{save_generic_svref}, '5.005_03');
708 ===============================================================================
710 # check --nofilter option
712 my $o = ppport(qw(--nochanges));
713 ok($o =~ /^Scanning.*foo\.cpp/mi);
714 ok($o =~ /Analyzing.*foo\.cpp/mi);
715 ok(matches($o, '^Scanning', 'm'), 1);
716 ok(matches($o, 'Analyzing', 'm'), 1);
718 $o = ppport(qw(--nochanges foo.cpp foo.o Makefile.PL));
719 ok($o =~ /Skipping the following files \(use --nofilter to avoid this\):/m);
720 ok(matches($o, '^\|\s+foo\.o', 'mi'), 1);
721 ok(matches($o, '^\|\s+Makefile\.PL', 'mi'), 1);
722 ok($o =~ /^Scanning.*foo\.cpp/mi);
723 ok($o =~ /Analyzing.*foo\.cpp/mi);
724 ok(matches($o, '^Scanning', 'm'), 1);
725 ok(matches($o, 'Analyzing', 'm'), 1);
727 $o = ppport(qw(--nochanges --nofilter foo.cpp foo.o Makefile.PL));
728 ok($o =~ /^Scanning.*foo\.cpp/mi);
729 ok($o =~ /Analyzing.*foo\.cpp/mi);
730 ok($o =~ /^Scanning.*foo\.o/mi);
731 ok($o =~ /Analyzing.*foo\.o/mi);
732 ok($o =~ /^Scanning.*Makefile/mi);
733 ok($o =~ /Analyzing.*Makefile/mi);
734 ok(matches($o, '^Scanning', 'm'), 3);
735 ok(matches($o, 'Analyzing', 'm'), 3);
737 ---------------------------- foo.cpp ------------------------------------------
741 ---------------------------- foo.o --------------------------------------------
745 ---------------------------- Makefile.PL --------------------------------------
749 ===============================================================================
751 # check if explicit variables are handled propery
753 my $o = ppport(qw(--copy=a));
754 ok($o =~ /^Needs to include.*ppport\.h/m);
755 ok($o =~ /^Uses PL_signals/m);
756 ok($o =~ /^File needs PL_signals, adding static request/m);
757 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
759 unlink qw(MyExt.xsa);
761 ---------------------------- MyExt.xs -----------------------------------------
764 if (PL_signals == 42)
767 ---------------------------- MyExt.ra -----------------------------------------
769 #define NEED_PL_signals
772 if (PL_signals == 42)