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}.
14 # This forces PL files to create target in same directory as PL file.
15 # This is so that make depend always knows where to find PL derivatives.
18 $file = basename($0, '.PL');
19 $file .= '.com' if $^O eq 'VMS';
21 open OUT,">$file" or die "Can't create $file: $!";
23 print "Extracting $file (with variable substitutions)\n";
25 # In this section, perl variables will be expanded during extraction.
26 # You can use $Config{...} to use Configure variables.
28 print OUT <<"!GROK!THIS!";
30 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
31 if \$running_under_some_shell;
34 # In the following, perl variables are not expanded during extraction.
36 print OUT <<'!NO!SUBS!';
40 h2xs - convert .h C header files to Perl extensions
44 B<h2xs> [B<-ACOPXcdf>] [B<-v> version] [B<-n> module_name] [B<-p> prefix] [B<-s> sub] [headerfile ... [extra_libraries]]
50 I<h2xs> builds a Perl extension from C header files. The extension
51 will include functions which can be used to retrieve the value of any
52 #define statement which was in the C header files.
54 The I<module_name> will be used for the name of the extension. If
55 module_name is not supplied then the name of the first header file
56 will be used, with the first character capitalized.
58 If the extension might need extra libraries, they should be included
59 here. The extension Makefile.PL will take care of checking whether
60 the libraries actually exist and how they should be loaded.
61 The extra libraries should be specified in the form -lm -lposix, etc,
62 just as on the cc command line. By default, the Makefile.PL will
63 search through the library path determined by Configure. That path
64 can be augmented by including arguments of the form B<-L/another/library/path>
65 in the extra-libraries argument.
73 Omit all autoload facilities. This is the same as B<-c> but also removes the
74 S<C<use AutoLoader>> statement from the .pm file.
78 Omits creation of the F<Changes> file, and adds a HISTORY section to
83 Additional flags to specify to C preprocessor when scanning header for
84 function declarations. Should not be used without B<-x>.
86 =item B<-M> I<regular expression>
88 selects functions/macros to process.
92 Allows a pre-existing extension directory to be overwritten.
96 Omit the autogenerated stub POD section.
100 Omit the XS portion. Used to generate templates for a module which is not
101 XS-based. C<-c> and C<-f> are implicitly enabled.
105 Generate an accessor method for each element of structs and unions. The
106 generated methods are named after the element name; will return the current
107 value of the element if called without additional arguments; and will set
108 the element to the supplied value (and return the old value) if called with
109 an additional argument.
113 Omit C<constant()> from the .xs file and corresponding specialised
114 C<AUTOLOAD> from the .pm file.
118 Turn on debugging messages.
122 Allows an extension to be created for a header even if that header is
123 not found in standard include directories.
127 Print the usage, help and version for this h2xs and exit.
129 =item B<-n> I<module_name>
131 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
133 =item B<-o> I<regular expression>
135 Use "opaque" data type for the C types matched by the regular
136 expression, even if these types are C<typedef>-equivalent to types
137 from typemaps. Should not be used without B<-x>.
139 This may be useful since, say, types which are C<typedef>-equivalent
140 to integers may represent OS-related handles, and one may want to work
141 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
142 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque types.
144 The type-to-match is whitewashed (except for commas, which have no
145 whitespace before them, and multiple C<*> which have no whitespace
148 =item B<-p> I<prefix>
150 Specify a prefix which should be removed from the Perl function names, e.g., S<-p sec_rgy_>
151 This sets up the XS B<PREFIX> keyword and removes the prefix from functions that are
152 autoloaded via the C<constant()> mechanism.
154 =item B<-s> I<sub1,sub2>
156 Create a perl subroutine for the specified macros rather than autoload with the constant() subroutine.
157 These macros are assumed to have a return type of B<char *>, e.g., S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
159 =item B<-v> I<version>
161 Specify a version number for this extension. This version number is added
162 to the templates. The default is 0.01.
166 Automatically generate XSUBs basing on function declarations in the
167 header file. The package C<C::Scan> should be installed. If this
168 option is specified, the name of the header file may look like
169 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified string,
170 but XSUBs are emitted only for the declarations included from file NAME2.
172 Note that some types of arguments/return-values for functions may
173 result in XSUB-declarations/typemap-entries which need
174 hand-editing. Such may be objects which cannot be converted from/to a
175 pointer (like C<long long>), pointers to functions, or arrays. See
176 also the section on L<LIMITATIONS of B<-x>>.
183 # Default behavior, extension is Rusers
186 # Same, but extension is RUSERS
187 h2xs -n RUSERS rpcsvc/rusers
189 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
192 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
193 h2xs -n ONC::RPC rpcsvc/rusers
195 # Without constant() or AUTOLOAD
196 h2xs -c rpcsvc/rusers
198 # Creates templates for an extension named RPC
201 # Extension is ONC::RPC.
204 # Makefile.PL will look for library -lrpc in
205 # additional directory /opt/net/lib
206 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
208 # Extension is DCE::rgynbase
209 # prefix "sec_rgy_" is dropped from perl function names
210 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
212 # Extension is DCE::rgynbase
213 # prefix "sec_rgy_" is dropped from perl function names
214 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
215 h2xs -n DCE::rgynbase -p sec_rgy_ \
216 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
218 # Make XS without defines in perl.h, but with function declarations
219 # visible from perl.h. Name of the extension is perl1.
220 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
221 # Extra backslashes below because the string is passed to shell.
222 # Note that a directory with perl header files would
223 # be added automatically to include path.
224 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
226 # Same with function declaration in proto.h as visible from perl.h.
227 h2xs -xAn perl2 perl.h,proto.h
229 # Same but select only functions which match /^av_/
230 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
232 # Same but treat SV* etc as "opaque" types
233 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
237 No environment variables are used.
241 Larry Wall and others
245 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
249 The usual warnings if it cannot read or write the files involved.
251 =head1 LIMITATIONS of B<-x>
253 F<h2xs> would not distinguish whether an argument to a C function
254 which is of the form, say, C<int *>, is an input, output, or
255 input/output parameter. In particular, argument declarations of the
262 should be better rewritten as
268 if C<n> is an input parameter.
270 Additionally, F<h2xs> has no facilities to intuit that a function
277 takes a pair of address and length of data at this address, so it is better
278 to rewrite this function as
288 RETVAL = foo(s, len);
298 char *s = SvPV(sv,len);
303 MODULE = foo PACKAGE = foo PREFIX = my_
309 See L<perlxs> and L<perlxstut> for additional details.
316 my( $H2XS_VERSION ) = ' $Revision: 1.20 $ ' =~ /\$Revision:\s+([^\s]+)/;
317 my $TEMPLATE_VERSION = '0.01';
324 die "h2xs [-ACOPXcdfh] [-v version] [-n module_name] [-p prefix] [-s subs] [headerfile [extra_libraries]]
325 version: $H2XS_VERSION
326 -A Omit all autoloading facilities (implies -c).
327 -C Omit creating the Changes file, add HISTORY heading to stub POD.
328 -F Additional flags for C preprocessor (used with -x).
329 -M Mask to select C functions/macros (default is select all).
330 -O Allow overwriting of a pre-existing extension directory.
331 -P Omit the stub POD section.
332 -X Omit the XS portion (implies both -c and -f).
333 -a Generate get/set accessors for struct and union members (used with -x).
334 -c Omit the constant() function and specialised AUTOLOAD from the XS file.
335 -d Turn on debugging messages.
336 -f Force creation of the extension even if the C header does not exist.
337 -h Display this help message
338 -n Specify a name to use for the extension (recommended).
339 -o Regular expression for \"opaque\" types.
340 -p Specify a prefix which should be removed from the Perl function names.
341 -s Create subroutines for specified macros.
342 -v Specify a version number for this extension.
343 -x Autogenerate XSUBs using C::Scan.
345 are any libraries that might be needed for loading the
346 extension, e.g. -lm would try to link in the math library.
351 getopts("ACF:M:OPXacdfhn:o:p:s:v:x") || usage;
352 use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_a $opt_c
353 $opt_d $opt_f $opt_h $opt_n $opt_o $opt_p $opt_s $opt_v $opt_x);
358 $TEMPLATE_VERSION = $opt_v;
362 $opt_c = 1 if $opt_A;
364 # -X implies -c and -f
365 $opt_c = $opt_f = 1 if $opt_X;
367 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
371 while (my $arg = shift) {
372 if ($arg =~ /^-l/i) {
373 $extralibs = "$arg @ARGV";
379 usage "Must supply header file or module name\n"
380 unless (@path_h or $opt_n);
385 $fmask = qr{$opt_M} if defined $opt_M;
386 $tmask = qr{$opt_o} if defined $opt_o;
387 my $tmask_all = $tmask && $opt_o eq '.';
390 eval {require C::Scan; 1}
392 C::Scan required if you use -x option.
393 To install C::Scan, execute
394 perl -MCPAN -e "install C::Scan"
396 unless ($tmask_all) {
397 $C::Scan::VERSION >= 0.70
399 C::Scan v. 0.70 or later required unless you use -o . option.
400 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
401 To install C::Scan, execute
402 perl -MCPAN -e "install C::Scan"
406 elsif ($opt_o or $opt_F) {
408 Options -o and -F do not make sense without -x.
412 my @path_h_ini = @path_h;
413 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
419 if ($^O eq 'VMS') { # Consider overrides of default location
420 # XXXX This is not equivalent to what the older version did:
421 # it was looking at $hadsys header-file per header-file...
422 my($hadsys) = grep s!^sys/!!i , @path_h;
423 @paths = qw( Sys$Library VAXC$Include );
424 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
425 push @paths, qw( DECC$Library_Include DECC$System_Include );
428 @paths = (File::Spec->curdir(), $Config{usrinc},
429 (split ' ', $Config{locincpth}), '/usr/include');
431 foreach my $path_h (@path_h) {
433 if( $path_h =~ s#::#/#g && $opt_n ){
434 warn "Nesting of headerfile ignored with -n\n";
436 $path_h .= ".h" unless $path_h =~ /\.h$/;
437 my $fullpath = $path_h;
438 $path_h =~ s/,.*$// if $opt_x;
439 $fullpath{$path_h} = $fullpath;
441 if (not -f $path_h) {
442 my $tmp_path_h = $path_h;
443 for my $dir (@paths) {
444 last if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
449 die "Can't find $path_h\n" if ( ! $opt_f && ! -f $path_h );
450 # Scan the header file (we should deal with nested header files)
451 # Record the names of simple #define constants into const_names
452 # Function prototypes are processed below.
453 open(CH, "<$path_h") || die "Can't open $path_h: $!\n";
456 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
459 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
462 # Cannot do: (-1) and ((LHANDLE)3) are OK:
463 #print("Skip non-wordy $def => $rest\n"),
464 # next defines if $rest =~ /[^\w\$]/;
466 print("Skip stringy $def => $rest\n") if $opt_d;
469 print "Matched $_ ($def)\n" if $opt_d;
470 $seen_define{$def} = $rest;
472 next if /^_.*_h_*$/i; # special case, but for what?
473 if (defined $opt_p) {
474 if (!/^$opt_p(\d)/) {
475 ++$prefix{$_} if s/^$opt_p//;
478 warn "can't remove $opt_p prefix from '$_'!\n";
481 $prefixless{$def} = $_;
482 if (!$fmask or /$fmask/) {
483 print "... Passes mask of -M.\n" if $opt_d and $fmask;
494 my $module = $opt_n || do {
503 my ($ext, $nested, @modparts, $modfname, $modpname);
504 (chdir 'ext', $ext = 'ext/') if -d 'ext';
506 if( $module =~ /::/ ){
508 @modparts = split(/::/,$module);
509 $modfname = $modparts[-1];
510 $modpname = join('/',@modparts);
515 $modfname = $modpname = $module;
520 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
523 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
528 mkdir("$modpath$_", 0777);
532 mkdir($modpname, 0777);
533 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
538 my $fdecls_parsed = [];
545 my @fnames_no_prefix;
547 if( ! $opt_X ){ # use XS, unless it was disabled
548 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
550 require Config; # Run-time directive
551 warn "Scanning typemaps...\n";
555 my $addflags = $opt_F || '';
557 foreach my $filename (@path_h) {
561 if ($fullpath{$filename} =~ /,/) {
565 warn "Scanning $filename for functions...\n";
566 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
567 'add_cppflags' => $addflags, 'c_styles' => [qw(C++ C9X)];
568 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]);
570 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
571 push(@$fdecls, @{$c->get('fdecls')});
573 push @td, @{$c->get('typedefs_maybe')};
575 my $structs = $c->get('typedef_structs');
576 @structs{keys %$structs} = values %$structs;
579 unless ($tmask_all) {
580 warn "Scanning $filename for typedefs...\n";
581 my $td = $c->get('typedef_hash');
582 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
583 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
584 push @good_td, @f_good_td;
585 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
589 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
591 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
594 for my $i (0..$#$fdecls_parsed) {
595 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
597 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
600 $fdecls = [@$fdecls[@good]];
601 $fdecls_parsed = [@$fdecls_parsed[@good]];
603 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
606 my %h = map( ($_->[1], $_), @$fdecls_parsed);
607 $fdecls_parsed = [ @h{@fnames} ];
609 @fnames_no_prefix = @fnames;
611 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix;
612 # Remove macros which expand to typedefs
613 print "Typedefs are @td.\n" if $opt_d;
614 my %td = map {($_, $_)} @td;
615 # Add some other possible but meaningless values for macros
616 for my $k (qw(char double float int long short unsigned signed void)) {
617 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
619 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
622 while (keys %td > $n) {
625 while (($k, $v) = each %seen_define) {
626 # print("found '$k'=>'$v'\n"),
627 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
630 # Now %bad_macs contains names of bad macros
631 for my $k (keys %bad_macs) {
632 delete $const_names{$prefixless{$k}};
633 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
637 my @const_names = sort keys %const_names;
639 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
642 warn "Writing $ext$modpname/$modfname.pm\n";
652 unless( $opt_X || $opt_c || $opt_A ){
653 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
665 print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled
670 # Are we using AutoLoader or not?
671 unless ($opt_A) { # no autoloader whatsoever.
672 unless ($opt_c) { # we're doing the AUTOLOAD
673 print PM "use AutoLoader;\n";
676 print PM "use AutoLoader qw(AUTOLOAD);\n"
681 my $myISA = 'our @ISA = qw(Exporter'; # We seem to always want this.
682 $myISA .= ' DynaLoader' unless $opt_X; # no XS
684 print PM "\n$myISA\n\n";
686 my @exported_names = (@const_names, @fnames_no_prefix);
689 # Items to export into callers namespace by default. Note: do not export
690 # names by default without a very good reason. Use EXPORT_OK instead.
691 # Do not simply export all your public functions/methods/constants.
693 # This allows declaration use $module ':all';
694 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
696 our %EXPORT_TAGS = ( 'all' => [ qw(
700 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
705 our \$VERSION = '$TEMPLATE_VERSION';
709 print PM <<"END" unless $opt_c or $opt_X;
711 # This AUTOLOAD is used to 'autoload' constants from the constant()
712 # XS function. If a constant is not found then control is passed
713 # to the AUTOLOAD in AutoLoader.
717 (\$constname = \$AUTOLOAD) =~ s/.*:://;
718 croak "&$module::constant not defined" if \$constname eq 'constant';
719 my \$val = constant(\$constname, \@_ ? \$_[0] : 0);
721 if (\$! =~ /Invalid/ || \$!{EINVAL}) {
722 \$AutoLoader::AUTOLOAD = \$AUTOLOAD;
723 goto &AutoLoader::AUTOLOAD;
726 croak "Your vendor has not defined $module macro \$constname";
731 # Fixed between 5.005_53 and 5.005_61
732 if (\$] >= 5.00561) {
733 *\$AUTOLOAD = sub () { \$val };
736 *\$AUTOLOAD = sub { \$val };
744 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
746 bootstrap $module \$VERSION;
751 if( $opt_P ){ # if POD is disabled
760 # Preloaded methods go here.
763 print PM <<"END" unless $opt_A;
765 # Autoload methods go after $after, and are processed by the autosplit program.
774 my $author = "A. U. Thor";
775 my $email = 'a.u.thor@a.galaxy.far.far.away';
778 $revhist = <<EOT if $opt_C;
784 =item $TEMPLATE_VERSION
786 Original version; created by h2xs $H2XS_VERSION with options
801 if (@const_names and not $opt_P) {
803 =head2 Exportable constants
805 @{[join "\n ", @const_names]}
809 if (defined $fdecls and @$fdecls and not $opt_P) {
811 =head2 Exportable functions
814 $exp_doc .= <<EOD if $opt_p;
815 When accessing these functions from Perl, prefix C<$opt_p> should be removed.
819 @{[join "\n ", @known_fnames{@fnames}]}
824 my $pod = <<"END" unless $opt_P;
825 ## Below is stub documentation for your module. You better edit it!
829 #$module - Perl extension for blah blah blah
838 #Stub documentation for $module, created by h2xs. It looks like the
839 #author of the extension was negligent enough to leave the stub
855 $pod =~ s/^\#//gm unless $opt_P;
856 print PM $pod unless $opt_P;
861 if( ! $opt_X ){ # print XS, unless it is disabled
862 warn "Writing $ext$modpname/$modfname.xs\n";
871 foreach my $path_h (@path_h_ini) {
873 $h =~ s#^/usr/include/##;
874 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
875 print XS qq{#include <$h>\n};
880 my %pointer_typedefs;
885 my $out = $pointer_typedefs{$type};
886 return $out if defined $out;
888 $out = ($type =~ /\*$/);
889 # This converts only the guys which do not have trailing part in the typedef
891 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
892 $type = normalize_type($type);
893 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
895 $out = td_is_pointer($type);
897 return ($pointer_typedefs{$otype} = $out);
902 my $out = $struct_typedefs{$type};
903 return $out if defined $out;
905 $out = ($type =~ /^struct\b/) && !td_is_pointer($type);
906 # This converts only the guys which do not have trailing part in the typedef
908 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
909 $type = normalize_type($type);
910 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
912 $out = td_is_struct($type);
914 return ($struct_typedefs{$otype} = $out);
917 # Some macros will bomb if you try to return them from a double-returning func.
918 # Say, ((char *)0), or strlen (if somebody #define STRLEN strlen).
919 # Fortunately, we can detect both these cases...
920 sub protect_convert_to_double {
923 return '' unless defined ($val = $seen_define{$in});
924 return '(IV)' if $known_fnames{$val};
925 # OUT_t of ((OUT_t)-1):
926 return '' unless $val =~ /^\s*(\(\s*)?\(\s*([^()]*?)\s*\)/;
927 td_is_pointer($2) ? '(IV)' : '';
930 # For each of the generated functions, length($pref) leading
931 # letters are already checked. Moreover, it is recommended that
932 # the generated functions uses switch on letter at offset at least
933 # $off + length($pref).
935 # The given list has length($pref) chars removed at front, it is
936 # guarantied that $off leading chars in the rest are the same for all
939 # Returns: how at which offset it was decided to make a switch, or -1 if none.
944 my ($fh, $pref, $off, $list) = (shift,shift,shift,shift);
946 my $offarg = length $pref;
948 if (@$list == 0) { # Can happen on the initial iteration only
951 constant(char *name, int len, int arg)
960 if (@$list == 1) { # Can happen on the initial iteration only
961 my $protect = protect_convert_to_double("$pref$list->[0]");
965 constant(char *name, int len, int arg)
968 if (strEQ(name + $offarg, "$list->[0]")) { /* $pref removed */
969 #ifdef $pref$list->[0]
970 return $protect$pref$list->[0];
984 my $c = substr $n, $off, 1;
985 $leading{$c} = [] unless exists $leading{$c};
986 push @{$leading{$c}}, substr $n, $off + 1;
989 if (keys(%leading) == 1) {
990 return 1 + write_const $fh, $pref, $off + 1, $list;
993 my $leader = substr $list->[0], 0, $off;
994 foreach my $letter (keys %leading) {
995 write_const $fh, "$pref$leader$letter", 0, $leading{$letter}
996 if @{$leading{$letter}} > 1;
999 my $npref = "_$pref";
1000 $npref = '' if $pref eq '';
1004 constant$npref(char *name, int len, int arg)
1008 print $fh <<"END" if $npref eq '';
1012 print $fh <<"END" if $off;
1013 if ($offarg + $off >= len ) {
1020 switch (name[$offarg + $off]) {
1023 foreach my $letter (sort keys %leading) {
1025 $let = '\0' if $letter eq '';
1030 if (@{$leading{$letter}} > 1) {
1031 # It makes sense to call a function
1034 if (!strnEQ(name + $offarg,"$leader", $off))
1039 return constant_$pref$leader$letter(name, len, arg);
1045 = protect_convert_to_double("$pref$leader$letter$leading{$letter}[0]");
1048 if (strEQ(name + $offarg, "$leader$letter$leading{$letter}[0]")) { /* $pref removed */
1049 #ifdef $pref$leader$letter$leading{$letter}[0]
1050 return $protect$pref$leader$letter$leading{$letter}[0];
1077 croak("$module::%s not implemented on this architecture", s);
1083 write_const(\*XS, '', 0, \@const_names);
1087 $prefix = "PREFIX = $opt_p" if defined $opt_p;
1089 # Now switch from C to XS by issuing the first MODULE declaration:
1092 MODULE = $module PACKAGE = $module $prefix
1096 foreach (sort keys %const_xsub) {
1105 croak("Your vendor has not defined the $module macro $_");
1114 # If a constant() function was written then output a corresponding
1116 print XS <<"END" unless $opt_c;
1124 char * s = SvPV(sv, len);
1127 RETVAL = constant(s,len,arg);
1139 my ($type, $name, $args) = @$decl;
1140 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1142 my @argnames = map {$_->[1]} @$args;
1143 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1144 my @argarrays = map { $_->[4] || '' } @$args;
1145 my $numargs = @$args;
1146 if ($numargs and $argtypes[-1] eq '...') {
1148 $argnames[-1] = '...';
1151 $type = normalize_type($type, 1);
1159 for my $arg (0 .. $numargs - 1) {
1161 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1166 sub print_accessors {
1167 my($fh, $name, $struct) = @_;
1168 return unless defined $struct && $name !~ /\s|_ANON/;
1169 $name = normalize_type($name);
1170 my $ptrname = normalize_type("$name *");
1173 MODULE = $module PACKAGE = ${name}Ptr $prefix
1176 my @items = @$struct;
1178 my $item = shift @items;
1179 if ($item->[0] =~ /_ANON/) {
1180 if (defined $item->[1]) {
1182 $_->[0], "$item->[1]_$_->[1]", "$item->[1].$_->[1]"
1183 ], @{ $structs{$item->[0]} };
1185 push @items, @{ $structs{$item->[0]} };
1188 my $type = normalize_type($item->[0]);
1191 $item->[1](THIS, __value = NO_INIT)
1196 RETVAL = THIS->$item->[-1];
1198 THIS->$item->[-1] = __value;
1207 # Should be called before any actual call to normalize_type().
1209 # We do not want to read ./typemap by obvios reasons.
1210 my @tm = qw(../../../typemap ../../typemap ../typemap);
1211 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1212 unshift @tm, $stdtypemap;
1213 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1215 # Start with useful default values
1216 $typemap{float} = 'T_DOUBLE';
1218 foreach my $typemap (@tm) {
1219 next unless -e $typemap ;
1220 # skip directories, binary files etc.
1221 warn " Scanning $typemap\n";
1222 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1223 unless -T $typemap ;
1224 open(TYPEMAP, $typemap)
1225 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1226 my $mode = 'Typemap';
1229 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1230 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1231 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1232 elsif ($mode eq 'Typemap') {
1233 next if /^\s*($|\#)/ ;
1235 if ( ($type, $image) =
1236 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1237 # This may reference undefined functions:
1238 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1239 $typemap{normalize_type($type)} = $image;
1243 close(TYPEMAP) or die "Cannot close $typemap: $!";
1245 %std_types = %types_seen;
1250 sub normalize_type { # Second arg: do not strip const's before \*
1252 my $do_keep_deep_const = shift;
1253 # If $do_keep_deep_const this is heuristical only
1254 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1256 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1257 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1258 $type =~ s/$ignore_mods//go;
1261 $type =~ s/$ignore_mods//go;
1263 $type =~ s/([^\s\w])/ \1 /g;
1267 $type =~ s/\* (?=\*)/*/g;
1268 $type =~ s/\. \. \./.../g;
1270 $types_seen{$type}++
1271 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1277 sub assign_typemap_entry {
1281 if ($tmask and $type =~ /$tmask/) {
1282 print "Type $type matches -o mask\n" if $opt_d;
1283 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1285 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1286 $type = normalize_type $type;
1287 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1288 $entry = assign_typemap_entry($type);
1290 $entry ||= $typemap{$otype}
1291 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1292 $typemap{$otype} = $entry;
1293 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1298 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1300 while (my($name, $struct) = each %structs) {
1301 print_accessors(\*XS, $name, $struct);
1310 warn "Writing $ext$modpname/typemap\n";
1311 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1313 for $type (sort keys %types_seen) {
1314 my $entry = assign_typemap_entry $type;
1315 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1318 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1319 #############################################################################
1322 if (sv_derived_from($arg, \"${ntype}\")) {
1324 char *s = SvPV((SV*)SvRV($arg), len);
1326 if (len != sizeof($var))
1327 croak(\"Size %d of packed data != expected %d\",
1332 croak(\"$var is not of type ${ntype}\")
1333 #############################################################################
1336 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1339 close TM or die "Cannot close typemap file for write: $!";
1344 warn "Writing $ext$modpname/Makefile.PL\n";
1345 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1348 use ExtUtils::MakeMaker;
1349 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1350 # the contents of the Makefile that is written.
1352 'NAME' => '$module',
1353 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION
1354 'PREREQ_PM' => {}, # e.g., Module::Name => 1.1
1356 if (!$opt_X) { # print C stuff, unless XS is disabled
1357 $opt_F = '' unless defined $opt_F;
1359 'LIBS' => ['$extralibs'], # e.g., '-lm'
1360 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1361 'INC' => '', # e.g., '-I/usr/include/other'
1365 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1367 warn "Writing $ext$modpname/test.pl\n";
1368 open(EX, ">test.pl") || die "Can't create $ext$modpname/test.pl: $!\n";
1370 # Before `make install' is performed this script should be runnable with
1371 # `make test'. After `make install' it should work as `perl test.pl'
1373 ######################### We start with some black magic to print on failure.
1375 # Change 1..1 below to 1..last_test_to_print .
1376 # (It may become useful if the test is moved to ./t subdirectory.)
1378 BEGIN { $| = 1; print "1..1\n"; }
1379 END {print "not ok 1\n" unless $loaded;}
1388 ######################### End of black magic.
1390 # Insert your test code below (better if it prints "ok 13"
1391 # (correspondingly "not ok 13") depending on the success of chunk 13
1392 # of the test code):
1395 close(EX) || die "Can't close $ext$modpname/test.pl: $!\n";
1398 warn "Writing $ext$modpname/Changes\n";
1400 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
1401 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
1403 Revision history for Perl extension $module.
1405 $TEMPLATE_VERSION @{[scalar localtime]}
1406 \t- original version; created by h2xs $H2XS_VERSION with options
1410 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
1413 warn "Writing $ext$modpname/MANIFEST\n";
1414 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
1417 eval {opendir(D,'.');};
1418 unless ($@) { @files = readdir(D); closedir(D); }
1420 if (!@files) { @files = map {chomp && $_} `ls`; }
1423 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
1425 # Fix up for case-sensitive file systems
1426 s/$modfname/$modfname/i && next;
1427 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
1428 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
1431 print MANI join("\n",@files), "\n";
1435 close OUT or die "Can't close $file: $!";
1436 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1437 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';