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.
119 =item B<-b> I<version>
121 Generates a .pm file which is backwards compatible with the specified
124 For versions < 5.6.0, the changes are.
125 - no use of 'our' (uses 'use vars' instead)
128 Specifying a compatibility version higher than the version of perl you
129 are using to run h2xs will have no effect.
133 Omit C<constant()> from the .xs file and corresponding specialised
134 C<AUTOLOAD> from the .pm file.
138 Turn on debugging messages.
142 Allows an extension to be created for a header even if that header is
143 not found in standard include directories.
147 Print the usage, help and version for this h2xs and exit.
151 For function arguments declared as C<const>, omit the const attribute in the
156 B<Experimental>: for each variable declared in the header file(s), declare
157 a perl variable of the same name magically tied to the C variable.
159 =item B<-n> I<module_name>
161 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
163 =item B<-o> I<regular expression>
165 Use "opaque" data type for the C types matched by the regular
166 expression, even if these types are C<typedef>-equivalent to types
167 from typemaps. Should not be used without B<-x>.
169 This may be useful since, say, types which are C<typedef>-equivalent
170 to integers may represent OS-related handles, and one may want to work
171 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
172 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
175 The type-to-match is whitewashed (except for commas, which have no
176 whitespace before them, and multiple C<*> which have no whitespace
179 =item B<-p> I<prefix>
181 Specify a prefix which should be removed from the Perl function names,
182 e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
183 the prefix from functions that are autoloaded via the C<constant()>
186 =item B<-s> I<sub1,sub2>
188 Create a perl subroutine for the specified macros rather than autoload
189 with the constant() subroutine. These macros are assumed to have a
190 return type of B<char *>, e.g.,
191 S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
195 Specify the internal type that the constant() mechanism uses for macros.
196 The default is IV (signed integer). Currently all macros found during the
197 header scanning process will be assumed to have this type. Future versions
198 of C<h2xs> may gain the ability to make educated guesses.
200 =item B<-v> I<version>
202 Specify a version number for this extension. This version number is added
203 to the templates. The default is 0.01.
207 Automatically generate XSUBs basing on function declarations in the
208 header file. The package C<C::Scan> should be installed. If this
209 option is specified, the name of the header file may look like
210 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
211 string, but XSUBs are emitted only for the declarations included from
214 Note that some types of arguments/return-values for functions may
215 result in XSUB-declarations/typemap-entries which need
216 hand-editing. Such may be objects which cannot be converted from/to a
217 pointer (like C<long long>), pointers to functions, or arrays. See
218 also the section on L<LIMITATIONS of B<-x>>.
225 # Default behavior, extension is Rusers
228 # Same, but extension is RUSERS
229 h2xs -n RUSERS rpcsvc/rusers
231 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
234 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
235 h2xs -n ONC::RPC rpcsvc/rusers
237 # Without constant() or AUTOLOAD
238 h2xs -c rpcsvc/rusers
240 # Creates templates for an extension named RPC
243 # Extension is ONC::RPC.
246 # Makefile.PL will look for library -lrpc in
247 # additional directory /opt/net/lib
248 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
250 # Extension is DCE::rgynbase
251 # prefix "sec_rgy_" is dropped from perl function names
252 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
254 # Extension is DCE::rgynbase
255 # prefix "sec_rgy_" is dropped from perl function names
256 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
257 h2xs -n DCE::rgynbase -p sec_rgy_ \
258 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
260 # Make XS without defines in perl.h, but with function declarations
261 # visible from perl.h. Name of the extension is perl1.
262 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
263 # Extra backslashes below because the string is passed to shell.
264 # Note that a directory with perl header files would
265 # be added automatically to include path.
266 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
268 # Same with function declaration in proto.h as visible from perl.h.
269 h2xs -xAn perl2 perl.h,proto.h
271 # Same but select only functions which match /^av_/
272 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
274 # Same but treat SV* etc as "opaque" types
275 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
277 =head2 Extension based on F<.h> and F<.c> files
279 Suppose that you have some C files implementing some functionality,
280 and the corresponding header files. How to create an extension which
281 makes this functionality accessable in Perl? The example below
282 assumes that the header files are F<interface_simple.h> and
283 I<interface_hairy.h>, and you want the perl module be named as
284 C<Ext::Ension>. If you need some preprocessor directives and/or
285 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
290 =item Find the directory name
292 Start with a dummy run of h2xs:
294 h2xs -Afn Ext::Ension
296 The only purpose of this step is to create the needed directories, and
297 let you know the names of these directories. From the output you can
298 see that the directory for the extension is F<Ext/Ension>.
302 Copy your header files and C files to this directory F<Ext/Ension>.
304 =item Create the extension
306 Run h2xs, overwriting older autogenerated files:
308 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
310 h2xs looks for header files I<after> changing to the extension
311 directory, so it will find your header files OK.
313 =item Archive and test
325 It is important to do C<make dist> as early as possible. This way you
326 can easily merge(1) your changes to autogenerated files if you decide
327 to edit your C<.h> files and rerun h2xs.
329 Do not forget to edit the documentation in the generated F<.pm> file.
331 Consider the autogenerated files as skeletons only, you may invent
332 better interfaces than what h2xs could guess.
334 Consider this section as a guideline only, some other options of h2xs
335 may better suit your needs.
341 No environment variables are used.
345 Larry Wall and others
349 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
353 The usual warnings if it cannot read or write the files involved.
355 =head1 LIMITATIONS of B<-x>
357 F<h2xs> would not distinguish whether an argument to a C function
358 which is of the form, say, C<int *>, is an input, output, or
359 input/output parameter. In particular, argument declarations of the
366 should be better rewritten as
372 if C<n> is an input parameter.
374 Additionally, F<h2xs> has no facilities to intuit that a function
381 takes a pair of address and length of data at this address, so it is better
382 to rewrite this function as
392 RETVAL = foo(s, len);
402 char *s = SvPV(sv,len);
407 MODULE = foo PACKAGE = foo PREFIX = my_
413 See L<perlxs> and L<perlxstut> for additional details.
420 my( $H2XS_VERSION ) = ' $Revision: 1.21 $ ' =~ /\$Revision:\s+([^\s]+)/;
421 my $TEMPLATE_VERSION = '0.01';
423 my $compat_version = $];
428 $Text::Wrap::huge = 'overflow';
429 $Text::Wrap::columns = 80;
430 use ExtUtils::Constant qw (constant_types C_constant XS_constant autoload);
435 h2xs [-ACOPXacdfhkmx] [-F addflags] [-M fmask] [-n module_name] [-o tmask] [-p prefix] [-s subs] [-v version] [-b compat_version ] [headerfile [extra_libraries]]
436 version: $H2XS_VERSION
437 -A Omit all autoloading facilities (implies -c).
438 -C Omit creating the Changes file, add HISTORY heading to stub POD.
439 -F Additional flags for C preprocessor (used with -x).
440 -M Mask to select C functions/macros (default is select all).
441 -O Allow overwriting of a pre-existing extension directory.
442 -P Omit the stub POD section.
443 -X Omit the XS portion (implies both -c and -f).
444 -a Generate get/set accessors for struct and union members (used with -x).
445 -c Omit the constant() function and specialised AUTOLOAD from the XS file.
446 -d Turn on debugging messages.
447 -f Force creation of the extension even if the C header does not exist.
448 -h Display this help message
449 -k Omit 'const' attribute on function arguments (used with -x).
450 -m Generate tied variables for access to declared variables.
451 -n Specify a name to use for the extension (recommended).
452 -o Regular expression for \"opaque\" types.
453 -p Specify a prefix which should be removed from the Perl function names.
454 -s Create subroutines for specified macros.
455 -v Specify a version number for this extension.
456 -x Autogenerate XSUBs using C::Scan.
457 -b Specify a perl version to be backwards compatibile with
458 -t Default type for autoloaded constants
460 are any libraries that might be needed for loading the
461 extension, e.g. -lm would try to link in the math library.
466 getopts("ACF:M:OPXacdfhkmn:o:p:s:v:xb:t:") || usage;
467 use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_a $opt_c
468 $opt_d $opt_f $opt_h $opt_k $opt_m $opt_n $opt_o $opt_p $opt_s
469 $opt_v $opt_x $opt_b $opt_t);
474 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
475 $opt_b =~ /^\d+\.\d+\.\d+/ ||
476 usage "You must provide the backwards compatibility version in X.Y.Z form. " .
478 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
479 $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
483 $TEMPLATE_VERSION = $opt_v;
487 $opt_c = 1 if $opt_A;
489 # -X implies -c and -f
490 $opt_c = $opt_f = 1 if $opt_X;
492 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
498 while (my $arg = shift) {
499 if ($arg =~ /^-l/i) {
500 $extralibs = "$arg @ARGV";
506 usage "Must supply header file or module name\n"
507 unless (@path_h or $opt_n);
512 $fmask = qr{$opt_M} if defined $opt_M;
513 $tmask = qr{$opt_o} if defined $opt_o;
514 my $tmask_all = $tmask && $opt_o eq '.';
517 eval {require C::Scan; 1}
519 C::Scan required if you use -x option.
520 To install C::Scan, execute
521 perl -MCPAN -e "install C::Scan"
523 unless ($tmask_all) {
524 $C::Scan::VERSION >= 0.70
526 C::Scan v. 0.70 or later required unless you use -o . option.
527 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
528 To install C::Scan, execute
529 perl -MCPAN -e "install C::Scan"
532 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
534 C::Scan v. 0.73 or later required to use -m or -a options.
535 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
536 To install C::Scan, execute
537 perl -MCPAN -e "install C::Scan"
541 elsif ($opt_o or $opt_F) {
543 Options -o and -F do not make sense without -x.
547 my @path_h_ini = @path_h;
548 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
556 if ($^O eq 'VMS') { # Consider overrides of default location
557 # XXXX This is not equivalent to what the older version did:
558 # it was looking at $hadsys header-file per header-file...
559 my($hadsys) = grep s!^sys/!!i , @path_h;
560 @paths = qw( Sys$Library VAXC$Include );
561 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
562 push @paths, qw( DECC$Library_Include DECC$System_Include );
565 @paths = (File::Spec->curdir(), $Config{usrinc},
566 (split ' ', $Config{locincpth}), '/usr/include');
568 foreach my $path_h (@path_h) {
572 if ( $name !~ /::/ ) {
579 if( $path_h =~ s#::#/#g && $opt_n ){
580 warn "Nesting of headerfile ignored with -n\n";
582 $path_h .= ".h" unless $path_h =~ /\.h$/;
583 my $fullpath = $path_h;
584 $path_h =~ s/,.*$// if $opt_x;
585 $fullpath{$path_h} = $fullpath;
587 # Minor trickery: we can't chdir() before we processed the headers
588 # (so know the name of the extension), but the header may be in the
589 # extension directory...
590 my $tmp_path_h = $path_h;
591 my $rel_path_h = $path_h;
593 if (not -f $path_h) {
595 for my $dir (@paths) {
597 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
600 $rel_path_h = $path_h;
602 (my $epath = $module) =~ s,::,/,g;
603 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
604 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
605 $path_h = $tmp_path_h; # Used during -x
611 die "Can't find $tmp_path_h in @dirs\n"
612 if ( ! $opt_f && ! -f "$rel_path_h" );
613 # Scan the header file (we should deal with nested header files)
614 # Record the names of simple #define constants into const_names
615 # Function prototypes are processed below.
616 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
619 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
622 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
625 # Cannot do: (-1) and ((LHANDLE)3) are OK:
626 #print("Skip non-wordy $def => $rest\n"),
627 # next defines if $rest =~ /[^\w\$]/;
629 print("Skip stringy $def => $rest\n") if $opt_d;
632 print "Matched $_ ($def)\n" if $opt_d;
633 $seen_define{$def} = $rest;
635 next if /^_.*_h_*$/i; # special case, but for what?
636 if (defined $opt_p) {
637 if (!/^$opt_p(\d)/) {
638 ++$prefix{$_} if s/^$opt_p//;
641 warn "can't remove $opt_p prefix from '$_'!\n";
644 $prefixless{$def} = $_;
645 if (!$fmask or /$fmask/) {
646 print "... Passes mask of -M.\n" if $opt_d and $fmask;
658 my ($ext, $nested, @modparts, $modfname, $modpname);
660 $ext = chdir 'ext' ? 'ext/' : '';
662 if( $module =~ /::/ ){
664 @modparts = split(/::/,$module);
665 $modfname = $modparts[-1];
666 $modpname = join('/',@modparts);
671 $modfname = $modpname = $module;
676 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
679 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
684 -d "$modpath$_" || mkdir("$modpath$_", 0777);
688 -d "$modpname" || mkdir($modpname, 0777);
689 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
694 my $fdecls_parsed = [];
701 my @fnames_no_prefix;
705 if( ! $opt_X ){ # use XS, unless it was disabled
706 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
708 require Config; # Run-time directive
709 warn "Scanning typemaps...\n";
713 my $addflags = $opt_F || '';
715 foreach my $filename (@path_h) {
719 if ($fullpath{$filename} =~ /,/) {
723 warn "Scanning $filename for functions...\n";
724 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
725 'add_cppflags' => $addflags, 'c_styles' => [qw(C++ C9X)];
726 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]);
728 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
729 push(@$fdecls, @{$c->get('fdecls')});
731 push @td, @{$c->get('typedefs_maybe')};
733 my $structs = $c->get('typedef_structs');
734 @structs{keys %$structs} = values %$structs;
738 %vdecl_hash = %{ $c->get('vdecl_hash') };
739 @vdecls = sort keys %vdecl_hash;
740 for (local $_ = 0; $_ < @vdecls; ++$_) {
741 my $var = $vdecls[$_];
742 my($type, $post) = @{ $vdecl_hash{$var} };
744 warn "Can't handle variable '$type $var $post', skipping.\n";
745 splice @vdecls, $_, 1;
748 $type = normalize_type($type);
749 $vdecl_hash{$var} = $type;
753 unless ($tmask_all) {
754 warn "Scanning $filename for typedefs...\n";
755 my $td = $c->get('typedef_hash');
756 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
757 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
758 push @good_td, @f_good_td;
759 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
763 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
765 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
768 for my $i (0..$#$fdecls_parsed) {
769 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
771 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
774 $fdecls = [@$fdecls[@good]];
775 $fdecls_parsed = [@$fdecls_parsed[@good]];
777 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
780 my %h = map( ($_->[1], $_), @$fdecls_parsed);
781 $fdecls_parsed = [ @h{@fnames} ];
783 @fnames_no_prefix = @fnames;
785 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix;
786 # Remove macros which expand to typedefs
787 print "Typedefs are @td.\n" if $opt_d;
788 my %td = map {($_, $_)} @td;
789 # Add some other possible but meaningless values for macros
790 for my $k (qw(char double float int long short unsigned signed void)) {
791 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
793 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
796 while (keys %td > $n) {
799 while (($k, $v) = each %seen_define) {
800 # print("found '$k'=>'$v'\n"),
801 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
804 # Now %bad_macs contains names of bad macros
805 for my $k (keys %bad_macs) {
806 delete $const_names{$prefixless{$k}};
807 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
811 my @const_names = sort keys %const_names;
813 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
816 warn "Writing $ext$modpname/$modfname.pm\n";
818 if ( $compat_version < 5.006 ) {
836 unless( $opt_X || $opt_c || $opt_A ){
837 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
849 print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled
854 # Are we using AutoLoader or not?
855 unless ($opt_A) { # no autoloader whatsoever.
856 unless ($opt_c) { # we're doing the AUTOLOAD
857 print PM "use AutoLoader;\n";
860 print PM "use AutoLoader qw(AUTOLOAD);\n"
864 if ( $compat_version < 5.006 ) {
865 if ( $opt_X || $opt_c || $opt_A ) {
866 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
868 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
873 my $myISA = 'our @ISA = qw(Exporter'; # We seem to always want this.
874 $myISA .= ' DynaLoader' unless $opt_X; # no XS
876 $myISA =~ s/^our // if $compat_version < 5.006;
878 print PM "\n$myISA\n\n";
880 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
883 # Items to export into callers namespace by default. Note: do not export
884 # names by default without a very good reason. Use EXPORT_OK instead.
885 # Do not simply export all your public functions/methods/constants.
887 # This allows declaration use $module ':all';
888 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
890 our %EXPORT_TAGS = ( 'all' => [ qw(
894 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
899 our \$VERSION = '$TEMPLATE_VERSION';
903 $tmp =~ s/^our //mg if $compat_version < 5.006;
907 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
911 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
913 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
915 bootstrap $module \$VERSION;
919 # tying the variables can happen only after bootstrap
923 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
930 if( $opt_P ){ # if POD is disabled
939 # Preloaded methods go here.
942 print PM <<"END" unless $opt_A;
944 # Autoload methods go after $after, and are processed by the autosplit program.
957 ($user,$author) = (getpwuid($>))[0,6];
958 $author =~ s/,.*$//; # in case of sub fields
959 my $domain = $Config{'mydomain'};
961 $email = "$user\@$domain";
964 $author ||= "A. U. Thor";
965 $email ||= 'a.u.thor@a.galaxy.far.far.away';
968 $revhist = <<EOT if $opt_C;
974 #=item $TEMPLATE_VERSION
976 #Original version; created by h2xs $H2XS_VERSION with options
992 if (@const_names and not $opt_P) {
994 #=head2 Exportable constants
996 # @{[join "\n ", @const_names]}
1001 if (defined $fdecls and @$fdecls and not $opt_P) {
1003 #=head2 Exportable functions
1007 # $exp_doc .= <<EOD if $opt_p;
1008 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1012 # @{[join "\n ", @known_fnames{@fnames}]}
1019 if ($opt_x && $opt_a) {
1021 $meth_doc .= accessor_docs($name, $struct)
1022 while ($name, $struct) = each %structs;
1025 my $pod = <<"END" unless $opt_P;
1026 ## Below is stub documentation for your module. You better edit it!
1030 #$module - Perl extension for blah blah blah
1039 #Stub documentation for $module, created by h2xs. It looks like the
1040 #author of the extension was negligent enough to leave the stub
1044 $exp_doc$meth_doc$revhist
1048 #Mention other useful documentation such as the documentation of
1049 #related modules or operating system documentation (such as man pages
1050 #in UNIX), or any relevant external documentation such as RFCs or
1053 #If you have a mailing list set up for your module, mention it here.
1055 #If you have a web site set up for your module, mention it here.
1059 #$author, E<lt>${email}E<gt>
1061 #=head1 COPYRIGHT AND LICENSE
1063 #Copyright ${\(1900 + (localtime) [5])} by $author
1065 #This library is free software; you can redistribute it and/or modify
1066 #it under the same terms as Perl itself.
1071 $pod =~ s/^\#//gm unless $opt_P;
1072 print PM $pod unless $opt_P;
1077 if( ! $opt_X ){ # print XS, unless it is disabled
1078 warn "Writing $ext$modpname/$modfname.xs\n";
1087 foreach my $path_h (@path_h_ini) {
1089 $h =~ s#^/usr/include/##;
1090 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1091 print XS qq{#include <$h>\n};
1096 my %pointer_typedefs;
1097 my %struct_typedefs;
1101 my $out = $pointer_typedefs{$type};
1102 return $out if defined $out;
1104 $out = ($type =~ /\*$/);
1105 # This converts only the guys which do not have trailing part in the typedef
1107 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1108 $type = normalize_type($type);
1109 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1111 $out = td_is_pointer($type);
1113 return ($pointer_typedefs{$otype} = $out);
1118 my $out = $struct_typedefs{$type};
1119 return $out if defined $out;
1121 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1122 # This converts only the guys which do not have trailing part in the typedef
1124 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1125 $type = normalize_type($type);
1126 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1128 $out = td_is_struct($type);
1130 return ($struct_typedefs{$otype} = $out);
1134 # Important. Passing an undef scalar doesn't cause the
1135 # autovivified hashref to appear back out in this scope.
1138 print XS constant_types(), "\n";
1139 foreach (C_constant (undef, $opt_t, $types, undef, undef, @const_names)) {
1144 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1146 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1148 # Now switch from C to XS by issuing the first MODULE declaration:
1151 MODULE = $module PACKAGE = $module $prefix
1155 foreach (sort keys %const_xsub) {
1164 croak("Your vendor has not defined the $module macro $_");
1173 # If a constant() function was written then output a corresponding
1176 print XS XS_constant ($module, $types) unless $opt_c;
1184 my ($type, $name, $args) = @$decl;
1185 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1187 my @argnames = map {$_->[1]} @$args;
1188 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1190 s/^\s*const\b\s*// for @argtypes;
1192 my @argarrays = map { $_->[4] || '' } @$args;
1193 my $numargs = @$args;
1194 if ($numargs and $argtypes[-1] eq '...') {
1196 $argnames[-1] = '...';
1199 $type = normalize_type($type, 1);
1207 for my $arg (0 .. $numargs - 1) {
1209 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1214 sub print_tievar_subs {
1215 my($fh, $name, $type) = @_;
1218 _get_$name(IV index, SV *sv) {
1223 (void)call_pv("$module\::_get_$name", G_DISCARD);
1228 _set_$name(IV index, SV *sv) {
1233 (void)call_pv("$module\::_set_$name", G_DISCARD);
1240 sub print_tievar_xsubs {
1241 my($fh, $name, $type) = @_;
1249 uf.uf_val = &_get_$name;
1250 uf.uf_set = &_set_$name;
1251 uf.uf_index = (IV)&_get_$name;
1252 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1256 $type THIS = NO_INIT
1272 sub print_accessors {
1273 my($fh, $name, $struct) = @_;
1274 return unless defined $struct && $name !~ /\s|_ANON/;
1275 $name = normalize_type($name);
1276 my $ptrname = normalize_type("$name *");
1279 MODULE = $module PACKAGE = ${name} $prefix
1283 $name THIS = NO_INIT
1286 if (sv_derived_from(ST(0), "$name")) {
1288 char *s = SvPV((SV*)SvRV(ST(0)), len);
1289 if (len != sizeof(THIS))
1290 croak("Size \%d of packed data != expected \%d",
1292 RETVAL = ($name *)s;
1295 croak("THIS is not of type $name");
1301 char *CLASS = NO_INIT
1304 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1308 MODULE = $module PACKAGE = ${name}Ptr $prefix
1311 my @items = @$struct;
1313 my $item = shift @items;
1314 if ($item->[0] =~ /_ANON/) {
1315 if (defined $item->[2]) {
1317 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1318 ], @{ $structs{$item->[0]} };
1320 push @items, @{ $structs{$item->[0]} };
1323 my $type = normalize_type($item->[0]);
1324 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1327 $item->[2](THIS, __value = NO_INIT)
1333 THIS->$item->[-1] = __value;
1335 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1346 my($name, $struct) = @_;
1347 return unless defined $struct && $name !~ /\s|_ANON/;
1348 $name = normalize_type($name);
1349 my $ptrname = $name . 'Ptr';
1350 my @items = @$struct;
1353 my $item = shift @items;
1354 if ($item->[0] =~ /_ANON/) {
1355 if (defined $item->[2]) {
1357 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1358 ], @{ $structs{$item->[0]} };
1360 push @items, @{ $structs{$item->[0]} };
1363 push @list, $item->[2];
1366 my $methods = (join '(...)>, C<', @list) . '(...)';
1370 #=head2 Object and class methods for C<$name>/C<$ptrname>
1372 #The principal Perl representation of a C object of type C<$name> is an
1373 #object of class C<$ptrname> which is a reference to an integer
1374 #representation of a C pointer. To create such an object, one may use
1377 # my \$buffer = $name->new();
1378 # my \$obj = \$buffer->_to_ptr();
1380 #This exersizes the following two methods, and an additional class
1381 #C<$name>, the internal representation of which is a reference to a
1382 #packed string with the C structure. Keep in mind that \$buffer should
1383 #better survive longer than \$obj.
1387 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1389 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1391 #=item C<$name-E<gt>new()>
1393 #Creates an empty object of type C<$name>. The corresponding packed
1394 #string is zeroed out.
1398 #return the current value of the corresponding element if called
1399 #without additional arguments. Set the element to the supplied value
1400 #(and return the new value) if called with an additional argument.
1402 #Applicable to objects of type C<$ptrname>.
1411 # Should be called before any actual call to normalize_type().
1413 # We do not want to read ./typemap by obvios reasons.
1414 my @tm = qw(../../../typemap ../../typemap ../typemap);
1415 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1416 unshift @tm, $stdtypemap;
1417 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1419 # Start with useful default values
1420 $typemap{float} = 'T_NV';
1422 foreach my $typemap (@tm) {
1423 next unless -e $typemap ;
1424 # skip directories, binary files etc.
1425 warn " Scanning $typemap\n";
1426 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1427 unless -T $typemap ;
1428 open(TYPEMAP, $typemap)
1429 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1430 my $mode = 'Typemap';
1433 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1434 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1435 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1436 elsif ($mode eq 'Typemap') {
1437 next if /^\s*($|\#)/ ;
1439 if ( ($type, $image) =
1440 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1441 # This may reference undefined functions:
1442 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1443 $typemap{normalize_type($type)} = $image;
1447 close(TYPEMAP) or die "Cannot close $typemap: $!";
1449 %std_types = %types_seen;
1454 sub normalize_type { # Second arg: do not strip const's before \*
1456 my $do_keep_deep_const = shift;
1457 # If $do_keep_deep_const this is heuristical only
1458 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1460 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1461 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1462 $type =~ s/$ignore_mods//go;
1465 $type =~ s/$ignore_mods//go;
1467 $type =~ s/([^\s\w])/ $1 /g;
1471 $type =~ s/\* (?=\*)/*/g;
1472 $type =~ s/\. \. \./.../g;
1474 $types_seen{$type}++
1475 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1481 sub assign_typemap_entry {
1485 if ($tmask and $type =~ /$tmask/) {
1486 print "Type $type matches -o mask\n" if $opt_d;
1487 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1489 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1490 $type = normalize_type $type;
1491 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1492 $entry = assign_typemap_entry($type);
1494 $entry ||= $typemap{$otype}
1495 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1496 $typemap{$otype} = $entry;
1497 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1502 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1506 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1508 while (my($name, $struct) = each %structs) {
1509 print_accessors(\*XS, $name, $struct);
1518 warn "Writing $ext$modpname/typemap\n";
1519 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1521 for $type (sort keys %types_seen) {
1522 my $entry = assign_typemap_entry $type;
1523 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1526 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1527 #############################################################################
1530 if (sv_derived_from($arg, \"${ntype}\")) {
1532 char *s = SvPV((SV*)SvRV($arg), len);
1534 if (len != sizeof($var))
1535 croak(\"Size %d of packed data != expected %d\",
1540 croak(\"$var is not of type ${ntype}\")
1541 #############################################################################
1544 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1547 close TM or die "Cannot close typemap file for write: $!";
1552 warn "Writing $ext$modpname/Makefile.PL\n";
1553 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1556 use ExtUtils::MakeMaker;
1557 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1558 # the contents of the Makefile that is written.
1560 'NAME' => '$module',
1561 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION
1562 'PREREQ_PM' => {}, # e.g., Module::Name => 1.1
1563 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1564 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1565 AUTHOR => '$author <$email>') : ()),
1567 if (!$opt_X) { # print C stuff, unless XS is disabled
1568 $opt_F = '' unless defined $opt_F;
1569 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1570 my $Ihelp = ($I ? '-I. ' : '');
1571 my $Icomment = ($I ? '' : <<EOC);
1572 # Insert -I. if you add *.h files later:
1576 'LIBS' => ['$extralibs'], # e.g., '-lm'
1577 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1578 $Icomment 'INC' => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1581 my $C = grep $_ ne "$modfname.c", (glob '*.c'), (glob '*.cc'), (glob '*.C');
1582 my $Cpre = ($C ? '' : '# ');
1583 my $Ccomment = ($C ? '' : <<EOC);
1584 # Un-comment this if you add C files to link with later:
1588 $Ccomment $Cpre\'OBJECT' => '\$(O_FILES)', # link all the C files too
1592 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1594 # Create a simple README since this is a CPAN requirement
1595 # and it doesnt hurt to have one
1596 warn "Writing $ext$modpname/README\n";
1597 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
1598 my $thisyear = (gmtime)[5] + 1900;
1599 my $rmhead = "$modpname version $TEMPLATE_VERSION";
1600 my $rmheadeq = "=" x length($rmhead);
1605 The README is used to introduce the module and provide instructions on
1606 how to install the module, any machine dependencies it may have (for
1607 example C compilers and installed libraries) and any other information
1608 that should be provided before the module is installed.
1610 A README file is required for CPAN modules since CPAN extracts the
1611 README file from a module distribution so that people browsing the
1612 archive can use it get an idea of the modules uses. It is usually a
1613 good idea to provide version information here so that people can
1614 decide whether fixes for the module are worth downloading.
1618 To install this module type the following:
1627 This module requires these other modules and libraries:
1631 COPYRIGHT AND LICENCE
1633 Put the correct copyright and licence information here.
1635 Copyright (C) $thisyear $author
1637 This library is free software; you can redistribute it and/or modify
1638 it under the same terms as Perl itself.
1641 close(RM) || die "Can't close $ext$modpname/README: $!\n";
1644 my $testfile = "$testdir/1.t";
1645 unless (-d "$testdir") {
1646 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
1648 warn "Writing $ext$modpname/$testfile\n";
1649 my $tests = @const_names ? 2 : 1;
1651 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
1653 # Before `make install' is performed this script should be runnable with
1654 # `make test'. After `make install' it should work as `perl 1.t'
1656 #########################
1658 # change 'tests => $tests' to 'tests => last_test_to_print';
1661 BEGIN { plan tests => $tests };
1663 ok(1); # If we made it this far, we're ok.
1667 my $const_names = join " ", @const_names;
1671 foreach my $constname (qw(
1673 print EX wrap ("\t", "\t", $const_names);
1674 print EX (")) {\n");
1676 next if (eval "my \\\$a = \$constname; 1");
1677 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
1678 print "# pass: \$\@";
1680 print "# fail: \$\@";
1685 print "not ok 2\\n";
1693 #########################
1695 # Insert your test code below, the Test module is use()ed here so read
1696 # its man page ( perldoc Test ) for help writing this test script.
1699 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
1702 warn "Writing $ext$modpname/Changes\n";
1704 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
1705 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
1707 Revision history for Perl extension $module.
1709 $TEMPLATE_VERSION @{[scalar localtime]}
1710 \t- original version; created by h2xs $H2XS_VERSION with options
1714 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
1717 warn "Writing $ext$modpname/MANIFEST\n";
1718 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
1719 my @files = grep { -f } (<*>, <t/*>);
1721 eval {opendir(D,'.');};
1722 unless ($@) { @files = readdir(D); closedir(D); }
1724 if (!@files) { @files = map {chomp && $_} `ls`; }
1727 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
1729 # Fix up for case-sensitive file systems
1730 s/$modfname/$modfname/i && next;
1731 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
1732 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
1735 print MANI join("\n",@files), "\n";
1739 close OUT or die "Can't close $file: $!";
1740 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1741 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';