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 ################################################################################
18 # Disable broken TRIE-optimization
19 BEGIN { eval '${^RE_TRIE_MAXBUF} = -1' if "$]" >= 5.009004 && "$]" <= 5.009005 }
21 my $VERSION = __VERSION__;
34 my($ppport) = $0 =~ /([\w.]+)$/;
35 my $LF = '(?:\r\n|[\r\n])'; # line feed
36 my $HS = "[ \t]"; # horizontal whitespace
38 # Never use C comments in this file!
41 my $rccs = quotemeta $ccs;
42 my $rcce = quotemeta $cce;
46 Getopt::Long::GetOptions(\%opt, qw(
47 help quiet diag! filter! hints! changes! cplusplus strip version
48 patch=s copy=s diff=s compat-version=s
49 list-provided list-unsupported api-info=s
53 if ($@ and grep /^-/, @ARGV) {
54 usage() if "@ARGV" =~ /^--?h(?:elp)?$/;
55 die "Getopt::Long not found. Please don't use any options.\n";
59 print "This is $0 $VERSION.\n";
63 usage() if $opt{help};
64 strip() if $opt{strip};
66 if (exists $opt{'compat-version'}) {
67 my($r,$v,$s) = eval { parse_version($opt{'compat-version'}) };
69 die "Invalid version number format: '$opt{'compat-version'}'\n";
71 die "Only Perl 5 is supported\n" if $r != 5;
72 die "Invalid version number: $opt{'compat-version'}\n" if $v >= 1000 || $s >= 1000;
73 $opt{'compat-version'} = sprintf "%d.%03d%03d", $r, $v, $s;
76 $opt{'compat-version'} = 5;
79 my %API = map { /^(\w+)\|([^|]*)\|([^|]*)\|(\w*)$/
81 ($2 ? ( base => $2 ) : ()),
82 ($3 ? ( todo => $3 ) : ()),
83 (index($4, 'v') >= 0 ? ( varargs => 1 ) : ()),
84 (index($4, 'p') >= 0 ? ( provided => 1 ) : ()),
85 (index($4, 'n') >= 0 ? ( nothxarg => 1 ) : ()),
87 : die "invalid spec: $_" } qw(
91 if (exists $opt{'list-unsupported'}) {
93 for $f (sort { lc $a cmp lc $b } keys %API) {
94 next unless $API{$f}{todo};
95 print "$f ", '.'x(40-length($f)), " ", format_version($API{$f}{todo}), "\n";
100 # Scan for possible replacement candidates
102 my(%replace, %need, %hints, %warnings, %depends);
104 my($hint, $define, $function);
110 / (?: \*[^*]*\*+(?:[^$ccs][^*]*\*+)* / | /[^\r\n]*)
111 | "[^"\\]*(?:\\.[^"\\]*)*"
112 | '[^'\\]*(?:\\.[^'\\]*)*' }{}egsx;
113 grep { exists $API{$_} } $code =~ /(\w+)/mg;
118 my $h = $hint->[0] eq 'Hint' ? \%hints : \%warnings;
119 if (m{^\s*\*\s(.*?)\s*$}) {
120 for (@{$hint->[1]}) {
121 $h->{$_} ||= ''; # suppress warning with older perls
128 $hint = [$1, [split /,?\s+/, $2]]
129 if m{^\s*$rccs\s+(Hint|Warning):\s+(\w+(?:,?\s+\w+)*)\s*$};
132 if ($define->[1] =~ /\\$/) {
136 if (exists $API{$define->[0]} && $define->[1] !~ /^DPPP_\(/) {
137 my @n = find_api($define->[1]);
138 push @{$depends{$define->[0]}}, @n if @n
144 $define = [$1, $2] if m{^\s*#\s*define\s+(\w+)(?:\([^)]*\))?\s+(.*)};
148 if (exists $API{$function->[0]}) {
149 my @n = find_api($function->[1]);
150 push @{$depends{$function->[0]}}, @n if @n
155 $function->[1] .= $_;
159 $function = [$1, ''] if m{^DPPP_\(my_(\w+)\)};
161 $replace = $1 if m{^\s*$rccs\s+Replace:\s+(\d+)\s+$rcce\s*$};
162 $replace{$2} = $1 if $replace and m{^\s*#\s*define\s+(\w+)(?:\([^)]*\))?\s+(\w+)};
163 $replace{$2} = $1 if m{^\s*#\s*define\s+(\w+)(?:\([^)]*\))?\s+(\w+).*$rccs\s+Replace\s+$rcce};
164 $replace{$1} = $2 if m{^\s*$rccs\s+Replace (\w+) with (\w+)\s+$rcce\s*$};
166 if (m{^\s*$rccs\s+(\w+(\s*,\s*\w+)*)\s+depends\s+on\s+(\w+(\s*,\s*\w+)*)\s+$rcce\s*$}) {
167 my @deps = map { s/\s+//g; $_ } split /,/, $3;
169 for $d (map { s/\s+//g; $_ } split /,/, $1) {
170 push @{$depends{$d}}, @deps;
174 $need{$1} = 1 if m{^#if\s+defined\(NEED_(\w+)(?:_GLOBAL)?\)};
177 for (values %depends) {
179 $_ = [sort grep !$s{$_}++, @$_];
182 if (exists $opt{'api-info'}) {
185 my $match = $opt{'api-info'} =~ m!^/(.*)/$! ? $1 : "^\Q$opt{'api-info'}\E\$";
186 for $f (sort { lc $a cmp lc $b } keys %API) {
187 next unless $f =~ /$match/;
188 print "\n=== $f ===\n\n";
190 if ($API{$f}{base} || $API{$f}{todo}) {
191 my $base = format_version($API{$f}{base} || $API{$f}{todo});
192 print "Supported at least starting from perl-$base.\n";
195 if ($API{$f}{provided}) {
196 my $todo = $API{$f}{todo} ? format_version($API{$f}{todo}) : "__MIN_PERL__";
197 print "Support by $ppport provided back to perl-$todo.\n";
198 print "Support needs to be explicitly requested by NEED_$f.\n" if exists $need{$f};
199 print "Depends on: ", join(', ', @{$depends{$f}}), ".\n" if exists $depends{$f};
200 print "\n$hints{$f}" if exists $hints{$f};
201 print "\nWARNING:\n$warnings{$f}" if exists $warnings{$f};
204 print "No portability information available.\n" unless $info;
207 $count or print "Found no API matching '$opt{'api-info'}'.";
212 if (exists $opt{'list-provided'}) {
214 for $f (sort { lc $a cmp lc $b } keys %API) {
215 next unless $API{$f}{provided};
217 push @flags, 'explicit' if exists $need{$f};
218 push @flags, 'depend' if exists $depends{$f};
219 push @flags, 'hint' if exists $hints{$f};
220 push @flags, 'warning' if exists $warnings{$f};
221 my $flags = @flags ? ' ['.join(', ', @flags).']' : '';
228 my @srcext = qw( .xs .c .h .cc .cpp -c.inc -xs.inc );
229 my $srcext = join '|', map { quotemeta $_ } @srcext;
236 push @files, $_ unless $seen{$_}++;
238 else { warn "'$_' is not a file.\n" }
241 my @new = grep { -f } glob $_
242 or warn "'$_' does not exist.\n";
243 push @files, grep { !$seen{$_}++ } @new;
250 File::Find::find(sub {
251 $File::Find::name =~ /($srcext)$/i
252 and push @files, $File::Find::name;
256 @files = map { glob "*$_" } @srcext;
260 if (!@ARGV || $opt{filter}) {
262 my %xsc = map { /(.*)\.xs$/ ? ("$1.c" => 1, "$1.cc" => 1) : () } @files;
264 my $out = exists $xsc{$_} || /\b\Q$ppport\E$/i || !/($srcext)$/i;
265 push @{ $out ? \@out : \@in }, $_;
268 warning("Skipping the following files (use --nofilter to avoid this):\n| ", join "\n| ", @out);
273 die "No input files given!\n" unless @files;
275 my(%files, %global, %revreplace);
276 %revreplace = reverse %replace;
278 my $patch_opened = 0;
280 for $filename (@files) {
281 unless (open IN, "<$filename") {
282 warn "Unable to read from $filename: $!\n";
286 info("Scanning $filename ...");
288 my $c = do { local $/; <IN> };
291 my %file = (orig => $c, changes => 0);
293 # Temporarily remove C/XS comments and strings from the code
297 ( ^$HS*\#$HS*include\b[^\r\n]+\b(?:\Q$ppport\E|XSUB\.h)\b[^\r\n]*
298 | ^$HS*\#$HS*(?:define|elif|if(?:def)?)\b[^\r\n]* )
300 | "[^"\\]*(?:\\.[^"\\]*)*"
301 | '[^'\\]*(?:\\.[^'\\]*)*'
302 | / (?: \*[^*]*\*+(?:[^$ccs][^*]*\*+)* / | /[^\r\n]* ) )
303 }{ defined $2 and push @ccom, $2;
304 defined $1 ? $1 : "$ccs$#ccom$cce" }mgsex;
306 $file{ccom} = \@ccom;
308 $file{has_inc_ppport} = $c =~ /^$HS*#$HS*include[^\r\n]+\b\Q$ppport\E\b/m;
312 for $func (keys %API) {
314 $match .= "|$revreplace{$func}" if exists $revreplace{$func};
315 if ($c =~ /\b(?:Perl_)?($match)\b/) {
316 $file{uses_replace}{$1}++ if exists $revreplace{$func} && $1 eq $revreplace{$func};
317 $file{uses_Perl}{$func}++ if $c =~ /\bPerl_$func\b/;
318 if (exists $API{$func}{provided}) {
319 $file{uses_provided}{$func}++;
320 if (!exists $API{$func}{base} || $API{$func}{base} > $opt{'compat-version'}) {
321 $file{uses}{$func}++;
322 my @deps = rec_depend($func);
324 $file{uses_deps}{$func} = \@deps;
326 $file{uses}{$_} = 0 unless exists $file{uses}{$_};
330 $file{needs}{$_} = 'static' if exists $need{$_};
334 if (exists $API{$func}{todo} && $API{$func}{todo} > $opt{'compat-version'}) {
335 if ($c =~ /\b$func\b/) {
336 $file{uses_todo}{$func}++;
342 while ($c =~ /^$HS*#$HS*define$HS+(NEED_(\w+?)(_GLOBAL)?)\b/mg) {
343 if (exists $need{$2}) {
344 $file{defined $3 ? 'needed_global' : 'needed_static'}{$2}++;
346 else { warning("Possibly wrong #define $1 in $filename") }
349 for (qw(uses needs uses_todo needed_global needed_static)) {
350 for $func (keys %{$file{$_}}) {
351 push @{$global{$_}{$func}}, $filename;
355 $files{$filename} = \%file;
358 # Globally resolve NEED_'s
360 for $need (keys %{$global{needs}}) {
361 if (@{$global{needs}{$need}} > 1) {
362 my @targets = @{$global{needs}{$need}};
363 my @t = grep $files{$_}{needed_global}{$need}, @targets;
365 @t = grep /\.xs$/i, @targets;
367 my $target = shift @targets;
368 $files{$target}{needs}{$need} = 'global';
369 for (@{$global{needs}{$need}}) {
370 $files{$_}{needs}{$need} = 'extern' if $_ ne $target;
375 for $filename (@files) {
376 exists $files{$filename} or next;
378 info("=== Analyzing $filename ===");
380 my %file = %{$files{$filename}};
385 for $func (sort keys %{$file{uses_Perl}}) {
386 if ($API{$func}{varargs}) {
387 unless ($API{$func}{nothxarg}) {
388 my $changes = ($c =~ s{\b(Perl_$func\s*\(\s*)(?!aTHX_?)(\)|[^\s)]*\))}
389 { $1 . ($2 eq ')' ? 'aTHX' : 'aTHX_ ') . $2 }ge);
391 warning("Doesn't pass interpreter argument aTHX to Perl_$func");
392 $file{changes} += $changes;
397 warning("Uses Perl_$func instead of $func");
398 $file{changes} += ($c =~ s{\bPerl_$func(\s*)\((\s*aTHX_?)?\s*}
403 for $func (sort keys %{$file{uses_replace}}) {
404 warning("Uses $func instead of $replace{$func}");
405 $file{changes} += ($c =~ s/\b$func\b/$replace{$func}/g);
408 for $func (sort keys %{$file{uses_provided}}) {
409 if ($file{uses}{$func}) {
410 if (exists $file{uses_deps}{$func}) {
411 diag("Uses $func, which depends on ", join(', ', @{$file{uses_deps}{$func}}));
417 $warnings += hint($func);
420 unless ($opt{quiet}) {
421 for $func (sort keys %{$file{uses_todo}}) {
422 print "*** WARNING: Uses $func, which may not be portable below perl ",
423 format_version($API{$func}{todo}), ", even with '$ppport'\n";
428 for $func (sort keys %{$file{needed_static}}) {
430 if (not exists $file{uses}{$func}) {
431 $message = "No need to define NEED_$func if $func is never used";
433 elsif (exists $file{needs}{$func} && $file{needs}{$func} ne 'static') {
434 $message = "No need to define NEED_$func when already needed globally";
438 $file{changes} += ($c =~ s/^$HS*#$HS*define$HS+NEED_$func\b.*$LF//mg);
442 for $func (sort keys %{$file{needed_global}}) {
444 if (not exists $global{uses}{$func}) {
445 $message = "No need to define NEED_${func}_GLOBAL if $func is never used";
447 elsif (exists $file{needs}{$func}) {
448 if ($file{needs}{$func} eq 'extern') {
449 $message = "No need to define NEED_${func}_GLOBAL when already needed globally";
451 elsif ($file{needs}{$func} eq 'static') {
452 $message = "No need to define NEED_${func}_GLOBAL when only used in this file";
457 $file{changes} += ($c =~ s/^$HS*#$HS*define$HS+NEED_${func}_GLOBAL\b.*$LF//mg);
461 $file{needs_inc_ppport} = keys %{$file{uses}};
463 if ($file{needs_inc_ppport}) {
466 for $func (sort keys %{$file{needs}}) {
467 my $type = $file{needs}{$func};
468 next if $type eq 'extern';
469 my $suffix = $type eq 'global' ? '_GLOBAL' : '';
470 unless (exists $file{"needed_$type"}{$func}) {
471 if ($type eq 'global') {
472 diag("Files [@{$global{needs}{$func}}] need $func, adding global request");
475 diag("File needs $func, adding static request");
477 $pp .= "#define NEED_$func$suffix\n";
481 if ($pp && ($c =~ s/^(?=$HS*#$HS*define$HS+NEED_\w+)/$pp/m)) {
486 unless ($file{has_inc_ppport}) {
487 diag("Needs to include '$ppport'");
488 $pp .= qq(#include "$ppport"\n)
492 $file{changes} += ($c =~ s/^($HS*#$HS*define$HS+NEED_\w+.*?)^/$1$pp/ms)
493 || ($c =~ s/^(?=$HS*#$HS*include.*\Q$ppport\E)/$pp/m)
494 || ($c =~ s/^($HS*#$HS*include.*XSUB.*\s*?)^/$1$pp/m)
499 if ($file{has_inc_ppport}) {
500 diag("No need to include '$ppport'");
501 $file{changes} += ($c =~ s/^$HS*?#$HS*include.*\Q$ppport\E.*?$LF//m);
505 # put back in our C comments
508 my @ccom = @{$file{ccom}};
509 for $ix (0 .. $#ccom) {
510 if (!$opt{cplusplus} && $ccom[$ix] =~ s!^//!!) {
512 $file{changes} += $c =~ s/$rccs$ix$rcce/$ccs$ccom[$ix] $cce/;
515 $c =~ s/$rccs$ix$rcce/$ccom[$ix]/;
520 my $s = $cppc != 1 ? 's' : '';
521 warning("Uses $cppc C++ style comment$s, which is not portable");
524 my $s = $warnings != 1 ? 's' : '';
525 my $warn = $warnings ? " ($warnings warning$s)" : '';
526 info("Analysis completed$warn");
528 if ($file{changes}) {
529 if (exists $opt{copy}) {
530 my $newfile = "$filename$opt{copy}";
532 error("'$newfile' already exists, refusing to write copy of '$filename'");
536 if (open F, ">$newfile") {
537 info("Writing copy of '$filename' with changes to '$newfile'");
542 error("Cannot open '$newfile' for writing: $!");
546 elsif (exists $opt{patch} || $opt{changes}) {
547 if (exists $opt{patch}) {
548 unless ($patch_opened) {
549 if (open PATCH, ">$opt{patch}") {
553 error("Cannot open '$opt{patch}' for writing: $!");
559 mydiff(\*PATCH, $filename, $c);
563 info("Suggested changes:");
564 mydiff(\*STDOUT, $filename, $c);
568 my $s = $file{changes} == 1 ? '' : 's';
569 info("$file{changes} potentially required change$s detected");
577 close PATCH if $patch_opened;
581 #######################################################################
583 sub try_use { eval "use @_;"; return $@ eq '' }
588 my($file, $str) = @_;
591 if (exists $opt{diff}) {
592 $diff = run_diff($opt{diff}, $file, $str);
595 if (!defined $diff and try_use('Text::Diff')) {
596 $diff = Text::Diff::diff($file, \$str, { STYLE => 'Unified' });
597 $diff = <<HEADER . $diff;
603 if (!defined $diff) {
604 $diff = run_diff('diff -u', $file, $str);
607 if (!defined $diff) {
608 $diff = run_diff('diff', $file, $str);
611 if (!defined $diff) {
612 error("Cannot generate a diff. Please install Text::Diff or use --copy.");
621 my($prog, $file, $str) = @_;
622 my $tmp = 'dppptemp';
627 while (-e "$tmp.$suf") { $suf++ }
630 if (open F, ">$tmp") {
634 if (open F, "$prog $file $tmp |") {
636 s/\Q$tmp\E/$file.patched/;
647 error("Cannot open '$tmp' for writing: $!");
655 my($func, $seen) = @_;
656 return () unless exists $depends{$func};
657 $seen = {%{$seen||{}}};
658 return () if $seen->{$func}++;
660 grep !$s{$_}++, map { ($_, rec_depend($_, $seen)) } @{$depends{$func}};
667 if ($ver =~ /^(\d+)\.(\d+)\.(\d+)$/) {
670 elsif ($ver !~ /^\d+\.[\d_]+$/) {
671 die "cannot parse version '$ver'\n";
677 my($r,$v,$s) = $ver =~ /(\d+)\.(\d{3})(\d{3})/;
682 if ($r < 5 || ($r == 5 && $v < 6)) {
684 die "cannot parse version '$ver'\n";
696 my($r,$v,$s) = $ver =~ /(\d+)\.(\d{3})(\d{3})/;
701 if ($r < 5 || ($r == 5 && $v < 6)) {
703 die "invalid version '$ver'\n";
707 $ver = sprintf "%d.%03d", $r, $v;
708 $s > 0 and $ver .= sprintf "_%02d", $s;
713 return sprintf "%d.%d.%d", $r, $v, $s;
718 $opt{quiet} and return;
724 $opt{quiet} and return;
725 $opt{diag} and print @_, "\n";
730 $opt{quiet} and return;
731 print "*** ", @_, "\n";
736 print "*** ERROR: ", @_, "\n";
743 $opt{quiet} and return;
746 if (exists $warnings{$func} && !$given_warnings{$func}++) {
747 my $warn = $warnings{$func};
748 $warn =~ s!^!*** !mg;
749 print "*** WARNING: $func\n", $warn;
752 if ($opt{hints} && exists $hints{$func} && !$given_hints{$func}++) {
753 my $hint = $hints{$func};
755 print " --- hint for $func ---\n", $hint;
762 my($usage) = do { local(@ARGV,$/)=($0); <> } =~ /^=head\d$HS+SYNOPSIS\s*^(.*?)\s*^=/ms;
763 my %M = ( 'I' => '*' );
764 $usage =~ s/^\s*perl\s+\S+/$^X $0/;
765 $usage =~ s/([A-Z])<([^>]+)>/$M{$1}$2$M{$1}/g;
771 See perldoc $0 for details.
780 my $self = do { local(@ARGV,$/)=($0); <> };
781 my($copy) = $self =~ /^=head\d\s+COPYRIGHT\s*^(.*?)^=\w+/ms;
782 $copy =~ s/^(?=\S+)/ /gms;
783 $self =~ s/^$HS+Do NOT edit.*?(?=^-)/$copy/ms;
784 $self =~ s/^SKIP.*(?=^__DATA__)/SKIP
785 if (\@ARGV && \$ARGV[0] eq '--unstrip') {
786 eval { require Devel::PPPort };
787 \$@ and die "Cannot require Devel::PPPort, please install.\\n";
788 if (eval \$Devel::PPPort::VERSION < $VERSION) {
789 die "$0 was originally generated with Devel::PPPort $VERSION.\\n"
790 . "Your Devel::PPPort is only version \$Devel::PPPort::VERSION.\\n"
791 . "Please install a newer version, or --unstrip will not work.\\n";
793 Devel::PPPort::WriteFile(\$0);
798 Sorry, but this is a stripped version of \$0.
800 To be able to use its original script and doc functionality,
801 please try to regenerate this file using:
807 my($pl, $c) = $self =~ /(.*^__DATA__)(.*)/ms;
809 / (?: \*[^*]*\*+(?:[^$ccs][^*]*\*+)* / | /[^\r\n]*)
810 | ( "[^"\\]*(?:\\.[^"\\]*)*"
811 | '[^'\\]*(?:\\.[^'\\]*)*' )
812 | ($HS+) }{ defined $2 ? ' ' : ($1 || '') }gsex;
815 $c =~ s!^\s*#\s*!#!mg;
818 open OUT, ">$0" or die "cannot strip $0: $!\n";