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 my $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!';
42 h2xs - convert .h C header files to Perl extensions
46 B<h2xs> [B<-ACOPXacdfkmx>] [B<-F> addflags] [B<-M> fmask] [B<-n> module_name] [B<-o> tmask] [B<-p> prefix] [B<-s> subs] [B<-v> version] [B<-b> compat_version] [headerfile ... [extra_libraries]]
52 I<h2xs> builds a Perl extension from C header files. The extension
53 will include functions which can be used to retrieve the value of any
54 #define statement which was in the C header files.
56 The I<module_name> will be used for the name of the extension. If
57 module_name is not supplied then the name of the first header file
58 will be used, with the first character capitalized.
60 If the extension might need extra libraries, they should be included
61 here. The extension Makefile.PL will take care of checking whether
62 the libraries actually exist and how they should be loaded. The extra
63 libraries should be specified in the form -lm -lposix, etc, just as on
64 the cc command line. By default, the Makefile.PL will search through
65 the library path determined by Configure. That path can be augmented
66 by including arguments of the form B<-L/another/library/path> in the
67 extra-libraries argument.
75 Omit all autoload facilities. This is the same as B<-c> but also
76 removes the S<C<use AutoLoader>> statement from the .pm file.
80 Omits creation of the F<Changes> file, and adds a HISTORY section to
83 =item B<-F> I<addflags>
85 Additional flags to specify to C preprocessor when scanning header for
86 function declarations. Should not be used without B<-x>.
88 =item B<-M> I<regular expression>
90 selects functions/macros to process.
94 Allows a pre-existing extension directory to be overwritten.
98 Omit the autogenerated stub POD section.
102 Omit the XS portion. Used to generate templates for a module which is not
103 XS-based. C<-c> and C<-f> are implicitly enabled.
107 Generate an accessor method for each element of structs and unions. The
108 generated methods are named after the element name; will return the current
109 value of the element if called without additional arguments; and will set
110 the element to the supplied value (and return the new value) if called with
111 an additional argument. Embedded structures and unions are returned as a
112 pointer rather than the complete structure, to facilitate chained calls.
114 These methods all apply to the Ptr type for the structure; additionally
115 two methods are constructed for the structure type itself, C<_to_ptr>
116 which returns a Ptr type pointing to the same structure, and a C<new>
117 method to construct and return a new structure, initialised to zeroes.
121 Omit C<constant()> from the .xs file and corresponding specialised
122 C<AUTOLOAD> from the .pm file.
126 Turn on debugging messages.
130 Allows an extension to be created for a header even if that header is
131 not found in standard include directories.
135 Print the usage, help and version for this h2xs and exit.
139 For function arguments declared as C<const>, omit the const attribute in the
144 B<Experimental>: for each variable declared in the header file(s), declare
145 a perl variable of the same name magically tied to the C variable.
147 =item B<-n> I<module_name>
149 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
151 =item B<-o> I<regular expression>
153 Use "opaque" data type for the C types matched by the regular
154 expression, even if these types are C<typedef>-equivalent to types
155 from typemaps. Should not be used without B<-x>.
157 This may be useful since, say, types which are C<typedef>-equivalent
158 to integers may represent OS-related handles, and one may want to work
159 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
160 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
163 The type-to-match is whitewashed (except for commas, which have no
164 whitespace before them, and multiple C<*> which have no whitespace
167 =item B<-p> I<prefix>
169 Specify a prefix which should be removed from the Perl function names,
170 e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
171 the prefix from functions that are autoloaded via the C<constant()>
174 =item B<-s> I<sub1,sub2>
176 Create a perl subroutine for the specified macros rather than autoload
177 with the constant() subroutine. These macros are assumed to have a
178 return type of B<char *>, e.g.,
179 S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
181 =item B<-v> I<version>
183 Specify a version number for this extension. This version number is added
184 to the templates. The default is 0.01.
188 Automatically generate XSUBs basing on function declarations in the
189 header file. The package C<C::Scan> should be installed. If this
190 option is specified, the name of the header file may look like
191 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
192 string, but XSUBs are emitted only for the declarations included from
195 Note that some types of arguments/return-values for functions may
196 result in XSUB-declarations/typemap-entries which need
197 hand-editing. Such may be objects which cannot be converted from/to a
198 pointer (like C<long long>), pointers to functions, or arrays. See
199 also the section on L<LIMITATIONS of B<-x>>.
201 =item B<-b> I<version>
203 Generates a .pm file which is backwards compatible with the specified
206 For versions < 5.6.0, the changes are.
207 - no use of 'our' (uses 'use vars' instead)
210 Specifying a compatibility version higher than the version of perl you
211 are using to run h2xs will have no effect.
218 # Default behavior, extension is Rusers
221 # Same, but extension is RUSERS
222 h2xs -n RUSERS rpcsvc/rusers
224 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
227 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
228 h2xs -n ONC::RPC rpcsvc/rusers
230 # Without constant() or AUTOLOAD
231 h2xs -c rpcsvc/rusers
233 # Creates templates for an extension named RPC
236 # Extension is ONC::RPC.
239 # Makefile.PL will look for library -lrpc in
240 # additional directory /opt/net/lib
241 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
243 # Extension is DCE::rgynbase
244 # prefix "sec_rgy_" is dropped from perl function names
245 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
247 # Extension is DCE::rgynbase
248 # prefix "sec_rgy_" is dropped from perl function names
249 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
250 h2xs -n DCE::rgynbase -p sec_rgy_ \
251 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
253 # Make XS without defines in perl.h, but with function declarations
254 # visible from perl.h. Name of the extension is perl1.
255 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
256 # Extra backslashes below because the string is passed to shell.
257 # Note that a directory with perl header files would
258 # be added automatically to include path.
259 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
261 # Same with function declaration in proto.h as visible from perl.h.
262 h2xs -xAn perl2 perl.h,proto.h
264 # Same but select only functions which match /^av_/
265 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
267 # Same but treat SV* etc as "opaque" types
268 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
270 =head2 Extension based on F<.h> and F<.c> files
272 Suppose that you have some C files implementing some functionality,
273 and the corresponding header files. How to create an extension which
274 makes this functionality accessable in Perl? The example below
275 assumes that the header files are F<interface_simple.h> and
276 I<interface_hairy.h>, and you want the perl module be named as
277 C<Ext::Ension>. If you need some preprocessor directives and/or
278 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
283 =item Find the directory name
285 Start with a dummy run of h2xs:
287 h2xs -Afn Ext::Ension
289 The only purpose of this step is to create the needed directories, and
290 let you know the names of these directories. From the output you can
291 see that the directory for the extension is F<Ext/Ension>.
295 Copy your header files and C files to this directory F<Ext/Ension>.
297 =item Create the extension
299 Run h2xs, overwriting older autogenerated files:
301 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
303 h2xs looks for header files I<after> changing to the extension
304 directory, so it will find your header files OK.
306 =item Archive and test
318 It is important to do C<make dist> as early as possible. This way you
319 can easily merge(1) your changes to autogenerated files if you decide
320 to edit your C<.h> files and rerun h2xs.
322 Do not forget to edit the documentation in the generated F<.pm> file.
324 Consider the autogenerated files as skeletons only, you may invent
325 better interfaces than what h2xs could guess.
327 Consider this section as a guideline only, some other options of h2xs
328 may better suit your needs.
334 No environment variables are used.
338 Larry Wall and others
342 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
346 The usual warnings if it cannot read or write the files involved.
348 =head1 LIMITATIONS of B<-x>
350 F<h2xs> would not distinguish whether an argument to a C function
351 which is of the form, say, C<int *>, is an input, output, or
352 input/output parameter. In particular, argument declarations of the
359 should be better rewritten as
365 if C<n> is an input parameter.
367 Additionally, F<h2xs> has no facilities to intuit that a function
374 takes a pair of address and length of data at this address, so it is better
375 to rewrite this function as
385 RETVAL = foo(s, len);
395 char *s = SvPV(sv,len);
400 MODULE = foo PACKAGE = foo PREFIX = my_
406 See L<perlxs> and L<perlxstut> for additional details.
413 my( $H2XS_VERSION ) = ' $Revision: 1.21 $ ' =~ /\$Revision:\s+([^\s]+)/;
414 my $TEMPLATE_VERSION = '0.01';
416 my $compat_version = $];
424 h2xs [-ACOPXacdfhkmx] [-F addflags] [-M fmask] [-n module_name] [-o tmask] [-p prefix] [-s subs] [-v version] [-b compat_version ] [headerfile [extra_libraries]]
425 version: $H2XS_VERSION
426 -A Omit all autoloading facilities (implies -c).
427 -C Omit creating the Changes file, add HISTORY heading to stub POD.
428 -F Additional flags for C preprocessor (used with -x).
429 -M Mask to select C functions/macros (default is select all).
430 -O Allow overwriting of a pre-existing extension directory.
431 -P Omit the stub POD section.
432 -X Omit the XS portion (implies both -c and -f).
433 -a Generate get/set accessors for struct and union members (used with -x).
434 -c Omit the constant() function and specialised AUTOLOAD from the XS file.
435 -d Turn on debugging messages.
436 -f Force creation of the extension even if the C header does not exist.
437 -h Display this help message
438 -k Omit 'const' attribute on function arguments (used with -x).
439 -m Generate tied variables for access to declared variables.
440 -n Specify a name to use for the extension (recommended).
441 -o Regular expression for \"opaque\" types.
442 -p Specify a prefix which should be removed from the Perl function names.
443 -s Create subroutines for specified macros.
444 -v Specify a version number for this extension.
445 -x Autogenerate XSUBs using C::Scan.
446 -b Specify a perl version to be backwards compatibile with
448 are any libraries that might be needed for loading the
449 extension, e.g. -lm would try to link in the math library.
454 getopts("ACF:M:OPXacdfhkmn:o:p:s:v:xb:") || usage;
455 use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_a $opt_c $opt_d
456 $opt_f $opt_h $opt_k $opt_m $opt_n $opt_o $opt_p $opt_s $opt_v $opt_x
462 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
463 $opt_b =~ /^\d+\.\d+\.\d+/ ||
464 usage "You must provide the backwards compatibility version in X.Y.Z form. " .
466 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
467 $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
471 $TEMPLATE_VERSION = $opt_v;
475 $opt_c = 1 if $opt_A;
477 # -X implies -c and -f
478 $opt_c = $opt_f = 1 if $opt_X;
480 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
486 while (my $arg = shift) {
487 if ($arg =~ /^-l/i) {
488 $extralibs = "$arg @ARGV";
494 usage "Must supply header file or module name\n"
495 unless (@path_h or $opt_n);
500 $fmask = qr{$opt_M} if defined $opt_M;
501 $tmask = qr{$opt_o} if defined $opt_o;
502 my $tmask_all = $tmask && $opt_o eq '.';
505 eval {require C::Scan; 1}
507 C::Scan required if you use -x option.
508 To install C::Scan, execute
509 perl -MCPAN -e "install C::Scan"
511 unless ($tmask_all) {
512 $C::Scan::VERSION >= 0.70
514 C::Scan v. 0.70 or later required unless you use -o . option.
515 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
516 To install C::Scan, execute
517 perl -MCPAN -e "install C::Scan"
520 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
522 C::Scan v. 0.73 or later required to use -m or -a options.
523 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
524 To install C::Scan, execute
525 perl -MCPAN -e "install C::Scan"
529 elsif ($opt_o or $opt_F) {
531 Options -o and -F do not make sense without -x.
535 my @path_h_ini = @path_h;
536 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
544 if ($^O eq 'VMS') { # Consider overrides of default location
545 # XXXX This is not equivalent to what the older version did:
546 # it was looking at $hadsys header-file per header-file...
547 my($hadsys) = grep s!^sys/!!i , @path_h;
548 @paths = qw( Sys$Library VAXC$Include );
549 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
550 push @paths, qw( DECC$Library_Include DECC$System_Include );
553 @paths = (File::Spec->curdir(), $Config{usrinc},
554 (split ' ', $Config{locincpth}), '/usr/include');
556 foreach my $path_h (@path_h) {
560 if ( $name !~ /::/ ) {
567 if( $path_h =~ s#::#/#g && $opt_n ){
568 warn "Nesting of headerfile ignored with -n\n";
570 $path_h .= ".h" unless $path_h =~ /\.h$/;
571 my $fullpath = $path_h;
572 $path_h =~ s/,.*$// if $opt_x;
573 $fullpath{$path_h} = $fullpath;
575 # Minor trickery: we can't chdir() before we processed the headers
576 # (so know the name of the extension), but the header may be in the
577 # extension directory...
578 my $tmp_path_h = $path_h;
579 my $rel_path_h = $path_h;
581 if (not -f $path_h) {
583 for my $dir (@paths) {
585 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
588 $rel_path_h = $path_h;
590 (my $epath = $module) =~ s,::,/,g;
591 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
592 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
593 $path_h = $tmp_path_h; # Used during -x
599 die "Can't find $tmp_path_h in @dirs\n"
600 if ( ! $opt_f && ! -f "$rel_path_h" );
601 # Scan the header file (we should deal with nested header files)
602 # Record the names of simple #define constants into const_names
603 # Function prototypes are processed below.
604 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
607 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
610 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
613 # Cannot do: (-1) and ((LHANDLE)3) are OK:
614 #print("Skip non-wordy $def => $rest\n"),
615 # next defines if $rest =~ /[^\w\$]/;
617 print("Skip stringy $def => $rest\n") if $opt_d;
620 print "Matched $_ ($def)\n" if $opt_d;
621 $seen_define{$def} = $rest;
623 next if /^_.*_h_*$/i; # special case, but for what?
624 if (defined $opt_p) {
625 if (!/^$opt_p(\d)/) {
626 ++$prefix{$_} if s/^$opt_p//;
629 warn "can't remove $opt_p prefix from '$_'!\n";
632 $prefixless{$def} = $_;
633 if (!$fmask or /$fmask/) {
634 print "... Passes mask of -M.\n" if $opt_d and $fmask;
646 my ($ext, $nested, @modparts, $modfname, $modpname);
648 $ext = chdir 'ext' ? 'ext/' : '';
650 if( $module =~ /::/ ){
652 @modparts = split(/::/,$module);
653 $modfname = $modparts[-1];
654 $modpname = join('/',@modparts);
659 $modfname = $modpname = $module;
664 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
667 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
672 -d "$modpath$_" || mkdir("$modpath$_", 0777);
676 -d "$modpname" || mkdir($modpname, 0777);
677 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
682 my $fdecls_parsed = [];
689 my @fnames_no_prefix;
693 if( ! $opt_X ){ # use XS, unless it was disabled
694 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
696 require Config; # Run-time directive
697 warn "Scanning typemaps...\n";
701 my $addflags = $opt_F || '';
703 foreach my $filename (@path_h) {
707 if ($fullpath{$filename} =~ /,/) {
711 warn "Scanning $filename for functions...\n";
712 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
713 'add_cppflags' => $addflags, 'c_styles' => [qw(C++ C9X)];
714 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]);
716 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
717 push(@$fdecls, @{$c->get('fdecls')});
719 push @td, @{$c->get('typedefs_maybe')};
721 my $structs = $c->get('typedef_structs');
722 @structs{keys %$structs} = values %$structs;
726 %vdecl_hash = %{ $c->get('vdecl_hash') };
727 @vdecls = sort keys %vdecl_hash;
728 for (local $_ = 0; $_ < @vdecls; ++$_) {
729 my $var = $vdecls[$_];
730 my($type, $post) = @{ $vdecl_hash{$var} };
732 warn "Can't handle variable '$type $var $post', skipping.\n";
733 splice @vdecls, $_, 1;
736 $type = normalize_type($type);
737 $vdecl_hash{$var} = $type;
741 unless ($tmask_all) {
742 warn "Scanning $filename for typedefs...\n";
743 my $td = $c->get('typedef_hash');
744 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
745 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
746 push @good_td, @f_good_td;
747 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
751 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
753 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
756 for my $i (0..$#$fdecls_parsed) {
757 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
759 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
762 $fdecls = [@$fdecls[@good]];
763 $fdecls_parsed = [@$fdecls_parsed[@good]];
765 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
768 my %h = map( ($_->[1], $_), @$fdecls_parsed);
769 $fdecls_parsed = [ @h{@fnames} ];
771 @fnames_no_prefix = @fnames;
773 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix;
774 # Remove macros which expand to typedefs
775 print "Typedefs are @td.\n" if $opt_d;
776 my %td = map {($_, $_)} @td;
777 # Add some other possible but meaningless values for macros
778 for my $k (qw(char double float int long short unsigned signed void)) {
779 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
781 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
784 while (keys %td > $n) {
787 while (($k, $v) = each %seen_define) {
788 # print("found '$k'=>'$v'\n"),
789 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
792 # Now %bad_macs contains names of bad macros
793 for my $k (keys %bad_macs) {
794 delete $const_names{$prefixless{$k}};
795 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
799 my @const_names = sort keys %const_names;
801 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
804 warn "Writing $ext$modpname/$modfname.pm\n";
806 if ( $compat_version < 5.006 ) {
824 unless( $opt_X || $opt_c || $opt_A ){
825 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
837 print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled
842 # Are we using AutoLoader or not?
843 unless ($opt_A) { # no autoloader whatsoever.
844 unless ($opt_c) { # we're doing the AUTOLOAD
845 print PM "use AutoLoader;\n";
848 print PM "use AutoLoader qw(AUTOLOAD);\n"
852 if ( $compat_version < 5.006 ) {
853 if ( $opt_X || $opt_c || $opt_A ) {
854 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
856 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
861 my $myISA = 'our @ISA = qw(Exporter'; # We seem to always want this.
862 $myISA .= ' DynaLoader' unless $opt_X; # no XS
864 $myISA =~ s/^our // if $compat_version < 5.006;
866 print PM "\n$myISA\n\n";
868 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
871 # Items to export into callers namespace by default. Note: do not export
872 # names by default without a very good reason. Use EXPORT_OK instead.
873 # Do not simply export all your public functions/methods/constants.
875 # This allows declaration use $module ':all';
876 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
878 our %EXPORT_TAGS = ( 'all' => [ qw(
882 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
887 our \$VERSION = '$TEMPLATE_VERSION';
891 $tmp =~ s/^our //mg if $compat_version < 5.006;
895 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
899 $tmp = ( $compat_version < 5.006 ? "" : "our \$AUTOLOAD;" );
900 print PM <<"END" unless $opt_c or $opt_X;
902 # This AUTOLOAD is used to 'autoload' constants from the constant()
903 # XS function. If a constant is not found then control is passed
904 # to the AUTOLOAD in AutoLoader.
908 (\$constname = \$AUTOLOAD) =~ s/.*:://;
909 croak "&${module}::constant not defined" if \$constname eq 'constant';
910 my \$val = constant(\$constname, \@_ ? \$_[0] : 0);
912 if (\$! =~ /Invalid/ || \$!{EINVAL}) {
913 \$AutoLoader::AUTOLOAD = \$AUTOLOAD;
914 goto &AutoLoader::AUTOLOAD;
917 croak "Your vendor has not defined $module macro \$constname";
922 # Fixed between 5.005_53 and 5.005_61
923 if (\$] >= 5.00561) {
924 *\$AUTOLOAD = sub () { \$val };
927 *\$AUTOLOAD = sub { \$val };
935 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
937 bootstrap $module \$VERSION;
941 # tying the variables can happen only after bootstrap
945 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
952 if( $opt_P ){ # if POD is disabled
961 # Preloaded methods go here.
964 print PM <<"END" unless $opt_A;
966 # Autoload methods go after $after, and are processed by the autosplit program.
979 ($user,$author) = (getpwuid($>))[0,6];
980 $author =~ s/,.*$//; # in case of sub fields
981 my $domain = $Config{'mydomain'};
983 $email = "$user\@$domain";
986 $author ||= "A. U. Thor";
987 $email ||= 'a.u.thor@a.galaxy.far.far.away';
990 $revhist = <<EOT if $opt_C;
996 #=item $TEMPLATE_VERSION
998 #Original version; created by h2xs $H2XS_VERSION with options
1006 my $exp_doc = <<EOD;
1014 if (@const_names and not $opt_P) {
1016 #=head2 Exportable constants
1018 # @{[join "\n ", @const_names]}
1023 if (defined $fdecls and @$fdecls and not $opt_P) {
1025 #=head2 Exportable functions
1029 # $exp_doc .= <<EOD if $opt_p;
1030 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1034 # @{[join "\n ", @known_fnames{@fnames}]}
1041 if ($opt_x && $opt_a) {
1043 $meth_doc .= accessor_docs($name, $struct)
1044 while ($name, $struct) = each %structs;
1047 my $pod = <<"END" unless $opt_P;
1048 ## Below is stub documentation for your module. You better edit it!
1052 #$module - Perl extension for blah blah blah
1061 #Stub documentation for $module, created by h2xs. It looks like the
1062 #author of the extension was negligent enough to leave the stub
1066 $exp_doc$meth_doc$revhist
1070 #Mention other useful documentation such as the documentation of
1071 #related modules or operating system documentation (such as man pages
1072 #in UNIX), or any relevant external documentation such as RFCs or
1075 #If you have a mailing list set up for your module, mention it here.
1077 #If you have a web site set up for your module, mention it here.
1081 #$author, E<lt>${email}E<gt>
1083 #=head1 COPYRIGHT AND LICENSE
1085 #Copyright ${\(1900 + (localtime) [5])} by $author
1087 #This library is free software; you can redistribute it and/or modify
1088 #it under the same terms as Perl itself.
1093 $pod =~ s/^\#//gm unless $opt_P;
1094 print PM $pod unless $opt_P;
1099 if( ! $opt_X ){ # print XS, unless it is disabled
1100 warn "Writing $ext$modpname/$modfname.xs\n";
1109 foreach my $path_h (@path_h_ini) {
1111 $h =~ s#^/usr/include/##;
1112 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1113 print XS qq{#include <$h>\n};
1118 my %pointer_typedefs;
1119 my %struct_typedefs;
1123 my $out = $pointer_typedefs{$type};
1124 return $out if defined $out;
1126 $out = ($type =~ /\*$/);
1127 # This converts only the guys which do not have trailing part in the typedef
1129 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1130 $type = normalize_type($type);
1131 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1133 $out = td_is_pointer($type);
1135 return ($pointer_typedefs{$otype} = $out);
1140 my $out = $struct_typedefs{$type};
1141 return $out if defined $out;
1143 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1144 # This converts only the guys which do not have trailing part in the typedef
1146 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1147 $type = normalize_type($type);
1148 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1150 $out = td_is_struct($type);
1152 return ($struct_typedefs{$otype} = $out);
1155 # Some macros will bomb if you try to return them from a double-returning func.
1156 # Say, ((char *)0), or strlen (if somebody #define STRLEN strlen).
1157 # Fortunately, we can detect both these cases...
1158 sub protect_convert_to_double {
1161 return '' unless defined ($val = $seen_define{$in});
1162 return '(IV)' if $known_fnames{$val};
1163 # OUT_t of ((OUT_t)-1):
1164 return '' unless $val =~ /^\s*(\(\s*)?\(\s*([^()]*?)\s*\)/;
1165 td_is_pointer($2) ? '(IV)' : '';
1168 # For each of the generated functions, length($pref) leading
1169 # letters are already checked. Moreover, it is recommended that
1170 # the generated functions uses switch on letter at offset at least
1171 # $off + length($pref).
1173 # The given list has length($pref) chars removed at front, it is
1174 # guarantied that $off leading chars in the rest are the same for all
1177 # Returns: how at which offset it was decided to make a switch, or -1 if none.
1182 my ($fh, $pref, $off, $list) = (shift,shift,shift,shift);
1184 my $offarg = length $pref;
1186 if (@$list == 0) { # Can happen on the initial iteration only
1189 constant(char *name, int len, int arg)
1198 if (@$list == 1) { # Can happen on the initial iteration only
1199 my $protect = protect_convert_to_double("$pref$list->[0]");
1203 constant(char *name, int len, int arg)
1206 if (strEQ(name + $offarg, "$list->[0]")) { /* \"$pref\" removed */
1207 #ifdef $pref$list->[0]
1208 return $protect$pref$list->[0];
1221 for my $n (@$list) {
1222 my $c = substr $n, $off, 1;
1223 $leading{$c} = [] unless exists $leading{$c};
1224 push @{$leading{$c}}, $off < length $n ? substr $n, $off + 1 : $n
1227 if (keys(%leading) == 1) {
1228 return 1 + write_const $fh, $pref, $off + 1, $list;
1231 my $leader = substr $list->[0], 0, $off;
1232 foreach my $letter (keys %leading) {
1233 write_const $fh, "$pref$leader$letter", 0, $leading{$letter}
1234 if @{$leading{$letter}} > 1;
1237 my $npref = "_$pref";
1238 $npref = '' if $pref eq '';
1242 constant$npref(char *name, int len, int arg)
1246 print $fh <<"END" if $npref eq '';
1253 foreach my $letter (keys %leading) {
1254 if ($letter eq '') {
1260 my $cmp = $null ? '>' : '>=';
1263 if ($offarg + $off $cmp len ) {
1271 switch (name[$offarg + $off]) {
1274 foreach my $letter (sort keys %leading) {
1276 $let = '\0' if $letter eq '';
1281 if (@{$leading{$letter}} > 1) {
1282 # It makes sense to call a function
1285 if (!strnEQ(name + $offarg,"$leader", $off))
1290 return constant_$pref$leader$letter(name, len, arg);
1296 = protect_convert_to_double("$pref$leader$letter$leading{$letter}[0]");
1299 if (strEQ(name + $offarg, "$leader$letter$leading{$letter}[0]")) { /* \"$pref\" removed */
1300 #ifdef $pref$leader$letter$leading{$letter}[0]
1301 return $protect$pref$leader$letter$leading{$letter}[0];
1328 croak("${module}::%s not implemented on this architecture", s);
1334 write_const(\*XS, '', 0, \@const_names);
1337 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1339 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1341 # Now switch from C to XS by issuing the first MODULE declaration:
1344 MODULE = $module PACKAGE = $module $prefix
1348 foreach (sort keys %const_xsub) {
1357 croak("Your vendor has not defined the $module macro $_");
1366 # If a constant() function was written then output a corresponding
1368 print XS <<"END" unless $opt_c;
1376 char * s = SvPV(sv, len);
1379 RETVAL = constant(s,len,arg);
1391 my ($type, $name, $args) = @$decl;
1392 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1394 my @argnames = map {$_->[1]} @$args;
1395 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1397 s/^\s*const\b\s*// for @argtypes;
1399 my @argarrays = map { $_->[4] || '' } @$args;
1400 my $numargs = @$args;
1401 if ($numargs and $argtypes[-1] eq '...') {
1403 $argnames[-1] = '...';
1406 $type = normalize_type($type, 1);
1414 for my $arg (0 .. $numargs - 1) {
1416 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1421 sub print_tievar_subs {
1422 my($fh, $name, $type) = @_;
1425 _get_$name(IV index, SV *sv) {
1430 (void)call_pv("$module\::_get_$name", G_DISCARD);
1435 _set_$name(IV index, SV *sv) {
1440 (void)call_pv("$module\::_set_$name", G_DISCARD);
1447 sub print_tievar_xsubs {
1448 my($fh, $name, $type) = @_;
1456 uf.uf_val = &_get_$name;
1457 uf.uf_set = &_set_$name;
1458 uf.uf_index = (IV)&_get_$name;
1459 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1463 $type THIS = NO_INIT
1479 sub print_accessors {
1480 my($fh, $name, $struct) = @_;
1481 return unless defined $struct && $name !~ /\s|_ANON/;
1482 $name = normalize_type($name);
1483 my $ptrname = normalize_type("$name *");
1486 MODULE = $module PACKAGE = ${name} $prefix
1490 $name THIS = NO_INIT
1493 if (sv_derived_from(ST(0), "$name")) {
1495 char *s = SvPV((SV*)SvRV(ST(0)), len);
1496 if (len != sizeof(THIS))
1497 croak("Size \%d of packed data != expected \%d",
1499 RETVAL = ($name *)s;
1502 croak("THIS is not of type $name");
1508 char *CLASS = NO_INIT
1511 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1515 MODULE = $module PACKAGE = ${name}Ptr $prefix
1518 my @items = @$struct;
1520 my $item = shift @items;
1521 if ($item->[0] =~ /_ANON/) {
1522 if (defined $item->[2]) {
1524 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1525 ], @{ $structs{$item->[0]} };
1527 push @items, @{ $structs{$item->[0]} };
1530 my $type = normalize_type($item->[0]);
1531 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1534 $item->[2](THIS, __value = NO_INIT)
1540 THIS->$item->[-1] = __value;
1542 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1553 my($name, $struct) = @_;
1554 return unless defined $struct && $name !~ /\s|_ANON/;
1555 $name = normalize_type($name);
1556 my $ptrname = $name . 'Ptr';
1557 my @items = @$struct;
1560 my $item = shift @items;
1561 if ($item->[0] =~ /_ANON/) {
1562 if (defined $item->[2]) {
1564 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1565 ], @{ $structs{$item->[0]} };
1567 push @items, @{ $structs{$item->[0]} };
1570 push @list, $item->[2];
1573 my $methods = (join '(...)>, C<', @list) . '(...)';
1577 #=head2 Object and class methods for C<$name>/C<$ptrname>
1579 #The principal Perl representation of a C object of type C<$name> is an
1580 #object of class C<$ptrname> which is a reference to an integer
1581 #representation of a C pointer. To create such an object, one may use
1584 # my \$buffer = $name->new();
1585 # my \$obj = \$buffer->_to_ptr();
1587 #This exersizes the following two methods, and an additional class
1588 #C<$name>, the internal representation of which is a reference to a
1589 #packed string with the C structure. Keep in mind that \$buffer should
1590 #better survive longer than \$obj.
1594 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1596 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1598 #=item C<$name-E<gt>new()>
1600 #Creates an empty object of type C<$name>. The corresponding packed
1601 #string is zeroed out.
1605 #return the current value of the corresponding element if called
1606 #without additional arguments. Set the element to the supplied value
1607 #(and return the new value) if called with an additional argument.
1609 #Applicable to objects of type C<$ptrname>.
1618 # Should be called before any actual call to normalize_type().
1620 # We do not want to read ./typemap by obvios reasons.
1621 my @tm = qw(../../../typemap ../../typemap ../typemap);
1622 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1623 unshift @tm, $stdtypemap;
1624 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1626 # Start with useful default values
1627 $typemap{float} = 'T_NV';
1629 foreach my $typemap (@tm) {
1630 next unless -e $typemap ;
1631 # skip directories, binary files etc.
1632 warn " Scanning $typemap\n";
1633 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1634 unless -T $typemap ;
1635 open(TYPEMAP, $typemap)
1636 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1637 my $mode = 'Typemap';
1640 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1641 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1642 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1643 elsif ($mode eq 'Typemap') {
1644 next if /^\s*($|\#)/ ;
1646 if ( ($type, $image) =
1647 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1648 # This may reference undefined functions:
1649 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1650 $typemap{normalize_type($type)} = $image;
1654 close(TYPEMAP) or die "Cannot close $typemap: $!";
1656 %std_types = %types_seen;
1661 sub normalize_type { # Second arg: do not strip const's before \*
1663 my $do_keep_deep_const = shift;
1664 # If $do_keep_deep_const this is heuristical only
1665 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1667 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1668 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1669 $type =~ s/$ignore_mods//go;
1672 $type =~ s/$ignore_mods//go;
1674 $type =~ s/([^\s\w])/ $1 /g;
1678 $type =~ s/\* (?=\*)/*/g;
1679 $type =~ s/\. \. \./.../g;
1681 $types_seen{$type}++
1682 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1688 sub assign_typemap_entry {
1692 if ($tmask and $type =~ /$tmask/) {
1693 print "Type $type matches -o mask\n" if $opt_d;
1694 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1696 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1697 $type = normalize_type $type;
1698 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1699 $entry = assign_typemap_entry($type);
1701 $entry ||= $typemap{$otype}
1702 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1703 $typemap{$otype} = $entry;
1704 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1709 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1713 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1715 while (my($name, $struct) = each %structs) {
1716 print_accessors(\*XS, $name, $struct);
1725 warn "Writing $ext$modpname/typemap\n";
1726 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1728 for $type (sort keys %types_seen) {
1729 my $entry = assign_typemap_entry $type;
1730 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1733 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1734 #############################################################################
1737 if (sv_derived_from($arg, \"${ntype}\")) {
1739 char *s = SvPV((SV*)SvRV($arg), len);
1741 if (len != sizeof($var))
1742 croak(\"Size %d of packed data != expected %d\",
1747 croak(\"$var is not of type ${ntype}\")
1748 #############################################################################
1751 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1754 close TM or die "Cannot close typemap file for write: $!";
1759 warn "Writing $ext$modpname/Makefile.PL\n";
1760 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1763 use ExtUtils::MakeMaker;
1764 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1765 # the contents of the Makefile that is written.
1767 'NAME' => '$module',
1768 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION
1769 'PREREQ_PM' => {}, # e.g., Module::Name => 1.1
1770 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1771 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1772 AUTHOR => '$author <$email>') : ()),
1774 if (!$opt_X) { # print C stuff, unless XS is disabled
1775 $opt_F = '' unless defined $opt_F;
1776 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1777 my $Ihelp = ($I ? '-I. ' : '');
1778 my $Icomment = ($I ? '' : <<EOC);
1779 # Insert -I. if you add *.h files later:
1783 'LIBS' => ['$extralibs'], # e.g., '-lm'
1784 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1785 $Icomment 'INC' => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1788 my $C = grep $_ ne "$modfname.c", (glob '*.c'), (glob '*.cc'), (glob '*.C');
1789 my $Cpre = ($C ? '' : '# ');
1790 my $Ccomment = ($C ? '' : <<EOC);
1791 # Un-comment this if you add C files to link with later:
1795 $Ccomment $Cpre\'OBJECT' => '\$(O_FILES)', # link all the C files too
1799 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1801 # Create a simple README since this is a CPAN requirement
1802 # and it doesnt hurt to have one
1803 warn "Writing $ext$modpname/README\n";
1804 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
1805 my $thisyear = (gmtime)[5] + 1900;
1806 my $rmhead = "$modpname version $TEMPLATE_VERSION";
1807 my $rmheadeq = "=" x length($rmhead);
1812 The README is used to introduce the module and provide instructions on
1813 how to install the module, any machine dependencies it may have (for
1814 example C compilers and installed libraries) and any other information
1815 that should be provided before the module is installed.
1817 A README file is required for CPAN modules since CPAN extracts the
1818 README file from a module distribution so that people browsing the
1819 archive can use it get an idea of the modules uses. It is usually a
1820 good idea to provide version information here so that people can
1821 decide whether fixes for the module are worth downloading.
1825 To install this module type the following:
1834 This module requires these other modules and libraries:
1838 COPYRIGHT AND LICENCE
1840 Put the correct copyright and licence information here.
1842 Copyright (C) $thisyear $author
1844 This library is free software; you can redistribute it and/or modify
1845 it under the same terms as Perl itself.
1848 close(RM) || die "Can't close $ext$modpname/README: $!\n";
1851 my $testfile = "$testdir/1.t";
1852 unless (-d "$testdir") {
1853 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
1855 warn "Writing $ext$modpname/$testfile\n";
1856 my $tests = @const_names ? 2 : 1;
1858 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
1860 # Before `make install' is performed this script should be runnable with
1861 # `make test'. After `make install' it should work as `perl 1.t'
1863 #########################
1865 # change 'tests => $tests' to 'tests => last_test_to_print';
1868 BEGIN { plan tests => $tests };
1870 ok(1); # If we made it this far, we're ok.
1874 my $const_names = join " ", @const_names;
1878 foreach my \$constname qw($const_names) {
1879 next if (eval "my \\\$a = \$constname; 1");
1880 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
1881 print "# pass: \$\@";
1883 print "# fail: \$\@";
1888 print "not ok 2\\n";
1896 #########################
1898 # Insert your test code below, the Test module is use()ed here so read
1899 # its man page ( perldoc Test ) for help writing this test script.
1902 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
1905 warn "Writing $ext$modpname/Changes\n";
1907 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
1908 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
1910 Revision history for Perl extension $module.
1912 $TEMPLATE_VERSION @{[scalar localtime]}
1913 \t- original version; created by h2xs $H2XS_VERSION with options
1917 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
1920 warn "Writing $ext$modpname/MANIFEST\n";
1921 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
1922 my @files = grep { -f } (<*>, <t/*>);
1924 eval {opendir(D,'.');};
1925 unless ($@) { @files = readdir(D); closedir(D); }
1927 if (!@files) { @files = map {chomp && $_} `ls`; }
1930 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
1932 # Fix up for case-sensitive file systems
1933 s/$modfname/$modfname/i && next;
1934 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
1935 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
1938 print MANI join("\n",@files), "\n";
1942 close OUT or die "Can't close $file: $!";
1943 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1944 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';