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<OPTIONS> ...] [headerfile ... [extra_libraries]]
48 B<h2xs> B<-h>|B<-?>|B<--help>
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.
73 =item B<-A>, B<--omit-autoload>
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.
78 =item B<-C>, B<--omit-changes>
80 Omits creation of the F<Changes> file, and adds a HISTORY section to
83 =item B<-F>, B<--cpp-flags>=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>, B<--func-mask>=I<regular expression>
90 selects functions/macros to process.
92 =item B<-O>, B<--overwrite-ok>
94 Allows a pre-existing extension directory to be overwritten.
96 =item B<-P>, B<--omit-pod>
98 Omit the autogenerated stub POD section.
100 =item B<-X>, B<--omit-XS>
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.
105 =item B<-a>, B<--gen-accessors>
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>, B<--compat-version>=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.
131 =item B<-c>, B<--omit-constant>
133 Omit C<constant()> from the .xs file and corresponding specialised
134 C<AUTOLOAD> from the .pm file.
136 =item B<-d>, B<--debugging>
138 Turn on debugging messages.
140 =item B<-f>, B<--force>
142 Allows an extension to be created for a header even if that header is
143 not found in standard include directories.
145 =item B<-h>, B<-?>, B<--help>
147 Print the usage, help and version for this h2xs and exit.
149 =item B<-k>, B<--omit-const-func>
151 For function arguments declared as C<const>, omit the const attribute in the
154 =item B<-m>, B<--gen-tied-var>
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>, B<--name>=I<module_name>
161 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
163 =item B<-o>, B<--opaque-re>=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>, B<--remove-prefix>=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>, B<--const-subs>=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>.
193 =item B<-t>, B<--default-type>=I<type>
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<--use-new-tests>
202 When B<--compat-version> (B<-b>) is present the generated tests will use
203 C<Test::More> rather then C<Test> which is the default for versions before
204 5.7.2 . C<Test::More> will be added to PREREQ_PM in the generated
207 =item B<--use-old-tests>
209 Will force the generation of test code that uses the older C<Test> module.
211 =item B<-v>, B<--version>=I<version>
213 Specify a version number for this extension. This version number is added
214 to the templates. The default is 0.01.
216 =item B<-x>, B<--autogen-xsubs>
218 Automatically generate XSUBs basing on function declarations in the
219 header file. The package C<C::Scan> should be installed. If this
220 option is specified, the name of the header file may look like
221 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
222 string, but XSUBs are emitted only for the declarations included from
225 Note that some types of arguments/return-values for functions may
226 result in XSUB-declarations/typemap-entries which need
227 hand-editing. Such may be objects which cannot be converted from/to a
228 pointer (like C<long long>), pointers to functions, or arrays. See
229 also the section on L<LIMITATIONS of B<-x>>.
236 # Default behavior, extension is Rusers
239 # Same, but extension is RUSERS
240 h2xs -n RUSERS rpcsvc/rusers
242 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
245 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
246 h2xs -n ONC::RPC rpcsvc/rusers
248 # Without constant() or AUTOLOAD
249 h2xs -c rpcsvc/rusers
251 # Creates templates for an extension named RPC
254 # Extension is ONC::RPC.
257 # Makefile.PL will look for library -lrpc in
258 # additional directory /opt/net/lib
259 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
261 # Extension is DCE::rgynbase
262 # prefix "sec_rgy_" is dropped from perl function names
263 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
265 # Extension is DCE::rgynbase
266 # prefix "sec_rgy_" is dropped from perl function names
267 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
268 h2xs -n DCE::rgynbase -p sec_rgy_ \
269 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
271 # Make XS without defines in perl.h, but with function declarations
272 # visible from perl.h. Name of the extension is perl1.
273 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
274 # Extra backslashes below because the string is passed to shell.
275 # Note that a directory with perl header files would
276 # be added automatically to include path.
277 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
279 # Same with function declaration in proto.h as visible from perl.h.
280 h2xs -xAn perl2 perl.h,proto.h
282 # Same but select only functions which match /^av_/
283 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
285 # Same but treat SV* etc as "opaque" types
286 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
288 =head2 Extension based on F<.h> and F<.c> files
290 Suppose that you have some C files implementing some functionality,
291 and the corresponding header files. How to create an extension which
292 makes this functionality accessable in Perl? The example below
293 assumes that the header files are F<interface_simple.h> and
294 I<interface_hairy.h>, and you want the perl module be named as
295 C<Ext::Ension>. If you need some preprocessor directives and/or
296 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
301 =item Find the directory name
303 Start with a dummy run of h2xs:
305 h2xs -Afn Ext::Ension
307 The only purpose of this step is to create the needed directories, and
308 let you know the names of these directories. From the output you can
309 see that the directory for the extension is F<Ext/Ension>.
313 Copy your header files and C files to this directory F<Ext/Ension>.
315 =item Create the extension
317 Run h2xs, overwriting older autogenerated files:
319 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
321 h2xs looks for header files I<after> changing to the extension
322 directory, so it will find your header files OK.
324 =item Archive and test
336 It is important to do C<make dist> as early as possible. This way you
337 can easily merge(1) your changes to autogenerated files if you decide
338 to edit your C<.h> files and rerun h2xs.
340 Do not forget to edit the documentation in the generated F<.pm> file.
342 Consider the autogenerated files as skeletons only, you may invent
343 better interfaces than what h2xs could guess.
345 Consider this section as a guideline only, some other options of h2xs
346 may better suit your needs.
352 No environment variables are used.
356 Larry Wall and others
360 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
364 The usual warnings if it cannot read or write the files involved.
366 =head1 LIMITATIONS of B<-x>
368 F<h2xs> would not distinguish whether an argument to a C function
369 which is of the form, say, C<int *>, is an input, output, or
370 input/output parameter. In particular, argument declarations of the
377 should be better rewritten as
383 if C<n> is an input parameter.
385 Additionally, F<h2xs> has no facilities to intuit that a function
392 takes a pair of address and length of data at this address, so it is better
393 to rewrite this function as
403 RETVAL = foo(s, len);
413 char *s = SvPV(sv,len);
418 MODULE = foo PACKAGE = foo PREFIX = my_
424 See L<perlxs> and L<perlxstut> for additional details.
431 my( $H2XS_VERSION ) = ' $Revision: 1.21 $ ' =~ /\$Revision:\s+([^\s]+)/;
432 my $TEMPLATE_VERSION = '0.01';
434 my $compat_version = $];
439 $Text::Wrap::huge = 'overflow';
440 $Text::Wrap::columns = 80;
441 use ExtUtils::Constant qw (constant_types C_constant XS_constant autoload);
446 h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
447 version: $H2XS_VERSION
449 -A, --omit-autoload Omit all autoloading facilities (implies -c).
450 -C, --omit-changes Omit creating the Changes file, add HISTORY heading
452 -F, --cpp-flags Additional flags for C preprocessor (used with -x).
453 -M, --func-mask Mask to select C functions/macros
454 (default is select all).
455 -O, --overwrite-ok Allow overwriting of a pre-existing extension directory.
456 -P, --omit-pod Omit the stub POD section.
457 -X, --omit-XS Omit the XS portion (implies both -c and -f).
458 -a, --gen-accessors Generate get/set accessors for struct and union members (used with -x).
459 -b, --compat-version Specify a perl version to be backwards compatibile with
460 -c, --omit-constant Omit the constant() function and specialised AUTOLOAD
462 -d, --debugging Turn on debugging messages.
463 -f, --force Force creation of the extension even if the C header
465 -h, -?, --help Display this help message
466 -k, --omit-const-func Omit 'const' attribute on function arguments
468 -m, --gen-tied-var Generate tied variables for access to declared
470 -n, --name Specify a name to use for the extension (recommended).
471 -o, --opaque-re Regular expression for \"opaque\" types.
472 -p, --remove-prefix Specify a prefix which should be removed from the
474 -s, --const-subs Create subroutines for specified macros.
475 -t, --default-type Default type for autoloaded constants
476 --use-new-tests Use Test::More in backward compatible modules
477 --use-old-tests Use the module Test rather than Test::More
478 -v, --version Specify a version number for this extension.
479 -x, --autogen-xsubs Autogenerate XSUBs using C::Scan.
482 are any libraries that might be needed for loading the
483 extension, e.g. -lm would try to link in the math library.
513 Getopt::Long::Configure('bundling');
516 'omit-autoload|A' => \$opt_A,
517 'omit-changes|C' => \$opt_C,
518 'cpp-flags|F=s' => \$opt_F,
519 'func-mask|M=s' => \$opt_M,
520 'overwrite_ok|O' => \$opt_O,
521 'omit-pod|P' => \$opt_P,
522 'omit-XS|X' => \$opt_X,
523 'gen-accessors|a' => \$opt_a,
524 'compat-version|b=s' => \$opt_b,
525 'omit-constant|c' => \$opt_c,
526 'debugging|d' => \$opt_d,
527 'force|f' => \$opt_f,
528 'help|h|?' => \$opt_h,
529 'omit-const-func|k' => \$opt_k,
530 'gen-tied-var|m' => \$opt_m,
531 'name|n=s' => \$opt_n,
532 'opaque-re|o=s' => \$opt_o,
533 'remove-prefix|p=s' => \$opt_p,
534 'const-subs|s=s' => \$opt_s,
535 'default-type|t=s' => \$opt_t,
536 'version|v=s' => \$opt_v,
537 'autogen-xsubs|x=s' => \$opt_x,
538 'use-new-tests' => \$new_test,
539 'use-old-tests' => \$old_test
542 GetOptions(%options) || usage;
547 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
548 $opt_b =~ /^\d+\.\d+\.\d+/ ||
549 usage "You must provide the backwards compatibility version in X.Y.Z form. "
551 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
552 $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
556 $TEMPLATE_VERSION = $opt_v;
560 $opt_c = 1 if $opt_A;
562 # -X implies -c and -f
563 $opt_c = $opt_f = 1 if $opt_X;
565 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
571 while (my $arg = shift) {
572 if ($arg =~ /^-l/i) {
573 $extralibs = "$arg @ARGV";
579 usage "Must supply header file or module name\n"
580 unless (@path_h or $opt_n);
585 $fmask = qr{$opt_M} if defined $opt_M;
586 $tmask = qr{$opt_o} if defined $opt_o;
587 my $tmask_all = $tmask && $opt_o eq '.';
590 eval {require C::Scan; 1}
592 C::Scan required if you use -x option.
593 To install C::Scan, execute
594 perl -MCPAN -e "install C::Scan"
596 unless ($tmask_all) {
597 $C::Scan::VERSION >= 0.70
599 C::Scan v. 0.70 or later required unless you use -o . option.
600 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
601 To install C::Scan, execute
602 perl -MCPAN -e "install C::Scan"
605 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
607 C::Scan v. 0.73 or later required to use -m or -a options.
608 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
609 To install C::Scan, execute
610 perl -MCPAN -e "install C::Scan"
614 elsif ($opt_o or $opt_F) {
616 Options -o and -F do not make sense without -x.
620 my @path_h_ini = @path_h;
621 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
629 my $pre_sub_tri_graphs = 1;
630 if ($^O eq 'VMS') { # Consider overrides of default location
631 # XXXX This is not equivalent to what the older version did:
632 # it was looking at $hadsys header-file per header-file...
633 my($hadsys) = grep s!^sys/!!i , @path_h;
634 @paths = qw( Sys$Library VAXC$Include );
635 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
636 push @paths, qw( DECC$Library_Include DECC$System_Include );
639 @paths = (File::Spec->curdir(), $Config{usrinc},
640 (split ' ', $Config{locincpth}), '/usr/include');
642 foreach my $path_h (@path_h) {
646 if ( $name !~ /::/ ) {
653 if( $path_h =~ s#::#/#g && $opt_n ){
654 warn "Nesting of headerfile ignored with -n\n";
656 $path_h .= ".h" unless $path_h =~ /\.h$/;
657 my $fullpath = $path_h;
658 $path_h =~ s/,.*$// if $opt_x;
659 $fullpath{$path_h} = $fullpath;
661 # Minor trickery: we can't chdir() before we processed the headers
662 # (so know the name of the extension), but the header may be in the
663 # extension directory...
664 my $tmp_path_h = $path_h;
665 my $rel_path_h = $path_h;
667 if (not -f $path_h) {
669 for my $dir (@paths) {
671 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
674 $rel_path_h = $path_h;
676 (my $epath = $module) =~ s,::,/,g;
677 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
678 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
679 $path_h = $tmp_path_h; # Used during -x
685 die "Can't find $tmp_path_h in @dirs\n"
686 if ( ! $opt_f && ! -f "$rel_path_h" );
687 # Scan the header file (we should deal with nested header files)
688 # Record the names of simple #define constants into const_names
689 # Function prototypes are processed below.
690 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
693 if ($pre_sub_tri_graphs) {
694 # Preprocess all tri-graphs
695 # including things stuck in quoted string constants.
696 s/\?\?=/#/g; # | ??=| #|
697 s/\?\?\!/|/g; # | ??!| ||
698 s/\?\?'/^/g; # | ??'| ^|
699 s/\?\?\(/[/g; # | ??(| [|
700 s/\?\?\)/]/g; # | ??)| ]|
701 s/\?\?\-/~/g; # | ??-| ~|
702 s/\?\?\//\\/g; # | ??/| \|
703 s/\?\?</{/g; # | ??<| {|
704 s/\?\?>/}/g; # | ??>| }|
706 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
709 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
712 # Cannot do: (-1) and ((LHANDLE)3) are OK:
713 #print("Skip non-wordy $def => $rest\n"),
714 # next defines if $rest =~ /[^\w\$]/;
716 print("Skip stringy $def => $rest\n") if $opt_d;
719 print "Matched $_ ($def)\n" if $opt_d;
720 $seen_define{$def} = $rest;
722 next if /^_.*_h_*$/i; # special case, but for what?
723 if (defined $opt_p) {
724 if (!/^$opt_p(\d)/) {
725 ++$prefix{$_} if s/^$opt_p//;
728 warn "can't remove $opt_p prefix from '$_'!\n";
731 $prefixless{$def} = $_;
732 if (!$fmask or /$fmask/) {
733 print "... Passes mask of -M.\n" if $opt_d and $fmask;
745 my ($ext, $nested, @modparts, $modfname, $modpname);
747 $ext = chdir 'ext' ? 'ext/' : '';
749 if( $module =~ /::/ ){
751 @modparts = split(/::/,$module);
752 $modfname = $modparts[-1];
753 $modpname = join('/',@modparts);
758 $modfname = $modpname = $module;
763 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
766 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
771 -d "$modpath$_" || mkdir("$modpath$_", 0777);
775 -d "$modpname" || mkdir($modpname, 0777);
776 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
781 my $fdecls_parsed = [];
788 my @fnames_no_prefix;
792 if( ! $opt_X ){ # use XS, unless it was disabled
793 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
795 require Config; # Run-time directive
796 warn "Scanning typemaps...\n";
800 my $addflags = $opt_F || '';
802 foreach my $filename (@path_h) {
806 if ($fullpath{$filename} =~ /,/) {
810 warn "Scanning $filename for functions...\n";
811 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
812 'add_cppflags' => $addflags, 'c_styles' => [qw(C++ C9X)];
813 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]);
815 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
816 push(@$fdecls, @{$c->get('fdecls')});
818 push @td, @{$c->get('typedefs_maybe')};
820 my $structs = $c->get('typedef_structs');
821 @structs{keys %$structs} = values %$structs;
825 %vdecl_hash = %{ $c->get('vdecl_hash') };
826 @vdecls = sort keys %vdecl_hash;
827 for (local $_ = 0; $_ < @vdecls; ++$_) {
828 my $var = $vdecls[$_];
829 my($type, $post) = @{ $vdecl_hash{$var} };
831 warn "Can't handle variable '$type $var $post', skipping.\n";
832 splice @vdecls, $_, 1;
835 $type = normalize_type($type);
836 $vdecl_hash{$var} = $type;
840 unless ($tmask_all) {
841 warn "Scanning $filename for typedefs...\n";
842 my $td = $c->get('typedef_hash');
843 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
844 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
845 push @good_td, @f_good_td;
846 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
850 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
852 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
855 for my $i (0..$#$fdecls_parsed) {
856 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
858 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
861 $fdecls = [@$fdecls[@good]];
862 $fdecls_parsed = [@$fdecls_parsed[@good]];
864 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
867 my %h = map( ($_->[1], $_), @$fdecls_parsed);
868 $fdecls_parsed = [ @h{@fnames} ];
870 @fnames_no_prefix = @fnames;
872 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix;
873 # Remove macros which expand to typedefs
874 print "Typedefs are @td.\n" if $opt_d;
875 my %td = map {($_, $_)} @td;
876 # Add some other possible but meaningless values for macros
877 for my $k (qw(char double float int long short unsigned signed void)) {
878 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
880 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
883 while (keys %td > $n) {
886 while (($k, $v) = each %seen_define) {
887 # print("found '$k'=>'$v'\n"),
888 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
891 # Now %bad_macs contains names of bad macros
892 for my $k (keys %bad_macs) {
893 delete $const_names{$prefixless{$k}};
894 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
898 my @const_names = sort keys %const_names;
900 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
903 warn "Writing $ext$modpname/$modfname.pm\n";
905 if ( $compat_version < 5.006 ) {
923 unless( $opt_X || $opt_c || $opt_A ){
924 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
936 print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled
941 # Are we using AutoLoader or not?
942 unless ($opt_A) { # no autoloader whatsoever.
943 unless ($opt_c) { # we're doing the AUTOLOAD
944 print PM "use AutoLoader;\n";
947 print PM "use AutoLoader qw(AUTOLOAD);\n"
951 if ( $compat_version < 5.006 ) {
952 if ( $opt_X || $opt_c || $opt_A ) {
953 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
955 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
960 my $myISA = 'our @ISA = qw(Exporter'; # We seem to always want this.
961 $myISA .= ' DynaLoader' unless $opt_X; # no XS
963 $myISA =~ s/^our // if $compat_version < 5.006;
965 print PM "\n$myISA\n\n";
967 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
970 # Items to export into callers namespace by default. Note: do not export
971 # names by default without a very good reason. Use EXPORT_OK instead.
972 # Do not simply export all your public functions/methods/constants.
974 # This allows declaration use $module ':all';
975 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
977 our %EXPORT_TAGS = ( 'all' => [ qw(
981 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
986 our \$VERSION = '$TEMPLATE_VERSION';
990 $tmp =~ s/^our //mg if $compat_version < 5.006;
994 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
998 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
1000 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
1002 bootstrap $module \$VERSION;
1006 # tying the variables can happen only after bootstrap
1010 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
1017 if( $opt_P ){ # if POD is disabled
1026 # Preloaded methods go here.
1029 print PM <<"END" unless $opt_A;
1031 # Autoload methods go after $after, and are processed by the autosplit program.
1040 my ($email,$author);
1044 ($user,$author) = (getpwuid($>))[0,6];
1045 $author =~ s/,.*$//; # in case of sub fields
1046 my $domain = $Config{'mydomain'};
1048 $email = "$user\@$domain";
1051 $author ||= "A. U. Thor";
1052 $email ||= 'a.u.thor@a.galaxy.far.far.away';
1055 $revhist = <<EOT if $opt_C;
1061 #=item $TEMPLATE_VERSION
1063 #Original version; created by h2xs $H2XS_VERSION with options
1071 my $exp_doc = <<EOD;
1079 if (@const_names and not $opt_P) {
1081 #=head2 Exportable constants
1083 # @{[join "\n ", @const_names]}
1088 if (defined $fdecls and @$fdecls and not $opt_P) {
1090 #=head2 Exportable functions
1094 # $exp_doc .= <<EOD if $opt_p;
1095 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1099 # @{[join "\n ", @known_fnames{@fnames}]}
1106 if ($opt_x && $opt_a) {
1108 $meth_doc .= accessor_docs($name, $struct)
1109 while ($name, $struct) = each %structs;
1112 my $pod = <<"END" unless $opt_P;
1113 ## Below is stub documentation for your module. You better edit it!
1117 #$module - Perl extension for blah blah blah
1126 # This should be the abstract for $module.
1127 # The abstract is used when making PPD (Perl Package Description) files.
1128 # If you don't want an ABSTRACT you should also edit Makefile.PL to
1129 # remove the ABSTRACT_FROM option.
1133 #Stub documentation for $module, created by h2xs. It looks like the
1134 #author of the extension was negligent enough to leave the stub
1138 $exp_doc$meth_doc$revhist
1142 #Mention other useful documentation such as the documentation of
1143 #related modules or operating system documentation (such as man pages
1144 #in UNIX), or any relevant external documentation such as RFCs or
1147 #If you have a mailing list set up for your module, mention it here.
1149 #If you have a web site set up for your module, mention it here.
1153 #$author, E<lt>${email}E<gt>
1155 #=head1 COPYRIGHT AND LICENSE
1157 #Copyright ${\(1900 + (localtime) [5])} by $author
1159 #This library is free software; you can redistribute it and/or modify
1160 #it under the same terms as Perl itself.
1165 $pod =~ s/^\#//gm unless $opt_P;
1166 print PM $pod unless $opt_P;
1171 if( ! $opt_X ){ # print XS, unless it is disabled
1172 warn "Writing $ext$modpname/$modfname.xs\n";
1181 foreach my $path_h (@path_h_ini) {
1183 $h =~ s#^/usr/include/##;
1184 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1185 print XS qq{#include <$h>\n};
1190 my %pointer_typedefs;
1191 my %struct_typedefs;
1195 my $out = $pointer_typedefs{$type};
1196 return $out if defined $out;
1198 $out = ($type =~ /\*$/);
1199 # This converts only the guys which do not have trailing part in the typedef
1201 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1202 $type = normalize_type($type);
1203 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1205 $out = td_is_pointer($type);
1207 return ($pointer_typedefs{$otype} = $out);
1212 my $out = $struct_typedefs{$type};
1213 return $out if defined $out;
1215 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1216 # This converts only the guys which do not have trailing part in the typedef
1218 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1219 $type = normalize_type($type);
1220 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1222 $out = td_is_struct($type);
1224 return ($struct_typedefs{$otype} = $out);
1228 # Important. Passing an undef scalar doesn't cause the
1229 # autovivified hashref to appear back out in this scope.
1232 print XS constant_types(), "\n";
1233 foreach (C_constant ($module, undef, $opt_t, $types, undef, undef,
1239 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1241 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1243 # Now switch from C to XS by issuing the first MODULE declaration:
1246 MODULE = $module PACKAGE = $module $prefix
1250 foreach (sort keys %const_xsub) {
1259 croak("Your vendor has not defined the $module macro $_");
1268 # If a constant() function was written then output a corresponding
1271 print XS XS_constant ($module, $types) unless $opt_c;
1279 my ($type, $name, $args) = @$decl;
1280 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1282 my @argnames = map {$_->[1]} @$args;
1283 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1285 s/^\s*const\b\s*// for @argtypes;
1287 my @argarrays = map { $_->[4] || '' } @$args;
1288 my $numargs = @$args;
1289 if ($numargs and $argtypes[-1] eq '...') {
1291 $argnames[-1] = '...';
1294 $type = normalize_type($type, 1);
1302 for my $arg (0 .. $numargs - 1) {
1304 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1309 sub print_tievar_subs {
1310 my($fh, $name, $type) = @_;
1313 _get_$name(IV index, SV *sv) {
1318 (void)call_pv("$module\::_get_$name", G_DISCARD);
1323 _set_$name(IV index, SV *sv) {
1328 (void)call_pv("$module\::_set_$name", G_DISCARD);
1335 sub print_tievar_xsubs {
1336 my($fh, $name, $type) = @_;
1344 uf.uf_val = &_get_$name;
1345 uf.uf_set = &_set_$name;
1346 uf.uf_index = (IV)&_get_$name;
1347 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1351 $type THIS = NO_INIT
1367 sub print_accessors {
1368 my($fh, $name, $struct) = @_;
1369 return unless defined $struct && $name !~ /\s|_ANON/;
1370 $name = normalize_type($name);
1371 my $ptrname = normalize_type("$name *");
1374 MODULE = $module PACKAGE = ${name} $prefix
1378 $name THIS = NO_INIT
1381 if (sv_derived_from(ST(0), "$name")) {
1383 char *s = SvPV((SV*)SvRV(ST(0)), len);
1384 if (len != sizeof(THIS))
1385 croak("Size \%d of packed data != expected \%d",
1387 RETVAL = ($name *)s;
1390 croak("THIS is not of type $name");
1396 char *CLASS = NO_INIT
1399 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1403 MODULE = $module PACKAGE = ${name}Ptr $prefix
1406 my @items = @$struct;
1408 my $item = shift @items;
1409 if ($item->[0] =~ /_ANON/) {
1410 if (defined $item->[2]) {
1412 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1413 ], @{ $structs{$item->[0]} };
1415 push @items, @{ $structs{$item->[0]} };
1418 my $type = normalize_type($item->[0]);
1419 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1422 $item->[2](THIS, __value = NO_INIT)
1428 THIS->$item->[-1] = __value;
1430 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1441 my($name, $struct) = @_;
1442 return unless defined $struct && $name !~ /\s|_ANON/;
1443 $name = normalize_type($name);
1444 my $ptrname = $name . 'Ptr';
1445 my @items = @$struct;
1448 my $item = shift @items;
1449 if ($item->[0] =~ /_ANON/) {
1450 if (defined $item->[2]) {
1452 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1453 ], @{ $structs{$item->[0]} };
1455 push @items, @{ $structs{$item->[0]} };
1458 push @list, $item->[2];
1461 my $methods = (join '(...)>, C<', @list) . '(...)';
1465 #=head2 Object and class methods for C<$name>/C<$ptrname>
1467 #The principal Perl representation of a C object of type C<$name> is an
1468 #object of class C<$ptrname> which is a reference to an integer
1469 #representation of a C pointer. To create such an object, one may use
1472 # my \$buffer = $name->new();
1473 # my \$obj = \$buffer->_to_ptr();
1475 #This exersizes the following two methods, and an additional class
1476 #C<$name>, the internal representation of which is a reference to a
1477 #packed string with the C structure. Keep in mind that \$buffer should
1478 #better survive longer than \$obj.
1482 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1484 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1486 #=item C<$name-E<gt>new()>
1488 #Creates an empty object of type C<$name>. The corresponding packed
1489 #string is zeroed out.
1493 #return the current value of the corresponding element if called
1494 #without additional arguments. Set the element to the supplied value
1495 #(and return the new value) if called with an additional argument.
1497 #Applicable to objects of type C<$ptrname>.
1506 # Should be called before any actual call to normalize_type().
1508 # We do not want to read ./typemap by obvios reasons.
1509 my @tm = qw(../../../typemap ../../typemap ../typemap);
1510 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1511 unshift @tm, $stdtypemap;
1512 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1514 # Start with useful default values
1515 $typemap{float} = 'T_NV';
1517 foreach my $typemap (@tm) {
1518 next unless -e $typemap ;
1519 # skip directories, binary files etc.
1520 warn " Scanning $typemap\n";
1521 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1522 unless -T $typemap ;
1523 open(TYPEMAP, $typemap)
1524 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1525 my $mode = 'Typemap';
1528 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1529 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1530 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1531 elsif ($mode eq 'Typemap') {
1532 next if /^\s*($|\#)/ ;
1534 if ( ($type, $image) =
1535 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1536 # This may reference undefined functions:
1537 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1538 $typemap{normalize_type($type)} = $image;
1542 close(TYPEMAP) or die "Cannot close $typemap: $!";
1544 %std_types = %types_seen;
1549 sub normalize_type { # Second arg: do not strip const's before \*
1551 my $do_keep_deep_const = shift;
1552 # If $do_keep_deep_const this is heuristical only
1553 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1555 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1556 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1557 $type =~ s/$ignore_mods//go;
1560 $type =~ s/$ignore_mods//go;
1562 $type =~ s/([^\s\w])/ $1 /g;
1566 $type =~ s/\* (?=\*)/*/g;
1567 $type =~ s/\. \. \./.../g;
1569 $types_seen{$type}++
1570 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1576 sub assign_typemap_entry {
1580 if ($tmask and $type =~ /$tmask/) {
1581 print "Type $type matches -o mask\n" if $opt_d;
1582 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1584 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1585 $type = normalize_type $type;
1586 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1587 $entry = assign_typemap_entry($type);
1589 $entry ||= $typemap{$otype}
1590 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1591 $typemap{$otype} = $entry;
1592 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1597 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1601 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1603 while (my($name, $struct) = each %structs) {
1604 print_accessors(\*XS, $name, $struct);
1613 warn "Writing $ext$modpname/typemap\n";
1614 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1616 for $type (sort keys %types_seen) {
1617 my $entry = assign_typemap_entry $type;
1618 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1621 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1622 #############################################################################
1625 if (sv_derived_from($arg, \"${ntype}\")) {
1627 char *s = SvPV((SV*)SvRV($arg), len);
1629 if (len != sizeof($var))
1630 croak(\"Size %d of packed data != expected %d\",
1635 croak(\"$var is not of type ${ntype}\")
1636 #############################################################################
1639 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1642 close TM or die "Cannot close typemap file for write: $!";
1647 warn "Writing $ext$modpname/Makefile.PL\n";
1648 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1652 if ( $compat_version < 5.00702 and $new_test )
1654 $prereq_pm = q%'Test::More' => 0%;
1662 use ExtUtils::MakeMaker;
1663 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1664 # the contents of the Makefile that is written.
1666 'NAME' => '$module',
1667 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION
1668 'PREREQ_PM' => {$prereq_pm}, # e.g., Module::Name => 1.1
1669 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1670 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1671 AUTHOR => '$author <$email>') : ()),
1673 if (!$opt_X) { # print C stuff, unless XS is disabled
1674 $opt_F = '' unless defined $opt_F;
1675 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1676 my $Ihelp = ($I ? '-I. ' : '');
1677 my $Icomment = ($I ? '' : <<EOC);
1678 # Insert -I. if you add *.h files later:
1682 'LIBS' => ['$extralibs'], # e.g., '-lm'
1683 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1684 $Icomment 'INC' => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1687 my $C = grep $_ ne "$modfname.c", (glob '*.c'), (glob '*.cc'), (glob '*.C');
1688 my $Cpre = ($C ? '' : '# ');
1689 my $Ccomment = ($C ? '' : <<EOC);
1690 # Un-comment this if you add C files to link with later:
1694 $Ccomment $Cpre\'OBJECT' => '\$(O_FILES)', # link all the C files too
1698 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1700 # Create a simple README since this is a CPAN requirement
1701 # and it doesnt hurt to have one
1702 warn "Writing $ext$modpname/README\n";
1703 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
1704 my $thisyear = (gmtime)[5] + 1900;
1705 my $rmhead = "$modpname version $TEMPLATE_VERSION";
1706 my $rmheadeq = "=" x length($rmhead);
1710 if ( $compat_version < 5.00702 and $new_test )
1712 $rm_prereq = 'Test::More';
1716 $rm_prereq = 'blah blah blah';
1723 The README is used to introduce the module and provide instructions on
1724 how to install the module, any machine dependencies it may have (for
1725 example C compilers and installed libraries) and any other information
1726 that should be provided before the module is installed.
1728 A README file is required for CPAN modules since CPAN extracts the
1729 README file from a module distribution so that people browsing the
1730 archive can use it get an idea of the modules uses. It is usually a
1731 good idea to provide version information here so that people can
1732 decide whether fixes for the module are worth downloading.
1736 To install this module type the following:
1745 This module requires these other modules and libraries:
1749 COPYRIGHT AND LICENCE
1751 Put the correct copyright and licence information here.
1753 Copyright (C) $thisyear $author
1755 This library is free software; you can redistribute it and/or modify
1756 it under the same terms as Perl itself.
1759 close(RM) || die "Can't close $ext$modpname/README: $!\n";
1762 my $testfile = "$testdir/1.t";
1763 unless (-d "$testdir") {
1764 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
1766 warn "Writing $ext$modpname/$testfile\n";
1767 my $tests = @const_names ? 2 : 1;
1769 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
1772 # Before `make install' is performed this script should be runnable with
1773 # `make test'. After `make install' it should work as `perl 1.t'
1775 #########################
1777 # change 'tests => $tests' to 'tests => last_test_to_print';
1781 my $test_mod = 'Test::More';
1783 if ( $old_test or ($compat_version < 5.007 and not $new_test ))
1785 my $test_mod = 'Test';
1789 BEGIN { plan tests => $tests };
1791 ok(1); # If we made it this far, we're ok.
1796 my $const_names = join " ", @const_names;
1800 foreach my $constname (qw(
1803 print EX wrap ("\t", "\t", $const_names);
1804 print EX (")) {\n");
1807 next if (eval "my \\\$a = \$constname; 1");
1808 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
1809 print "# pass: \$\@";
1811 print "# fail: \$\@";
1816 print "not ok 2\\n";
1827 use Test::More tests => $tests;
1828 BEGIN { use_ok('$module') };
1833 my $const_names = join " ", @const_names;
1837 foreach my $constname (qw(
1840 print EX wrap ("\t", "\t", $const_names);
1841 print EX (")) {\n");
1844 next if (eval "my \\\$a = \$constname; 1");
1845 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
1846 print "# pass: \$\@";
1848 print "# fail: \$\@";
1854 ok( \$fail == 0 , 'Constants' );
1860 #########################
1862 # Insert your test code below, the $test_mod module is use()ed here so read
1863 # its man page ( perldoc $test_mod ) for help writing this test script.
1867 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
1870 warn "Writing $ext$modpname/Changes\n";
1872 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
1873 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
1875 Revision history for Perl extension $module.
1877 $TEMPLATE_VERSION @{[scalar localtime]}
1878 \t- original version; created by h2xs $H2XS_VERSION with options
1882 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
1885 warn "Writing $ext$modpname/MANIFEST\n";
1886 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
1887 my @files = grep { -f } (<*>, <t/*>);
1889 eval {opendir(D,'.');};
1890 unless ($@) { @files = readdir(D); closedir(D); }
1892 if (!@files) { @files = map {chomp && $_} `ls`; }
1895 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
1897 # Fix up for case-sensitive file systems
1898 s/$modfname/$modfname/i && next;
1899 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
1900 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
1903 print MANI join("\n",@files), "\n";
1907 close OUT or die "Can't close $file: $!";
1908 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1909 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';