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.
63 The extra libraries should be specified in the form -lm -lposix, etc,
64 just as on the cc command line. By default, the Makefile.PL will
65 search through the library path determined by Configure. That path
66 can be augmented by including arguments of the form B<-L/another/library/path>
67 in the extra-libraries argument.
75 Omit all autoload facilities. This is the same as B<-c> but also removes the
76 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 types.
162 The type-to-match is whitewashed (except for commas, which have no
163 whitespace before them, and multiple C<*> which have no whitespace
166 =item B<-p> I<prefix>
168 Specify a prefix which should be removed from the Perl function names, e.g., S<-p sec_rgy_>
169 This sets up the XS B<PREFIX> keyword and removes the prefix from functions that are
170 autoloaded via the C<constant()> mechanism.
172 =item B<-s> I<sub1,sub2>
174 Create a perl subroutine for the specified macros rather than autoload with the constant() subroutine.
175 These macros are assumed to have a return type of B<char *>, e.g., S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
177 =item B<-v> I<version>
179 Specify a version number for this extension. This version number is added
180 to the templates. The default is 0.01.
184 Automatically generate XSUBs basing on function declarations in the
185 header file. The package C<C::Scan> should be installed. If this
186 option is specified, the name of the header file may look like
187 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified string,
188 but XSUBs are emitted only for the declarations included from file NAME2.
190 Note that some types of arguments/return-values for functions may
191 result in XSUB-declarations/typemap-entries which need
192 hand-editing. Such may be objects which cannot be converted from/to a
193 pointer (like C<long long>), pointers to functions, or arrays. See
194 also the section on L<LIMITATIONS of B<-x>>.
196 =item B<-b> I<version>
198 Generates a .pm file which is backwards compatible with the specified
201 For versions < 5.6.0, the changes are.
202 - no use of 'our' (uses 'use vars' instead)
205 Specifying a compatibility version higher than the version of perl you
206 are using to run h2xs will have no effect.
213 # Default behavior, extension is Rusers
216 # Same, but extension is RUSERS
217 h2xs -n RUSERS rpcsvc/rusers
219 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
222 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
223 h2xs -n ONC::RPC rpcsvc/rusers
225 # Without constant() or AUTOLOAD
226 h2xs -c rpcsvc/rusers
228 # Creates templates for an extension named RPC
231 # Extension is ONC::RPC.
234 # Makefile.PL will look for library -lrpc in
235 # additional directory /opt/net/lib
236 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
238 # Extension is DCE::rgynbase
239 # prefix "sec_rgy_" is dropped from perl function names
240 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
242 # Extension is DCE::rgynbase
243 # prefix "sec_rgy_" is dropped from perl function names
244 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
245 h2xs -n DCE::rgynbase -p sec_rgy_ \
246 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
248 # Make XS without defines in perl.h, but with function declarations
249 # visible from perl.h. Name of the extension is perl1.
250 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
251 # Extra backslashes below because the string is passed to shell.
252 # Note that a directory with perl header files would
253 # be added automatically to include path.
254 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
256 # Same with function declaration in proto.h as visible from perl.h.
257 h2xs -xAn perl2 perl.h,proto.h
259 # Same but select only functions which match /^av_/
260 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
262 # Same but treat SV* etc as "opaque" types
263 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
265 =head2 Extension based on F<.h> and F<.c> files
267 Suppose that you have some C files implementing some functionality,
268 and the corresponding header files. How to create an extension which
269 makes this functionality accessable in Perl? The example below
270 assumes that the header files are F<interface_simple.h> and
271 I<interface_hairy.h>, and you want the perl module be named as
272 C<Ext::Ension>. If you need some preprocessor directives and/or
273 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
278 =item Find the directory name
280 Start with a dummy run of h2xs:
282 h2xs -Afn Ext::Ension
284 The only purpose of this step is to create the needed directories, and
285 let you know the names of these directories. From the output you can
286 see that the directory for the extension is F<Ext/Ension>.
290 Copy your header files and C files to this directory F<Ext/Ension>.
292 =item Create the extension
294 Run h2xs, overwriting older autogenerated files:
296 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
298 h2xs looks for header files I<after> changing to the extension
299 directory, so it will find your header files OK.
301 =item Archive and test
313 It is important to do C<make dist> as early as possible. This way you
314 can easily merge(1) your changes to autogenerated files if you decide
315 to edit your C<.h> files and rerun h2xs.
317 Do not forget to edit the documentation in the generated F<.pm> file.
319 Consider the autogenerated files as skeletons only, you may invent
320 better interfaces than what h2xs could guess.
322 Consider this section as a guideline only, some other options of h2xs
323 may better suit your needs.
329 No environment variables are used.
333 Larry Wall and others
337 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
341 The usual warnings if it cannot read or write the files involved.
343 =head1 LIMITATIONS of B<-x>
345 F<h2xs> would not distinguish whether an argument to a C function
346 which is of the form, say, C<int *>, is an input, output, or
347 input/output parameter. In particular, argument declarations of the
354 should be better rewritten as
360 if C<n> is an input parameter.
362 Additionally, F<h2xs> has no facilities to intuit that a function
369 takes a pair of address and length of data at this address, so it is better
370 to rewrite this function as
380 RETVAL = foo(s, len);
390 char *s = SvPV(sv,len);
395 MODULE = foo PACKAGE = foo PREFIX = my_
401 See L<perlxs> and L<perlxstut> for additional details.
408 my( $H2XS_VERSION ) = ' $Revision: 1.21 $ ' =~ /\$Revision:\s+([^\s]+)/;
409 my $TEMPLATE_VERSION = '0.01';
411 my $compat_version = $];
419 h2xs [-ACOPXacdfhkmx] [-F addflags] [-M fmask] [-n module_name] [-o tmask] [-p prefix] [-s subs] [-v version] [-b compat_version ] [headerfile [extra_libraries]]
420 version: $H2XS_VERSION
421 -A Omit all autoloading facilities (implies -c).
422 -C Omit creating the Changes file, add HISTORY heading to stub POD.
423 -F Additional flags for C preprocessor (used with -x).
424 -M Mask to select C functions/macros (default is select all).
425 -O Allow overwriting of a pre-existing extension directory.
426 -P Omit the stub POD section.
427 -X Omit the XS portion (implies both -c and -f).
428 -a Generate get/set accessors for struct and union members (used with -x).
429 -c Omit the constant() function and specialised AUTOLOAD from the XS file.
430 -d Turn on debugging messages.
431 -f Force creation of the extension even if the C header does not exist.
432 -h Display this help message
433 -k Omit 'const' attribute on function arguments (used with -x).
434 -m Generate tied variables for access to declared variables.
435 -n Specify a name to use for the extension (recommended).
436 -o Regular expression for \"opaque\" types.
437 -p Specify a prefix which should be removed from the Perl function names.
438 -s Create subroutines for specified macros.
439 -v Specify a version number for this extension.
440 -x Autogenerate XSUBs using C::Scan.
441 -b Specify a perl version to be backwards compatibile with
443 are any libraries that might be needed for loading the
444 extension, e.g. -lm would try to link in the math library.
449 getopts("ACF:M:OPXacdfhkmn:o:p:s:v:xb:") || usage;
450 use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_a $opt_c $opt_d
451 $opt_f $opt_h $opt_k $opt_m $opt_n $opt_o $opt_p $opt_s $opt_v $opt_x
457 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
458 $opt_b =~ /^\d+\.\d+\.\d+/ ||
459 usage "You must provide the backwards compatibility version in X.Y.Z form. " .
461 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
462 $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
466 $TEMPLATE_VERSION = $opt_v;
470 $opt_c = 1 if $opt_A;
472 # -X implies -c and -f
473 $opt_c = $opt_f = 1 if $opt_X;
475 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
481 while (my $arg = shift) {
482 if ($arg =~ /^-l/i) {
483 $extralibs = "$arg @ARGV";
489 usage "Must supply header file or module name\n"
490 unless (@path_h or $opt_n);
495 $fmask = qr{$opt_M} if defined $opt_M;
496 $tmask = qr{$opt_o} if defined $opt_o;
497 my $tmask_all = $tmask && $opt_o eq '.';
500 eval {require C::Scan; 1}
502 C::Scan required if you use -x option.
503 To install C::Scan, execute
504 perl -MCPAN -e "install C::Scan"
506 unless ($tmask_all) {
507 $C::Scan::VERSION >= 0.70
509 C::Scan v. 0.70 or later required unless you use -o . option.
510 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
511 To install C::Scan, execute
512 perl -MCPAN -e "install C::Scan"
515 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
517 C::Scan v. 0.73 or later required to use -m or -a options.
518 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
519 To install C::Scan, execute
520 perl -MCPAN -e "install C::Scan"
524 elsif ($opt_o or $opt_F) {
526 Options -o and -F do not make sense without -x.
530 my @path_h_ini = @path_h;
531 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
539 if ($^O eq 'VMS') { # Consider overrides of default location
540 # XXXX This is not equivalent to what the older version did:
541 # it was looking at $hadsys header-file per header-file...
542 my($hadsys) = grep s!^sys/!!i , @path_h;
543 @paths = qw( Sys$Library VAXC$Include );
544 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
545 push @paths, qw( DECC$Library_Include DECC$System_Include );
548 @paths = (File::Spec->curdir(), $Config{usrinc},
549 (split ' ', $Config{locincpth}), '/usr/include');
551 foreach my $path_h (@path_h) {
555 if ( $name !~ /::/ ) {
562 if( $path_h =~ s#::#/#g && $opt_n ){
563 warn "Nesting of headerfile ignored with -n\n";
565 $path_h .= ".h" unless $path_h =~ /\.h$/;
566 my $fullpath = $path_h;
567 $path_h =~ s/,.*$// if $opt_x;
568 $fullpath{$path_h} = $fullpath;
570 # Minor trickery: we can't chdir() before we processed the headers
571 # (so know the name of the extension), but the header may be in the
572 # extension directory...
573 my $tmp_path_h = $path_h;
574 my $rel_path_h = $path_h;
576 if (not -f $path_h) {
578 for my $dir (@paths) {
580 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
583 $rel_path_h = $path_h;
585 (my $epath = $module) =~ s,::,/,g;
586 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
587 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
588 $path_h = $tmp_path_h; # Used during -x
594 die "Can't find $tmp_path_h in @dirs\n"
595 if ( ! $opt_f && ! -f "$rel_path_h" );
596 # Scan the header file (we should deal with nested header files)
597 # Record the names of simple #define constants into const_names
598 # Function prototypes are processed below.
599 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
602 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
605 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
608 # Cannot do: (-1) and ((LHANDLE)3) are OK:
609 #print("Skip non-wordy $def => $rest\n"),
610 # next defines if $rest =~ /[^\w\$]/;
612 print("Skip stringy $def => $rest\n") if $opt_d;
615 print "Matched $_ ($def)\n" if $opt_d;
616 $seen_define{$def} = $rest;
618 next if /^_.*_h_*$/i; # special case, but for what?
619 if (defined $opt_p) {
620 if (!/^$opt_p(\d)/) {
621 ++$prefix{$_} if s/^$opt_p//;
624 warn "can't remove $opt_p prefix from '$_'!\n";
627 $prefixless{$def} = $_;
628 if (!$fmask or /$fmask/) {
629 print "... Passes mask of -M.\n" if $opt_d and $fmask;
641 my ($ext, $nested, @modparts, $modfname, $modpname);
643 $ext = chdir 'ext' ? 'ext/' : '';
645 if( $module =~ /::/ ){
647 @modparts = split(/::/,$module);
648 $modfname = $modparts[-1];
649 $modpname = join('/',@modparts);
654 $modfname = $modpname = $module;
659 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
662 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
667 mkdir("$modpath$_", 0777);
671 mkdir($modpname, 0777);
672 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
677 my $fdecls_parsed = [];
684 my @fnames_no_prefix;
688 if( ! $opt_X ){ # use XS, unless it was disabled
689 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
691 require Config; # Run-time directive
692 warn "Scanning typemaps...\n";
696 my $addflags = $opt_F || '';
698 foreach my $filename (@path_h) {
702 if ($fullpath{$filename} =~ /,/) {
706 warn "Scanning $filename for functions...\n";
707 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
708 'add_cppflags' => $addflags, 'c_styles' => [qw(C++ C9X)];
709 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]);
711 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
712 push(@$fdecls, @{$c->get('fdecls')});
714 push @td, @{$c->get('typedefs_maybe')};
716 my $structs = $c->get('typedef_structs');
717 @structs{keys %$structs} = values %$structs;
721 %vdecl_hash = %{ $c->get('vdecl_hash') };
722 @vdecls = sort keys %vdecl_hash;
723 for (local $_ = 0; $_ < @vdecls; ++$_) {
724 my $var = $vdecls[$_];
725 my($type, $post) = @{ $vdecl_hash{$var} };
727 warn "Can't handle variable '$type $var $post', skipping.\n";
728 splice @vdecls, $_, 1;
731 $type = normalize_type($type);
732 $vdecl_hash{$var} = $type;
736 unless ($tmask_all) {
737 warn "Scanning $filename for typedefs...\n";
738 my $td = $c->get('typedef_hash');
739 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
740 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
741 push @good_td, @f_good_td;
742 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
746 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
748 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
751 for my $i (0..$#$fdecls_parsed) {
752 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
754 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
757 $fdecls = [@$fdecls[@good]];
758 $fdecls_parsed = [@$fdecls_parsed[@good]];
760 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
763 my %h = map( ($_->[1], $_), @$fdecls_parsed);
764 $fdecls_parsed = [ @h{@fnames} ];
766 @fnames_no_prefix = @fnames;
768 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix;
769 # Remove macros which expand to typedefs
770 print "Typedefs are @td.\n" if $opt_d;
771 my %td = map {($_, $_)} @td;
772 # Add some other possible but meaningless values for macros
773 for my $k (qw(char double float int long short unsigned signed void)) {
774 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
776 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
779 while (keys %td > $n) {
782 while (($k, $v) = each %seen_define) {
783 # print("found '$k'=>'$v'\n"),
784 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
787 # Now %bad_macs contains names of bad macros
788 for my $k (keys %bad_macs) {
789 delete $const_names{$prefixless{$k}};
790 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
794 my @const_names = sort keys %const_names;
796 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
799 warn "Writing $ext$modpname/$modfname.pm\n";
801 if ( $compat_version < 5.006 ) {
819 unless( $opt_X || $opt_c || $opt_A ){
820 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
832 print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled
837 # Are we using AutoLoader or not?
838 unless ($opt_A) { # no autoloader whatsoever.
839 unless ($opt_c) { # we're doing the AUTOLOAD
840 print PM "use AutoLoader;\n";
843 print PM "use AutoLoader qw(AUTOLOAD);\n"
847 if ( $compat_version < 5.006 ) {
848 if ( $opt_X || $opt_c || $opt_A ) {
849 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
851 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
856 my $myISA = 'our @ISA = qw(Exporter'; # We seem to always want this.
857 $myISA .= ' DynaLoader' unless $opt_X; # no XS
859 $myISA =~ s/^our // if $compat_version < 5.006;
861 print PM "\n$myISA\n\n";
863 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
866 # Items to export into callers namespace by default. Note: do not export
867 # names by default without a very good reason. Use EXPORT_OK instead.
868 # Do not simply export all your public functions/methods/constants.
870 # This allows declaration use $module ':all';
871 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
873 our %EXPORT_TAGS = ( 'all' => [ qw(
877 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
882 our \$VERSION = '$TEMPLATE_VERSION';
886 $tmp =~ s/^our //mg if $compat_version < 5.006;
890 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
894 $tmp = ( $compat_version < 5.006 ? "" : "our \$AUTOLOAD;" );
895 print PM <<"END" unless $opt_c or $opt_X;
897 # This AUTOLOAD is used to 'autoload' constants from the constant()
898 # XS function. If a constant is not found then control is passed
899 # to the AUTOLOAD in AutoLoader.
903 (\$constname = \$AUTOLOAD) =~ s/.*:://;
904 croak "&${module}::constant not defined" if \$constname eq 'constant';
905 my \$val = constant(\$constname, \@_ ? \$_[0] : 0);
907 if (\$! =~ /Invalid/ || \$!{EINVAL}) {
908 \$AutoLoader::AUTOLOAD = \$AUTOLOAD;
909 goto &AutoLoader::AUTOLOAD;
912 croak "Your vendor has not defined $module macro \$constname";
917 # Fixed between 5.005_53 and 5.005_61
918 if (\$] >= 5.00561) {
919 *\$AUTOLOAD = sub () { \$val };
922 *\$AUTOLOAD = sub { \$val };
930 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
932 bootstrap $module \$VERSION;
936 # tying the variables can happen only after bootstrap
940 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
947 if( $opt_P ){ # if POD is disabled
956 # Preloaded methods go here.
959 print PM <<"END" unless $opt_A;
961 # Autoload methods go after $after, and are processed by the autosplit program.
974 ($user,$author) = (getpwuid($>))[0,6];
975 $author =~ s/,.*$//; # in case of sub fields
976 my $domain = $Config{'mydomain'};
978 $email = "$user\@$domain";
981 $author ||= "A. U. Thor";
982 $email ||= 'a.u.thor@a.galaxy.far.far.away';
985 $revhist = <<EOT if $opt_C;
991 #=item $TEMPLATE_VERSION
993 #Original version; created by h2xs $H2XS_VERSION with options
1001 my $exp_doc = <<EOD;
1009 if (@const_names and not $opt_P) {
1011 #=head2 Exportable constants
1013 # @{[join "\n ", @const_names]}
1018 if (defined $fdecls and @$fdecls and not $opt_P) {
1020 #=head2 Exportable functions
1024 # $exp_doc .= <<EOD if $opt_p;
1025 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1029 # @{[join "\n ", @known_fnames{@fnames}]}
1036 if ($opt_x && $opt_a) {
1038 $meth_doc .= accessor_docs($name, $struct)
1039 while ($name, $struct) = each %structs;
1042 my $pod = <<"END" unless $opt_P;
1043 ## Below is stub documentation for your module. You better edit it!
1047 #$module - Perl extension for blah blah blah
1056 #Stub documentation for $module, created by h2xs. It looks like the
1057 #author of the extension was negligent enough to leave the stub
1061 $exp_doc$meth_doc$revhist
1064 #$author, E<lt>${email}E<gt>
1066 #=head1 MAILING LIST
1068 #If you have a mailing list set up for your module, mention it here.
1070 #=head1 COPYRIGHT AND LICENSE
1072 #Copyright (C) YEAR YOURNAMEHERE
1074 #This library is free software; you can redistribute it and/or modify
1075 #it under the same terms as Perl itself.
1084 $pod =~ s/^\#//gm unless $opt_P;
1085 print PM $pod unless $opt_P;
1090 if( ! $opt_X ){ # print XS, unless it is disabled
1091 warn "Writing $ext$modpname/$modfname.xs\n";
1100 foreach my $path_h (@path_h_ini) {
1102 $h =~ s#^/usr/include/##;
1103 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1104 print XS qq{#include <$h>\n};
1109 my %pointer_typedefs;
1110 my %struct_typedefs;
1114 my $out = $pointer_typedefs{$type};
1115 return $out if defined $out;
1117 $out = ($type =~ /\*$/);
1118 # This converts only the guys which do not have trailing part in the typedef
1120 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1121 $type = normalize_type($type);
1122 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1124 $out = td_is_pointer($type);
1126 return ($pointer_typedefs{$otype} = $out);
1131 my $out = $struct_typedefs{$type};
1132 return $out if defined $out;
1134 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1135 # This converts only the guys which do not have trailing part in the typedef
1137 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1138 $type = normalize_type($type);
1139 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1141 $out = td_is_struct($type);
1143 return ($struct_typedefs{$otype} = $out);
1146 # Some macros will bomb if you try to return them from a double-returning func.
1147 # Say, ((char *)0), or strlen (if somebody #define STRLEN strlen).
1148 # Fortunately, we can detect both these cases...
1149 sub protect_convert_to_double {
1152 return '' unless defined ($val = $seen_define{$in});
1153 return '(IV)' if $known_fnames{$val};
1154 # OUT_t of ((OUT_t)-1):
1155 return '' unless $val =~ /^\s*(\(\s*)?\(\s*([^()]*?)\s*\)/;
1156 td_is_pointer($2) ? '(IV)' : '';
1159 # For each of the generated functions, length($pref) leading
1160 # letters are already checked. Moreover, it is recommended that
1161 # the generated functions uses switch on letter at offset at least
1162 # $off + length($pref).
1164 # The given list has length($pref) chars removed at front, it is
1165 # guarantied that $off leading chars in the rest are the same for all
1168 # Returns: how at which offset it was decided to make a switch, or -1 if none.
1173 my ($fh, $pref, $off, $list) = (shift,shift,shift,shift);
1175 my $offarg = length $pref;
1177 if (@$list == 0) { # Can happen on the initial iteration only
1180 constant(char *name, int len, int arg)
1189 if (@$list == 1) { # Can happen on the initial iteration only
1190 my $protect = protect_convert_to_double("$pref$list->[0]");
1194 constant(char *name, int len, int arg)
1197 if (strEQ(name + $offarg, "$list->[0]")) { /* $pref removed */
1198 #ifdef $pref$list->[0]
1199 return $protect$pref$list->[0];
1212 for my $n (@$list) {
1213 my $c = substr $n, $off, 1;
1214 $leading{$c} = [] unless exists $leading{$c};
1215 push @{$leading{$c}}, $off < length $n ? substr $n, $off + 1 : $n
1218 if (keys(%leading) == 1) {
1219 return 1 + write_const $fh, $pref, $off + 1, $list;
1222 my $leader = substr $list->[0], 0, $off;
1223 foreach my $letter (keys %leading) {
1224 write_const $fh, "$pref$leader$letter", 0, $leading{$letter}
1225 if @{$leading{$letter}} > 1;
1228 my $npref = "_$pref";
1229 $npref = '' if $pref eq '';
1233 constant$npref(char *name, int len, int arg)
1237 print $fh <<"END" if $npref eq '';
1241 print $fh <<"END" if $off;
1242 if ($offarg + $off >= len ) {
1249 switch (name[$offarg + $off]) {
1252 foreach my $letter (sort keys %leading) {
1254 $let = '\0' if $letter eq '';
1259 if (@{$leading{$letter}} > 1) {
1260 # It makes sense to call a function
1263 if (!strnEQ(name + $offarg,"$leader", $off))
1268 return constant_$pref$leader$letter(name, len, arg);
1274 = protect_convert_to_double("$pref$leader$letter$leading{$letter}[0]");
1277 if (strEQ(name + $offarg, "$leader$letter$leading{$letter}[0]")) { /* $pref removed */
1278 #ifdef $pref$leader$letter$leading{$letter}[0]
1279 return $protect$pref$leader$letter$leading{$letter}[0];
1306 croak("${module}::%s not implemented on this architecture", s);
1312 write_const(\*XS, '', 0, \@const_names);
1315 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1317 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1319 # Now switch from C to XS by issuing the first MODULE declaration:
1322 MODULE = $module PACKAGE = $module $prefix
1326 foreach (sort keys %const_xsub) {
1335 croak("Your vendor has not defined the $module macro $_");
1344 # If a constant() function was written then output a corresponding
1346 print XS <<"END" unless $opt_c;
1354 char * s = SvPV(sv, len);
1357 RETVAL = constant(s,len,arg);
1369 my ($type, $name, $args) = @$decl;
1370 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1372 my @argnames = map {$_->[1]} @$args;
1373 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1375 s/^\s*const\b\s*// for @argtypes;
1377 my @argarrays = map { $_->[4] || '' } @$args;
1378 my $numargs = @$args;
1379 if ($numargs and $argtypes[-1] eq '...') {
1381 $argnames[-1] = '...';
1384 $type = normalize_type($type, 1);
1392 for my $arg (0 .. $numargs - 1) {
1394 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1399 sub print_tievar_subs {
1400 my($fh, $name, $type) = @_;
1403 _get_$name(IV index, SV *sv) {
1408 (void)call_pv("$module\::_get_$name", G_DISCARD);
1413 _set_$name(IV index, SV *sv) {
1418 (void)call_pv("$module\::_set_$name", G_DISCARD);
1425 sub print_tievar_xsubs {
1426 my($fh, $name, $type) = @_;
1434 uf.uf_val = &_get_$name;
1435 uf.uf_set = &_set_$name;
1436 uf.uf_index = (IV)&_get_$name;
1437 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1441 $type THIS = NO_INIT
1457 sub print_accessors {
1458 my($fh, $name, $struct) = @_;
1459 return unless defined $struct && $name !~ /\s|_ANON/;
1460 $name = normalize_type($name);
1461 my $ptrname = normalize_type("$name *");
1464 MODULE = $module PACKAGE = ${name} $prefix
1468 $name THIS = NO_INIT
1471 if (sv_derived_from(ST(0), "$name")) {
1473 char *s = SvPV((SV*)SvRV(ST(0)), len);
1474 if (len != sizeof(THIS))
1475 croak("Size \%d of packed data != expected \%d",
1477 RETVAL = ($name *)s;
1480 croak("THIS is not of type $name");
1486 char *CLASS = NO_INIT
1489 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1493 MODULE = $module PACKAGE = ${name}Ptr $prefix
1496 my @items = @$struct;
1498 my $item = shift @items;
1499 if ($item->[0] =~ /_ANON/) {
1500 if (defined $item->[2]) {
1502 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1503 ], @{ $structs{$item->[0]} };
1505 push @items, @{ $structs{$item->[0]} };
1508 my $type = normalize_type($item->[0]);
1509 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1512 $item->[2](THIS, __value = NO_INIT)
1518 THIS->$item->[-1] = __value;
1520 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1531 my($name, $struct) = @_;
1532 return unless defined $struct && $name !~ /\s|_ANON/;
1533 $name = normalize_type($name);
1534 my $ptrname = $name . 'Ptr';
1535 my @items = @$struct;
1538 my $item = shift @items;
1539 if ($item->[0] =~ /_ANON/) {
1540 if (defined $item->[2]) {
1542 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1543 ], @{ $structs{$item->[0]} };
1545 push @items, @{ $structs{$item->[0]} };
1548 push @list, $item->[2];
1551 my $methods = (join '(...)>, C<', @list) . '(...)';
1555 #=head2 Object and class methods for C<$name>/C<$ptrname>
1557 #The principal Perl representation of a C object of type C<$name> is an
1558 #object of class C<$ptrname> which is a reference to an integer
1559 #representation of a C pointer. To create such an object, one may use
1562 # my \$buffer = $name->new();
1563 # my \$obj = \$buffer->_to_ptr();
1565 #This exersizes the following two methods, and an additional class
1566 #C<$name>, the internal representation of which is a reference to a
1567 #packed string with the C structure. Keep in mind that \$buffer should
1568 #better survive longer than \$obj.
1572 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1574 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1576 #=item C<$name-E<gt>new()>
1578 #Creates an empty object of type C<$name>. The corresponding packed
1579 #string is zeroed out.
1583 #return the current value of the corresponding element if called
1584 #without additional arguments. Set the element to the supplied value
1585 #(and return the new value) if called with an additional argument.
1587 #Applicable to objects of type C<$ptrname>.
1596 # Should be called before any actual call to normalize_type().
1598 # We do not want to read ./typemap by obvios reasons.
1599 my @tm = qw(../../../typemap ../../typemap ../typemap);
1600 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1601 unshift @tm, $stdtypemap;
1602 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1604 # Start with useful default values
1605 $typemap{float} = 'T_DOUBLE';
1607 foreach my $typemap (@tm) {
1608 next unless -e $typemap ;
1609 # skip directories, binary files etc.
1610 warn " Scanning $typemap\n";
1611 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1612 unless -T $typemap ;
1613 open(TYPEMAP, $typemap)
1614 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1615 my $mode = 'Typemap';
1618 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1619 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1620 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1621 elsif ($mode eq 'Typemap') {
1622 next if /^\s*($|\#)/ ;
1624 if ( ($type, $image) =
1625 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1626 # This may reference undefined functions:
1627 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1628 $typemap{normalize_type($type)} = $image;
1632 close(TYPEMAP) or die "Cannot close $typemap: $!";
1634 %std_types = %types_seen;
1639 sub normalize_type { # Second arg: do not strip const's before \*
1641 my $do_keep_deep_const = shift;
1642 # If $do_keep_deep_const this is heuristical only
1643 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1645 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1646 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1647 $type =~ s/$ignore_mods//go;
1650 $type =~ s/$ignore_mods//go;
1652 $type =~ s/([^\s\w])/ $1 /g;
1656 $type =~ s/\* (?=\*)/*/g;
1657 $type =~ s/\. \. \./.../g;
1659 $types_seen{$type}++
1660 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1666 sub assign_typemap_entry {
1670 if ($tmask and $type =~ /$tmask/) {
1671 print "Type $type matches -o mask\n" if $opt_d;
1672 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1674 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1675 $type = normalize_type $type;
1676 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1677 $entry = assign_typemap_entry($type);
1679 $entry ||= $typemap{$otype}
1680 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1681 $typemap{$otype} = $entry;
1682 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1687 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1691 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1693 while (my($name, $struct) = each %structs) {
1694 print_accessors(\*XS, $name, $struct);
1703 warn "Writing $ext$modpname/typemap\n";
1704 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1706 for $type (sort keys %types_seen) {
1707 my $entry = assign_typemap_entry $type;
1708 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1711 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1712 #############################################################################
1715 if (sv_derived_from($arg, \"${ntype}\")) {
1717 char *s = SvPV((SV*)SvRV($arg), len);
1719 if (len != sizeof($var))
1720 croak(\"Size %d of packed data != expected %d\",
1725 croak(\"$var is not of type ${ntype}\")
1726 #############################################################################
1729 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1732 close TM or die "Cannot close typemap file for write: $!";
1737 warn "Writing $ext$modpname/Makefile.PL\n";
1738 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1741 use ExtUtils::MakeMaker;
1742 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1743 # the contents of the Makefile that is written.
1745 'NAME' => '$module',
1746 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION
1747 'PREREQ_PM' => {}, # e.g., Module::Name => 1.1
1748 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1749 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1750 AUTHOR => '$author <$email>') : ()),
1752 if (!$opt_X) { # print C stuff, unless XS is disabled
1753 $opt_F = '' unless defined $opt_F;
1754 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1755 my $Ihelp = ($I ? '-I. ' : '');
1756 my $Icomment = ($I ? '' : <<EOC);
1757 # Insert -I. if you add *.h files later:
1761 'LIBS' => ['$extralibs'], # e.g., '-lm'
1762 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1763 $Icomment 'INC' => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1766 my $C = grep $_ ne "$modfname.c", (glob '*.c'), (glob '*.cc'), (glob '*.C');
1767 my $Cpre = ($C ? '' : '# ');
1768 my $Ccomment = ($C ? '' : <<EOC);
1769 # Un-comment this if you add C files to link with later:
1773 $Ccomment $Cpre\'OBJECT' => '\$(O_FILES)', # link all the C files too
1777 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1779 # Create a simple README since this is a CPAN requirement
1780 # and it doesnt hurt to have one
1781 warn "Writing $ext$modpname/README\n";
1782 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
1783 my $thisyear = (gmtime)[5] + 1900;
1784 my $rmhead = "$modpname version $TEMPLATE_VERSION";
1785 my $rmheadeq = "=" x length($rmhead);
1790 The README is used to introduce the module and provide instructions on
1791 how to install the module, any machine dependencies it may have (for
1792 example C compilers and installed libraries) and any other information
1793 that should be provided before the module is installed.
1795 A README file is required for CPAN modules since CPAN extracts the
1796 README file from a module distribution so that people browsing the
1797 archive can use it get an idea of the modules uses. It is usually a
1798 good idea to provide version information here so that people can
1799 decide whether fixes for the module are worth downloading.
1803 To install this module type the following:
1812 This module requires these other modules and libraries:
1816 COPYRIGHT AND LICENCE
1818 Put the correct copyright and licence information here.
1820 Copyright (C) $thisyear $author blah blah blah
1823 close(RM) || die "Can't close $ext$modpname/README: $!\n";
1825 warn "Writing $ext$modpname/test.pl\n";
1826 open(EX, ">test.pl") || die "Can't create $ext$modpname/test.pl: $!\n";
1828 # Before `make install' is performed this script should be runnable with
1829 # `make test'. After `make install' it should work as `perl test.pl'
1831 #########################
1833 # change 'tests => 1' to 'tests => last_test_to_print';
1836 BEGIN { plan tests => 1 };
1842 ok(1); # If we made it this far, we're ok.
1844 #########################
1846 # Insert your test code below, the Test module is use()ed here so read
1847 # its man page ( perldoc Test ) for help writing this test script.
1850 close(EX) || die "Can't close $ext$modpname/test.pl: $!\n";
1853 warn "Writing $ext$modpname/Changes\n";
1855 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
1856 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
1858 Revision history for Perl extension $module.
1860 $TEMPLATE_VERSION @{[scalar localtime]}
1861 \t- original version; created by h2xs $H2XS_VERSION with options
1865 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
1868 warn "Writing $ext$modpname/MANIFEST\n";
1869 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
1872 eval {opendir(D,'.');};
1873 unless ($@) { @files = readdir(D); closedir(D); }
1875 if (!@files) { @files = map {chomp && $_} `ls`; }
1878 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
1880 # Fix up for case-sensitive file systems
1881 s/$modfname/$modfname/i && next;
1882 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
1883 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
1886 print MANI join("\n",@files), "\n";
1890 close OUT or die "Can't close $file: $!";
1891 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1892 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';