1 ################################################################################
5 ## $Date: 2005/06/24 19:03:21 +0200 $
7 ################################################################################
9 ## Version 3.x, Copyright (C) 2004-2005, 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 ################################################################################
20 use File::Path qw/rmtree mkpath/;
25 my $perl = find_perl();
26 my $isVMS = $^O eq 'VMS';
27 my $isMAC = $^O eq 'MacOS';
29 rmtree($tmp) if -d $tmp;
30 mkpath($tmp) or die "mkpath $tmp: $!\n";
31 chdir($tmp) or die "chdir $tmp: $!\n";
33 if ($ENV{'PERL_CORE'}) {
36 $inc = '"-I../../lib"';
44 unshift @INC, '../../lib';
47 if ($perl =~ m!^\./!) {
52 chdir('..') if !-d $tmp && -d "../$tmp";
53 rmtree($tmp) if -d $tmp;
56 ok(&Devel::PPPort::WriteFile("ppport.h"));
62 $c .= "\n" unless $c =~ /[\r\n]$/;
68 my @args = ('ppport.h', @_);
69 unshift @args, $inc if $inc;
70 my $run = $perl =~ m/\s/ ? qq("$perl") : $perl;
71 $run .= ' -MMac::err=unix' if $isMAC;
73 $_ = qq("$_") if $isVMS && /^[^"]/;
76 print "# *** running $run ***\n";
77 $run .= ' 2>&1' unless $isMAC;
79 my $out = join '', @out;
81 return wantarray ? @out : $out;
86 my($str, $re, $mod) = @_;
88 eval "\@n = \$str =~ /$re/g$mod;";
91 $err =~ s/^/# *** /mg;
92 print "# *** ERROR ***\n$err\n";
94 return $@ ? -42 : scalar @n;
100 return 0 unless -e $f1 && -e $f2;
103 print "# File: $_\n";
104 unless (open F, $_) {
105 print "# couldn't open $_: $!\n";
108 $_ = do { local $/; <F> };
117 for (split /\s*={70,}\s*/, do { local $/; <DATA> }) {
120 ($c, @f{m/-{20,}\s+(\S+)\s+-{20,}/g}) = split /\s*-{20,}\s+\S+\s+-{20,}\s*/;
121 push @tests, { code => $c, files => \%f };
127 for $f (keys %{$t->{files}}) {
128 my @f = split /\//, $f;
131 my $path = join '/', @f;
132 mkpath($path) or die "mkpath('$path'): $!\n";
134 my $txt = $t->{files}{$f};
136 open F, ">$f" or die "open $f: $!\n";
140 print "# *** writing $f ***\n$txt\n";
146 $err =~ s/^/# *** /mg;
147 print "# *** ERROR ***\n$err\n";
151 for (keys %{$t->{files}}) {
152 unlink $_ or die "unlink('$_'): $!\n";
160 return $perl if $isVMS;
162 my $exe = $Config{'_exe'} || '';
164 if ($perl =~ /^perl\Q$exe\E$/i) {
166 eval "require File::Spec";
170 $perl = File::Spec->catfile(File::Spec->curdir(), $perl);
174 if ($perl !~ /\Q$exe\E$/i) {
178 warn "find_perl: cannot find $perl from $^X" unless -f $perl;
185 my $o = ppport(qw(--help));
186 ok($o =~ /^Usage:.*ppport\.h/m);
189 $o = ppport(qw(--nochanges));
190 ok($o =~ /^Scanning.*test\.xs/mi);
191 ok($o =~ /Analyzing.*test\.xs/mi);
192 ok(matches($o, '^Scanning', 'm'), 1);
193 ok(matches($o, 'Analyzing', 'm'), 1);
194 ok($o =~ /Uses Perl_newSViv instead of newSViv/);
196 $o = ppport(qw(--quiet --nochanges));
199 ---------------------------- test.xs ------------------------------------------
203 ===============================================================================
205 # check if C and C++ comments are filtered correctly
207 my $o = ppport(qw(--copy=a));
208 ok($o =~ /^Scanning.*MyExt\.xs/mi);
209 ok($o =~ /Analyzing.*MyExt\.xs/mi);
210 ok(matches($o, '^Scanning', 'm'), 1);
211 ok($o =~ /^Needs to include.*ppport\.h/m);
212 ok($o !~ /^Uses grok_bin/m);
213 ok($o !~ /^Uses newSVpv/m);
214 ok($o =~ /Uses 1 C\+\+ style comment/m);
215 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
217 # check if C++ are left untouched with --cplusplus
219 $o = ppport(qw(--copy=b --cplusplus));
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 \d+ C\+\+ style comment/m);
227 ok(eq_files('MyExt.xsb', 'MyExt.rb'));
229 unlink qw(MyExt.xsa MyExt.xsb);
231 ---------------------------- MyExt.xs -----------------------------------------
238 ---------------------------- MyExt.ra -----------------------------------------
246 ---------------------------- MyExt.rb -----------------------------------------
254 ===============================================================================
256 my $o = ppport(qw(--nochanges file1.xs));
257 ok($o =~ /^Scanning.*file1\.xs/mi);
258 ok($o =~ /Analyzing.*file1\.xs/mi);
259 ok($o !~ /^Scanning.*file2\.xs/mi);
260 ok($o =~ /^Uses newCONSTSUB/m);
261 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
262 ok($o =~ /hint for newCONSTSUB/m);
263 ok($o !~ /hint for sv_2pv_nolen/m);
264 ok($o =~ /^Looks good/m);
266 $o = ppport(qw(--nochanges --nohints file1.xs));
267 ok($o =~ /^Scanning.*file1\.xs/mi);
268 ok($o =~ /Analyzing.*file1\.xs/mi);
269 ok($o !~ /^Scanning.*file2\.xs/mi);
270 ok($o =~ /^Uses newCONSTSUB/m);
271 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
272 ok($o !~ /hint for newCONSTSUB/m);
273 ok($o !~ /hint for sv_2pv_nolen/m);
274 ok($o =~ /^Looks good/m);
276 $o = ppport(qw(--nochanges --nohints --nodiag file1.xs));
277 ok($o =~ /^Scanning.*file1\.xs/mi);
278 ok($o =~ /Analyzing.*file1\.xs/mi);
279 ok($o !~ /^Scanning.*file2\.xs/mi);
280 ok($o !~ /^Uses newCONSTSUB/m);
281 ok($o !~ /^Uses SvPV_nolen/m);
282 ok($o !~ /hint for newCONSTSUB/m);
283 ok($o !~ /hint for sv_2pv_nolen/m);
284 ok($o =~ /^Looks good/m);
286 $o = ppport(qw(--nochanges --quiet file1.xs));
289 $o = ppport(qw(--nochanges file2.xs));
290 ok($o =~ /^Scanning.*file2\.xs/mi);
291 ok($o =~ /Analyzing.*file2\.xs/mi);
292 ok($o !~ /^Scanning.*file1\.xs/mi);
293 ok($o =~ /^Uses mXPUSHp/m);
294 ok($o =~ /^Needs to include.*ppport\.h/m);
295 ok($o !~ /^Looks good/m);
296 ok($o =~ /^1 potentially required change detected/m);
298 $o = ppport(qw(--nochanges --nohints 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 --nodiag 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 --quiet file2.xs));
319 ---------------------------- file1.xs -----------------------------------------
321 #define NEED_newCONSTSUB
322 #define NEED_sv_2pv_nolen
328 ---------------------------- file2.xs -----------------------------------------
332 ===============================================================================
334 my $o = ppport(qw(--nochanges));
335 ok($o =~ /^Scanning.*FooBar\.xs/mi);
336 ok($o =~ /Analyzing.*FooBar\.xs/mi);
337 ok(matches($o, '^Scanning', 'm'), 1);
338 ok($o !~ /^Looks good/m);
339 ok($o =~ /^Uses grok_bin/m);
341 ---------------------------- FooBar.xs ----------------------------------------
347 ===============================================================================
349 my $o = ppport(qw(--nochanges));
350 ok($o =~ /^Scanning.*First\.xs/mi);
351 ok($o =~ /Analyzing.*First\.xs/mi);
352 ok($o =~ /^Scanning.*second\.h/mi);
353 ok($o =~ /Analyzing.*second\.h/mi);
354 ok($o =~ /^Scanning.*sub.*third\.c/mi);
355 ok($o =~ /Analyzing.*sub.*third\.c/mi);
356 ok($o !~ /^Scanning.*foobar/mi);
357 ok(matches($o, '^Scanning', 'm'), 3);
359 ---------------------------- First.xs -----------------------------------------
363 ---------------------------- foobar.xyz ---------------------------------------
367 ---------------------------- second.h -----------------------------------------
371 ---------------------------- sub/third.c --------------------------------------
375 ===============================================================================
377 my $o = ppport(qw(--nochanges));
378 ok($o =~ /Possibly wrong #define NEED_foobar in.*test.xs/i);
380 ---------------------------- test.xs ------------------------------------------
384 ===============================================================================
386 # And now some complex "real-world" example
388 my $o = ppport(qw(--copy=f));
389 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c mod5.c)) {
390 ok($o =~ /^Scanning.*\Q$_\E/mi);
391 ok($o =~ /Analyzing.*\Q$_\E/i);
393 ok(matches($o, '^Scanning', 'm'), 6);
395 ok(matches($o, '^Writing copy of', 'm'), 5);
398 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c)) {
399 ok($o =~ /^Writing copy of.*\Q$_\E.*with changes/mi);
401 ok(eq_files("${_}f", "${_}r"));
405 ---------------------------- main.xs ------------------------------------------
411 #define NEED_newCONSTSUB
412 #define NEED_grok_hex_GLOBAL
417 Perl_grok_bin(aTHX_ foo, bar);
423 Perl_grok_bin(bar, sv_no);
425 ---------------------------- mod1.c -------------------------------------------
431 #define NEED_grok_bin_GLOBAL
432 #define NEED_newCONSTSUB
439 Perl_sv_catpvf(); /* I know it's wrong ;-) */
442 ---------------------------- mod2.c -------------------------------------------
457 ---------------------------- mod3.c -------------------------------------------
466 ---------------------------- mod4.c -------------------------------------------
474 ---------------------------- mod5.c -------------------------------------------
483 ---------------------------- main.xsr -----------------------------------------
489 #define NEED_eval_pv_GLOBAL
490 #define NEED_grok_hex
491 #define NEED_newCONSTSUB_GLOBAL
502 grok_bin(bar, PL_sv_no);
504 ---------------------------- mod1.cr ------------------------------------------
510 #define NEED_grok_bin_GLOBAL
516 Perl_croak (aTHX_ "foo");
517 Perl_sv_catpvf(aTHX); /* I know it's wrong ;-) */
520 ---------------------------- mod2.cr ------------------------------------------
533 ---------------------------- mod3.cr ------------------------------------------
538 #define NEED_grok_oct
544 ---------------------------- mod4.cr ------------------------------------------
553 ===============================================================================
555 my $o = ppport(qw(--nochanges));
556 ok($o =~ /Uses grok_hex/m);
557 ok($o !~ /Looks good/m);
559 $o = ppport(qw(--nochanges --compat-version=5.8.0));
560 ok($o !~ /Uses grok_hex/m);
561 ok($o =~ /Looks good/m);
563 ---------------------------- FooBar.xs ----------------------------------------
567 ===============================================================================
569 my $o = ppport(qw(--nochanges));
570 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
572 $o = ppport(qw(--nochanges --compat-version=5.5.3));
573 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
575 $o = ppport(qw(--nochanges --compat-version=5.005_03));
576 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
578 $o = ppport(qw(--nochanges --compat-version=5.6.0));
579 ok($o !~ /Uses SvPVutf8_force/m);
581 $o = ppport(qw(--nochanges --compat-version=5.006));
582 ok($o !~ /Uses SvPVutf8_force/m);
584 $o = ppport(qw(--nochanges --compat-version=5.999.999));
585 ok($o !~ /Uses SvPVutf8_force/m);
587 $o = ppport(qw(--nochanges --compat-version=6.0.0));
588 ok($o =~ /Only Perl 5 is supported/m);
590 $o = ppport(qw(--nochanges --compat-version=5.1000.999));
591 ok($o =~ /Invalid version number: 5.1000.999/m);
593 $o = ppport(qw(--nochanges --compat-version=5.999.1000));
594 ok($o =~ /Invalid version number: 5.999.1000/m);
596 ---------------------------- FooBar.xs ----------------------------------------
600 ===============================================================================
602 my $o = ppport(qw(--nochanges));
603 ok($o !~ /potentially required change/);
604 ok(matches($o, '^Looks good', 'm'), 2);
606 ---------------------------- FooBar.xs ----------------------------------------
608 #define NEED_grok_numeric_radix
609 #define NEED_grok_number
612 GROK_NUMERIC_RADIX();
615 ---------------------------- foo.c --------------------------------------------
621 ===============================================================================
623 # check --api-info option
625 my $o = ppport(qw(--api-info=INT2PTR));
626 my %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
627 ok(scalar keys %found, 1);
628 ok(exists $found{INT2PTR});
629 ok(matches($o, '^Supported at least starting from perl-5\.6\.0\.', 'm'), 1);
630 ok(matches($o, '^Support by .*ppport.* provided back to perl-5\.003\.', 'm'), 1);
632 $o = ppport(qw(--api-info=Zero));
633 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
634 ok(scalar keys %found, 1);
635 ok(exists $found{Zero});
636 ok(matches($o, '^No portability information available\.', 'm'), 1);
638 $o = ppport(qw(--api-info=/Zero/));
639 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
640 ok(scalar keys %found, 2);
641 ok(exists $found{Zero});
642 ok(exists $found{ZeroD});
644 ===============================================================================
646 # check --list-provided option
648 my @o = ppport(qw(--list-provided));
652 my($name, $flags) = /^(\w+)(?:\s+\[(\w+(?:,\s+\w+)*)\])?$/ or $fail++;
653 exists $p{$name} and $fail++;
654 $p{$name} = defined $flags ? { map { ($_ => 1) } $flags =~ /(\w+)/g } : '';
659 ok(exists $p{call_sv});
660 ok(not ref $p{call_sv});
662 ok(exists $p{grok_bin});
663 ok(ref $p{grok_bin}, 'HASH');
664 ok(scalar keys %{$p{grok_bin}}, 1);
665 ok($p{grok_bin}{explicit});
667 ok(exists $p{gv_stashpvn});
668 ok(ref $p{gv_stashpvn}, 'HASH');
669 ok(scalar keys %{$p{gv_stashpvn}}, 1);
670 ok($p{gv_stashpvn}{hint});
672 ok(exists $p{sv_catpvf_mg});
673 ok(ref $p{sv_catpvf_mg}, 'HASH');
674 ok(scalar keys %{$p{sv_catpvf_mg}}, 2);
675 ok($p{sv_catpvf_mg}{explicit});
676 ok($p{sv_catpvf_mg}{depend});
678 ===============================================================================
680 # check --list-unsupported option
682 my @o = ppport(qw(--list-unsupported));
686 my($name, $ver) = /^(\w+)\s*\.+\s*([\d._]+)$/ or $fail++;
687 exists $p{$name} and $fail++;
693 ok(exists $p{utf8_distance});
694 ok($p{utf8_distance}, '5.6.0');
696 ok(exists $p{save_generic_svref});
697 ok($p{save_generic_svref}, '5.005_03');
699 ===============================================================================
701 # check --nofilter option
703 my $o = ppport(qw(--nochanges));
704 ok($o =~ /^Scanning.*foo\.cpp/mi);
705 ok($o =~ /Analyzing.*foo\.cpp/mi);
706 ok(matches($o, '^Scanning', 'm'), 1);
707 ok(matches($o, 'Analyzing', 'm'), 1);
709 $o = ppport(qw(--nochanges foo.cpp foo.o Makefile.PL));
710 ok($o =~ /Skipping the following files \(use --nofilter to avoid this\):/m);
711 ok(matches($o, '^\|\s+foo\.o', 'mi'), 1);
712 ok(matches($o, '^\|\s+Makefile\.PL', 'mi'), 1);
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 --nofilter foo.cpp foo.o Makefile.PL));
719 ok($o =~ /^Scanning.*foo\.cpp/mi);
720 ok($o =~ /Analyzing.*foo\.cpp/mi);
721 ok($o =~ /^Scanning.*foo\.o/mi);
722 ok($o =~ /Analyzing.*foo\.o/mi);
723 ok($o =~ /^Scanning.*Makefile/mi);
724 ok($o =~ /Analyzing.*Makefile/mi);
725 ok(matches($o, '^Scanning', 'm'), 3);
726 ok(matches($o, 'Analyzing', 'm'), 3);
728 ---------------------------- foo.cpp ------------------------------------------
732 ---------------------------- foo.o --------------------------------------------
736 ---------------------------- Makefile.PL --------------------------------------