This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
skip unreadable directory test when running as root
[perl5.git] / utils / h2ph.PL
1 #!/usr/local/bin/perl
2
3 use Config;
4 use File::Basename qw(basename dirname);
5 use Cwd;
6
7 # List explicitly here the variables you want Configure to
8 # generate.  Metaconfig only looks for shell variables, so you
9 # have to mention them as if they were shell variables, not
10 # %Config entries.  Thus you write
11 #  $startperl
12 # to ensure Configure will look for $Config{startperl}.
13 # Wanted:  $archlibexp
14
15 # This forces PL files to create target in same directory as PL file.
16 # This is so that make depend always knows where to find PL derivatives.
17 $origdir = cwd;
18 chdir dirname($0);
19 $file = basename($0, '.PL');
20 $file .= '.com' if $^O eq 'VMS';
21
22 open OUT,">$file" or die "Can't create $file: $!";
23
24 print "Extracting $file (with variable substitutions)\n";
25
26 # In this section, perl variables will be expanded during extraction.
27 # You can use $Config{...} to use Configure variables.
28
29 print OUT <<"!GROK!THIS!";
30 $Config{startperl}
31     eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
32         if \$running_under_some_shell;
33 !GROK!THIS!
34
35 # In the following, perl variables are not expanded during extraction.
36
37 print OUT <<'!NO!SUBS!';
38
39 use Config;
40 use File::Path qw(mkpath);
41 use Getopt::Std;
42
43 getopts('Dd:rlhaQ');
44 die "-r and -a options are mutually exclusive\n" if ($opt_r and $opt_a);
45 @inc_dirs = inc_dirs() if $opt_a;
46
47 my $Exit = 0;
48
49 my $Dest_dir = $opt_d || $Config{installsitearch};
50 die "Destination directory $Dest_dir doesn't exist or isn't a directory\n"
51     unless -d $Dest_dir;
52
53 @isatype = split(' ',<<END);
54         char    uchar   u_char
55         short   ushort  u_short
56         int     uint    u_int
57         long    ulong   u_long
58         FILE    key_t   caddr_t
59 END
60
61 @isatype{@isatype} = (1) x @isatype;
62 $inif = 0;
63
64 @ARGV = ('-') unless @ARGV;
65
66 build_preamble_if_necessary();
67
68 while (defined ($file = next_file())) {
69     if (-l $file and -d $file) {
70         link_if_possible($file) if ($opt_l);
71         next;
72     }
73
74     # Recover from header files with unbalanced cpp directives
75     $t = '';
76     $tab = 0;
77
78     # $eval_index goes into ``#line'' directives, to help locate syntax errors:
79     $eval_index = 1;
80
81     if ($file eq '-') {
82         open(IN, "-");
83         open(OUT, ">-");
84     } else {
85         ($outfile = $file) =~ s/\.h$/.ph/ || next;
86         print "$file -> $outfile\n" unless $opt_Q;
87         if ($file =~ m|^(.*)/|) {
88             $dir = $1;
89             mkpath "$Dest_dir/$dir";
90         }
91
92         if ($opt_a) { # automagic mode:  locate header file in @inc_dirs
93             foreach (@inc_dirs) {
94                 chdir $_;
95                 last if -f $file;
96             }
97         }
98
99         open(IN,"$file") || (($Exit = 1),(warn "Can't open $file: $!\n"),next);
100         open(OUT,">$Dest_dir/$outfile") || die "Can't create $outfile: $!\n";
101     }
102
103     print OUT "require '_h2ph_pre.ph';\n\n";
104     while (<IN>) {
105         chop;
106         while (/\\$/) {
107             chop;
108             $_ .= <IN>;
109             chop;
110         }
111         print OUT "# $_\n" if $opt_D;
112
113         if (s:/\*:\200:g) {
114             s:\*/:\201:g;
115             s/\200[^\201]*\201//g;      # delete single line comments
116             if (s/\200.*//) {           # begin multi-line comment?
117                 $_ .= '/*';
118                 $_ .= <IN>;
119                 redo;
120             }
121         }
122         if (s/^\s*\#\s*//) {
123             if (s/^define\s+(\w+)//) {
124                 $name = $1;
125                 $new = '';
126                 s/\s+$//;
127                 if (s/^\(([\w,\s]*)\)//) {
128                     $args = $1;
129                     my $proto = '() ';
130                     if ($args ne '') {
131                         $proto = '';
132                         foreach $arg (split(/,\s*/,$args)) {
133                             $arg =~ s/^\s*([^\s].*[^\s])\s*$/$1/;
134                             $curargs{$arg} = 1;
135                         }
136                         $args =~ s/\b(\w)/\$$1/g;
137                         $args = "local($args) = \@_;\n$t    ";
138                     }
139                     s/^\s+//;
140                     expr();
141                     $new =~ s/(["\\])/\\$1/g;       #"]);
142                     $new = reindent($new);
143                     $args = reindent($args);
144                     if ($t ne '') {
145                         $new =~ s/(['\\])/\\$1/g;   #']);
146                         if ($opt_h) {
147                             print OUT $t,
148                             "eval \"\\n#line $eval_index $outfile\\n\" . 'sub $name $proto\{\n$t    ${args}eval q($new);\n$t}' unless defined(\&$name);\n";
149                             $eval_index++;
150                         } else {
151                             print OUT $t,
152                             "eval 'sub $name $proto\{\n$t    ${args}eval q($new);\n$t}' unless defined(\&$name);\n";
153                         }
154                     } else {
155                       print OUT "unless(defined(\&$name)) {\n    sub $name $proto\{\n\t${args}eval q($new);\n    }\n}\n";
156                     }
157                     %curargs = ();
158                 } else {
159                     s/^\s+//;
160                     expr();
161                     $new = 1 if $new eq '';
162                     $new = reindent($new);
163                     $args = reindent($args);
164                     if ($t ne '') {
165                         $new =~ s/(['\\])/\\$1/g;        #']);
166
167                         if ($opt_h) {
168                             print OUT $t,"eval \"\\n#line $eval_index $outfile\\n\" . 'sub $name () {",$new,";}' unless defined(\&$name);\n";
169                             $eval_index++;
170                         } else {
171                             print OUT $t,"eval 'sub $name () {",$new,";}' unless defined(\&$name);\n";
172                         }
173                     } else {
174                         # Shunt around such directives as `#define FOO FOO':
175                         next if " \&$name" eq $new;
176
177                       print OUT $t,"unless(defined(\&$name)) {\n    sub $name () {\t",$new,";}\n}\n";
178                     }
179                 }
180             } elsif (/^(include|import)\s*[<"](.*)[>"]/) {
181                 ($incl = $2) =~ s/\.h$/.ph/;
182                 print OUT $t,"require '$incl';\n";
183             } elsif(/^include_next\s*[<"](.*)[>"]/) {
184                 ($incl = $1) =~ s/\.h$/.ph/;
185                 print OUT ($t,
186                            "eval {\n");
187                 $tab += 4;
188                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
189                 print OUT ($t,
190                            "my(\%INCD) = map { \$INC{\$_} => 1 } ",
191                            "(grep { \$_ eq \"$incl\" } keys(\%INC));\n");
192                 print OUT ($t,
193                            "my(\@REM) = map { \"\$_/$incl\" } ",
194                            "(grep { not exists(\$INCD{\"\$_/$incl\"})",
195                            "and -f \"\$_/$incl\" } \@INC);\n");
196                 print OUT ($t,
197                            "require \"\$REM[0]\" if \@REM;\n");
198                 $tab -= 4;
199                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
200                 print OUT ($t,
201                            "};\n");
202                 print OUT ($t,
203                            "warn(\$\@) if \$\@;\n");
204             } elsif (/^ifdef\s+(\w+)/) {
205                 print OUT $t,"if(defined(&$1)) {\n";
206                 $tab += 4;
207                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
208             } elsif (/^ifndef\s+(\w+)/) {
209                 print OUT $t,"unless(defined(&$1)) {\n";
210                 $tab += 4;
211                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
212             } elsif (s/^if\s+//) {
213                 $new = '';
214                 $inif = 1;
215                 expr();
216                 $inif = 0;
217                 print OUT $t,"if($new) {\n";
218                 $tab += 4;
219                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
220             } elsif (s/^elif\s+//) {
221                 $new = '';
222                 $inif = 1;
223                 expr();
224                 $inif = 0;
225                 $tab -= 4;
226                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
227                 print OUT $t,"}\n elsif($new) {\n";
228                 $tab += 4;
229                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
230             } elsif (/^else/) {
231                 $tab -= 4;
232                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
233                 print OUT $t,"} else {\n";
234                 $tab += 4;
235                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
236             } elsif (/^endif/) {
237                 $tab -= 4;
238                 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
239                 print OUT $t,"}\n";
240             } elsif(/^undef\s+(\w+)/) {
241                 print OUT $t, "undef(&$1) if defined(&$1);\n";
242             } elsif(/^error\s+(".*")/) {
243                 print OUT $t, "die($1);\n";
244             } elsif(/^error\s+(.*)/) {
245                 print OUT $t, "die(\"", quotemeta($1), "\");\n";
246             } elsif(/^warning\s+(.*)/) {
247                 print OUT $t, "warn(\"", quotemeta($1), "\");\n";
248             } elsif(/^ident\s+(.*)/) {
249                 print OUT $t, "# $1\n";
250             }
251         } elsif(/^\s*(typedef\s*)?enum\s*(\s+[a-zA-Z_]\w*\s*)?\{/) {
252             until(/\}.*?;/) {
253                 chomp($next = <IN>);
254                 $_ .= $next;
255                 print OUT "# $next\n" if $opt_D;
256             }
257             s@/\*.*?\*/@@g;
258             s/\s+/ /g;
259             /^\s?(typedef\s?)?enum\s?([a-zA-Z_]\w*)?\s?\{(.*)\}\s?([a-zA-Z_]\w*)?\s?;/;
260             ($enum_subs = $3) =~ s/\s//g;
261             @enum_subs = split(/,/, $enum_subs);
262             $enum_val = -1;
263             for $enum (@enum_subs) {
264                 ($enum_name, $enum_value) = $enum =~ /^([a-zA-Z_]\w*)(=.+)?$/;
265                 $enum_value =~ s/^=//;
266                 $enum_val = (length($enum_value) ? $enum_value : $enum_val + 1);
267                 if ($opt_h) {
268                     print OUT ($t,
269                                "eval(\"\\n#line $eval_index $outfile\\n",
270                                "sub $enum_name () \{ $enum_val; \}\") ",
271                                "unless defined(\&$enum_name);\n");
272                     ++ $eval_index;
273                 } else {
274                     print OUT ($t,
275                                "eval(\"sub $enum_name () \{ $enum_val; \}\") ",
276                                "unless defined(\&$enum_name);\n");
277                 }
278             }
279         }
280     }
281     print OUT "1;\n";
282
283     $is_converted{$file} = 1;
284     queue_includes_from($file) if ($opt_a);
285 }
286
287 exit $Exit;
288
289 sub reindent($) {
290     my($text) = shift;
291     $text =~ s/\n/\n    /g;
292     $text =~ s/        /\t/g;
293     $text;
294 }
295
296 sub expr {
297     if(keys(%curargs)) {
298         my($joined_args) = join('|', keys(%curargs));
299     }
300     while ($_ ne '') {
301         s/^\&\&// && do { $new .= " &&"; next;}; # handle && operator
302         s/^\&([\(a-z\)]+)/$1/i; # hack for things that take the address of
303         s/^(\s+)//              && do {$new .= ' '; next;};
304         s/^(0X[0-9A-F]+)[UL]*//i        && do {$new .= lc($1); next;};
305         s/^(-?\d+\.\d+E[-+]\d+)F?//i    && do {$new .= $1; next;};
306         s/^(\d+)\s*[LU]*//i     && do {$new .= $1; next;};
307         s/^("(\\"|[^"])*")//    && do {$new .= $1; next;};
308         s/^'((\\"|[^"])*)'//    && do {
309             if ($curargs{$1}) {
310                 $new .= "ord('\$$1')";
311             } else {
312                 $new .= "ord('$1')";
313             }
314             next;
315         };
316         # replace "sizeof(foo)" with "{foo}"
317         # also, remove * (C dereference operator) to avoid perl syntax
318         # problems.  Where the %sizeof array comes from is anyone's
319         # guess (c2ph?), but this at least avoids fatal syntax errors.
320         # Behavior is undefined if sizeof() delimiters are unbalanced.
321         # This code was modified to able to handle constructs like this:
322         #   sizeof(*(p)), which appear in the HP-UX 10.01 header files.
323         s/^sizeof\s*\(// && do {
324             $new .= '$sizeof';
325             my $lvl = 1;  # already saw one open paren
326             # tack { on the front, and skip it in the loop
327             $_ = "{" . "$_";
328             my $index = 1;
329             # find balanced closing paren
330             while ($index <= length($_) && $lvl > 0) {
331                 $lvl++ if substr($_, $index, 1) eq "(";
332                 $lvl-- if substr($_, $index, 1) eq ")";
333                 $index++;
334             }
335             # tack } on the end, replacing )
336             substr($_, $index - 1, 1) = "}";
337             # remove pesky * operators within the sizeof argument
338             substr($_, 0, $index - 1) =~ s/\*//g;
339             next;
340         };
341         # Eliminate typedefs
342         /\(([\w\s]+)[\*\s]*\)\s*[\w\(]/ && do {
343             foreach (split /\s+/, $1) {  # Make sure all the words are types,
344                 last unless ($isatype{$_} or $_ eq 'struct');
345             }
346             s/\([\w\s]+[\*\s]*\)// && next;      # then eliminate them.
347         };
348         # struct/union member, including arrays:
349         s/^([_A-Z]\w*(\[[^\]]+\])?((\.|->)[_A-Z]\w*(\[[^\]]+\])?)+)//i && do {
350             $id = $1;
351             $id =~ s/(\.|(->))([^\.\-]*)/->\{$3\}/g;
352             $id =~ s/\b([^\$])($joined_args)/$1\$$2/g if length($joined_args);
353             while($id =~ /\[\s*([^\$\&\d\]]+)\]/) {
354                 my($index) = $1;
355                 $index =~ s/\s//g;
356                 if(exists($curargs{$index})) {
357                     $index = "\$$index";
358                 } else {
359                     $index = "&$index";
360                 }
361                 $id =~ s/\[\s*([^\$\&\d\]]+)\]/[$index]/;
362             }
363             $new .= " (\$$id)";
364         };
365         s/^([_a-zA-Z]\w*)//     && do {
366             $id = $1;
367             if ($id eq 'struct') {
368                 s/^\s+(\w+)//;
369                 $id .= ' ' . $1;
370                 $isatype{$id} = 1;
371             } elsif ($id =~ /^((un)?signed)|(long)|(short)$/) {
372                 while (s/^\s+(\w+)//) { $id .= ' ' . $1; }
373                 $isatype{$id} = 1;
374             }
375             if ($curargs{$id}) {
376                 $new .= "\$$id";
377                 $new .= '->' if /^[\[\{]/;
378             } elsif ($id eq 'defined') {
379                 $new .= 'defined';
380             } elsif (/^\(/) {
381                 s/^\((\w),/("$1",/ if $id =~ /^_IO[WR]*$/i;     # cheat
382                 $new .= " &$id";
383             } elsif ($isatype{$id}) {
384                 if ($new =~ /{\s*$/) {
385                     $new .= "'$id'";
386                 } elsif ($new =~ /\(\s*$/ && /^[\s*]*\)/) {
387                     $new =~ s/\(\s*$//;
388                     s/^[\s*]*\)//;
389                 } else {
390                     $new .= q(').$id.q(');
391                 }
392             } else {
393                 if ($inif && $new !~ /defined\s*\($/) {
394                     $new .= '(defined(&' . $id . ') ? &' . $id . ' : 0)';
395                 } elsif (/^\[/) {
396                     $new .= " \$$id";
397                 } else {
398                     $new .= ' &' . $id;
399                 }
400             }
401             next;
402         };
403         s/^(.)// && do { if ($1 ne '#') { $new .= $1; } next;};
404     }
405 }
406
407
408 # Handle recursive subdirectories without getting a grotesquely big stack.
409 # Could this be implemented using File::Find?
410 sub next_file
411 {
412     my $file;
413
414     while (@ARGV) {
415         $file = shift @ARGV;
416
417         if ($file eq '-' or -f $file or -l $file) {
418             return $file;
419         } elsif (-d $file) {
420             if ($opt_r) {
421                 expand_glob($file);
422             } else {
423                 print STDERR "Skipping directory `$file'\n";
424             }
425         } elsif ($opt_a) {
426             return $file;
427         } else {
428             print STDERR "Skipping `$file':  not a file or directory\n";
429         }
430     }
431
432     return undef;
433 }
434
435
436 # Put all the files in $directory into @ARGV for processing.
437 sub expand_glob
438 {
439     my ($directory)  = @_;
440
441     $directory =~ s:/$::;
442
443     opendir DIR, $directory;
444         foreach (readdir DIR) {
445             next if ($_ eq '.' or $_ eq '..');
446
447             # expand_glob() is going to be called until $ARGV[0] isn't a
448             # directory; so push directories, and unshift everything else.
449             if (-d "$directory/$_") { push    @ARGV, "$directory/$_" }
450             else                    { unshift @ARGV, "$directory/$_" }
451         }
452     closedir DIR;
453 }
454
455
456 # Given $file, a symbolic link to a directory in the C include directory,
457 # make an equivalent symbolic link in $Dest_dir, if we can figure out how.
458 # Otherwise, just duplicate the file or directory.
459 sub link_if_possible
460 {
461     my ($dirlink)  = @_;
462     my $target  = eval 'readlink($dirlink)';
463
464     if ($target =~ m:^\.\./: or $target =~ m:^/:) {
465         # The target of a parent or absolute link could leave the $Dest_dir
466         # hierarchy, so let's put all of the contents of $dirlink (actually,
467         # the contents of $target) into @ARGV; as a side effect down the
468         # line, $dirlink will get created as an _actual_ directory.
469         expand_glob($dirlink);
470     } else {
471         if (-l "$Dest_dir/$dirlink") {
472             unlink "$Dest_dir/$dirlink" or
473                 print STDERR "Could not remove link $Dest_dir/$dirlink:  $!\n";
474         }
475
476         if (eval 'symlink($target, "$Dest_dir/$dirlink")') {
477             print "Linking $target -> $Dest_dir/$dirlink\n";
478
479             # Make sure that the link _links_ to something:
480             if (! -e "$Dest_dir/$target") {
481                 mkpath("$Dest_dir/$target", 0755) or
482                     print STDERR "Could not create $Dest_dir/$target/\n";
483             }
484         } else {
485             print STDERR "Could not symlink $target -> $Dest_dir/$dirlink:  $!\n";
486         }
487     }
488 }
489
490
491 # Push all #included files in $file onto our stack, except for STDIN
492 # and files we've already processed.
493 sub queue_includes_from
494 {
495     my ($file)    = @_;
496     my $line;
497
498     return if ($file eq "-");
499
500     open HEADER, $file or return;
501         while (defined($line = <HEADER>)) {
502             while (/\\$/) { # Handle continuation lines
503                 chop $line;
504                 $line .= <HEADER>;
505             }
506
507             if ($line =~ /^#\s*include\s+<(.*?)>/) {
508                 push(@ARGV, $1) unless $is_converted{$1};
509             }
510         }
511     close HEADER;
512 }
513
514
515 # Determine include directories; $Config{usrinc} should be enough for (all
516 # non-GCC?) C compilers, but gcc uses an additional include directory.
517 sub inc_dirs
518 {
519     my $from_gcc    = `$Config{cc} -v 2>&1`;
520     $from_gcc       =~ s:^Reading specs from (.*?)/specs\b.*:$1/include:s;
521
522     length($from_gcc) ? ($from_gcc, $Config{usrinc}) : ($Config{usrinc});
523 }
524
525
526 # Create "_h2ph_pre.ph", if it doesn't exist or was built by a different
527 # version of h2ph.
528 sub build_preamble_if_necessary
529 {
530     # Increment $VERSION every time this function is modified:
531     my $VERSION     = 2;
532     my $preamble    = "$Dest_dir/_h2ph_pre.ph";
533
534     # Can we skip building the preamble file?
535     if (-r $preamble) {
536         # Extract version number from first line of preamble:
537         open  PREAMBLE, $preamble or die "Cannot open $preamble:  $!";
538             my $line = <PREAMBLE>;
539             $line =~ /(\b\d+\b)/;
540         close PREAMBLE            or die "Cannot close $preamble:  $!";
541
542         # Don't build preamble if a compatible preamble exists:
543         return if $1 == $VERSION;
544     }
545
546     my (%define) = _extract_cc_defines();
547
548     open  PREAMBLE, ">$preamble" or die "Cannot open $preamble:  $!";
549         print PREAMBLE "# This file was created by h2ph version $VERSION\n";
550
551         foreach (sort keys %define) {
552             if ($opt_D) {
553                 print PREAMBLE "# $_=$define{$_}\n";
554             }
555
556             if ($define{$_} =~ /^\d+$/) {
557                 print PREAMBLE
558                     "unless (defined &$_) { sub $_() { $define{$_} } }\n\n";
559             } elsif ($define{$_} =~ /^\w+$/) {
560                 print PREAMBLE
561                     "unless (defined &$_) { sub $_() { &$define{$_} } }\n\n";
562             } else {
563                 print PREAMBLE
564                     "unless (defined &$_) { sub $_() { \"",
565                     quotemeta($define{$_}), "\" } }\n\n";
566             }
567         }
568     close PREAMBLE               or die "Cannot close $preamble:  $!";
569 }
570
571
572 # %Config contains information on macros that are pre-defined by the
573 # system's compiler.  We need this information to make the .ph files
574 # function with perl as the .h files do with cc.
575 sub _extract_cc_defines
576 {
577     my %define;
578     my $allsymbols = join " ", @Config{ccsymbols, cppsymbols, cppccsymbols};
579
580     # Split compiler pre-definitions into `key=value' pairs:
581     foreach (split /\s+/, $allsymbols) {
582         /(.+?)=(.+)/ and $define{$1} = $2;
583
584         if ($opt_D) {
585             print STDERR "$_:  $1 -> $2\n";
586         }
587     }
588
589     return %define;
590 }
591
592
593 1;
594
595 ##############################################################################
596 __END__
597
598 =head1 NAME
599
600 h2ph - convert .h C header files to .ph Perl header files
601
602 =head1 SYNOPSIS
603
604 B<h2ph [-d destination directory] [-r | -a] [-l] [headerfiles]>
605
606 =head1 DESCRIPTION
607
608 I<h2ph>
609 converts any C header files specified to the corresponding Perl header file
610 format.
611 It is most easily run while in /usr/include:
612
613         cd /usr/include; h2ph * sys/*
614
615 or
616
617         cd /usr/include; h2ph -r -l .
618
619 The output files are placed in the hierarchy rooted at Perl's
620 architecture dependent library directory.  You can specify a different
621 hierarchy with a B<-d> switch.
622
623 If run with no arguments, filters standard input to standard output.
624
625 =head1 OPTIONS
626
627 =over 4
628
629 =item -d destination_dir
630
631 Put the resulting B<.ph> files beneath B<destination_dir>, instead of
632 beneath the default Perl library location (C<$Config{'installsitsearch'}>).
633
634 =item -r
635
636 Run recursively; if any of B<headerfiles> are directories, then run I<h2ph>
637 on all files in those directories (and their subdirectories, etc.).  B<-r>
638 and B<-a> are mutually exclusive.
639
640 =item -a
641
642 Run automagically; convert B<headerfiles>, as well as any B<.h> files
643 which they include.  This option will search for B<.h> files in all
644 directories which your C compiler ordinarily uses.  B<-a> and B<-r> are
645 mutually exclusive.
646
647 =item -l
648
649 Symbolic links will be replicated in the destination directory.  If B<-l>
650 is not specified, then links are skipped over.
651
652 =item -h
653
654 Put ``hints'' in the .ph files which will help in locating problems with
655 I<h2ph>.  In those cases when you B<require> a B<.ph> file containing syntax
656 errors, instead of the cryptic
657
658         [ some error condition ] at (eval mmm) line nnn
659
660 you will see the slightly more helpful
661
662         [ some error condition ] at filename.ph line nnn
663
664 However, the B<.ph> files almost double in size when built using B<-h>.
665
666 =item -D
667
668 Include the code from the B<.h> file as a comment in the B<.ph> file.
669 This is primarily used for debugging I<h2ph>.
670
671 =item -Q
672
673 ``Quiet'' mode; don't print out the names of the files being converted.
674
675 =back
676
677 =head1 ENVIRONMENT
678
679 No environment variables are used.
680
681 =head1 FILES
682
683  /usr/include/*.h
684  /usr/include/sys/*.h
685
686 etc.
687
688 =head1 AUTHOR
689
690 Larry Wall
691
692 =head1 SEE ALSO
693
694 perl(1)
695
696 =head1 DIAGNOSTICS
697
698 The usual warnings if it can't read or write the files involved.
699
700 =head1 BUGS
701
702 Doesn't construct the %sizeof array for you.
703
704 It doesn't handle all C constructs, but it does attempt to isolate
705 definitions inside evals so that you can get at the definitions
706 that it can translate.
707
708 It's only intended as a rough tool.
709 You may need to dicker with the files produced.
710
711 Doesn't run with C<use strict>
712
713 You have to run this program by hand; it's not run as part of the Perl
714 installation.
715
716 Doesn't handle complicated expressions built piecemeal, a la:
717
718     enum {
719         FIRST_VALUE,
720         SECOND_VALUE,
721     #ifdef ABC
722         THIRD_VALUE
723     #endif
724     };
725
726 Doesn't necessarily locate all of your C compiler's internally-defined
727 symbols.
728
729 =cut
730
731 !NO!SUBS!
732
733 close OUT or die "Can't close $file: $!";
734 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
735 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';
736 chdir $origdir;