Commit | Line | Data |
adfe19db |
1 | ################################################################################ |
2 | ## |
c83e6f19 |
3 | ## $Revision: 44 $ |
adfe19db |
4 | ## $Author: mhx $ |
c83e6f19 |
5 | ## $Date: 2007/08/20 18:21:09 +0200 $ |
adfe19db |
6 | ## |
7 | ################################################################################ |
8 | ## |
d2dacc4f |
9 | ## Version 3.x, Copyright (C) 2004-2007, Marcus Holland-Moritz. |
adfe19db |
10 | ## Version 2.x, Copyright (C) 2001, Paul Marquess. |
11 | ## Version 1.x, Copyright (C) 1999, Kenneth Albanowski. |
12 | ## |
13 | ## This program is free software; you can redistribute it and/or |
14 | ## modify it under the same terms as Perl itself. |
15 | ## |
16 | ################################################################################ |
17 | |
18 | =provides |
19 | |
20 | =implementation |
21 | |
adfe19db |
22 | use strict; |
23 | |
c83e6f19 |
24 | # Disable broken TRIE-optimization |
25 | BEGIN { eval '${^RE_TRIE_MAXBUF} = -1' if $] >= 5.009004 && $] <= 5.009005 } |
26 | |
78b4ff79 |
27 | my $VERSION = __VERSION__; |
28 | |
adfe19db |
29 | my %opt = ( |
30 | quiet => 0, |
31 | diag => 1, |
32 | hints => 1, |
33 | changes => 1, |
34 | cplusplus => 0, |
4a582685 |
35 | filter => 1, |
0d0f8426 |
36 | strip => 0, |
78b4ff79 |
37 | version => 0, |
adfe19db |
38 | ); |
39 | |
40 | my($ppport) = $0 =~ /([\w.]+)$/; |
41 | my $LF = '(?:\r\n|[\r\n])'; # line feed |
42 | my $HS = "[ \t]"; # horizontal whitespace |
43 | |
c83e6f19 |
44 | # Never use C comments in this file! |
45 | my $ccs = '/'.'*'; |
46 | my $cce = '*'.'/'; |
47 | my $rccs = quotemeta $ccs; |
48 | my $rcce = quotemeta $cce; |
49 | |
adfe19db |
50 | eval { |
51 | require Getopt::Long; |
52 | Getopt::Long::GetOptions(\%opt, qw( |
78b4ff79 |
53 | help quiet diag! filter! hints! changes! cplusplus strip version |
adfe19db |
54 | patch=s copy=s diff=s compat-version=s |
04fc8b94 |
55 | list-provided list-unsupported api-info=s |
adfe19db |
56 | )) or usage(); |
57 | }; |
58 | |
59 | if ($@ and grep /^-/, @ARGV) { |
60 | usage() if "@ARGV" =~ /^--?h(?:elp)?$/; |
61 | die "Getopt::Long not found. Please don't use any options.\n"; |
62 | } |
63 | |
78b4ff79 |
64 | if ($opt{version}) { |
65 | print "This is $0 $VERSION.\n"; |
66 | exit 0; |
67 | } |
68 | |
adfe19db |
69 | usage() if $opt{help}; |
0d0f8426 |
70 | strip() if $opt{strip}; |
adfe19db |
71 | |
72 | if (exists $opt{'compat-version'}) { |
73 | my($r,$v,$s) = eval { parse_version($opt{'compat-version'}) }; |
74 | if ($@) { |
75 | die "Invalid version number format: '$opt{'compat-version'}'\n"; |
76 | } |
77 | die "Only Perl 5 is supported\n" if $r != 5; |
4a582685 |
78 | die "Invalid version number: $opt{'compat-version'}\n" if $v >= 1000 || $s >= 1000; |
adfe19db |
79 | $opt{'compat-version'} = sprintf "%d.%03d%03d", $r, $v, $s; |
80 | } |
81 | else { |
82 | $opt{'compat-version'} = 5; |
83 | } |
84 | |
adfe19db |
85 | my %API = map { /^(\w+)\|([^|]*)\|([^|]*)\|(\w*)$/ |
4a582685 |
86 | ? ( $1 => { |
adfe19db |
87 | ($2 ? ( base => $2 ) : ()), |
88 | ($3 ? ( todo => $3 ) : ()), |
89 | (index($4, 'v') >= 0 ? ( varargs => 1 ) : ()), |
90 | (index($4, 'p') >= 0 ? ( provided => 1 ) : ()), |
91 | (index($4, 'n') >= 0 ? ( nothxarg => 1 ) : ()), |
92 | } ) |
93 | : die "invalid spec: $_" } qw( |
94 | __PERL_API__ |
95 | ); |
96 | |
97 | if (exists $opt{'list-unsupported'}) { |
98 | my $f; |
99 | for $f (sort { lc $a cmp lc $b } keys %API) { |
100 | next unless $API{$f}{todo}; |
101 | print "$f ", '.'x(40-length($f)), " ", format_version($API{$f}{todo}), "\n"; |
102 | } |
103 | exit 0; |
104 | } |
105 | |
106 | # Scan for possible replacement candidates |
107 | |
679ad62d |
108 | my(%replace, %need, %hints, %warnings, %depends); |
adfe19db |
109 | my $replace = 0; |
679ad62d |
110 | my($hint, $define, $function); |
adfe19db |
111 | |
af36fda7 |
112 | sub find_api |
113 | { |
114 | my $code = shift; |
115 | $code =~ s{ |
c83e6f19 |
116 | / (?: \*[^*]*\*+(?:[^$ccs][^*]*\*+)* / | /[^\r\n]*) |
117 | | "[^"\\]*(?:\\.[^"\\]*)*" |
118 | | '[^'\\]*(?:\\.[^'\\]*)*' }{}egsx; |
af36fda7 |
119 | grep { exists $API{$_} } $code =~ /(\w+)/mg; |
120 | } |
121 | |
adfe19db |
122 | while (<DATA>) { |
123 | if ($hint) { |
679ad62d |
124 | my $h = $hint->[0] eq 'Hint' ? \%hints : \%warnings; |
adfe19db |
125 | if (m{^\s*\*\s(.*?)\s*$}) { |
679ad62d |
126 | for (@{$hint->[1]}) { |
127 | $h->{$_} ||= ''; # suppress warning with older perls |
128 | $h->{$_} .= "$1\n"; |
129 | } |
130 | } |
c83e6f19 |
131 | else { undef $hint } |
679ad62d |
132 | } |
133 | |
c83e6f19 |
134 | $hint = [$1, [split /,?\s+/, $2]] |
135 | if m{^\s*$rccs\s+(Hint|Warning):\s+(\w+(?:,?\s+\w+)*)\s*$}; |
679ad62d |
136 | |
137 | if ($define) { |
138 | if ($define->[1] =~ /\\$/) { |
139 | $define->[1] .= $_; |
140 | } |
141 | else { |
142 | if (exists $API{$define->[0]} && $define->[1] !~ /^DPPP_\(/) { |
af36fda7 |
143 | my @n = find_api($define->[1]); |
679ad62d |
144 | push @{$depends{$define->[0]}}, @n if @n |
145 | } |
146 | undef $define; |
147 | } |
148 | } |
149 | |
150 | $define = [$1, $2] if m{^\s*#\s*define\s+(\w+)(?:\([^)]*\))?\s+(.*)}; |
151 | |
152 | if ($function) { |
153 | if (/^}/) { |
154 | if (exists $API{$function->[0]}) { |
af36fda7 |
155 | my @n = find_api($function->[1]); |
679ad62d |
156 | push @{$depends{$function->[0]}}, @n if @n |
157 | } |
158 | undef $define; |
adfe19db |
159 | } |
160 | else { |
679ad62d |
161 | $function->[1] .= $_; |
adfe19db |
162 | } |
163 | } |
679ad62d |
164 | |
165 | $function = [$1, ''] if m{^DPPP_\(my_(\w+)\)}; |
adfe19db |
166 | |
167 | $replace = $1 if m{^\s*$rccs\s+Replace:\s+(\d+)\s+$rcce\s*$}; |
168 | $replace{$2} = $1 if $replace and m{^\s*#\s*define\s+(\w+)(?:\([^)]*\))?\s+(\w+)}; |
169 | $replace{$2} = $1 if m{^\s*#\s*define\s+(\w+)(?:\([^)]*\))?\s+(\w+).*$rccs\s+Replace\s+$rcce}; |
170 | $replace{$1} = $2 if m{^\s*$rccs\s+Replace (\w+) with (\w+)\s+$rcce\s*$}; |
171 | |
172 | if (m{^\s*$rccs\s+(\w+)\s+depends\s+on\s+(\w+(\s*,\s*\w+)*)\s+$rcce\s*$}) { |
173 | push @{$depends{$1}}, map { s/\s+//g; $_ } split /,/, $2; |
174 | } |
175 | |
176 | $need{$1} = 1 if m{^#if\s+defined\(NEED_(\w+)(?:_GLOBAL)?\)}; |
177 | } |
178 | |
679ad62d |
179 | for (values %depends) { |
180 | my %s; |
181 | $_ = [sort grep !$s{$_}++, @$_]; |
182 | } |
183 | |
04fc8b94 |
184 | if (exists $opt{'api-info'}) { |
185 | my $f; |
186 | my $count = 0; |
9132e1a3 |
187 | my $match = $opt{'api-info'} =~ m!^/(.*)/$! ? $1 : "^\Q$opt{'api-info'}\E\$"; |
04fc8b94 |
188 | for $f (sort { lc $a cmp lc $b } keys %API) { |
9132e1a3 |
189 | next unless $f =~ /$match/; |
04fc8b94 |
190 | print "\n=== $f ===\n\n"; |
191 | my $info = 0; |
192 | if ($API{$f}{base} || $API{$f}{todo}) { |
193 | my $base = format_version($API{$f}{base} || $API{$f}{todo}); |
9132e1a3 |
194 | print "Supported at least starting from perl-$base.\n"; |
04fc8b94 |
195 | $info++; |
196 | } |
197 | if ($API{$f}{provided}) { |
198 | my $todo = $API{$f}{todo} ? format_version($API{$f}{todo}) : "__MIN_PERL__"; |
9132e1a3 |
199 | print "Support by $ppport provided back to perl-$todo.\n"; |
04fc8b94 |
200 | print "Support needs to be explicitly requested by NEED_$f.\n" if exists $need{$f}; |
201 | print "Depends on: ", join(', ', @{$depends{$f}}), ".\n" if exists $depends{$f}; |
679ad62d |
202 | print "\n$hints{$f}" if exists $hints{$f}; |
203 | print "\nWARNING:\n$warnings{$f}" if exists $warnings{$f}; |
04fc8b94 |
204 | $info++; |
205 | } |
c83e6f19 |
206 | print "No portability information available.\n" unless $info; |
04fc8b94 |
207 | $count++; |
208 | } |
c83e6f19 |
209 | $count or print "Found no API matching '$opt{'api-info'}'."; |
210 | print "\n"; |
04fc8b94 |
211 | exit 0; |
212 | } |
213 | |
adfe19db |
214 | if (exists $opt{'list-provided'}) { |
215 | my $f; |
216 | for $f (sort { lc $a cmp lc $b } keys %API) { |
217 | next unless $API{$f}{provided}; |
218 | my @flags; |
219 | push @flags, 'explicit' if exists $need{$f}; |
220 | push @flags, 'depend' if exists $depends{$f}; |
221 | push @flags, 'hint' if exists $hints{$f}; |
679ad62d |
222 | push @flags, 'warning' if exists $warnings{$f}; |
adfe19db |
223 | my $flags = @flags ? ' ['.join(', ', @flags).']' : ''; |
224 | print "$f$flags\n"; |
225 | } |
226 | exit 0; |
227 | } |
228 | |
4a582685 |
229 | my @files; |
679ad62d |
230 | my @srcext = qw( .xs .c .h .cc .cpp -c.inc -xs.inc ); |
231 | my $srcext = join '|', map { quotemeta $_ } @srcext; |
4a582685 |
232 | |
233 | if (@ARGV) { |
234 | my %seen; |
679ad62d |
235 | for (@ARGV) { |
236 | if (-e) { |
237 | if (-f) { |
238 | push @files, $_ unless $seen{$_}++; |
239 | } |
240 | else { warn "'$_' is not a file.\n" } |
241 | } |
242 | else { |
243 | my @new = grep { -f } glob $_ |
244 | or warn "'$_' does not exist.\n"; |
245 | push @files, grep { !$seen{$_}++ } @new; |
246 | } |
247 | } |
4a582685 |
248 | } |
249 | else { |
250 | eval { |
251 | require File::Find; |
252 | File::Find::find(sub { |
679ad62d |
253 | $File::Find::name =~ /($srcext)$/i |
4a582685 |
254 | and push @files, $File::Find::name; |
255 | }, '.'); |
256 | }; |
257 | if ($@) { |
679ad62d |
258 | @files = map { glob "*$_" } @srcext; |
4a582685 |
259 | } |
260 | } |
261 | |
262 | if (!@ARGV || $opt{filter}) { |
263 | my(@in, @out); |
264 | my %xsc = map { /(.*)\.xs$/ ? ("$1.c" => 1, "$1.cc" => 1) : () } @files; |
265 | for (@files) { |
679ad62d |
266 | my $out = exists $xsc{$_} || /\b\Q$ppport\E$/i || !/($srcext)$/i; |
4a582685 |
267 | push @{ $out ? \@out : \@in }, $_; |
268 | } |
269 | if (@ARGV && @out) { |
270 | warning("Skipping the following files (use --nofilter to avoid this):\n| ", join "\n| ", @out); |
271 | } |
272 | @files = @in; |
273 | } |
274 | |
c83e6f19 |
275 | die "No input files given!\n" unless @files; |
4a582685 |
276 | |
adfe19db |
277 | my(%files, %global, %revreplace); |
278 | %revreplace = reverse %replace; |
279 | my $filename; |
280 | my $patch_opened = 0; |
281 | |
282 | for $filename (@files) { |
283 | unless (open IN, "<$filename") { |
284 | warn "Unable to read from $filename: $!\n"; |
285 | next; |
286 | } |
287 | |
288 | info("Scanning $filename ..."); |
289 | |
290 | my $c = do { local $/; <IN> }; |
291 | close IN; |
292 | |
293 | my %file = (orig => $c, changes => 0); |
294 | |
c83e6f19 |
295 | # Temporarily remove C/XS comments and strings from the code |
adfe19db |
296 | my @ccom; |
c83e6f19 |
297 | |
adfe19db |
298 | $c =~ s{ |
c83e6f19 |
299 | ( ^$HS*\#$HS*include\b[^\r\n]+\b(?:\Q$ppport\E|XSUB\.h)\b[^\r\n]* |
300 | | ^$HS*\#$HS*(?:define|elif|if(?:def)?)\b[^\r\n]* ) |
301 | | ( ^$HS*\#[^\r\n]* |
302 | | "[^"\\]*(?:\\.[^"\\]*)*" |
303 | | '[^'\\]*(?:\\.[^'\\]*)*' |
304 | | / (?: \*[^*]*\*+(?:[^$ccs][^*]*\*+)* / | /[^\r\n]* ) ) |
af36fda7 |
305 | }{ defined $2 and push @ccom, $2; |
c83e6f19 |
306 | defined $1 ? $1 : "$ccs$#ccom$cce" }mgsex; |
adfe19db |
307 | |
308 | $file{ccom} = \@ccom; |
309 | $file{code} = $c; |
c83e6f19 |
310 | $file{has_inc_ppport} = $c =~ /^$HS*#$HS*include[^\r\n]+\b\Q$ppport\E\b/m; |
adfe19db |
311 | |
312 | my $func; |
313 | |
314 | for $func (keys %API) { |
315 | my $match = $func; |
316 | $match .= "|$revreplace{$func}" if exists $revreplace{$func}; |
317 | if ($c =~ /\b(?:Perl_)?($match)\b/) { |
318 | $file{uses_replace}{$1}++ if exists $revreplace{$func} && $1 eq $revreplace{$func}; |
319 | $file{uses_Perl}{$func}++ if $c =~ /\bPerl_$func\b/; |
320 | if (exists $API{$func}{provided}) { |
679ad62d |
321 | $file{uses_provided}{$func}++; |
adfe19db |
322 | if (!exists $API{$func}{base} || $API{$func}{base} > $opt{'compat-version'}) { |
323 | $file{uses}{$func}++; |
adfe19db |
324 | my @deps = rec_depend($func); |
325 | if (@deps) { |
326 | $file{uses_deps}{$func} = \@deps; |
327 | for (@deps) { |
328 | $file{uses}{$_} = 0 unless exists $file{uses}{$_}; |
adfe19db |
329 | } |
330 | } |
331 | for ($func, @deps) { |
c83e6f19 |
332 | $file{needs}{$_} = 'static' if exists $need{$_}; |
adfe19db |
333 | } |
334 | } |
335 | } |
336 | if (exists $API{$func}{todo} && $API{$func}{todo} > $opt{'compat-version'}) { |
337 | if ($c =~ /\b$func\b/) { |
338 | $file{uses_todo}{$func}++; |
adfe19db |
339 | } |
340 | } |
341 | } |
342 | } |
343 | |
344 | while ($c =~ /^$HS*#$HS*define$HS+(NEED_(\w+?)(_GLOBAL)?)\b/mg) { |
345 | if (exists $need{$2}) { |
346 | $file{defined $3 ? 'needed_global' : 'needed_static'}{$2}++; |
adfe19db |
347 | } |
c83e6f19 |
348 | else { warning("Possibly wrong #define $1 in $filename") } |
adfe19db |
349 | } |
350 | |
96ad942f |
351 | for (qw(uses needs uses_todo needed_global needed_static)) { |
352 | for $func (keys %{$file{$_}}) { |
353 | push @{$global{$_}{$func}}, $filename; |
354 | } |
355 | } |
356 | |
adfe19db |
357 | $files{$filename} = \%file; |
358 | } |
359 | |
360 | # Globally resolve NEED_'s |
361 | my $need; |
362 | for $need (keys %{$global{needs}}) { |
363 | if (@{$global{needs}{$need}} > 1) { |
364 | my @targets = @{$global{needs}{$need}}; |
365 | my @t = grep $files{$_}{needed_global}{$need}, @targets; |
366 | @targets = @t if @t; |
367 | @t = grep /\.xs$/i, @targets; |
368 | @targets = @t if @t; |
369 | my $target = shift @targets; |
370 | $files{$target}{needs}{$need} = 'global'; |
371 | for (@{$global{needs}{$need}}) { |
372 | $files{$_}{needs}{$need} = 'extern' if $_ ne $target; |
373 | } |
374 | } |
375 | } |
376 | |
377 | for $filename (@files) { |
378 | exists $files{$filename} or next; |
379 | |
380 | info("=== Analyzing $filename ==="); |
381 | |
382 | my %file = %{$files{$filename}}; |
383 | my $func; |
384 | my $c = $file{code}; |
679ad62d |
385 | my $warnings = 0; |
adfe19db |
386 | |
387 | for $func (sort keys %{$file{uses_Perl}}) { |
388 | if ($API{$func}{varargs}) { |
389 | my $changes = ($c =~ s{\b(Perl_$func\s*\(\s*)(?!aTHX_?)(\)|[^\s)]*\))} |
390 | { $1 . ($2 eq ')' ? 'aTHX' : 'aTHX_ ') . $2 }ge); |
391 | if ($changes) { |
392 | warning("Doesn't pass interpreter argument aTHX to Perl_$func"); |
393 | $file{changes} += $changes; |
394 | } |
395 | } |
396 | else { |
397 | warning("Uses Perl_$func instead of $func"); |
398 | $file{changes} += ($c =~ s{\bPerl_$func(\s*)\((\s*aTHX_?)?\s*} |
399 | {$func$1(}g); |
400 | } |
401 | } |
402 | |
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); |
406 | } |
407 | |
679ad62d |
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}})); |
412 | } |
413 | else { |
414 | diag("Uses $func"); |
415 | } |
adfe19db |
416 | } |
679ad62d |
417 | $warnings += hint($func); |
adfe19db |
418 | } |
419 | |
679ad62d |
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"; |
424 | $warnings++; |
425 | } |
adfe19db |
426 | } |
427 | |
428 | for $func (sort keys %{$file{needed_static}}) { |
429 | my $message = ''; |
430 | if (not exists $file{uses}{$func}) { |
431 | $message = "No need to define NEED_$func if $func is never used"; |
432 | } |
433 | elsif (exists $file{needs}{$func} && $file{needs}{$func} ne 'static') { |
434 | $message = "No need to define NEED_$func when already needed globally"; |
435 | } |
436 | if ($message) { |
437 | diag($message); |
438 | $file{changes} += ($c =~ s/^$HS*#$HS*define$HS+NEED_$func\b.*$LF//mg); |
439 | } |
440 | } |
441 | |
442 | for $func (sort keys %{$file{needed_global}}) { |
443 | my $message = ''; |
444 | if (not exists $global{uses}{$func}) { |
445 | $message = "No need to define NEED_${func}_GLOBAL if $func is never used"; |
446 | } |
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"; |
450 | } |
451 | elsif ($file{needs}{$func} eq 'static') { |
452 | $message = "No need to define NEED_${func}_GLOBAL when only used in this file"; |
453 | } |
454 | } |
455 | if ($message) { |
456 | diag($message); |
457 | $file{changes} += ($c =~ s/^$HS*#$HS*define$HS+NEED_${func}_GLOBAL\b.*$LF//mg); |
458 | } |
459 | } |
460 | |
461 | $file{needs_inc_ppport} = keys %{$file{uses}}; |
462 | |
463 | if ($file{needs_inc_ppport}) { |
464 | my $pp = ''; |
465 | |
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"); |
473 | } |
474 | else { |
475 | diag("File needs $func, adding static request"); |
476 | } |
477 | $pp .= "#define NEED_$func$suffix\n"; |
478 | } |
479 | } |
480 | |
481 | if ($pp && ($c =~ s/^(?=$HS*#$HS*define$HS+NEED_\w+)/$pp/m)) { |
482 | $pp = ''; |
483 | $file{changes}++; |
484 | } |
485 | |
486 | unless ($file{has_inc_ppport}) { |
487 | diag("Needs to include '$ppport'"); |
488 | $pp .= qq(#include "$ppport"\n) |
489 | } |
490 | |
491 | if ($pp) { |
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) |
495 | || ($c =~ s/^/$pp/); |
496 | } |
497 | } |
498 | else { |
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); |
502 | } |
503 | } |
504 | |
505 | # put back in our C comments |
506 | my $ix; |
507 | my $cppc = 0; |
508 | my @ccom = @{$file{ccom}}; |
509 | for $ix (0 .. $#ccom) { |
510 | if (!$opt{cplusplus} && $ccom[$ix] =~ s!^//!!) { |
511 | $cppc++; |
512 | $file{changes} += $c =~ s/$rccs$ix$rcce/$ccs$ccom[$ix] $cce/; |
513 | } |
514 | else { |
515 | $c =~ s/$rccs$ix$rcce/$ccom[$ix]/; |
516 | } |
517 | } |
518 | |
519 | if ($cppc) { |
520 | my $s = $cppc != 1 ? 's' : ''; |
521 | warning("Uses $cppc C++ style comment$s, which is not portable"); |
522 | } |
523 | |
679ad62d |
524 | my $s = $warnings != 1 ? 's' : ''; |
525 | my $warn = $warnings ? " ($warnings warning$s)" : ''; |
526 | info("Analysis completed$warn"); |
527 | |
adfe19db |
528 | if ($file{changes}) { |
529 | if (exists $opt{copy}) { |
530 | my $newfile = "$filename$opt{copy}"; |
531 | if (-e $newfile) { |
532 | error("'$newfile' already exists, refusing to write copy of '$filename'"); |
533 | } |
534 | else { |
535 | local *F; |
536 | if (open F, ">$newfile") { |
537 | info("Writing copy of '$filename' with changes to '$newfile'"); |
538 | print F $c; |
539 | close F; |
540 | } |
541 | else { |
542 | error("Cannot open '$newfile' for writing: $!"); |
543 | } |
544 | } |
545 | } |
546 | elsif (exists $opt{patch} || $opt{changes}) { |
547 | if (exists $opt{patch}) { |
548 | unless ($patch_opened) { |
549 | if (open PATCH, ">$opt{patch}") { |
550 | $patch_opened = 1; |
551 | } |
552 | else { |
553 | error("Cannot open '$opt{patch}' for writing: $!"); |
554 | delete $opt{patch}; |
555 | $opt{changes} = 1; |
556 | goto fallback; |
557 | } |
558 | } |
559 | mydiff(\*PATCH, $filename, $c); |
560 | } |
561 | else { |
562 | fallback: |
563 | info("Suggested changes:"); |
564 | mydiff(\*STDOUT, $filename, $c); |
565 | } |
566 | } |
567 | else { |
568 | my $s = $file{changes} == 1 ? '' : 's'; |
569 | info("$file{changes} potentially required change$s detected"); |
570 | } |
571 | } |
572 | else { |
573 | info("Looks good"); |
574 | } |
575 | } |
576 | |
577 | close PATCH if $patch_opened; |
578 | |
579 | exit 0; |
580 | |
581 | ####################################################################### |
582 | |
c83e6f19 |
583 | sub try_use { eval "use @_;"; return $@ eq '' } |
584 | |
adfe19db |
585 | sub mydiff |
586 | { |
587 | local *F = shift; |
588 | my($file, $str) = @_; |
589 | my $diff; |
590 | |
591 | if (exists $opt{diff}) { |
592 | $diff = run_diff($opt{diff}, $file, $str); |
593 | } |
594 | |
c83e6f19 |
595 | if (!defined $diff and try_use('Text::Diff')) { |
adfe19db |
596 | $diff = Text::Diff::diff($file, \$str, { STYLE => 'Unified' }); |
597 | $diff = <<HEADER . $diff; |
598 | --- $file |
599 | +++ $file.patched |
600 | HEADER |
601 | } |
602 | |
603 | if (!defined $diff) { |
604 | $diff = run_diff('diff -u', $file, $str); |
605 | } |
606 | |
607 | if (!defined $diff) { |
608 | $diff = run_diff('diff', $file, $str); |
609 | } |
610 | |
611 | if (!defined $diff) { |
612 | error("Cannot generate a diff. Please install Text::Diff or use --copy."); |
613 | return; |
614 | } |
615 | |
616 | print F $diff; |
adfe19db |
617 | } |
618 | |
619 | sub run_diff |
620 | { |
621 | my($prog, $file, $str) = @_; |
622 | my $tmp = 'dppptemp'; |
623 | my $suf = 'aaa'; |
624 | my $diff = ''; |
625 | local *F; |
626 | |
627 | while (-e "$tmp.$suf") { $suf++ } |
628 | $tmp = "$tmp.$suf"; |
629 | |
630 | if (open F, ">$tmp") { |
631 | print F $str; |
632 | close F; |
633 | |
634 | if (open F, "$prog $file $tmp |") { |
635 | while (<F>) { |
636 | s/\Q$tmp\E/$file.patched/; |
637 | $diff .= $_; |
638 | } |
639 | close F; |
640 | unlink $tmp; |
641 | return $diff; |
642 | } |
643 | |
644 | unlink $tmp; |
645 | } |
646 | else { |
647 | error("Cannot open '$tmp' for writing: $!"); |
648 | } |
649 | |
650 | return undef; |
651 | } |
652 | |
adfe19db |
653 | sub rec_depend |
654 | { |
af36fda7 |
655 | my($func, $seen) = @_; |
adfe19db |
656 | return () unless exists $depends{$func}; |
af36fda7 |
657 | $seen = {%{$seen||{}}}; |
658 | return () if $seen->{$func}++; |
659 | my %s; |
660 | grep !$s{$_}++, map { ($_, rec_depend($_, $seen)) } @{$depends{$func}}; |
adfe19db |
661 | } |
662 | |
663 | sub parse_version |
664 | { |
665 | my $ver = shift; |
666 | |
667 | if ($ver =~ /^(\d+)\.(\d+)\.(\d+)$/) { |
668 | return ($1, $2, $3); |
669 | } |
670 | elsif ($ver !~ /^\d+\.[\d_]+$/) { |
671 | die "cannot parse version '$ver'\n"; |
672 | } |
673 | |
674 | $ver =~ s/_//g; |
675 | $ver =~ s/$/000000/; |
676 | |
677 | my($r,$v,$s) = $ver =~ /(\d+)\.(\d{3})(\d{3})/; |
678 | |
679 | $v = int $v; |
680 | $s = int $s; |
681 | |
682 | if ($r < 5 || ($r == 5 && $v < 6)) { |
683 | if ($s % 10) { |
684 | die "cannot parse version '$ver'\n"; |
685 | } |
686 | } |
687 | |
688 | return ($r, $v, $s); |
689 | } |
690 | |
691 | sub format_version |
692 | { |
693 | my $ver = shift; |
694 | |
695 | $ver =~ s/$/000000/; |
696 | my($r,$v,$s) = $ver =~ /(\d+)\.(\d{3})(\d{3})/; |
697 | |
698 | $v = int $v; |
699 | $s = int $s; |
700 | |
701 | if ($r < 5 || ($r == 5 && $v < 6)) { |
702 | if ($s % 10) { |
703 | die "invalid version '$ver'\n"; |
704 | } |
705 | $s /= 10; |
706 | |
707 | $ver = sprintf "%d.%03d", $r, $v; |
708 | $s > 0 and $ver .= sprintf "_%02d", $s; |
709 | |
710 | return $ver; |
711 | } |
712 | |
713 | return sprintf "%d.%d.%d", $r, $v, $s; |
714 | } |
715 | |
716 | sub info |
717 | { |
718 | $opt{quiet} and return; |
719 | print @_, "\n"; |
720 | } |
721 | |
722 | sub diag |
723 | { |
724 | $opt{quiet} and return; |
725 | $opt{diag} and print @_, "\n"; |
726 | } |
727 | |
728 | sub warning |
729 | { |
730 | $opt{quiet} and return; |
731 | print "*** ", @_, "\n"; |
732 | } |
733 | |
734 | sub error |
735 | { |
736 | print "*** ERROR: ", @_, "\n"; |
737 | } |
738 | |
739 | my %given_hints; |
679ad62d |
740 | my %given_warnings; |
adfe19db |
741 | sub hint |
742 | { |
743 | $opt{quiet} and return; |
adfe19db |
744 | my $func = shift; |
679ad62d |
745 | my $rv = 0; |
746 | if (exists $warnings{$func} && !$given_warnings{$func}++) { |
747 | my $warn = $warnings{$func}; |
748 | $warn =~ s!^!*** !mg; |
749 | print "*** WARNING: $func\n", $warn; |
750 | $rv++; |
751 | } |
752 | if ($opt{hints} && exists $hints{$func} && !$given_hints{$func}++) { |
753 | my $hint = $hints{$func}; |
754 | $hint =~ s/^/ /mg; |
755 | print " --- hint for $func ---\n", $hint; |
756 | } |
757 | $rv; |
adfe19db |
758 | } |
759 | |
760 | sub usage |
761 | { |
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; |
766 | |
767 | print <<ENDUSAGE; |
768 | |
769 | Usage: $usage |
770 | |
771 | See perldoc $0 for details. |
772 | |
773 | ENDUSAGE |
774 | |
775 | exit 2; |
776 | } |
0d0f8426 |
777 | |
778 | sub strip |
779 | { |
780 | my $self = do { local(@ARGV,$/)=($0); <> }; |
78b4ff79 |
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; |
0d0f8426 |
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"; |
78b4ff79 |
788 | if (\$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"; |
792 | } |
0d0f8426 |
793 | Devel::PPPort::WriteFile(\$0); |
794 | exit 0; |
795 | } |
796 | print <<END; |
797 | |
798 | Sorry, but this is a stripped version of \$0. |
799 | |
800 | To be able to use its original script and doc functionality, |
801 | please try to regenerate this file using: |
802 | |
803 | \$^X \$0 --unstrip |
804 | |
805 | END |
806 | /ms; |
c83e6f19 |
807 | my($pl, $c) = $self =~ /(.*^__DATA__)(.*)/ms; |
808 | $c =~ s{ |
809 | / (?: \*[^*]*\*+(?:[^$ccs][^*]*\*+)* / | /[^\r\n]*) |
810 | | ( "[^"\\]*(?:\\.[^"\\]*)*" |
811 | | '[^'\\]*(?:\\.[^'\\]*)*' ) |
812 | | ($HS+) }{ defined $2 ? ' ' : ($1 || '') }gsex; |
813 | $c =~ s!\s+$!!mg; |
814 | $c =~ s!^$LF!!mg; |
815 | $c =~ s!^\s*#\s*!#!mg; |
816 | $c =~ s!^\s+!!mg; |
0d0f8426 |
817 | |
818 | open OUT, ">$0" or die "cannot strip $0: $!\n"; |
c83e6f19 |
819 | print OUT "$pl$c\n"; |
0d0f8426 |
820 | |
821 | exit 0; |
822 | } |