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<-B>, B<--beta-version>
80 Use an alpha/beta style version number. Causes version number to
81 be "0.00_01" unless B<-v> is specified.
83 =item B<-C>, B<--omit-changes>
85 Omits creation of the F<Changes> file, and adds a HISTORY section to
88 =item B<-F>, B<--cpp-flags>=I<addflags>
90 Additional flags to specify to C preprocessor when scanning header for
91 function declarations. Writes these options in the generated F<Makefile.PL>
94 =item B<-M>, B<--func-mask>=I<regular expression>
96 selects functions/macros to process.
98 =item B<-O>, B<--overwrite-ok>
100 Allows a pre-existing extension directory to be overwritten.
102 =item B<-P>, B<--omit-pod>
104 Omit the autogenerated stub POD section.
106 =item B<-X>, B<--omit-XS>
108 Omit the XS portion. Used to generate templates for a module which is not
109 XS-based. C<-c> and C<-f> are implicitly enabled.
111 =item B<-a>, B<--gen-accessors>
113 Generate an accessor method for each element of structs and unions. The
114 generated methods are named after the element name; will return the current
115 value of the element if called without additional arguments; and will set
116 the element to the supplied value (and return the new value) if called with
117 an additional argument. Embedded structures and unions are returned as a
118 pointer rather than the complete structure, to facilitate chained calls.
120 These methods all apply to the Ptr type for the structure; additionally
121 two methods are constructed for the structure type itself, C<_to_ptr>
122 which returns a Ptr type pointing to the same structure, and a C<new>
123 method to construct and return a new structure, initialised to zeroes.
125 =item B<-b>, B<--compat-version>=I<version>
127 Generates a .pm file which is backwards compatible with the specified
130 For versions < 5.6.0, the changes are.
131 - no use of 'our' (uses 'use vars' instead)
134 Specifying a compatibility version higher than the version of perl you
135 are using to run h2xs will have no effect. If unspecified h2xs will default
136 to compatibility with the version of perl you are using to run h2xs.
138 =item B<-c>, B<--omit-constant>
140 Omit C<constant()> from the .xs file and corresponding specialised
141 C<AUTOLOAD> from the .pm file.
143 =item B<-d>, B<--debugging>
145 Turn on debugging messages.
147 =item B<-e>, B<--omit-enums>=[I<regular expression>]
149 If I<regular expression> is not given, skip all constants that are defined in
150 a C enumeration. Otherwise skip only those constants that are defined in an
151 enum whose name matches I<regular expression>.
153 Since I<regular expression> is optional, make sure that this switch is followed
154 by at least one other switch if you omit I<regular expression> and have some
155 pending arguments such as header-file names. This is ok:
157 h2xs -e -n Module::Foo foo.h
161 h2xs -n Module::Foo -e foo.h
163 In the latter, foo.h is taken as I<regular expression>.
165 =item B<-f>, B<--force>
167 Allows an extension to be created for a header even if that header is
168 not found in standard include directories.
170 =item B<-g>, B<--global>
172 Include code for safely storing static data in the .xs file.
173 Extensions that do no make use of static data can ignore this option.
175 =item B<-h>, B<-?>, B<--help>
177 Print the usage, help and version for this h2xs and exit.
179 =item B<-k>, B<--omit-const-func>
181 For function arguments declared as C<const>, omit the const attribute in the
184 =item B<-m>, B<--gen-tied-var>
186 B<Experimental>: for each variable declared in the header file(s), declare
187 a perl variable of the same name magically tied to the C variable.
189 =item B<-n>, B<--name>=I<module_name>
191 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
193 =item B<-o>, B<--opaque-re>=I<regular expression>
195 Use "opaque" data type for the C types matched by the regular
196 expression, even if these types are C<typedef>-equivalent to types
197 from typemaps. Should not be used without B<-x>.
199 This may be useful since, say, types which are C<typedef>-equivalent
200 to integers may represent OS-related handles, and one may want to work
201 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
202 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
205 The type-to-match is whitewashed (except for commas, which have no
206 whitespace before them, and multiple C<*> which have no whitespace
209 =item B<-p>, B<--remove-prefix>=I<prefix>
211 Specify a prefix which should be removed from the Perl function names,
212 e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
213 the prefix from functions that are autoloaded via the C<constant()>
216 =item B<-s>, B<--const-subs>=I<sub1,sub2>
218 Create a perl subroutine for the specified macros rather than autoload
219 with the constant() subroutine. These macros are assumed to have a
220 return type of B<char *>, e.g.,
221 S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
223 =item B<-t>, B<--default-type>=I<type>
225 Specify the internal type that the constant() mechanism uses for macros.
226 The default is IV (signed integer). Currently all macros found during the
227 header scanning process will be assumed to have this type. Future versions
228 of C<h2xs> may gain the ability to make educated guesses.
230 =item B<--use-new-tests>
232 When B<--compat-version> (B<-b>) is present the generated tests will use
233 C<Test::More> rather than C<Test> which is the default for versions before
234 5.7.2 . C<Test::More> will be added to PREREQ_PM in the generated
237 =item B<--use-old-tests>
239 Will force the generation of test code that uses the older C<Test> module.
241 =item B<--skip-exporter>
243 Do not use C<Exporter> and/or export any symbol.
245 =item B<--skip-ppport>
247 Do not use C<Devel::PPPort>: no portability to older version.
249 =item B<--skip-autoloader>
251 Do not use the module C<AutoLoader>; but keep the constant() function
252 and C<sub AUTOLOAD> for constants.
254 =item B<--skip-strict>
256 Do not use the pragma C<strict>.
258 =item B<--skip-warnings>
260 Do not use the pragma C<warnings>.
262 =item B<-v>, B<--version>=I<version>
264 Specify a version number for this extension. This version number is added
265 to the templates. The default is 0.01, or 0.00_01 if C<-B> is specified.
266 The version specified should be numeric.
268 =item B<-x>, B<--autogen-xsubs>
270 Automatically generate XSUBs basing on function declarations in the
271 header file. The package C<C::Scan> should be installed. If this
272 option is specified, the name of the header file may look like
273 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
274 string, but XSUBs are emitted only for the declarations included from
277 Note that some types of arguments/return-values for functions may
278 result in XSUB-declarations/typemap-entries which need
279 hand-editing. Such may be objects which cannot be converted from/to a
280 pointer (like C<long long>), pointers to functions, or arrays. See
281 also the section on L<LIMITATIONS of B<-x>>.
288 # Default behavior, extension is Rusers
291 # Same, but extension is RUSERS
292 h2xs -n RUSERS rpcsvc/rusers
294 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
297 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
298 h2xs -n ONC::RPC rpcsvc/rusers
300 # Without constant() or AUTOLOAD
301 h2xs -c rpcsvc/rusers
303 # Creates templates for an extension named RPC
306 # Extension is ONC::RPC.
309 # Extension is Lib::Foo which works at least with Perl5.005_03.
310 # Constants are created for all #defines and enums h2xs can find
312 h2xs -b 5.5.3 -n Lib::Foo foo.h
314 # Extension is Lib::Foo which works at least with Perl5.005_03.
315 # Constants are created for all #defines but only for enums
316 # whose names do not start with 'bar_'.
317 h2xs -b 5.5.3 -e '^bar_' -n Lib::Foo foo.h
319 # Makefile.PL will look for library -lrpc in
320 # additional directory /opt/net/lib
321 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
323 # Extension is DCE::rgynbase
324 # prefix "sec_rgy_" is dropped from perl function names
325 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
327 # Extension is DCE::rgynbase
328 # prefix "sec_rgy_" is dropped from perl function names
329 # subroutines are created for sec_rgy_wildcard_name and
330 # sec_rgy_wildcard_sid
331 h2xs -n DCE::rgynbase -p sec_rgy_ \
332 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
334 # Make XS without defines in perl.h, but with function declarations
335 # visible from perl.h. Name of the extension is perl1.
336 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
337 # Extra backslashes below because the string is passed to shell.
338 # Note that a directory with perl header files would
339 # be added automatically to include path.
340 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
342 # Same with function declaration in proto.h as visible from perl.h.
343 h2xs -xAn perl2 perl.h,proto.h
345 # Same but select only functions which match /^av_/
346 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
348 # Same but treat SV* etc as "opaque" types
349 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
351 =head2 Extension based on F<.h> and F<.c> files
353 Suppose that you have some C files implementing some functionality,
354 and the corresponding header files. How to create an extension which
355 makes this functionality accessable in Perl? The example below
356 assumes that the header files are F<interface_simple.h> and
357 I<interface_hairy.h>, and you want the perl module be named as
358 C<Ext::Ension>. If you need some preprocessor directives and/or
359 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
364 =item Find the directory name
366 Start with a dummy run of h2xs:
368 h2xs -Afn Ext::Ension
370 The only purpose of this step is to create the needed directories, and
371 let you know the names of these directories. From the output you can
372 see that the directory for the extension is F<Ext/Ension>.
376 Copy your header files and C files to this directory F<Ext/Ension>.
378 =item Create the extension
380 Run h2xs, overwriting older autogenerated files:
382 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
384 h2xs looks for header files I<after> changing to the extension
385 directory, so it will find your header files OK.
387 =item Archive and test
399 It is important to do C<make dist> as early as possible. This way you
400 can easily merge(1) your changes to autogenerated files if you decide
401 to edit your C<.h> files and rerun h2xs.
403 Do not forget to edit the documentation in the generated F<.pm> file.
405 Consider the autogenerated files as skeletons only, you may invent
406 better interfaces than what h2xs could guess.
408 Consider this section as a guideline only, some other options of h2xs
409 may better suit your needs.
415 No environment variables are used.
419 Larry Wall and others
423 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
427 The usual warnings if it cannot read or write the files involved.
429 =head1 LIMITATIONS of B<-x>
431 F<h2xs> would not distinguish whether an argument to a C function
432 which is of the form, say, C<int *>, is an input, output, or
433 input/output parameter. In particular, argument declarations of the
440 should be better rewritten as
446 if C<n> is an input parameter.
448 Additionally, F<h2xs> has no facilities to intuit that a function
455 takes a pair of address and length of data at this address, so it is better
456 to rewrite this function as
466 RETVAL = foo(s, len);
476 char *s = SvPV(sv,len);
481 MODULE = foo PACKAGE = foo PREFIX = my_
487 See L<perlxs> and L<perlxstut> for additional details.
495 my( $H2XS_VERSION ) = ' $Revision: 1.22 $ ' =~ /\$Revision:\s+([^\s]+)/;
496 my $TEMPLATE_VERSION = '0.01';
498 my $compat_version = $];
503 $Text::Wrap::huge = 'overflow';
504 $Text::Wrap::columns = 80;
505 use ExtUtils::Constant qw (WriteConstants WriteMakefileSnippet autoload);
511 h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
512 version: $H2XS_VERSION
514 -A, --omit-autoload Omit all autoloading facilities (implies -c).
515 -B, --beta-version Use beta \$VERSION of 0.00_01 (ignored if -v).
516 -C, --omit-changes Omit creating the Changes file, add HISTORY heading
518 -F, --cpp-flags Additional flags for C preprocessor/compile.
519 -M, --func-mask Mask to select C functions/macros
520 (default is select all).
521 -O, --overwrite-ok Allow overwriting of a pre-existing extension directory.
522 -P, --omit-pod Omit the stub POD section.
523 -X, --omit-XS Omit the XS portion (implies both -c and -f).
524 -a, --gen-accessors Generate get/set accessors for struct and union members (used with -x).
525 -b, --compat-version Specify a perl version to be backwards compatibile with
526 -c, --omit-constant Omit the constant() function and specialised AUTOLOAD
528 -d, --debugging Turn on debugging messages.
529 -e, --omit-enums Omit constants from enums in the constant() function.
530 If a pattern is given, only the matching enums are
532 -f, --force Force creation of the extension even if the C header
534 -g, --global Include code for safely storing static data in the .xs file.
535 -h, -?, --help Display this help message
536 -k, --omit-const-func Omit 'const' attribute on function arguments
538 -m, --gen-tied-var Generate tied variables for access to declared
540 -n, --name Specify a name to use for the extension (recommended).
541 -o, --opaque-re Regular expression for \"opaque\" types.
542 -p, --remove-prefix Specify a prefix which should be removed from the
544 -s, --const-subs Create subroutines for specified macros.
545 -t, --default-type Default type for autoloaded constants (default is IV)
546 --use-new-tests Use Test::More in backward compatible modules
547 --use-old-tests Use the module Test rather than Test::More
548 --skip-exporter Do not export symbols
549 --skip-ppport Do not use portability layer
550 --skip-autoloader Do not use the module C<AutoLoader>
551 --skip-strict Do not use the pragma C<strict>
552 --skip-warnings Do not use the pragma C<warnings>
553 -v, --version Specify a version number for this extension.
554 -x, --autogen-xsubs Autogenerate XSUBs using C::Scan.
557 are any libraries that might be needed for loading the
558 extension, e.g. -lm would try to link in the math library.
596 Getopt::Long::Configure('bundling');
599 'omit-autoload|A' => \$opt_A,
600 'beta-version|B' => \$opt_B,
601 'omit-changes|C' => \$opt_C,
602 'cpp-flags|F=s' => \$opt_F,
603 'func-mask|M=s' => \$opt_M,
604 'overwrite_ok|O' => \$opt_O,
605 'omit-pod|P' => \$opt_P,
606 'omit-XS|X' => \$opt_X,
607 'gen-accessors|a' => \$opt_a,
608 'compat-version|b=s' => \$opt_b,
609 'omit-constant|c' => \$opt_c,
610 'debugging|d' => \$opt_d,
611 'omit-enums|e:s' => \$opt_e,
612 'force|f' => \$opt_f,
613 'global|g' => \$opt_g,
614 'help|h|?' => \$opt_h,
615 'omit-const-func|k' => \$opt_k,
616 'gen-tied-var|m' => \$opt_m,
617 'name|n=s' => \$opt_n,
618 'opaque-re|o=s' => \$opt_o,
619 'remove-prefix|p=s' => \$opt_p,
620 'const-subs|s=s' => \$opt_s,
621 'default-type|t=s' => \$opt_t,
622 'version|v=s' => \$opt_v,
623 'autogen-xsubs|x' => \$opt_x,
624 'use-new-tests' => \$new_test,
625 'use-old-tests' => \$old_test,
626 'skip-exporter' => \$skip_exporter,
627 'skip-ppport' => \$skip_ppport,
628 'skip-autoloader' => \$skip_autoloader,
629 'skip-warnings' => \$skip_warnings,
630 'skip-strict' => \$skip_strict,
633 GetOptions(%options) || usage;
638 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
639 $opt_b =~ /^\d+\.\d+\.\d+/ ||
640 usage "You must provide the backwards compatibility version in X.Y.Z form. "
642 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
643 if ($maj < 5 || ($maj == 5 && $min < 6)) {
645 $sub ? sprintf("%d.%03d%02d",$maj,$min,$sub) :
646 sprintf("%d.%03d", $maj,$min);
649 $sub ? sprintf("%d.%03d%03d",$maj,$min,$sub) :
650 sprintf("%d.%03d", $maj,$min);
653 my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d*)/;
655 warn sprintf <<'EOF', $maj,$min,$sub;
656 Defaulting to backwards compatibility with perl %d.%d.%d
657 If you intend this module to be compatible with earlier perl versions, please
658 specify a minimum perl version with the -b option.
664 $TEMPLATE_VERSION = '0.00_01';
668 $TEMPLATE_VERSION = $opt_v;
670 # check if it is numeric
671 my $temp_version = $TEMPLATE_VERSION;
672 my $beta_version = $temp_version =~ s/(\d)_(\d\d)/$1$2/;
675 local $SIG{__WARN__} = sub { $notnum = 1 };
676 use warnings 'numeric';
677 $temp_version = 0+$temp_version;
681 my $module = $opt_n || 'Your::Module';
683 You have specified a non-numeric version. Unless you supply an
684 appropriate VERSION class method, users may not be able to specify a
685 minimum required version with C<use $module versionnum>.
690 $opt_B = $beta_version;
695 $skip_autoloader = $opt_c = 1 if $opt_A;
697 # -X implies -c and -f
698 $opt_c = $opt_f = 1 if $opt_X;
702 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
708 while (my $arg = shift) {
709 if ($arg =~ /^-l/i) {
710 $extralibs = "$arg @ARGV";
716 usage "Must supply header file or module name\n"
717 unless (@path_h or $opt_n);
722 $fmask = qr{$opt_M} if defined $opt_M;
723 $tmask = qr{$opt_o} if defined $opt_o;
724 my $tmask_all = $tmask && $opt_o eq '.';
727 eval {require C::Scan; 1}
729 C::Scan required if you use -x option.
730 To install C::Scan, execute
731 perl -MCPAN -e "install C::Scan"
733 unless ($tmask_all) {
734 $C::Scan::VERSION >= 0.70
736 C::Scan v. 0.70 or later required unless you use -o . option.
737 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
738 To install C::Scan, execute
739 perl -MCPAN -e "install C::Scan"
742 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
744 C::Scan v. 0.73 or later required to use -m or -a options.
745 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
746 To install C::Scan, execute
747 perl -MCPAN -e "install C::Scan"
751 elsif ($opt_o or $opt_F) {
752 warn <<EOD if $opt_o;
753 Option -o does not make sense without -x.
755 warn <<EOD if $opt_F and $opt_X ;
756 Option -F does not make sense with -X.
760 my @path_h_ini = @path_h;
761 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
768 my $pre_sub_tri_graphs = 1;
769 if ($^O eq 'VMS') { # Consider overrides of default location
770 # XXXX This is not equivalent to what the older version did:
771 # it was looking at $hadsys header-file per header-file...
772 my($hadsys) = grep s!^sys/!!i , @path_h;
773 @paths = qw( Sys$Library VAXC$Include );
774 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
775 push @paths, qw( DECC$Library_Include DECC$System_Include );
778 @paths = (File::Spec->curdir(), $Config{usrinc},
779 (split ' ', $Config{locincpth}), '/usr/include');
781 foreach my $path_h (@path_h) {
785 if ( $name !~ /::/ ) {
792 if( $path_h =~ s#::#/#g && $opt_n ){
793 warn "Nesting of headerfile ignored with -n\n";
795 $path_h .= ".h" unless $path_h =~ /\.h$/;
796 my $fullpath = $path_h;
797 $path_h =~ s/,.*$// if $opt_x;
798 $fullpath{$path_h} = $fullpath;
800 # Minor trickery: we can't chdir() before we processed the headers
801 # (so know the name of the extension), but the header may be in the
802 # extension directory...
803 my $tmp_path_h = $path_h;
804 my $rel_path_h = $path_h;
806 if (not -f $path_h) {
808 for my $dir (@paths) {
810 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
813 $rel_path_h = $path_h;
814 $fullpath{$path_h} = $fullpath;
816 (my $epath = $module) =~ s,::,/,g;
817 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
818 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
819 $path_h = $tmp_path_h; # Used during -x
825 die "Can't find $tmp_path_h in @dirs\n"
826 if ( ! $opt_f && ! -f "$rel_path_h" );
827 # Scan the header file (we should deal with nested header files)
828 # Record the names of simple #define constants into const_names
829 # Function prototypes are processed below.
830 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
833 if ($pre_sub_tri_graphs) {
834 # Preprocess all tri-graphs
835 # including things stuck in quoted string constants.
836 s/\?\?=/#/g; # | ??=| #|
837 s/\?\?\!/|/g; # | ??!| ||
838 s/\?\?'/^/g; # | ??'| ^|
839 s/\?\?\(/[/g; # | ??(| [|
840 s/\?\?\)/]/g; # | ??)| ]|
841 s/\?\?\-/~/g; # | ??-| ~|
842 s/\?\?\//\\/g; # | ??/| \|
843 s/\?\?</{/g; # | ??<| {|
844 s/\?\?>/}/g; # | ??>| }|
846 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
849 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
852 # Cannot do: (-1) and ((LHANDLE)3) are OK:
853 #print("Skip non-wordy $def => $rest\n"),
854 # next defines if $rest =~ /[^\w\$]/;
856 print("Skip stringy $def => $rest\n") if $opt_d;
859 print "Matched $_ ($def)\n" if $opt_d;
860 $seen_define{$def} = $rest;
862 next if /^_.*_h_*$/i; # special case, but for what?
863 if (defined $opt_p) {
864 if (!/^$opt_p(\d)/) {
865 ++$prefix{$_} if s/^$opt_p//;
868 warn "can't remove $opt_p prefix from '$_'!\n";
871 $prefixless{$def} = $_;
872 if (!$fmask or /$fmask/) {
873 print "... Passes mask of -M.\n" if $opt_d and $fmask;
878 if (defined $opt_e and !$opt_e) {
882 use Fcntl qw/SEEK_SET/;
883 seek CH, 0, SEEK_SET;
884 my $src = do { local $/; <CH> };
886 no warnings 'uninitialized';
888 # Remove C and C++ comments
889 $src =~ s#/\*[^*]*\*+([^/*][^*]*\*+)*/|("(\\.|[^"\\])*"|'(\\.|[^'\\])*'|.[^/"'\\]*)#$2#gs;
891 while ($src =~ /(\benum\s*([\w_]*)\s*\{\s([\s\w=,]+)\})/gsc) {
892 my ($enum_name, $enum_body) =
893 $1 =~ /enum\s*([\w_]*)\s*\{\s([\s\w=,]+)\}/gs;
894 # skip enums matching $opt_e
895 next if $opt_e && $enum_name =~ /$opt_e/;
897 for my $item (split /,/, $enum_body) {
898 my ($key, $declared_val) = $item =~ /(\w*)\s*=\s*(.*)/;
899 $val = length($declared_val) ? $declared_val : 1 + $val;
900 $seen_define{$key} = $declared_val;
901 $const_names{$key}++;
904 } # if (!defined $opt_e or $opt_e)
909 # Save current directory so that C::Scan can use it
910 my $cwd = File::Spec->rel2abs( File::Spec->curdir );
912 my ($ext, $nested, @modparts, $modfname, $modpname);
913 # As Ilya suggested, use a name that contains - and then it can't clash with
914 # the names of any packages. A directory 'fallback' will clash with any
915 # new pragmata down the fallback:: tree, but that seems unlikely.
916 my $constscfname = 'const-c.inc';
917 my $constsxsfname = 'const-xs.inc';
918 my $fallbackdirname = 'fallback';
920 $ext = chdir 'ext' ? 'ext/' : '';
922 if( $module =~ /::/ ){
924 @modparts = split(/::/,$module);
925 $modfname = $modparts[-1];
926 $modpname = join('/',@modparts);
931 $modfname = $modpname = $module;
936 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
939 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
944 -d "$modpath$_" || mkdir("$modpath$_", 0777);
948 -d "$modpname" || mkdir($modpname, 0777);
949 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
954 my $fdecls_parsed = [];
961 my @fnames_no_prefix;
965 if( ! $opt_X ){ # use XS, unless it was disabled
966 unless ($skip_ppport) {
967 require Devel::PPPort;
968 warn "Writing $ext$modpname/ppport.h\n";
969 Devel::PPPort::WriteFile('ppport.h')
970 || die "Can't create $ext$modpname/ppport.h: $!\n";
972 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
974 warn "Scanning typemaps...\n";
978 my $addflags = $opt_F || '';
980 foreach my $filename (@path_h) {
984 if ($fullpath{$filename} =~ /,/) {
988 warn "Scanning $filename for functions...\n";
989 my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X);
990 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
991 'add_cppflags' => $addflags, 'c_styles' => \@styles;
992 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]);
994 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
995 push(@$fdecls, @{$c->get('fdecls')});
997 push @td, @{$c->get('typedefs_maybe')};
999 my $structs = $c->get('typedef_structs');
1000 @structs{keys %$structs} = values %$structs;
1004 %vdecl_hash = %{ $c->get('vdecl_hash') };
1005 @vdecls = sort keys %vdecl_hash;
1006 for (local $_ = 0; $_ < @vdecls; ++$_) {
1007 my $var = $vdecls[$_];
1008 my($type, $post) = @{ $vdecl_hash{$var} };
1009 if (defined $post) {
1010 warn "Can't handle variable '$type $var $post', skipping.\n";
1011 splice @vdecls, $_, 1;
1014 $type = normalize_type($type);
1015 $vdecl_hash{$var} = $type;
1019 unless ($tmask_all) {
1020 warn "Scanning $filename for typedefs...\n";
1021 my $td = $c->get('typedef_hash');
1022 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
1023 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
1024 push @good_td, @f_good_td;
1025 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
1029 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
1031 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
1034 for my $i (0..$#$fdecls_parsed) {
1035 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
1037 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
1040 $fdecls = [@$fdecls[@good]];
1041 $fdecls_parsed = [@$fdecls_parsed[@good]];
1043 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
1044 # Sort declarations:
1046 my %h = map( ($_->[1], $_), @$fdecls_parsed);
1047 $fdecls_parsed = [ @h{@fnames} ];
1049 @fnames_no_prefix = @fnames;
1051 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix
1053 # Remove macros which expand to typedefs
1054 print "Typedefs are @td.\n" if $opt_d;
1055 my %td = map {($_, $_)} @td;
1056 # Add some other possible but meaningless values for macros
1057 for my $k (qw(char double float int long short unsigned signed void)) {
1058 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
1060 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
1063 while (keys %td > $n) {
1066 while (($k, $v) = each %seen_define) {
1067 # print("found '$k'=>'$v'\n"),
1068 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
1071 # Now %bad_macs contains names of bad macros
1072 for my $k (keys %bad_macs) {
1073 delete $const_names{$prefixless{$k}};
1074 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
1078 my @const_names = sort keys %const_names;
1080 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
1083 warn "Writing $ext$modpname/$modfname.pm\n";
1088 use $compat_version;
1091 print PM <<"END" unless $skip_strict;
1095 print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006;
1097 unless( $opt_X || $opt_c || $opt_A ){
1098 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
1105 print PM <<'END' unless $skip_exporter;
1110 my $use_Dyna = (not $opt_X and $compat_version < 5.006);
1111 print PM <<"END" if $use_Dyna; # use DynaLoader, unless XS was disabled
1116 # Are we using AutoLoader or not?
1117 unless ($skip_autoloader) { # no autoloader whatsoever.
1118 unless ($opt_c) { # we're doing the AUTOLOAD
1119 print PM "use AutoLoader;\n";
1122 print PM "use AutoLoader qw(AUTOLOAD);\n"
1126 if ( $compat_version < 5.006 ) {
1127 my $vars = '$VERSION @ISA';
1128 $vars .= ' @EXPORT @EXPORT_OK %EXPORT_TAGS' unless $skip_exporter;
1129 $vars .= ' $AUTOLOAD' unless $opt_X || $opt_c || $opt_A;
1130 $vars .= ' $XS_VERSION' if $opt_B && !$opt_X;
1131 print PM "use vars qw($vars);";
1136 push @modISA, 'Exporter' unless $skip_exporter;
1137 push @modISA, 'DynaLoader' if $use_Dyna; # no XS
1138 my $myISA = "our \@ISA = qw(@modISA);";
1139 $myISA =~ s/^our // if $compat_version < 5.006;
1141 print PM "\n$myISA\n\n";
1143 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
1146 $tmp .= <<"END" unless $skip_exporter;
1147 # Items to export into callers namespace by default. Note: do not export
1148 # names by default without a very good reason. Use EXPORT_OK instead.
1149 # Do not simply export all your public functions/methods/constants.
1151 # This allows declaration use $module ':all';
1152 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
1154 our %EXPORT_TAGS = ( 'all' => [ qw(
1158 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
1166 $tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n";
1168 $tmp .= "our \$XS_VERSION = \$VERSION;\n" unless $opt_X;
1169 $tmp .= "\$VERSION = eval \$VERSION; # see L<perlmodstyle>\n";
1173 $tmp =~ s/^our //mg if $compat_version < 5.006;
1177 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
1181 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
1183 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
1186 bootstrap $module \$VERSION;
1191 XSLoader::load('$module', \$VERSION);
1194 $tmp =~ s:\$VERSION:\$XS_VERSION:g if $opt_B;
1198 # tying the variables can happen only after bootstrap
1202 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
1209 if( $opt_P ){ # if POD is disabled
1218 # Preloaded methods go here.
1221 print PM <<"END" unless $opt_A;
1223 # Autoload methods go after $after, and are processed by the autosplit program.
1232 my ($email,$author);
1236 ($username,$author) = (getpwuid($>))[0,6];
1237 if (defined $username && defined $author) {
1238 $author =~ s/,.*$//; # in case of sub fields
1239 my $domain = $Config{'mydomain'};
1241 $email = "$username\@$domain";
1245 $author ||= "A. U. Thor";
1246 $email ||= 'a.u.thor@a.galaxy.far.far.away';
1249 $revhist = <<EOT if $opt_C;
1255 #=item $TEMPLATE_VERSION
1257 #Original version; created by h2xs $H2XS_VERSION with options
1265 my $exp_doc = $skip_exporter ? '' : <<EOD;
1273 if (@const_names and not $opt_P) {
1274 $exp_doc .= <<EOD unless $skip_exporter;
1275 #=head2 Exportable constants
1277 # @{[join "\n ", @const_names]}
1282 if (defined $fdecls and @$fdecls and not $opt_P) {
1283 $exp_doc .= <<EOD unless $skip_exporter;
1284 #=head2 Exportable functions
1288 # $exp_doc .= <<EOD if $opt_p;
1289 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1292 $exp_doc .= <<EOD unless $skip_exporter;
1293 # @{[join "\n ", @known_fnames{@fnames}]}
1300 if ($opt_x && $opt_a) {
1302 $meth_doc .= accessor_docs($name, $struct)
1303 while ($name, $struct) = each %structs;
1306 my $pod = <<"END" unless $opt_P;
1307 ## Below is stub documentation for your module. You'd better edit it!
1311 #$module - Perl extension for blah blah blah
1320 #Stub documentation for $module, created by h2xs. It looks like the
1321 #author of the extension was negligent enough to leave the stub
1325 $exp_doc$meth_doc$revhist
1329 #Mention other useful documentation such as the documentation of
1330 #related modules or operating system documentation (such as man pages
1331 #in UNIX), or any relevant external documentation such as RFCs or
1334 #If you have a mailing list set up for your module, mention it here.
1336 #If you have a web site set up for your module, mention it here.
1340 #$author, E<lt>${email}E<gt>
1342 #=head1 COPYRIGHT AND LICENSE
1344 #Copyright ${\(1900 + (localtime) [5])} by $author
1346 #This library is free software; you can redistribute it and/or modify
1347 #it under the same terms as Perl itself.
1352 $pod =~ s/^\#//gm unless $opt_P;
1353 print PM $pod unless $opt_P;
1358 if( ! $opt_X ){ # print XS, unless it is disabled
1359 warn "Writing $ext$modpname/$modfname.xs\n";
1368 print XS <<"END" unless $skip_ppport;
1374 foreach my $path_h (@path_h_ini) {
1376 $h =~ s#^/usr/include/##;
1377 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1378 print XS qq{#include <$h>\n};
1383 print XS <<"END" if $opt_g;
1387 #define MY_CXT_KEY "${module}::_guts" XS_VERSION
1390 /* Put Global Data in here */
1391 int dummy; /* you can access this elsewhere as MY_CXT.dummy */
1398 my %pointer_typedefs;
1399 my %struct_typedefs;
1403 my $out = $pointer_typedefs{$type};
1404 return $out if defined $out;
1406 $out = ($type =~ /\*$/);
1407 # This converts only the guys which do not have trailing part in the typedef
1409 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1410 $type = normalize_type($type);
1411 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1413 $out = td_is_pointer($type);
1415 return ($pointer_typedefs{$otype} = $out);
1420 my $out = $struct_typedefs{$type};
1421 return $out if defined $out;
1423 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1424 # This converts only the guys which do not have trailing part in the typedef
1426 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1427 $type = normalize_type($type);
1428 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1430 $out = td_is_struct($type);
1432 return ($struct_typedefs{$otype} = $out);
1435 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1438 # We write the "sample" files used when this module is built by perl without
1439 # ExtUtils::Constant.
1440 # h2xs will later check that these are the same as those generated by the
1441 # code embedded into Makefile.PL
1442 unless (-d $fallbackdirname) {
1443 mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n";
1445 warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n";
1446 warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n";
1447 my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname);
1448 my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname);
1449 WriteConstants ( C_FILE => $cfallback,
1450 XS_FILE => $xsfallback,
1451 DEFAULT_TYPE => $opt_t,
1453 NAMES => \@const_names,
1455 print XS "#include \"$constscfname\"\n";
1459 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1461 # Now switch from C to XS by issuing the first MODULE declaration:
1464 MODULE = $module PACKAGE = $module $prefix
1468 # If a constant() function was #included then output a corresponding
1470 print XS "INCLUDE: $constsxsfname\n" unless $opt_c;
1472 print XS <<"END" if $opt_g;
1477 /* If any of the fields in the my_cxt_t struct need
1478 to be initialised, do it here.
1484 foreach (sort keys %const_xsub) {
1493 croak("Your vendor has not defined the $module macro $_");
1508 my ($type, $name, $args) = @$decl;
1509 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1511 my @argnames = map {$_->[1]} @$args;
1512 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1514 s/^\s*const\b\s*// for @argtypes;
1516 my @argarrays = map { $_->[4] || '' } @$args;
1517 my $numargs = @$args;
1518 if ($numargs and $argtypes[-1] eq '...') {
1520 $argnames[-1] = '...';
1523 $type = normalize_type($type, 1);
1531 for my $arg (0 .. $numargs - 1) {
1533 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1538 sub print_tievar_subs {
1539 my($fh, $name, $type) = @_;
1542 _get_$name(IV index, SV *sv) {
1547 (void)call_pv("$module\::_get_$name", G_DISCARD);
1552 _set_$name(IV index, SV *sv) {
1557 (void)call_pv("$module\::_set_$name", G_DISCARD);
1564 sub print_tievar_xsubs {
1565 my($fh, $name, $type) = @_;
1573 uf.uf_val = &_get_$name;
1574 uf.uf_set = &_set_$name;
1575 uf.uf_index = (IV)&_get_$name;
1576 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1580 $type THIS = NO_INIT
1596 sub print_accessors {
1597 my($fh, $name, $struct) = @_;
1598 return unless defined $struct && $name !~ /\s|_ANON/;
1599 $name = normalize_type($name);
1600 my $ptrname = normalize_type("$name *");
1603 MODULE = $module PACKAGE = ${name} $prefix
1607 $name THIS = NO_INIT
1610 if (sv_derived_from(ST(0), "$name")) {
1612 char *s = SvPV((SV*)SvRV(ST(0)), len);
1613 if (len != sizeof(THIS))
1614 croak("Size \%d of packed data != expected \%d",
1616 RETVAL = ($name *)s;
1619 croak("THIS is not of type $name");
1625 char *CLASS = NO_INIT
1628 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1632 MODULE = $module PACKAGE = ${name}Ptr $prefix
1635 my @items = @$struct;
1637 my $item = shift @items;
1638 if ($item->[0] =~ /_ANON/) {
1639 if (defined $item->[2]) {
1641 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1642 ], @{ $structs{$item->[0]} };
1644 push @items, @{ $structs{$item->[0]} };
1647 my $type = normalize_type($item->[0]);
1648 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1651 $item->[2](THIS, __value = NO_INIT)
1657 THIS->$item->[-1] = __value;
1659 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1670 my($name, $struct) = @_;
1671 return unless defined $struct && $name !~ /\s|_ANON/;
1672 $name = normalize_type($name);
1673 my $ptrname = $name . 'Ptr';
1674 my @items = @$struct;
1677 my $item = shift @items;
1678 if ($item->[0] =~ /_ANON/) {
1679 if (defined $item->[2]) {
1681 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1682 ], @{ $structs{$item->[0]} };
1684 push @items, @{ $structs{$item->[0]} };
1687 push @list, $item->[2];
1690 my $methods = (join '(...)>, C<', @list) . '(...)';
1694 #=head2 Object and class methods for C<$name>/C<$ptrname>
1696 #The principal Perl representation of a C object of type C<$name> is an
1697 #object of class C<$ptrname> which is a reference to an integer
1698 #representation of a C pointer. To create such an object, one may use
1701 # my \$buffer = $name->new();
1702 # my \$obj = \$buffer->_to_ptr();
1704 #This exersizes the following two methods, and an additional class
1705 #C<$name>, the internal representation of which is a reference to a
1706 #packed string with the C structure. Keep in mind that \$buffer should
1707 #better survive longer than \$obj.
1711 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1713 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1715 #=item C<$name-E<gt>new()>
1717 #Creates an empty object of type C<$name>. The corresponding packed
1718 #string is zeroed out.
1722 #return the current value of the corresponding element if called
1723 #without additional arguments. Set the element to the supplied value
1724 #(and return the new value) if called with an additional argument.
1726 #Applicable to objects of type C<$ptrname>.
1735 # Should be called before any actual call to normalize_type().
1737 # We do not want to read ./typemap by obvios reasons.
1738 my @tm = qw(../../../typemap ../../typemap ../typemap);
1739 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1740 unshift @tm, $stdtypemap;
1741 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1743 # Start with useful default values
1744 $typemap{float} = 'T_NV';
1746 foreach my $typemap (@tm) {
1747 next unless -e $typemap ;
1748 # skip directories, binary files etc.
1749 warn " Scanning $typemap\n";
1750 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1751 unless -T $typemap ;
1752 open(TYPEMAP, $typemap)
1753 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1754 my $mode = 'Typemap';
1757 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1758 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1759 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1760 elsif ($mode eq 'Typemap') {
1761 next if /^\s*($|\#)/ ;
1763 if ( ($type, $image) =
1764 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1765 # This may reference undefined functions:
1766 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1767 $typemap{normalize_type($type)} = $image;
1771 close(TYPEMAP) or die "Cannot close $typemap: $!";
1773 %std_types = %types_seen;
1778 sub normalize_type { # Second arg: do not strip const's before \*
1780 my $do_keep_deep_const = shift;
1781 # If $do_keep_deep_const this is heuristical only
1782 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1784 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1785 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1786 $type =~ s/$ignore_mods//go;
1789 $type =~ s/$ignore_mods//go;
1791 $type =~ s/([^\s\w])/ $1 /g;
1795 $type =~ s/\* (?=\*)/*/g;
1796 $type =~ s/\. \. \./.../g;
1798 $types_seen{$type}++
1799 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1805 sub assign_typemap_entry {
1809 if ($tmask and $type =~ /$tmask/) {
1810 print "Type $type matches -o mask\n" if $opt_d;
1811 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1813 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1814 $type = normalize_type $type;
1815 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1816 $entry = assign_typemap_entry($type);
1818 # XXX good do better if our UV happens to be long long
1819 return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/;
1820 $entry ||= $typemap{$otype}
1821 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1822 $typemap{$otype} = $entry;
1823 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1828 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1832 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1834 while (my($name, $struct) = each %structs) {
1835 print_accessors(\*XS, $name, $struct);
1844 warn "Writing $ext$modpname/typemap\n";
1845 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1847 for $type (sort keys %types_seen) {
1848 my $entry = assign_typemap_entry $type;
1849 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1852 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1853 #############################################################################
1856 if (sv_derived_from($arg, \"${ntype}\")) {
1858 char *s = SvPV((SV*)SvRV($arg), len);
1860 if (len != sizeof($var))
1861 croak(\"Size %d of packed data != expected %d\",
1866 croak(\"$var is not of type ${ntype}\")
1867 #############################################################################
1870 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1873 close TM or die "Cannot close typemap file for write: $!";
1878 warn "Writing $ext$modpname/Makefile.PL\n";
1879 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1883 if ( $compat_version < 5.00702 and $new_test )
1885 $prereq_pm = q%'Test::More' => 0%;
1893 use $compat_version;
1894 use ExtUtils::MakeMaker;
1895 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1896 # the contents of the Makefile that is written.
1899 VERSION_FROM => '$modfname.pm', # finds \$VERSION
1900 PREREQ_PM => {$prereq_pm}, # e.g., Module::Name => 1.1
1901 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1902 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1903 AUTHOR => '$author <$email>') : ()),
1905 if (!$opt_X) { # print C stuff, unless XS is disabled
1906 $opt_F = '' unless defined $opt_F;
1907 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1908 my $Ihelp = ($I ? '-I. ' : '');
1909 my $Icomment = ($I ? '' : <<EOC);
1910 # Insert -I. if you add *.h files later:
1914 LIBS => ['$extralibs'], # e.g., '-lm'
1915 DEFINE => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1916 $Icomment INC => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1919 my $C = grep {$_ ne "$modfname.c"}
1920 (glob '*.c'), (glob '*.cc'), (glob '*.C');
1921 my $Cpre = ($C ? '' : '# ');
1922 my $Ccomment = ($C ? '' : <<EOC);
1923 # Un-comment this if you add C files to link with later:
1927 $Ccomment ${Cpre}OBJECT => '\$(O_FILES)', # link all the C files too
1933 WriteMakefileSnippet ( C_FILE => $constscfname,
1934 XS_FILE => $constsxsfname,
1935 DEFAULT_TYPE => $opt_t,
1937 NAMES => \@const_names,
1940 if (eval {require ExtUtils::Constant; 1}) {
1941 # If you edit these definitions to change the constants used by this module,
1942 # you will need to use the generated $constscfname and $constsxsfname
1943 # files to replace their "fallback" counterparts before distributing your
1950 foreach my \$file ('$constscfname', '$constsxsfname') {
1951 my \$fallback = File::Spec->catfile('$fallbackdirname', \$file);
1952 copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!";
1957 eval $generate_code;
1960 Attempting to test constant code in $ext$modpname/Makefile.PL:
1963 gave unexpected error $@
1964 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1965 using the perlbug script.
1970 foreach my $file ($constscfname, $constsxsfname) {
1971 my $fallback = File::Spec->catfile($fallbackdirname, $file);
1972 if (compare($file, $fallback)) {
1974 Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ.
1980 warn fill ('','', <<"EOM") . "\n";
1981 It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
1982 the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname
1985 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1986 using the perlbug script.
1989 unlink $constscfname, $constsxsfname;
1993 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1995 # Create a simple README since this is a CPAN requirement
1996 # and it doesnt hurt to have one
1997 warn "Writing $ext$modpname/README\n";
1998 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
1999 my $thisyear = (gmtime)[5] + 1900;
2000 my $rmhead = "$modpname version $TEMPLATE_VERSION";
2001 my $rmheadeq = "=" x length($rmhead);
2005 if ( $compat_version < 5.00702 and $new_test )
2007 $rm_prereq = 'Test::More';
2011 $rm_prereq = 'blah blah blah';
2018 The README is used to introduce the module and provide instructions on
2019 how to install the module, any machine dependencies it may have (for
2020 example C compilers and installed libraries) and any other information
2021 that should be provided before the module is installed.
2023 A README file is required for CPAN modules since CPAN extracts the
2024 README file from a module distribution so that people browsing the
2025 archive can use it get an idea of the modules uses. It is usually a
2026 good idea to provide version information here so that people can
2027 decide whether fixes for the module are worth downloading.
2031 To install this module type the following:
2040 This module requires these other modules and libraries:
2044 COPYRIGHT AND LICENCE
2046 Put the correct copyright and licence information here.
2048 Copyright (C) $thisyear $author
2050 This library is free software; you can redistribute it and/or modify
2051 it under the same terms as Perl itself.
2054 close(RM) || die "Can't close $ext$modpname/README: $!\n";
2057 my $testfile = "$testdir/1.t";
2058 unless (-d "$testdir") {
2059 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
2061 warn "Writing $ext$modpname/$testfile\n";
2062 my $tests = @const_names ? 2 : 1;
2064 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
2067 # Before `make install' is performed this script should be runnable with
2068 # `make test'. After `make install' it should work as `perl 1.t'
2070 #########################
2072 # change 'tests => $tests' to 'tests => last_test_to_print';
2076 my $test_mod = 'Test::More';
2078 if ( $old_test or ($compat_version < 5.007 and not $new_test ))
2080 my $test_mod = 'Test';
2084 BEGIN { plan tests => $tests };
2086 ok(1); # If we made it this far, we're ok.
2091 my $const_names = join " ", @const_names;
2095 foreach my $constname (qw(
2098 print EX wrap ("\t", "\t", $const_names);
2099 print EX (")) {\n");
2102 next if (eval "my \\\$a = \$constname; 1");
2103 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2104 print "# pass: \$\@";
2106 print "# fail: \$\@";
2111 print "not ok 2\\n";
2122 use Test::More tests => $tests;
2123 BEGIN { use_ok('$module') };
2128 my $const_names = join " ", @const_names;
2132 foreach my $constname (qw(
2135 print EX wrap ("\t", "\t", $const_names);
2136 print EX (")) {\n");
2139 next if (eval "my \\\$a = \$constname; 1");
2140 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2141 print "# pass: \$\@";
2143 print "# fail: \$\@";
2149 ok( \$fail == 0 , 'Constants' );
2155 #########################
2157 # Insert your test code below, the $test_mod module is use()ed here so read
2158 # its man page ( perldoc $test_mod ) for help writing this test script.
2162 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
2165 warn "Writing $ext$modpname/Changes\n";
2167 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
2168 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
2170 Revision history for Perl extension $module.
2172 $TEMPLATE_VERSION @{[scalar localtime]}
2173 \t- original version; created by h2xs $H2XS_VERSION with options
2177 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
2180 warn "Writing $ext$modpname/MANIFEST\n";
2181 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
2182 my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>);
2184 eval {opendir(D,'.');};
2185 unless ($@) { @files = readdir(D); closedir(D); }
2187 if (!@files) { @files = map {chomp && $_} `ls`; }
2190 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
2192 # Fix up for case-sensitive file systems
2193 s/$modfname/$modfname/i && next;
2194 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
2195 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
2198 print MANI join("\n",@files), "\n";
2202 close OUT or die "Can't close $file: $!";
2203 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
2204 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';