4 use File::Basename qw(basename dirname);
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
12 # to ensure Configure will look for $Config{startperl}.
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.
19 $file = basename($0, '.PL');
20 $file .= '.com' if $^O eq 'VMS';
22 open OUT,">$file" or die "Can't create $file: $!";
24 print "Extracting $file (with variable substitutions)\n";
26 # In this section, perl variables will be expanded during extraction.
27 # You can use $Config{...} to use Configure variables.
29 print OUT <<"!GROK!THIS!";
31 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
32 if \$running_under_some_shell;
35 # In the following, perl variables are not expanded during extraction.
37 print OUT <<'!NO!SUBS!';
42 use File::Path qw(mkpath);
46 use vars qw($opt_D $opt_d $opt_r $opt_l $opt_h $opt_a $opt_Q);
47 die "-r and -a options are mutually exclusive\n" if ($opt_r and $opt_a);
48 my @inc_dirs = inc_dirs() if $opt_a;
52 my $Dest_dir = $opt_d || $Config{installsitearch};
53 die "Destination directory $Dest_dir doesn't exist or isn't a directory\n"
56 my @isatype = split(' ',<<END);
65 @isatype{@isatype} = (1) x @isatype;
69 @ARGV = ('-') unless @ARGV;
71 build_preamble_if_necessary();
73 my ($t, $tab, %curargs, $new, $eval_index, $dir, $name, $args, $outfile);
75 while (defined (my $file = next_file())) {
76 if (-l $file and -d $file) {
77 link_if_possible($file) if ($opt_l);
81 # Recover from header files with unbalanced cpp directives
85 # $eval_index goes into ``#line'' directives, to help locate syntax errors:
92 ($outfile = $file) =~ s/\.h$/.ph/ || next;
93 print "$file -> $outfile\n" unless $opt_Q;
94 if ($file =~ m|^(.*)/|) {
96 mkpath "$Dest_dir/$dir";
99 if ($opt_a) { # automagic mode: locate header file in @inc_dirs
100 foreach (@inc_dirs) {
106 open(IN,"$file") || (($Exit = 1),(warn "Can't open $file: $!\n"),next);
107 open(OUT,">$Dest_dir/$outfile") || die "Can't create $outfile: $!\n";
110 print OUT "require '_h2ph_pre.ph';\n\n";
111 while (defined (local $_ = next_line())) {
113 if (s/^define\s+(\w+)//) {
117 if (s/^\(([\w,\s]*)\)//) {
122 foreach my $arg (split(/,\s*/,$args)) {
123 $arg =~ s/^\s*([^\s].*[^\s])\s*$/$1/;
126 $args =~ s/\b(\w)/\$$1/g;
127 $args = "local($args) = \@_;\n$t ";
131 $new =~ s/(["\\])/\\$1/g; #"]);
132 $new = reindent($new);
133 $args = reindent($args);
135 $new =~ s/(['\\])/\\$1/g; #']);
138 "eval \"\\n#line $eval_index $outfile\\n\" . 'sub $name $proto\{\n$t ${args}eval q($new);\n$t}' unless defined(\&$name);\n";
142 "eval 'sub $name $proto\{\n$t ${args}eval q($new);\n$t}' unless defined(\&$name);\n";
145 print OUT "unless(defined(\&$name)) {\n sub $name $proto\{\n\t${args}eval q($new);\n }\n}\n";
151 $new = 1 if $new eq '';
152 $new = reindent($new);
153 $args = reindent($args);
155 $new =~ s/(['\\])/\\$1/g; #']);
158 print OUT $t,"eval \"\\n#line $eval_index $outfile\\n\" . 'sub $name () {",$new,";}' unless defined(\&$name);\n";
161 print OUT $t,"eval 'sub $name () {",$new,";}' unless defined(\&$name);\n";
164 # Shunt around such directives as `#define FOO FOO':
165 next if " \&$name" eq $new;
167 print OUT $t,"unless(defined(\&$name)) {\n sub $name () {\t",$new,";}\n}\n";
170 } elsif (/^(include|import)\s*[<"](.*)[>"]/) {
171 ($incl = $2) =~ s/\.h$/.ph/;
172 print OUT $t,"require '$incl';\n";
173 } elsif(/^include_next\s*[<"](.*)[>"]/) {
174 ($incl = $1) =~ s/\.h$/.ph/;
178 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
180 "my(\%INCD) = map { \$INC{\$_} => 1 } ",
181 "(grep { \$_ eq \"$incl\" } keys(\%INC));\n");
183 "my(\@REM) = map { \"\$_/$incl\" } ",
184 "(grep { not exists(\$INCD{\"\$_/$incl\"})",
185 "and -f \"\$_/$incl\" } \@INC);\n");
187 "require \"\$REM[0]\" if \@REM;\n");
189 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
193 "warn(\$\@) if \$\@;\n");
194 } elsif (/^ifdef\s+(\w+)/) {
195 print OUT $t,"if(defined(&$1)) {\n";
197 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
198 } elsif (/^ifndef\s+(\w+)/) {
199 print OUT $t,"unless(defined(&$1)) {\n";
201 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
202 } elsif (s/^if\s+//) {
207 print OUT $t,"if($new) {\n";
209 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
210 } elsif (s/^elif\s+//) {
216 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
217 print OUT $t,"}\n elsif($new) {\n";
219 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
222 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
223 print OUT $t,"} else {\n";
225 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
228 $t = "\t" x ($tab / 8) . ' ' x ($tab % 8);
230 } elsif(/^undef\s+(\w+)/) {
231 print OUT $t, "undef(&$1) if defined(&$1);\n";
232 } elsif(/^error\s+(".*")/) {
233 print OUT $t, "die($1);\n";
234 } elsif(/^error\s+(.*)/) {
235 print OUT $t, "die(\"", quotemeta($1), "\");\n";
236 } elsif(/^warning\s+(.*)/) {
237 print OUT $t, "warn(\"", quotemeta($1), "\");\n";
238 } elsif(/^ident\s+(.*)/) {
239 print OUT $t, "# $1\n";
241 } elsif(/^\s*(typedef\s*)?enum\s*(\s+[a-zA-Z_]\w*\s*)?\{/) {
245 print OUT "# $next\n" if $opt_D;
249 /^\s?(typedef\s?)?enum\s?([a-zA-Z_]\w*)?\s?\{(.*)\}\s?([a-zA-Z_]\w*)?\s?;/;
250 (my $enum_subs = $3) =~ s/\s//g;
251 my @enum_subs = split(/,/, $enum_subs);
253 foreach my $enum (@enum_subs) {
254 my ($enum_name, $enum_value) = $enum =~ /^([a-zA-Z_]\w*)(=.+)?$/;
255 $enum_value =~ s/^=//;
256 $enum_val = (length($enum_value) ? $enum_value : $enum_val + 1);
259 "eval(\"\\n#line $eval_index $outfile\\n",
260 "sub $enum_name () \{ $enum_val; \}\") ",
261 "unless defined(\&$enum_name);\n");
265 "eval(\"sub $enum_name () \{ $enum_val; \}\") ",
266 "unless defined(\&$enum_name);\n");
273 $Is_converted{$file} = 1;
274 queue_includes_from($file) if ($opt_a);
291 $joined_args = join('|', keys(%curargs));
294 s/^\&\&// && do { $new .= " &&"; next;}; # handle && operator
295 s/^\&([\(a-z\)]+)/$1/i; # hack for things that take the address of
296 s/^(\s+)// && do {$new .= ' '; next;};
297 s/^(0X[0-9A-F]+)[UL]*//i && do {$new .= lc($1); next;};
298 s/^(-?\d+\.\d+E[-+]\d+)F?//i && do {$new .= $1; next;};
299 s/^(\d+)\s*[LU]*//i && do {$new .= $1; next;};
300 s/^("(\\"|[^"])*")// && do {$new .= $1; next;};
301 s/^'((\\"|[^"])*)'// && do {
303 $new .= "ord('\$$1')";
309 # replace "sizeof(foo)" with "{foo}"
310 # also, remove * (C dereference operator) to avoid perl syntax
311 # problems. Where the %sizeof array comes from is anyone's
312 # guess (c2ph?), but this at least avoids fatal syntax errors.
313 # Behavior is undefined if sizeof() delimiters are unbalanced.
314 # This code was modified to able to handle constructs like this:
315 # sizeof(*(p)), which appear in the HP-UX 10.01 header files.
316 s/^sizeof\s*\(// && do {
318 my $lvl = 1; # already saw one open paren
319 # tack { on the front, and skip it in the loop
322 # find balanced closing paren
323 while ($index <= length($_) && $lvl > 0) {
324 $lvl++ if substr($_, $index, 1) eq "(";
325 $lvl-- if substr($_, $index, 1) eq ")";
328 # tack } on the end, replacing )
329 substr($_, $index - 1, 1) = "}";
330 # remove pesky * operators within the sizeof argument
331 substr($_, 0, $index - 1) =~ s/\*//g;
335 /\(([\w\s]+)[\*\s]*\)\s*[\w\(]/ && do {
336 foreach (split /\s+/, $1) { # Make sure all the words are types,
337 last unless ($isatype{$_} or $_ eq 'struct');
339 s/\([\w\s]+[\*\s]*\)// && next; # then eliminate them.
341 # struct/union member, including arrays:
342 s/^([_A-Z]\w*(\[[^\]]+\])?((\.|->)[_A-Z]\w*(\[[^\]]+\])?)+)//i && do {
344 $id =~ s/(\.|(->))([^\.\-]*)/->\{$3\}/g;
345 $id =~ s/\b([^\$])($joined_args)/$1\$$2/g if length($joined_args);
346 while($id =~ /\[\s*([^\$\&\d\]]+)\]/) {
349 if(exists($curargs{$index})) {
354 $id =~ s/\[\s*([^\$\&\d\]]+)\]/[$index]/;
358 s/^([_a-zA-Z]\w*)// && do {
360 if ($id eq 'struct') {
364 } elsif ($id =~ /^((un)?signed)|(long)|(short)$/) {
365 while (s/^\s+(\w+)//) { $id .= ' ' . $1; }
370 $new .= '->' if /^[\[\{]/;
371 } elsif ($id eq 'defined') {
374 s/^\s*\((\w),/("$1",/ if $id =~ /^_IO[WR]*$/i; # cheat
376 } elsif ($isatype{$id}) {
377 if ($new =~ /{\s*$/) {
379 } elsif ($new =~ /\(\s*$/ && /^[\s*]*\)/) {
383 $new .= q(').$id.q(');
386 if ($inif && $new !~ /defined\s*\($/) {
387 $new .= '(defined(&' . $id . ') ? &' . $id . ' : 0)';
396 s/^(.)// && do { if ($1 ne '#') { $new .= $1; } next;};
405 READ: while (not eof IN) {
408 next unless length $in;
411 if ($in =~ s/\\$//) { # \-newline
414 } elsif ($in =~ s/^([^"'\\\/]+)//) { # Passthrough
416 } elsif ($in =~ s/^(\\.)//) { # \...
418 } elsif ($in =~ s/^('(\\.|[^'\\])*')//) { # '...
420 } elsif ($in =~ s/^("(\\.|[^"\\])*")//) { # "...
422 } elsif ($in =~ s/^\/\/.*//) { # //...
424 } elsif ($in =~ m/^\/\*/) { # /*...
425 # C comment removal adapted from perlfaq6:
426 if ($in =~ s/^\/\*[^*]*\*+([^\/*][^*]*\*+)*\///) {
428 } else { # Incomplete /* */
431 } elsif ($in =~ s/^(\/)//) { # /...
433 } elsif ($in =~ s/^([^\'\"\\\/]+)//) {
436 die "Cannot parse:\n$in\n";
447 # Handle recursive subdirectories without getting a grotesquely big stack.
448 # Could this be implemented using File::Find?
456 if ($file eq '-' or -f $file or -l $file) {
462 print STDERR "Skipping directory `$file'\n";
467 print STDERR "Skipping `$file': not a file or directory\n";
475 # Put all the files in $directory into @ARGV for processing.
478 my ($directory) = @_;
480 $directory =~ s:/$::;
482 opendir DIR, $directory;
483 foreach (readdir DIR) {
484 next if ($_ eq '.' or $_ eq '..');
486 # expand_glob() is going to be called until $ARGV[0] isn't a
487 # directory; so push directories, and unshift everything else.
488 if (-d "$directory/$_") { push @ARGV, "$directory/$_" }
489 else { unshift @ARGV, "$directory/$_" }
495 # Given $file, a symbolic link to a directory in the C include directory,
496 # make an equivalent symbolic link in $Dest_dir, if we can figure out how.
497 # Otherwise, just duplicate the file or directory.
501 my $target = eval 'readlink($dirlink)';
503 if ($target =~ m:^\.\./: or $target =~ m:^/:) {
504 # The target of a parent or absolute link could leave the $Dest_dir
505 # hierarchy, so let's put all of the contents of $dirlink (actually,
506 # the contents of $target) into @ARGV; as a side effect down the
507 # line, $dirlink will get created as an _actual_ directory.
508 expand_glob($dirlink);
510 if (-l "$Dest_dir/$dirlink") {
511 unlink "$Dest_dir/$dirlink" or
512 print STDERR "Could not remove link $Dest_dir/$dirlink: $!\n";
515 if (eval 'symlink($target, "$Dest_dir/$dirlink")') {
516 print "Linking $target -> $Dest_dir/$dirlink\n";
518 # Make sure that the link _links_ to something:
519 if (! -e "$Dest_dir/$target") {
520 mkpath("$Dest_dir/$target", 0755) or
521 print STDERR "Could not create $Dest_dir/$target/\n";
524 print STDERR "Could not symlink $target -> $Dest_dir/$dirlink: $!\n";
530 # Push all #included files in $file onto our stack, except for STDIN
531 # and files we've already processed.
532 sub queue_includes_from
537 return if ($file eq "-");
539 open HEADER, $file or return;
540 while (defined($line = <HEADER>)) {
541 while (/\\$/) { # Handle continuation lines
546 if ($line =~ /^#\s*include\s+<(.*?)>/) {
547 push(@ARGV, $1) unless $Is_converted{$1};
554 # Determine include directories; $Config{usrinc} should be enough for (all
555 # non-GCC?) C compilers, but gcc uses an additional include directory.
558 my $from_gcc = `$Config{cc} -v 2>&1`;
559 $from_gcc =~ s:^Reading specs from (.*?)/specs\b.*:$1/include:s;
561 length($from_gcc) ? ($from_gcc, $Config{usrinc}) : ($Config{usrinc});
565 # Create "_h2ph_pre.ph", if it doesn't exist or was built by a different
567 sub build_preamble_if_necessary
569 # Increment $VERSION every time this function is modified:
571 my $preamble = "$Dest_dir/_h2ph_pre.ph";
573 # Can we skip building the preamble file?
575 # Extract version number from first line of preamble:
576 open PREAMBLE, $preamble or die "Cannot open $preamble: $!";
577 my $line = <PREAMBLE>;
578 $line =~ /(\b\d+\b)/;
579 close PREAMBLE or die "Cannot close $preamble: $!";
581 # Don't build preamble if a compatible preamble exists:
582 return if $1 == $VERSION;
585 my (%define) = _extract_cc_defines();
587 open PREAMBLE, ">$preamble" or die "Cannot open $preamble: $!";
588 print PREAMBLE "# This file was created by h2ph version $VERSION\n";
590 foreach (sort keys %define) {
592 print PREAMBLE "# $_=$define{$_}\n";
595 if ($define{$_} =~ /^\d+$/) {
597 "unless (defined &$_) { sub $_() { $define{$_} } }\n\n";
598 } elsif ($define{$_} =~ /^\w+$/) {
600 "unless (defined &$_) { sub $_() { &$define{$_} } }\n\n";
603 "unless (defined &$_) { sub $_() { \"",
604 quotemeta($define{$_}), "\" } }\n\n";
607 close PREAMBLE or die "Cannot close $preamble: $!";
611 # %Config contains information on macros that are pre-defined by the
612 # system's compiler. We need this information to make the .ph files
613 # function with perl as the .h files do with cc.
614 sub _extract_cc_defines
617 my $allsymbols = join " ",
618 @Config{'ccsymbols', 'cppsymbols', 'cppccsymbols'};
620 # Split compiler pre-definitions into `key=value' pairs:
621 foreach (split /\s+/, $allsymbols) {
622 /(.+?)=(.+)/ and $define{$1} = $2;
625 print STDERR "$_: $1 -> $2\n";
635 ##############################################################################
640 h2ph - convert .h C header files to .ph Perl header files
644 B<h2ph [-d destination directory] [-r | -a] [-l] [headerfiles]>
649 converts any C header files specified to the corresponding Perl header file
651 It is most easily run while in /usr/include:
653 cd /usr/include; h2ph * sys/*
657 cd /usr/include; h2ph -r -l .
659 The output files are placed in the hierarchy rooted at Perl's
660 architecture dependent library directory. You can specify a different
661 hierarchy with a B<-d> switch.
663 If run with no arguments, filters standard input to standard output.
669 =item -d destination_dir
671 Put the resulting B<.ph> files beneath B<destination_dir>, instead of
672 beneath the default Perl library location (C<$Config{'installsitsearch'}>).
676 Run recursively; if any of B<headerfiles> are directories, then run I<h2ph>
677 on all files in those directories (and their subdirectories, etc.). B<-r>
678 and B<-a> are mutually exclusive.
682 Run automagically; convert B<headerfiles>, as well as any B<.h> files
683 which they include. This option will search for B<.h> files in all
684 directories which your C compiler ordinarily uses. B<-a> and B<-r> are
689 Symbolic links will be replicated in the destination directory. If B<-l>
690 is not specified, then links are skipped over.
694 Put ``hints'' in the .ph files which will help in locating problems with
695 I<h2ph>. In those cases when you B<require> a B<.ph> file containing syntax
696 errors, instead of the cryptic
698 [ some error condition ] at (eval mmm) line nnn
700 you will see the slightly more helpful
702 [ some error condition ] at filename.ph line nnn
704 However, the B<.ph> files almost double in size when built using B<-h>.
708 Include the code from the B<.h> file as a comment in the B<.ph> file.
709 This is primarily used for debugging I<h2ph>.
713 ``Quiet'' mode; don't print out the names of the files being converted.
719 No environment variables are used.
738 The usual warnings if it can't read or write the files involved.
742 Doesn't construct the %sizeof array for you.
744 It doesn't handle all C constructs, but it does attempt to isolate
745 definitions inside evals so that you can get at the definitions
746 that it can translate.
748 It's only intended as a rough tool.
749 You may need to dicker with the files produced.
751 You have to run this program by hand; it's not run as part of the Perl
754 Doesn't handle complicated expressions built piecemeal, a la:
764 Doesn't necessarily locate all of your C compiler's internally-defined
771 close OUT or die "Can't close $file: $!";
772 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
773 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';