1 ################################################################################
3 # !!!!! Do NOT edit this file directly! !!!!!
5 # Edit mktests.PL and/or parts/inc/ppphtest instead.
7 ################################################################################
10 if ($ENV{'PERL_CORE'}) {
12 @INC = ('../lib', '../ext/Devel/PPPort/t') if -d '../lib' && -d '../ext';
13 require Config; import Config;
15 if (" $Config{'extensions'} " !~ m[ Devel/PPPort ]) {
16 print "1..0 # Skip -- Perl configured without Devel::PPPort module\n";
26 require 'testutil.pl';
39 if ($ENV{'SKIP_PPPHTEST'}) {
47 use File::Path qw/rmtree mkpath/;
52 my $perl = find_perl();
53 my $isVMS = $^O eq 'VMS';
54 my $isMAC = $^O eq 'MacOS';
56 rmtree($tmp) if -d $tmp;
57 mkpath($tmp) or die "mkpath $tmp: $!\n";
58 chdir($tmp) or die "chdir $tmp: $!\n";
60 if ($ENV{'PERL_CORE'}) {
63 $inc = '"-I../../lib"';
71 unshift @INC, '../../lib';
74 if ($perl =~ m!^\./!) {
79 chdir('..') if !-d $tmp && -d "../$tmp";
80 rmtree($tmp) if -d $tmp;
83 ok(&Devel::PPPort::WriteFile("ppport.h"));
89 $c .= "\n" unless $c =~ /[\r\n]$/;
95 my @args = ('ppport.h', @_);
96 unshift @args, $inc if $inc;
97 my $run = $perl =~ m/\s/ ? qq("$perl") : $perl;
98 $run .= ' -MMac::err=unix' if $isMAC;
100 $_ = qq("$_") if $isVMS && /^[^"]/;
103 print "# *** running $run ***\n";
104 $run .= ' 2>&1' unless $isMAC;
106 my $out = join '', @out;
108 return wantarray ? @out : $out;
113 my($str, $re, $mod) = @_;
115 eval "\@n = \$str =~ /$re/g$mod;";
118 $err =~ s/^/# *** /mg;
119 print "# *** ERROR ***\n$err\n";
121 return $@ ? -42 : scalar @n;
127 return 0 unless -e $f1 && -e $f2;
130 print "# File: $_\n";
131 unless (open F, $_) {
132 print "# couldn't open $_: $!\n";
135 $_ = do { local $/; <F> };
144 for (split /\s*={70,}\s*/, do { local $/; <DATA> }) {
147 ($c, @f{m/-{20,}\s+(\S+)\s+-{20,}/g}) = split /\s*-{20,}\s+\S+\s+-{20,}\s*/;
148 push @tests, { code => $c, files => \%f };
154 for $f (keys %{$t->{files}}) {
155 my @f = split /\//, $f;
158 my $path = join '/', @f;
159 mkpath($path) or die "mkpath('$path'): $!\n";
161 my $txt = $t->{files}{$f};
163 open F, ">$f" or die "open $f: $!\n";
167 print "# *** writing $f ***\n$txt\n";
173 $err =~ s/^/# *** /mg;
174 print "# *** ERROR ***\n$err\n";
178 for (keys %{$t->{files}}) {
179 unlink $_ or die "unlink('$_'): $!\n";
187 return $perl if $isVMS;
189 my $exe = $Config{'_exe'} || '';
191 if ($perl =~ /^perl\Q$exe\E$/i) {
193 eval "require File::Spec";
197 $perl = File::Spec->catfile(File::Spec->curdir(), $perl);
201 if ($perl !~ /\Q$exe\E$/i) {
205 warn "find_perl: cannot find $perl from $^X" unless -f $perl;
212 my $o = ppport(qw(--help));
213 ok($o =~ /^Usage:.*ppport\.h/m);
216 $o = ppport(qw(--nochanges));
217 ok($o =~ /^Scanning.*test\.xs/mi);
218 ok($o =~ /Analyzing.*test\.xs/mi);
219 ok(matches($o, '^Scanning', 'm'), 1);
220 ok(matches($o, 'Analyzing', 'm'), 1);
221 ok($o =~ /Uses Perl_newSViv instead of newSViv/);
223 $o = ppport(qw(--quiet --nochanges));
226 ---------------------------- test.xs ------------------------------------------
230 ===============================================================================
232 # check if C and C++ comments are filtered correctly
234 my $o = ppport(qw(--copy=a));
235 ok($o =~ /^Scanning.*MyExt\.xs/mi);
236 ok($o =~ /Analyzing.*MyExt\.xs/mi);
237 ok(matches($o, '^Scanning', 'm'), 1);
238 ok($o =~ /^Needs to include.*ppport\.h/m);
239 ok($o !~ /^Uses grok_bin/m);
240 ok($o !~ /^Uses newSVpv/m);
241 ok($o =~ /Uses 1 C\+\+ style comment/m);
242 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
244 # check if C++ are left untouched with --cplusplus
246 $o = ppport(qw(--copy=b --cplusplus));
247 ok($o =~ /^Scanning.*MyExt\.xs/mi);
248 ok($o =~ /Analyzing.*MyExt\.xs/mi);
249 ok(matches($o, '^Scanning', 'm'), 1);
250 ok($o =~ /^Needs to include.*ppport\.h/m);
251 ok($o !~ /^Uses grok_bin/m);
252 ok($o !~ /^Uses newSVpv/m);
253 ok($o !~ /Uses \d+ C\+\+ style comment/m);
254 ok(eq_files('MyExt.xsb', 'MyExt.rb'));
256 unlink qw(MyExt.xsa MyExt.xsb);
258 ---------------------------- MyExt.xs -----------------------------------------
265 ---------------------------- MyExt.ra -----------------------------------------
273 ---------------------------- MyExt.rb -----------------------------------------
281 ===============================================================================
283 my $o = ppport(qw(--nochanges file1.xs));
284 ok($o =~ /^Scanning.*file1\.xs/mi);
285 ok($o =~ /Analyzing.*file1\.xs/mi);
286 ok($o !~ /^Scanning.*file2\.xs/mi);
287 ok($o =~ /^Uses newCONSTSUB/m);
288 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
289 ok($o =~ /hint for newCONSTSUB/m);
290 ok($o !~ /hint for sv_2pv_nolen/m);
291 ok($o =~ /^Looks good/m);
293 $o = ppport(qw(--nochanges --nohints file1.xs));
294 ok($o =~ /^Scanning.*file1\.xs/mi);
295 ok($o =~ /Analyzing.*file1\.xs/mi);
296 ok($o !~ /^Scanning.*file2\.xs/mi);
297 ok($o =~ /^Uses newCONSTSUB/m);
298 ok($o =~ /^Uses SvPV_nolen.*depends.*sv_2pv_nolen/m);
299 ok($o !~ /hint for newCONSTSUB/m);
300 ok($o !~ /hint for sv_2pv_nolen/m);
301 ok($o =~ /^Looks good/m);
303 $o = ppport(qw(--nochanges --nohints --nodiag file1.xs));
304 ok($o =~ /^Scanning.*file1\.xs/mi);
305 ok($o =~ /Analyzing.*file1\.xs/mi);
306 ok($o !~ /^Scanning.*file2\.xs/mi);
307 ok($o !~ /^Uses newCONSTSUB/m);
308 ok($o !~ /^Uses SvPV_nolen/m);
309 ok($o !~ /hint for newCONSTSUB/m);
310 ok($o !~ /hint for sv_2pv_nolen/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_sv_2pv_nolen
355 ---------------------------- file2.xs -----------------------------------------
359 ===============================================================================
361 my $o = ppport(qw(--nochanges));
362 ok($o =~ /^Scanning.*FooBar\.xs/mi);
363 ok($o =~ /Analyzing.*FooBar\.xs/mi);
364 ok(matches($o, '^Scanning', 'm'), 1);
365 ok($o !~ /^Looks good/m);
366 ok($o =~ /^Uses grok_bin/m);
368 ---------------------------- FooBar.xs ----------------------------------------
374 ===============================================================================
376 my $o = ppport(qw(--nochanges));
377 ok($o =~ /^Scanning.*First\.xs/mi);
378 ok($o =~ /Analyzing.*First\.xs/mi);
379 ok($o =~ /^Scanning.*second\.h/mi);
380 ok($o =~ /Analyzing.*second\.h/mi);
381 ok($o =~ /^Scanning.*sub.*third\.c/mi);
382 ok($o =~ /Analyzing.*sub.*third\.c/mi);
383 ok($o !~ /^Scanning.*foobar/mi);
384 ok(matches($o, '^Scanning', 'm'), 3);
386 ---------------------------- First.xs -----------------------------------------
390 ---------------------------- foobar.xyz ---------------------------------------
394 ---------------------------- second.h -----------------------------------------
398 ---------------------------- sub/third.c --------------------------------------
402 ===============================================================================
404 my $o = ppport(qw(--nochanges));
405 ok($o =~ /Possibly wrong #define NEED_foobar in.*test.xs/i);
407 ---------------------------- test.xs ------------------------------------------
411 ===============================================================================
413 # And now some complex "real-world" example
415 my $o = ppport(qw(--copy=f));
416 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c mod5.c)) {
417 ok($o =~ /^Scanning.*\Q$_\E/mi);
418 ok($o =~ /Analyzing.*\Q$_\E/i);
420 ok(matches($o, '^Scanning', 'm'), 6);
422 ok(matches($o, '^Writing copy of', 'm'), 5);
425 for (qw(main.xs mod1.c mod2.c mod3.c mod4.c)) {
426 ok($o =~ /^Writing copy of.*\Q$_\E.*with changes/mi);
428 ok(eq_files("${_}f", "${_}r"));
432 ---------------------------- main.xs ------------------------------------------
438 #define NEED_newCONSTSUB
439 #define NEED_grok_hex_GLOBAL
444 Perl_grok_bin(aTHX_ foo, bar);
450 Perl_grok_bin(bar, sv_no);
452 ---------------------------- mod1.c -------------------------------------------
458 #define NEED_grok_bin_GLOBAL
459 #define NEED_newCONSTSUB
466 Perl_sv_catpvf(); /* I know it's wrong ;-) */
469 ---------------------------- mod2.c -------------------------------------------
484 ---------------------------- mod3.c -------------------------------------------
493 ---------------------------- mod4.c -------------------------------------------
501 ---------------------------- mod5.c -------------------------------------------
510 ---------------------------- main.xsr -----------------------------------------
516 #define NEED_eval_pv_GLOBAL
517 #define NEED_grok_hex
518 #define NEED_newCONSTSUB_GLOBAL
529 grok_bin(bar, PL_sv_no);
531 ---------------------------- mod1.cr ------------------------------------------
537 #define NEED_grok_bin_GLOBAL
543 Perl_croak (aTHX_ "foo");
544 Perl_sv_catpvf(aTHX); /* I know it's wrong ;-) */
547 ---------------------------- mod2.cr ------------------------------------------
560 ---------------------------- mod3.cr ------------------------------------------
565 #define NEED_grok_oct
571 ---------------------------- mod4.cr ------------------------------------------
580 ===============================================================================
582 my $o = ppport(qw(--nochanges));
583 ok($o =~ /Uses grok_hex/m);
584 ok($o !~ /Looks good/m);
586 $o = ppport(qw(--nochanges --compat-version=5.8.0));
587 ok($o !~ /Uses grok_hex/m);
588 ok($o =~ /Looks good/m);
590 ---------------------------- FooBar.xs ----------------------------------------
594 ===============================================================================
596 my $o = ppport(qw(--nochanges));
597 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
599 $o = ppport(qw(--nochanges --compat-version=5.5.3));
600 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
602 $o = ppport(qw(--nochanges --compat-version=5.005_03));
603 ok($o =~ /Uses SvPVutf8_force, which may not be portable/m);
605 $o = ppport(qw(--nochanges --compat-version=5.6.0));
606 ok($o !~ /Uses SvPVutf8_force/m);
608 $o = ppport(qw(--nochanges --compat-version=5.006));
609 ok($o !~ /Uses SvPVutf8_force/m);
611 $o = ppport(qw(--nochanges --compat-version=5.999.999));
612 ok($o !~ /Uses SvPVutf8_force/m);
614 $o = ppport(qw(--nochanges --compat-version=6.0.0));
615 ok($o =~ /Only Perl 5 is supported/m);
617 $o = ppport(qw(--nochanges --compat-version=5.1000.999));
618 ok($o =~ /Invalid version number: 5.1000.999/m);
620 $o = ppport(qw(--nochanges --compat-version=5.999.1000));
621 ok($o =~ /Invalid version number: 5.999.1000/m);
623 ---------------------------- FooBar.xs ----------------------------------------
627 ===============================================================================
629 my $o = ppport(qw(--nochanges));
630 ok($o !~ /potentially required change/);
631 ok(matches($o, '^Looks good', 'm'), 2);
633 ---------------------------- FooBar.xs ----------------------------------------
635 #define NEED_grok_numeric_radix
636 #define NEED_grok_number
639 GROK_NUMERIC_RADIX();
642 ---------------------------- foo.c --------------------------------------------
648 ===============================================================================
650 # check --api-info option
652 my $o = ppport(qw(--api-info=INT2PTR));
653 my %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
654 ok(scalar keys %found, 1);
655 ok(exists $found{INT2PTR});
656 ok(matches($o, '^Supported at least starting from perl-5\.6\.0\.', 'm'), 1);
657 ok(matches($o, '^Support by .*ppport.* provided back to perl-5\.003\.', 'm'), 1);
659 $o = ppport(qw(--api-info=Zero));
660 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
661 ok(scalar keys %found, 1);
662 ok(exists $found{Zero});
663 ok(matches($o, '^No portability information available\.', 'm'), 1);
665 $o = ppport(qw(--api-info=/Zero/));
666 %found = map {($_ => 1)} $o =~ /^===\s+(\w+)\s+===/mg;
667 ok(scalar keys %found, 2);
668 ok(exists $found{Zero});
669 ok(exists $found{ZeroD});
671 ===============================================================================
673 # check --list-provided option
675 my @o = ppport(qw(--list-provided));
679 my($name, $flags) = /^(\w+)(?:\s+\[(\w+(?:,\s+\w+)*)\])?$/ or $fail++;
680 exists $p{$name} and $fail++;
681 $p{$name} = defined $flags ? { map { ($_ => 1) } $flags =~ /(\w+)/g } : '';
686 ok(exists $p{call_sv});
687 ok(not ref $p{call_sv});
689 ok(exists $p{grok_bin});
690 ok(ref $p{grok_bin}, 'HASH');
691 ok(scalar keys %{$p{grok_bin}}, 1);
692 ok($p{grok_bin}{explicit});
694 ok(exists $p{gv_stashpvn});
695 ok(ref $p{gv_stashpvn}, 'HASH');
696 ok(scalar keys %{$p{gv_stashpvn}}, 1);
697 ok($p{gv_stashpvn}{hint});
699 ok(exists $p{sv_catpvf_mg});
700 ok(ref $p{sv_catpvf_mg}, 'HASH');
701 ok(scalar keys %{$p{sv_catpvf_mg}}, 2);
702 ok($p{sv_catpvf_mg}{explicit});
703 ok($p{sv_catpvf_mg}{depend});
705 ===============================================================================
707 # check --list-unsupported option
709 my @o = ppport(qw(--list-unsupported));
713 my($name, $ver) = /^(\w+)\s*\.+\s*([\d._]+)$/ or $fail++;
714 exists $p{$name} and $fail++;
720 ok(exists $p{utf8_distance});
721 ok($p{utf8_distance}, '5.6.0');
723 ok(exists $p{save_generic_svref});
724 ok($p{save_generic_svref}, '5.005_03');
726 ===============================================================================
728 # check --nofilter option
730 my $o = ppport(qw(--nochanges));
731 ok($o =~ /^Scanning.*foo\.cpp/mi);
732 ok($o =~ /Analyzing.*foo\.cpp/mi);
733 ok(matches($o, '^Scanning', 'm'), 1);
734 ok(matches($o, 'Analyzing', 'm'), 1);
736 $o = ppport(qw(--nochanges foo.cpp foo.o Makefile.PL));
737 ok($o =~ /Skipping the following files \(use --nofilter to avoid this\):/m);
738 ok(matches($o, '^\|\s+foo\.o', 'mi'), 1);
739 ok(matches($o, '^\|\s+Makefile\.PL', 'mi'), 1);
740 ok($o =~ /^Scanning.*foo\.cpp/mi);
741 ok($o =~ /Analyzing.*foo\.cpp/mi);
742 ok(matches($o, '^Scanning', 'm'), 1);
743 ok(matches($o, 'Analyzing', 'm'), 1);
745 $o = ppport(qw(--nochanges --nofilter foo.cpp foo.o Makefile.PL));
746 ok($o =~ /^Scanning.*foo\.cpp/mi);
747 ok($o =~ /Analyzing.*foo\.cpp/mi);
748 ok($o =~ /^Scanning.*foo\.o/mi);
749 ok($o =~ /Analyzing.*foo\.o/mi);
750 ok($o =~ /^Scanning.*Makefile/mi);
751 ok($o =~ /Analyzing.*Makefile/mi);
752 ok(matches($o, '^Scanning', 'm'), 3);
753 ok(matches($o, 'Analyzing', 'm'), 3);
755 ---------------------------- foo.cpp ------------------------------------------
759 ---------------------------- foo.o --------------------------------------------
763 ---------------------------- Makefile.PL --------------------------------------
767 ===============================================================================
769 # check if explicit variables are handled propery
771 my $o = ppport(qw(--copy=a));
772 ok($o =~ /^Needs to include.*ppport\.h/m);
773 ok($o =~ /^Uses PL_signals/m);
774 ok($o =~ /^File needs PL_signals, adding static request/m);
775 ok(eq_files('MyExt.xsa', 'MyExt.ra'));
777 unlink qw(MyExt.xsa);
779 ---------------------------- MyExt.xs -----------------------------------------
782 if (PL_signals == 42)
785 ---------------------------- MyExt.ra -----------------------------------------
787 #define NEED_PL_signals
790 if (PL_signals == 42)