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 Omit C<constant()> from the .xs file and corresponding specialised
106 C<AUTOLOAD> from the .pm file.
110 Turn on debugging messages.
114 Allows an extension to be created for a header even if that header is
115 not found in standard include directories.
119 Print the usage, help and version for this h2xs and exit.
121 =item B<-n> I<module_name>
123 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
125 =item B<-o> I<regular expression>
127 Use "opaque" data type for the C types matched by the regular
128 expression, even if these types are C<typedef>-equivalent to types
129 from typemaps. Should not be used without B<-x>.
131 This may be useful since, say, types which are C<typedef>-equivalent
132 to integers may represent OS-related handles, and one may want to work
133 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
134 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque types.
136 The type-to-match is whitewashed (except for commas, which have no
137 whitespace before them, and multiple C<*> which have no whitespace
140 =item B<-p> I<prefix>
142 Specify a prefix which should be removed from the Perl function names, e.g., S<-p sec_rgy_>
143 This sets up the XS B<PREFIX> keyword and removes the prefix from functions that are
144 autoloaded via the C<constant()> mechanism.
146 =item B<-s> I<sub1,sub2>
148 Create a perl subroutine for the specified macros rather than autoload with the constant() subroutine.
149 These macros are assumed to have a return type of B<char *>, e.g., S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
151 =item B<-v> I<version>
153 Specify a version number for this extension. This version number is added
154 to the templates. The default is 0.01.
158 Automatically generate XSUBs basing on function declarations in the
159 header file. The package C<C::Scan> should be installed. If this
160 option is specified, the name of the header file may look like
161 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified string,
162 but XSUBs are emitted only for the declarations included from file NAME2.
164 Note that some types of arguments/return-values for functions may
165 result in XSUB-declarations/typemap-entries which need
166 hand-editing. Such may be objects which cannot be converted from/to a
167 pointer (like C<long long>), pointers to functions, or arrays. See
168 also the section on L<LIMITATIONS of B<-x>>.
175 # Default behavior, extension is Rusers
178 # Same, but extension is RUSERS
179 h2xs -n RUSERS rpcsvc/rusers
181 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
184 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
185 h2xs -n ONC::RPC rpcsvc/rusers
187 # Without constant() or AUTOLOAD
188 h2xs -c rpcsvc/rusers
190 # Creates templates for an extension named RPC
193 # Extension is ONC::RPC.
196 # Makefile.PL will look for library -lrpc in
197 # additional directory /opt/net/lib
198 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
200 # Extension is DCE::rgynbase
201 # prefix "sec_rgy_" is dropped from perl function names
202 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
204 # Extension is DCE::rgynbase
205 # prefix "sec_rgy_" is dropped from perl function names
206 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
207 h2xs -n DCE::rgynbase -p sec_rgy_ \
208 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
210 # Make XS without defines in perl.h, but with function declarations
211 # visible from perl.h. Name of the extension is perl1.
212 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
213 # Extra backslashes below because the string is passed to shell.
214 # Note that a directory with perl header files would
215 # be added automatically to include path.
216 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
218 # Same with function declaration in proto.h as visible from perl.h.
219 h2xs -xAn perl2 perl.h,proto.h
221 # Same but select only functions which match /^av_/
222 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
224 # Same but treat SV* etc as "opaque" types
225 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
229 No environment variables are used.
233 Larry Wall and others
237 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
241 The usual warnings if it cannot read or write the files involved.
243 =head1 LIMITATIONS of B<-x>
245 F<h2xs> would not distinguish whether an argument to a C function
246 which is of the form, say, C<int *>, is an input, output, or
247 input/output parameter. In particular, argument declarations of the
254 should be better rewritten as
260 if C<n> is an input parameter.
262 Additionally, F<h2xs> has no facilities to intuit that a function
269 takes a pair of address and length of data at this address, so it is better
270 to rewrite this function as
280 RETVAL = foo(s, len);
290 char *s = SvPV(sv,len);
295 MODULE = foo PACKAGE = foo PREFIX = my_
301 See L<perlxs> and L<perlxstut> for additional details.
308 my( $H2XS_VERSION ) = ' $Revision: 1.20 $ ' =~ /\$Revision:\s+([^\s]+)/;
309 my $TEMPLATE_VERSION = '0.01';
316 die "h2xs [-ACOPXcdfh] [-v version] [-n module_name] [-p prefix] [-s subs] [headerfile [extra_libraries]]
317 version: $H2XS_VERSION
318 -A Omit all autoloading facilities (implies -c).
319 -C Omit creating the Changes file, add HISTORY heading to stub POD.
320 -F Additional flags for C preprocessor (used with -x).
321 -M Mask to select C functions/macros (default is select all).
322 -O Allow overwriting of a pre-existing extension directory.
323 -P Omit the stub POD section.
324 -X Omit the XS portion (implies both -c and -f).
325 -c Omit the constant() function and specialised AUTOLOAD from the XS file.
326 -d Turn on debugging messages.
327 -f Force creation of the extension even if the C header does not exist.
328 -h Display this help message
329 -n Specify a name to use for the extension (recommended).
330 -o Regular expression for \"opaque\" types.
331 -p Specify a prefix which should be removed from the Perl function names.
332 -s Create subroutines for specified macros.
333 -v Specify a version number for this extension.
334 -x Autogenerate XSUBs using C::Scan.
336 are any libraries that might be needed for loading the
337 extension, e.g. -lm would try to link in the math library.
342 getopts("ACF:M:OPXcdfhn:o:p:s:v:x") || usage;
343 use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_c
344 $opt_d $opt_f $opt_h $opt_n $opt_o $opt_p $opt_s $opt_v $opt_x);
349 $TEMPLATE_VERSION = $opt_v;
353 $opt_c = 1 if $opt_A;
355 # -X implies -c and -f
356 $opt_c = $opt_f = 1 if $opt_X;
358 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
362 while (my $arg = shift) {
363 if ($arg =~ /^-l/i) {
364 $extralibs = "$arg @ARGV";
370 usage "Must supply header file or module name\n"
371 unless (@path_h or $opt_n);
376 $fmask = qr{$opt_M} if defined $opt_M;
377 $tmask = qr{$opt_o} if defined $opt_o;
378 my $tmask_all = $tmask && $opt_o eq '.';
381 eval {require C::Scan; 1}
383 C::Scan required if you use -x option.
384 To install C::Scan, execute
385 perl -MCPAN -e "install C::Scan"
387 unless ($tmask_all) {
388 $C::Scan::VERSION >= 0.70
390 C::Scan v. 0.70 or later required unless you use -o . option.
391 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
392 To install C::Scan, execute
393 perl -MCPAN -e "install C::Scan"
396 } elsif ($opt_o or $opt_F) {
398 Options -o and -F do not make sense without -x.
402 my @path_h_ini = @path_h;
403 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
409 if ($^O eq 'VMS') { # Consider overrides of default location
410 # XXXX This is not equivalent to what the older version did:
411 # it was looking at $hadsys header-file per header-file...
412 my($hadsys) = grep s!^sys/!!i , @path_h;
413 @paths = qw( Sys\$Library VAXC$Include );
414 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
415 push @paths, qw( DECC$Library_Include DECC$System_Include );
417 @paths = (File::Spec->curdir(), $Config{usrinc},
418 (split ' ', $Config{locincpth}), '/usr/include');
420 foreach my $path_h (@path_h) {
422 if( $path_h =~ s#::#/#g && $opt_n ){
423 warn "Nesting of headerfile ignored with -n\n";
425 $path_h .= ".h" unless $path_h =~ /\.h$/;
426 my $fullpath = $path_h;
427 $path_h =~ s/,.*$// if $opt_x;
428 $fullpath{$path_h} = $fullpath;
430 if (not -f $path_h) {
431 my $tmp_path_h = $path_h;
432 for my $dir (@paths) {
433 last if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
438 die "Can't find $path_h\n" if ( ! $opt_f && ! -f $path_h );
439 # Scan the header file (we should deal with nested header files)
440 # Record the names of simple #define constants into const_names
441 # Function prototypes are processed below.
442 open(CH, "<$path_h") || die "Can't open $path_h: $!\n";
445 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
448 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
451 # Cannot do: (-1) and ((LHANDLE)3) are OK:
452 #print("Skip non-wordy $def => $rest\n"),
453 # next defines if $rest =~ /[^\w\$]/;
455 print("Skip stringy $def => $rest\n") if $opt_d;
458 print "Matched $_ ($def)\n" if $opt_d;
459 $seen_define{$def} = $rest;
461 next if /^_.*_h_*$/i; # special case, but for what?
462 if (defined $opt_p) {
463 if (!/^$opt_p(\d)/) {
464 ++$prefix{$_} if s/^$opt_p//;
467 warn "can't remove $opt_p prefix from '$_'!\n";
470 $prefixless{$def} = $_;
471 if (!$fmask or /$fmask/) {
472 print "... Passes mask of -M.\n" if $opt_d and $fmask;
483 my $module = $opt_n || do {
492 my ($ext, $nested, @modparts, $modfname, $modpname);
493 (chdir 'ext', $ext = 'ext/') if -d 'ext';
495 if( $module =~ /::/ ){
497 @modparts = split(/::/,$module);
498 $modfname = $modparts[-1];
499 $modpname = join('/',@modparts);
504 $modfname = $modpname = $module;
509 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
511 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
516 mkdir("$modpath$_", 0777);
520 mkdir($modpname, 0777);
521 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
526 my $fdecls_parsed = [];
532 my @fnames_no_prefix;
534 if( ! $opt_X ){ # use XS, unless it was disabled
535 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
537 require Config; # Run-time directive
538 warn "Scanning typemaps...\n";
542 my $addflags = $opt_F || '';
544 foreach my $filename (@path_h) {
548 if ($fullpath{$filename} =~ /,/) {
552 warn "Scanning $filename for functions...\n";
553 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
554 'add_cppflags' => $addflags;
555 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]);
557 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
558 push(@$fdecls, @{$c->get('fdecls')});
560 push @td, @{$c->get('typedefs_maybe')};
562 unless ($tmask_all) {
563 warn "Scanning $filename for typedefs...\n";
564 my $td = $c->get('typedef_hash');
565 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
566 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
567 push @good_td, @f_good_td;
568 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
572 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b);
574 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
577 for my $i (0..$#$fdecls_parsed) {
578 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
580 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
583 $fdecls = [@$fdecls[@good]];
584 $fdecls_parsed = [@$fdecls_parsed[@good]];
586 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
589 my %h = map( ($_->[1], $_), @$fdecls_parsed);
590 $fdecls_parsed = [ @h{@fnames} ];
592 @fnames_no_prefix = @fnames;
594 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix;
595 # Remove macros which expand to typedefs
596 print "Typedefs are @td.\n" if $opt_d;
597 my %td = map {($_, $_)} @td;
598 # Add some other possible but meaningless values for macros
599 for my $k (qw(char double float int long short unsigned signed void)) {
600 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
602 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
605 while (keys %td > $n) {
608 while (($k, $v) = each %seen_define) {
609 # print("found '$k'=>'$v'\n"),
610 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
613 # Now %bad_macs contains names of bad macros
614 for my $k (keys %bad_macs) {
615 delete $const_names{$prefixless{$k}};
616 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
620 my @const_names = sort keys %const_names;
622 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
625 warn "Writing $ext$modpname/$modfname.pm\n";
633 if( $opt_X || $opt_c || $opt_A ){
634 # we won't have our own AUTOLOAD(), so won't have $AUTOLOAD
636 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
640 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
644 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);
653 print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled
658 # Are we using AutoLoader or not?
659 unless ($opt_A) { # no autoloader whatsoever.
660 unless ($opt_c) { # we're doing the AUTOLOAD
661 print PM "use AutoLoader;\n";
664 print PM "use AutoLoader qw(AUTOLOAD);\n"
669 my $myISA = '@ISA = qw(Exporter'; # We seem to always want this.
670 $myISA .= ' DynaLoader' unless $opt_X; # no XS
672 print PM "\n$myISA\n\n";
674 my @exported_names = (@const_names, @fnames_no_prefix);
677 # Items to export into callers namespace by default. Note: do not export
678 # names by default without a very good reason. Use EXPORT_OK instead.
679 # Do not simply export all your public functions/methods/constants.
681 # This allows declaration use $module ':all';
682 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
684 %EXPORT_TAGS = ( 'all' => [ qw(
688 \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
693 \$VERSION = '$TEMPLATE_VERSION';
697 print PM <<"END" unless $opt_c or $opt_X;
699 # This AUTOLOAD is used to 'autoload' constants from the constant()
700 # XS function. If a constant is not found then control is passed
701 # to the AUTOLOAD in AutoLoader.
704 (\$constname = \$AUTOLOAD) =~ s/.*:://;
705 croak "&$module::constant not defined" if \$constname eq 'constant';
706 my \$val = constant(\$constname, \@_ ? \$_[0] : 0);
708 if (\$! =~ /Invalid/ || \$!{EINVAL}) {
709 \$AutoLoader::AUTOLOAD = \$AUTOLOAD;
710 goto &AutoLoader::AUTOLOAD;
713 croak "Your vendor has not defined $module macro \$constname";
717 # Next line doesn't help with older Perls; in newers: no such warnings
718 # local \$^W = 0; # Prototype mismatch: sub XXX vs ()
719 if (\$] >= 5.00561) { # Fixed between 5.005_53 and 5.005_61
720 *\$AUTOLOAD = sub () { \$val };
722 *\$AUTOLOAD = sub { \$val };
730 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
732 bootstrap $module \$VERSION;
737 if( $opt_P ){ # if POD is disabled
746 # Preloaded methods go here.
749 print PM <<"END" unless $opt_A;
751 # Autoload methods go after $after, and are processed by the autosplit program.
760 my $author = "A. U. Thor";
761 my $email = 'a.u.thor@a.galaxy.far.far.away';
764 $revhist = <<EOT if $opt_C;
770 =item $TEMPLATE_VERSION
772 Original version; created by h2xs $H2XS_VERSION with options
787 if (@const_names and not $opt_P) {
789 =head2 Exportable constants
791 @{[join "\n ", @const_names]}
795 if (defined $fdecls and @$fdecls and not $opt_P) {
797 =head2 Exportable functions
800 $exp_doc .= <<EOD if $opt_p;
801 When accessing these functions from Perl, prefix C<$opt_p> should be removed.
805 @{[join "\n ", @known_fnames{@fnames}]}
810 my $pod = <<"END" unless $opt_P;
811 ## Below is the stub of documentation for your module. You better edit it!
815 #$module - Perl extension for blah blah blah
824 #Stub documentation for $module was created by h2xs. It looks like the
825 #author of the extension was negligent enough to leave the stub
841 $pod =~ s/^\#//gm unless $opt_P;
842 print PM $pod unless $opt_P;
847 if( ! $opt_X ){ # print XS, unless it is disabled
848 warn "Writing $ext$modpname/$modfname.xs\n";
857 foreach my $path_h (@path_h_ini) {
859 $h =~ s#^/usr/include/##;
860 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
861 print XS qq{#include <$h>\n};
866 my %pointer_typedefs;
871 my $out = $pointer_typedefs{$type};
872 return $out if defined $out;
874 $out = ($type =~ /\*$/);
875 # This converts only the guys which do not have trailing part in the typedef
877 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
878 $type = normalize_type($type);
879 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
881 $out = td_is_pointer($type);
883 return ($pointer_typedefs{$otype} = $out);
888 my $out = $struct_typedefs{$type};
889 return $out if defined $out;
891 $out = ($type =~ /^struct\b/) && !td_is_pointer($type);
892 # This converts only the guys which do not have trailing part in the typedef
894 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
895 $type = normalize_type($type);
896 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
898 $out = td_is_struct($type);
900 return ($struct_typedefs{$otype} = $out);
903 # Some macros will bomb if you try to return them from a double-returning func.
904 # Say, ((char *)0), or strlen (if somebody #define STRLEN strlen).
905 # Fortunately, we can detect both these cases...
906 sub protect_convert_to_double {
909 return '' unless defined ($val = $seen_define{$in});
910 return '(IV)' if $known_fnames{$val};
911 # OUT_t of ((OUT_t)-1):
912 return '' unless $val =~ /^\s*(\(\s*)?\(\s*([^()]*?)\s*\)/;
913 td_is_pointer($2) ? '(IV)' : '';
916 # For each of the generated functions, length($pref) leading
917 # letters are already checked. Moreover, it is recommended that
918 # the generated functions uses switch on letter at offset at least
919 # $off + length($pref).
921 # The given list has length($pref) chars removed at front, it is
922 # guarantied that $off leading chars in the rest are the same for all
925 # Returns: how at which offset it was decided to make a switch, or -1 if none.
930 my ($fh, $pref, $off, $list) = (shift,shift,shift,shift);
932 my $offarg = length $pref;
934 if (@$list == 0) { # Can happen on the initial iteration only
937 constant(char *name, int len, int arg)
946 if (@$list == 1) { # Can happen on the initial iteration only
947 my $protect = protect_convert_to_double("$pref$list->[0]");
951 constant(char *name, int len, int arg)
953 if (strEQ(name + $offarg, "$list->[0]")) { /* $pref removed */
954 #ifdef $pref$list->[0]
955 return $protect$pref$list->[0];
969 my $c = substr $n, $off, 1;
970 $leading{$c} = [] unless exists $leading{$c};
971 push @{$leading{$c}}, substr $n, $off + 1;
974 if (keys(%leading) == 1) {
975 return 1 + write_const $fh, $pref, $off + 1, $list;
978 my $leader = substr $list->[0], 0, $off;
979 foreach my $letter (keys %leading) {
980 write_const $fh, "$pref$leader$letter", 0, $leading{$letter}
981 if @{$leading{$letter}} > 1;
984 my $npref = "_$pref";
985 $npref = '' if $pref eq '';
989 constant$npref(char *name, int len, int arg)
994 print $fh <<"END" if $off;
995 if ($offarg + $off >= len ) {
1002 switch (name[$offarg + $off]) {
1005 foreach my $letter (sort keys %leading) {
1007 $let = '\0' if $letter eq '';
1012 if (@{$leading{$letter}} > 1) {
1013 # It makes sense to call a function
1016 if (!strnEQ(name + $offarg,"$leader", $off))
1021 return constant_$pref$leader$letter(name, len, arg);
1026 = protect_convert_to_double("$pref$leader$letter$leading{$letter}[0]");
1029 if (strEQ(name + $offarg, "$leader$letter$leading{$letter}[0]")) { /* $pref removed */
1030 #ifdef $pref$leader$letter$leading{$letter}[0]
1031 return $protect$pref$leader$letter$leading{$letter}[0];
1058 croak("$module::%s not implemented on this architecture", s);
1064 write_const(\*XS, '', 0, \@const_names);
1068 $prefix = "PREFIX = $opt_p" if defined $opt_p;
1070 # Now switch from C to XS by issuing the first MODULE declaration:
1073 MODULE = $module PACKAGE = $module $prefix
1077 foreach (sort keys %const_xsub) {
1086 croak("Your vendor has not defined the $module macro $_");
1095 # If a constant() function was written then output a corresponding
1097 print XS <<"END" unless $opt_c;
1105 char * s = SvPV(sv, len);
1108 RETVAL = constant(s,len,arg);
1120 my ($type, $name, $args) = @$decl;
1121 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1123 my @argnames = map {$_->[1]} @$args;
1124 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1125 my @argarrays = map { $_->[4] || '' } @$args;
1126 my $numargs = @$args;
1127 if ($numargs and $argtypes[-1] eq '...') {
1129 $argnames[-1] = '...';
1132 $type = normalize_type($type, 1);
1140 for my $arg (0 .. $numargs - 1) {
1142 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1147 # Should be called before any actual call to normalize_type().
1149 # We do not want to read ./typemap by obvios reasons.
1150 my @tm = qw(../../../typemap ../../typemap ../typemap);
1151 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1152 unshift @tm, $stdtypemap;
1153 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1155 # Start with useful default values
1156 $typemap{float} = 'T_DOUBLE';
1158 foreach my $typemap (@tm) {
1159 next unless -e $typemap ;
1160 # skip directories, binary files etc.
1161 warn " Scanning $typemap\n";
1162 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1163 unless -T $typemap ;
1164 open(TYPEMAP, $typemap)
1165 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1166 my $mode = 'Typemap';
1169 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1170 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1171 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1172 elsif ($mode eq 'Typemap') {
1173 next if /^\s*($|\#)/ ;
1175 if ( ($type, $image) =
1176 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1177 # This may reference undefined functions:
1178 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1179 $typemap{normalize_type($type)} = $image;
1183 close(TYPEMAP) or die "Cannot close $typemap: $!";
1185 %std_types = %types_seen;
1190 sub normalize_type { # Second arg: do not strip const's before \*
1192 my $do_keep_deep_const = shift;
1193 # If $do_keep_deep_const this is heuristical only
1194 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1196 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1197 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1198 $type =~ s/$ignore_mods//go;
1200 $type =~ s/$ignore_mods//go;
1202 $type =~ s/([^\s\w])/ \1 /g;
1206 $type =~ s/\* (?=\*)/*/g;
1207 $type =~ s/\. \. \./.../g;
1209 $types_seen{$type}++
1210 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1216 sub assign_typemap_entry {
1220 if ($tmask and $type =~ /$tmask/) {
1221 print "Type $type matches -o mask\n" if $opt_d;
1222 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1224 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1225 $type = normalize_type $type;
1226 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1227 $entry = assign_typemap_entry($type);
1229 $entry ||= $typemap{$otype}
1230 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1231 $typemap{$otype} = $entry;
1232 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1237 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1244 warn "Writing $ext$modpname/typemap\n";
1245 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1247 for $type (sort keys %types_seen) {
1248 my $entry = assign_typemap_entry $type;
1249 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1252 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1253 #############################################################################
1256 if (sv_derived_from($arg, \"${ntype}\")) {
1258 char *s = SvPV((SV*)SvRV($arg), len);
1260 if (len != sizeof($var))
1261 croak(\"Size %d of packed data != expected %d\",
1266 croak(\"$var is not of type ${ntype}\")
1267 #############################################################################
1270 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1273 close TM or die "Cannot close typemap file for write: $!";
1278 warn "Writing $ext$modpname/Makefile.PL\n";
1279 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1282 use ExtUtils::MakeMaker;
1283 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1284 # the contents of the Makefile that is written.
1286 print PL "WriteMakefile(\n";
1287 print PL " 'NAME' => '$module',\n";
1288 print PL " 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION\n";
1289 if( ! $opt_X ){ # print C stuff, unless XS is disabled
1290 $opt_F = '' unless defined $opt_F;
1291 print PL " 'LIBS' => ['$extralibs'], # e.g., '-lm' \n";
1292 print PL " 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING' \n";
1293 print PL " 'INC' => '', # e.g., '-I/usr/include/other' \n";
1296 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1298 warn "Writing $ext$modpname/test.pl\n";
1299 open(EX, ">test.pl") || die "Can't create $ext$modpname/test.pl: $!\n";
1301 # Before `make install' is performed this script should be runnable with
1302 # `make test'. After `make install' it should work as `perl test.pl'
1304 ######################### We start with some black magic to print on failure.
1306 # Change 1..1 below to 1..last_test_to_print .
1307 # (It may become useful if the test is moved to ./t subdirectory.)
1309 BEGIN { $| = 1; print "1..1\n"; }
1310 END {print "not ok 1\n" unless $loaded;}
1319 ######################### End of black magic.
1321 # Insert your test code below (better if it prints "ok 13"
1322 # (correspondingly "not ok 13") depending on the success of chunk 13
1323 # of the test code):
1326 close(EX) || die "Can't close $ext$modpname/test.pl: $!\n";
1329 warn "Writing $ext$modpname/Changes\n";
1331 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
1332 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
1334 Revision history for Perl extension $module.
1336 $TEMPLATE_VERSION @{[scalar localtime]}
1337 \t- original version; created by h2xs $H2XS_VERSION with options
1341 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
1344 warn "Writing $ext$modpname/MANIFEST\n";
1345 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
1348 eval {opendir(D,'.');};
1349 unless ($@) { @files = readdir(D); closedir(D); }
1351 if (!@files) { @files = map {chomp && $_} `ls`; }
1354 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
1356 # Fix up for case-sensitive file systems
1357 s/$modfname/$modfname/i && next;
1358 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
1359 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
1362 print MANI join("\n",@files), "\n";
1366 close OUT or die "Can't close $file: $!";
1367 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1368 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';