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');
597 Getopt::Long::Configure('pass_through');
600 'omit-autoload|A' => \$opt_A,
601 'beta-version|B' => \$opt_B,
602 'omit-changes|C' => \$opt_C,
603 'cpp-flags|F=s' => \$opt_F,
604 'func-mask|M=s' => \$opt_M,
605 'overwrite_ok|O' => \$opt_O,
606 'omit-pod|P' => \$opt_P,
607 'omit-XS|X' => \$opt_X,
608 'gen-accessors|a' => \$opt_a,
609 'compat-version|b=s' => \$opt_b,
610 'omit-constant|c' => \$opt_c,
611 'debugging|d' => \$opt_d,
612 'omit-enums|e:s' => \$opt_e,
613 'force|f' => \$opt_f,
614 'global|g' => \$opt_g,
615 'help|h|?' => \$opt_h,
616 'omit-const-func|k' => \$opt_k,
617 'gen-tied-var|m' => \$opt_m,
618 'name|n=s' => \$opt_n,
619 'opaque-re|o=s' => \$opt_o,
620 'remove-prefix|p=s' => \$opt_p,
621 'const-subs|s=s' => \$opt_s,
622 'default-type|t=s' => \$opt_t,
623 'version|v=s' => \$opt_v,
624 'autogen-xsubs|x' => \$opt_x,
625 'use-new-tests' => \$new_test,
626 'use-old-tests' => \$old_test,
627 'skip-exporter' => \$skip_exporter,
628 'skip-ppport' => \$skip_ppport,
629 'skip-autoloader' => \$skip_autoloader,
630 'skip-warnings' => \$skip_warnings,
631 'skip-strict' => \$skip_strict,
634 GetOptions(%options) || usage;
639 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
640 $opt_b =~ /^\d+\.\d+\.\d+/ ||
641 usage "You must provide the backwards compatibility version in X.Y.Z form. "
643 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
644 if ($maj < 5 || ($maj == 5 && $min < 6)) {
646 $sub ? sprintf("%d.%03d%02d",$maj,$min,$sub) :
647 sprintf("%d.%03d", $maj,$min);
650 $sub ? sprintf("%d.%03d%03d",$maj,$min,$sub) :
651 sprintf("%d.%03d", $maj,$min);
654 my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d*)/;
656 warn sprintf <<'EOF', $maj,$min,$sub;
657 Defaulting to backwards compatibility with perl %d.%d.%d
658 If you intend this module to be compatible with earlier perl versions, please
659 specify a minimum perl version with the -b option.
665 $TEMPLATE_VERSION = '0.00_01';
669 $TEMPLATE_VERSION = $opt_v;
671 # check if it is numeric
672 my $temp_version = $TEMPLATE_VERSION;
673 my $beta_version = $temp_version =~ s/(\d)_(\d\d)/$1$2/;
676 local $SIG{__WARN__} = sub { $notnum = 1 };
677 use warnings 'numeric';
678 $temp_version = 0+$temp_version;
682 my $module = $opt_n || 'Your::Module';
684 You have specified a non-numeric version. Unless you supply an
685 appropriate VERSION class method, users may not be able to specify a
686 minimum required version with C<use $module versionnum>.
691 $opt_B = $beta_version;
696 $skip_autoloader = $opt_c = 1 if $opt_A;
698 # -X implies -c and -f
699 $opt_c = $opt_f = 1 if $opt_X;
703 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
709 while (my $arg = shift) {
710 if ($arg =~ /^-l/i) {
711 $extralibs .= "$arg ";
718 usage "Must supply header file or module name\n"
719 unless (@path_h or $opt_n);
724 $fmask = qr{$opt_M} if defined $opt_M;
725 $tmask = qr{$opt_o} if defined $opt_o;
726 my $tmask_all = $tmask && $opt_o eq '.';
729 eval {require C::Scan; 1}
731 C::Scan required if you use -x option.
732 To install C::Scan, execute
733 perl -MCPAN -e "install C::Scan"
735 unless ($tmask_all) {
736 $C::Scan::VERSION >= 0.70
738 C::Scan v. 0.70 or later required unless you use -o . option.
739 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
740 To install C::Scan, execute
741 perl -MCPAN -e "install C::Scan"
744 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
746 C::Scan v. 0.73 or later required to use -m or -a options.
747 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
748 To install C::Scan, execute
749 perl -MCPAN -e "install C::Scan"
753 elsif ($opt_o or $opt_F) {
754 warn <<EOD if $opt_o;
755 Option -o does not make sense without -x.
757 warn <<EOD if $opt_F and $opt_X ;
758 Option -F does not make sense with -X.
762 my @path_h_ini = @path_h;
763 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
770 my $pre_sub_tri_graphs = 1;
771 if ($^O eq 'VMS') { # Consider overrides of default location
772 # XXXX This is not equivalent to what the older version did:
773 # it was looking at $hadsys header-file per header-file...
774 my($hadsys) = grep s!^sys/!!i , @path_h;
775 @paths = qw( Sys$Library VAXC$Include );
776 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
777 push @paths, qw( DECC$Library_Include DECC$System_Include );
780 @paths = (File::Spec->curdir(), $Config{usrinc},
781 (split ' ', $Config{locincpth}), '/usr/include');
783 foreach my $path_h (@path_h) {
787 if ( $name !~ /::/ ) {
794 if( $path_h =~ s#::#/#g && $opt_n ){
795 warn "Nesting of headerfile ignored with -n\n";
797 $path_h .= ".h" unless $path_h =~ /\.h$/;
798 my $fullpath = $path_h;
799 $path_h =~ s/,.*$// if $opt_x;
800 $fullpath{$path_h} = $fullpath;
802 # Minor trickery: we can't chdir() before we processed the headers
803 # (so know the name of the extension), but the header may be in the
804 # extension directory...
805 my $tmp_path_h = $path_h;
806 my $rel_path_h = $path_h;
808 if (not -f $path_h) {
810 for my $dir (@paths) {
812 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
815 $rel_path_h = $path_h;
816 $fullpath{$path_h} = $fullpath;
818 (my $epath = $module) =~ s,::,/,g;
819 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
820 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
821 $path_h = $tmp_path_h; # Used during -x
827 die "Can't find $tmp_path_h in @dirs\n"
828 if ( ! $opt_f && ! -f "$rel_path_h" );
829 # Scan the header file (we should deal with nested header files)
830 # Record the names of simple #define constants into const_names
831 # Function prototypes are processed below.
832 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
835 if ($pre_sub_tri_graphs) {
836 # Preprocess all tri-graphs
837 # including things stuck in quoted string constants.
838 s/\?\?=/#/g; # | ??=| #|
839 s/\?\?\!/|/g; # | ??!| ||
840 s/\?\?'/^/g; # | ??'| ^|
841 s/\?\?\(/[/g; # | ??(| [|
842 s/\?\?\)/]/g; # | ??)| ]|
843 s/\?\?\-/~/g; # | ??-| ~|
844 s/\?\?\//\\/g; # | ??/| \|
845 s/\?\?</{/g; # | ??<| {|
846 s/\?\?>/}/g; # | ??>| }|
848 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
851 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
854 # Cannot do: (-1) and ((LHANDLE)3) are OK:
855 #print("Skip non-wordy $def => $rest\n"),
856 # next defines if $rest =~ /[^\w\$]/;
858 print("Skip stringy $def => $rest\n") if $opt_d;
861 print "Matched $_ ($def)\n" if $opt_d;
862 $seen_define{$def} = $rest;
864 next if /^_.*_h_*$/i; # special case, but for what?
865 if (defined $opt_p) {
866 if (!/^$opt_p(\d)/) {
867 ++$prefix{$_} if s/^$opt_p//;
870 warn "can't remove $opt_p prefix from '$_'!\n";
873 $prefixless{$def} = $_;
874 if (!$fmask or /$fmask/) {
875 print "... Passes mask of -M.\n" if $opt_d and $fmask;
880 if (defined $opt_e and !$opt_e) {
884 # Work from miniperl too - on "normal" systems
885 my $SEEK_SET = eval 'use Fcntl qw/SEEK_SET/; SEEK_SET' or 0;
886 seek CH, 0, $SEEK_SET;
887 my $src = do { local $/; <CH> };
889 no warnings 'uninitialized';
891 # Remove C and C++ comments
892 $src =~ s#/\*[^*]*\*+([^/*][^*]*\*+)*/|("(\\.|[^"\\])*"|'(\\.|[^'\\])*'|.[^/"'\\]*)#$2#gs;
894 while ($src =~ /(\benum\s*([\w_]*)\s*\{\s([\s\w=,]+)\})/gsc) {
895 my ($enum_name, $enum_body) =
896 $1 =~ /enum\s*([\w_]*)\s*\{\s([\s\w=,]+)\}/gs;
897 # skip enums matching $opt_e
898 next if $opt_e && $enum_name =~ /$opt_e/;
900 for my $item (split /,/, $enum_body) {
901 my ($key, $declared_val) = $item =~ /(\w*)\s*=\s*(.*)/;
902 $val = length($declared_val) ? $declared_val : 1 + $val;
903 $seen_define{$key} = $declared_val;
904 $const_names{$key}++;
907 } # if (!defined $opt_e or $opt_e)
912 # Save current directory so that C::Scan can use it
913 my $cwd = File::Spec->rel2abs( File::Spec->curdir );
915 my ($ext, $nested, @modparts, $modfname, $modpname);
916 # As Ilya suggested, use a name that contains - and then it can't clash with
917 # the names of any packages. A directory 'fallback' will clash with any
918 # new pragmata down the fallback:: tree, but that seems unlikely.
919 my $constscfname = 'const-c.inc';
920 my $constsxsfname = 'const-xs.inc';
921 my $fallbackdirname = 'fallback';
923 $ext = chdir 'ext' ? 'ext/' : '';
925 if( $module =~ /::/ ){
927 @modparts = split(/::/,$module);
928 $modfname = $modparts[-1];
929 $modpname = join('/',@modparts);
934 $modfname = $modpname = $module;
939 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
942 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
947 -d "$modpath$_" || mkdir("$modpath$_", 0777);
951 -d "$modpname" || mkdir($modpname, 0777);
952 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
957 my $fdecls_parsed = [];
964 my @fnames_no_prefix;
968 if( ! $opt_X ){ # use XS, unless it was disabled
969 unless ($skip_ppport) {
970 require Devel::PPPort;
971 warn "Writing $ext$modpname/ppport.h\n";
972 Devel::PPPort::WriteFile('ppport.h')
973 || die "Can't create $ext$modpname/ppport.h: $!\n";
975 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
977 warn "Scanning typemaps...\n";
981 my $addflags = $opt_F || '';
983 foreach my $filename (@path_h) {
987 if ($fullpath{$filename} =~ /,/) {
991 warn "Scanning $filename for functions...\n";
992 my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X);
993 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
994 'add_cppflags' => $addflags, 'c_styles' => \@styles;
995 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]);
997 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
998 push(@$fdecls, @{$c->get('fdecls')});
1000 push @td, @{$c->get('typedefs_maybe')};
1002 my $structs = $c->get('typedef_structs');
1003 @structs{keys %$structs} = values %$structs;
1007 %vdecl_hash = %{ $c->get('vdecl_hash') };
1008 @vdecls = sort keys %vdecl_hash;
1009 for (local $_ = 0; $_ < @vdecls; ++$_) {
1010 my $var = $vdecls[$_];
1011 my($type, $post) = @{ $vdecl_hash{$var} };
1012 if (defined $post) {
1013 warn "Can't handle variable '$type $var $post', skipping.\n";
1014 splice @vdecls, $_, 1;
1017 $type = normalize_type($type);
1018 $vdecl_hash{$var} = $type;
1022 unless ($tmask_all) {
1023 warn "Scanning $filename for typedefs...\n";
1024 my $td = $c->get('typedef_hash');
1025 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
1026 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
1027 push @good_td, @f_good_td;
1028 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
1032 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
1034 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
1037 for my $i (0..$#$fdecls_parsed) {
1038 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
1040 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
1043 $fdecls = [@$fdecls[@good]];
1044 $fdecls_parsed = [@$fdecls_parsed[@good]];
1046 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
1047 # Sort declarations:
1049 my %h = map( ($_->[1], $_), @$fdecls_parsed);
1050 $fdecls_parsed = [ @h{@fnames} ];
1052 @fnames_no_prefix = @fnames;
1054 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix
1056 # Remove macros which expand to typedefs
1057 print "Typedefs are @td.\n" if $opt_d;
1058 my %td = map {($_, $_)} @td;
1059 # Add some other possible but meaningless values for macros
1060 for my $k (qw(char double float int long short unsigned signed void)) {
1061 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
1063 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
1066 while (keys %td > $n) {
1069 while (($k, $v) = each %seen_define) {
1070 # print("found '$k'=>'$v'\n"),
1071 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
1074 # Now %bad_macs contains names of bad macros
1075 for my $k (keys %bad_macs) {
1076 delete $const_names{$prefixless{$k}};
1077 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
1081 my @const_names = sort keys %const_names;
1083 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
1086 warn "Writing $ext$modpname/$modfname.pm\n";
1091 use $compat_version;
1094 print PM <<"END" unless $skip_strict;
1098 print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006;
1100 unless( $opt_X || $opt_c || $opt_A ){
1101 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
1108 print PM <<'END' unless $skip_exporter;
1113 my $use_Dyna = (not $opt_X and $compat_version < 5.006);
1114 print PM <<"END" if $use_Dyna; # use DynaLoader, unless XS was disabled
1119 # Are we using AutoLoader or not?
1120 unless ($skip_autoloader) { # no autoloader whatsoever.
1121 unless ($opt_c) { # we're doing the AUTOLOAD
1122 print PM "use AutoLoader;\n";
1125 print PM "use AutoLoader qw(AUTOLOAD);\n"
1129 if ( $compat_version < 5.006 ) {
1130 my $vars = '$VERSION @ISA';
1131 $vars .= ' @EXPORT @EXPORT_OK %EXPORT_TAGS' unless $skip_exporter;
1132 $vars .= ' $AUTOLOAD' unless $opt_X || $opt_c || $opt_A;
1133 $vars .= ' $XS_VERSION' if $opt_B && !$opt_X;
1134 print PM "use vars qw($vars);";
1139 push @modISA, 'Exporter' unless $skip_exporter;
1140 push @modISA, 'DynaLoader' if $use_Dyna; # no XS
1141 my $myISA = "our \@ISA = qw(@modISA);";
1142 $myISA =~ s/^our // if $compat_version < 5.006;
1144 print PM "\n$myISA\n\n";
1146 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
1149 $tmp .= <<"END" unless $skip_exporter;
1150 # Items to export into callers namespace by default. Note: do not export
1151 # names by default without a very good reason. Use EXPORT_OK instead.
1152 # Do not simply export all your public functions/methods/constants.
1154 # This allows declaration use $module ':all';
1155 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
1157 our %EXPORT_TAGS = ( 'all' => [ qw(
1161 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
1169 $tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n";
1171 $tmp .= "our \$XS_VERSION = \$VERSION;\n" unless $opt_X;
1172 $tmp .= "\$VERSION = eval \$VERSION; # see L<perlmodstyle>\n";
1176 $tmp =~ s/^our //mg if $compat_version < 5.006;
1180 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
1184 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
1186 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
1189 bootstrap $module \$VERSION;
1194 XSLoader::load('$module', \$VERSION);
1197 $tmp =~ s:\$VERSION:\$XS_VERSION:g if $opt_B;
1201 # tying the variables can happen only after bootstrap
1205 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
1212 if( $opt_P ){ # if POD is disabled
1221 # Preloaded methods go here.
1224 print PM <<"END" unless $opt_A;
1226 # Autoload methods go after $after, and are processed by the autosplit program.
1235 my ($email,$author);
1239 ($username,$author) = (getpwuid($>))[0,6];
1240 if (defined $username && defined $author) {
1241 $author =~ s/,.*$//; # in case of sub fields
1242 my $domain = $Config{'mydomain'};
1244 $email = "$username\@$domain";
1248 $author ||= "A. U. Thor";
1249 $email ||= 'a.u.thor@a.galaxy.far.far.away';
1252 $revhist = <<EOT if $opt_C;
1258 #=item $TEMPLATE_VERSION
1260 #Original version; created by h2xs $H2XS_VERSION with options
1268 my $exp_doc = $skip_exporter ? '' : <<EOD;
1276 if (@const_names and not $opt_P) {
1277 $exp_doc .= <<EOD unless $skip_exporter;
1278 #=head2 Exportable constants
1280 # @{[join "\n ", @const_names]}
1285 if (defined $fdecls and @$fdecls and not $opt_P) {
1286 $exp_doc .= <<EOD unless $skip_exporter;
1287 #=head2 Exportable functions
1291 # $exp_doc .= <<EOD if $opt_p;
1292 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1295 $exp_doc .= <<EOD unless $skip_exporter;
1296 # @{[join "\n ", @known_fnames{@fnames}]}
1303 if ($opt_x && $opt_a) {
1305 $meth_doc .= accessor_docs($name, $struct)
1306 while ($name, $struct) = each %structs;
1309 my $pod = <<"END" unless $opt_P;
1310 ## Below is stub documentation for your module. You'd better edit it!
1314 #$module - Perl extension for blah blah blah
1323 #Stub documentation for $module, created by h2xs. It looks like the
1324 #author of the extension was negligent enough to leave the stub
1328 $exp_doc$meth_doc$revhist
1332 #Mention other useful documentation such as the documentation of
1333 #related modules or operating system documentation (such as man pages
1334 #in UNIX), or any relevant external documentation such as RFCs or
1337 #If you have a mailing list set up for your module, mention it here.
1339 #If you have a web site set up for your module, mention it here.
1343 #$author, E<lt>${email}E<gt>
1345 #=head1 COPYRIGHT AND LICENSE
1347 #Copyright ${\(1900 + (localtime) [5])} by $author
1349 #This library is free software; you can redistribute it and/or modify
1350 #it under the same terms as Perl itself.
1355 $pod =~ s/^\#//gm unless $opt_P;
1356 print PM $pod unless $opt_P;
1361 if( ! $opt_X ){ # print XS, unless it is disabled
1362 warn "Writing $ext$modpname/$modfname.xs\n";
1371 print XS <<"END" unless $skip_ppport;
1377 foreach my $path_h (@path_h_ini) {
1379 $h =~ s#^/usr/include/##;
1380 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1381 print XS qq{#include <$h>\n};
1386 print XS <<"END" if $opt_g;
1390 #define MY_CXT_KEY "${module}::_guts" XS_VERSION
1393 /* Put Global Data in here */
1394 int dummy; /* you can access this elsewhere as MY_CXT.dummy */
1401 my %pointer_typedefs;
1402 my %struct_typedefs;
1406 my $out = $pointer_typedefs{$type};
1407 return $out if defined $out;
1409 $out = ($type =~ /\*$/);
1410 # This converts only the guys which do not have trailing part in the typedef
1412 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1413 $type = normalize_type($type);
1414 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1416 $out = td_is_pointer($type);
1418 return ($pointer_typedefs{$otype} = $out);
1423 my $out = $struct_typedefs{$type};
1424 return $out if defined $out;
1426 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1427 # This converts only the guys which do not have trailing part in the typedef
1429 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1430 $type = normalize_type($type);
1431 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1433 $out = td_is_struct($type);
1435 return ($struct_typedefs{$otype} = $out);
1438 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1441 # We write the "sample" files used when this module is built by perl without
1442 # ExtUtils::Constant.
1443 # h2xs will later check that these are the same as those generated by the
1444 # code embedded into Makefile.PL
1445 unless (-d $fallbackdirname) {
1446 mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n";
1448 warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n";
1449 warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n";
1450 my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname);
1451 my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname);
1452 WriteConstants ( C_FILE => $cfallback,
1453 XS_FILE => $xsfallback,
1454 DEFAULT_TYPE => $opt_t,
1456 NAMES => \@const_names,
1458 print XS "#include \"$constscfname\"\n";
1462 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1464 # Now switch from C to XS by issuing the first MODULE declaration:
1467 MODULE = $module PACKAGE = $module $prefix
1471 # If a constant() function was #included then output a corresponding
1473 print XS "INCLUDE: $constsxsfname\n" unless $opt_c;
1475 print XS <<"END" if $opt_g;
1480 /* If any of the fields in the my_cxt_t struct need
1481 to be initialised, do it here.
1487 foreach (sort keys %const_xsub) {
1496 croak("Your vendor has not defined the $module macro $_");
1511 my ($type, $name, $args) = @$decl;
1512 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1514 my @argnames = map {$_->[1]} @$args;
1515 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1517 s/^\s*const\b\s*// for @argtypes;
1519 my @argarrays = map { $_->[4] || '' } @$args;
1520 my $numargs = @$args;
1521 if ($numargs and $argtypes[-1] eq '...') {
1523 $argnames[-1] = '...';
1526 $type = normalize_type($type, 1);
1534 for my $arg (0 .. $numargs - 1) {
1536 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1541 sub print_tievar_subs {
1542 my($fh, $name, $type) = @_;
1545 _get_$name(IV index, SV *sv) {
1550 (void)call_pv("$module\::_get_$name", G_DISCARD);
1555 _set_$name(IV index, SV *sv) {
1560 (void)call_pv("$module\::_set_$name", G_DISCARD);
1567 sub print_tievar_xsubs {
1568 my($fh, $name, $type) = @_;
1576 uf.uf_val = &_get_$name;
1577 uf.uf_set = &_set_$name;
1578 uf.uf_index = (IV)&_get_$name;
1579 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1583 $type THIS = NO_INIT
1599 sub print_accessors {
1600 my($fh, $name, $struct) = @_;
1601 return unless defined $struct && $name !~ /\s|_ANON/;
1602 $name = normalize_type($name);
1603 my $ptrname = normalize_type("$name *");
1606 MODULE = $module PACKAGE = ${name} $prefix
1610 $name THIS = NO_INIT
1613 if (sv_derived_from(ST(0), "$name")) {
1615 char *s = SvPV((SV*)SvRV(ST(0)), len);
1616 if (len != sizeof(THIS))
1617 croak("Size \%d of packed data != expected \%d",
1619 RETVAL = ($name *)s;
1622 croak("THIS is not of type $name");
1628 char *CLASS = NO_INIT
1631 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1635 MODULE = $module PACKAGE = ${name}Ptr $prefix
1638 my @items = @$struct;
1640 my $item = shift @items;
1641 if ($item->[0] =~ /_ANON/) {
1642 if (defined $item->[2]) {
1644 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1645 ], @{ $structs{$item->[0]} };
1647 push @items, @{ $structs{$item->[0]} };
1650 my $type = normalize_type($item->[0]);
1651 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1654 $item->[2](THIS, __value = NO_INIT)
1660 THIS->$item->[-1] = __value;
1662 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1673 my($name, $struct) = @_;
1674 return unless defined $struct && $name !~ /\s|_ANON/;
1675 $name = normalize_type($name);
1676 my $ptrname = $name . 'Ptr';
1677 my @items = @$struct;
1680 my $item = shift @items;
1681 if ($item->[0] =~ /_ANON/) {
1682 if (defined $item->[2]) {
1684 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1685 ], @{ $structs{$item->[0]} };
1687 push @items, @{ $structs{$item->[0]} };
1690 push @list, $item->[2];
1693 my $methods = (join '(...)>, C<', @list) . '(...)';
1697 #=head2 Object and class methods for C<$name>/C<$ptrname>
1699 #The principal Perl representation of a C object of type C<$name> is an
1700 #object of class C<$ptrname> which is a reference to an integer
1701 #representation of a C pointer. To create such an object, one may use
1704 # my \$buffer = $name->new();
1705 # my \$obj = \$buffer->_to_ptr();
1707 #This exersizes the following two methods, and an additional class
1708 #C<$name>, the internal representation of which is a reference to a
1709 #packed string with the C structure. Keep in mind that \$buffer should
1710 #better survive longer than \$obj.
1714 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1716 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1718 #=item C<$name-E<gt>new()>
1720 #Creates an empty object of type C<$name>. The corresponding packed
1721 #string is zeroed out.
1725 #return the current value of the corresponding element if called
1726 #without additional arguments. Set the element to the supplied value
1727 #(and return the new value) if called with an additional argument.
1729 #Applicable to objects of type C<$ptrname>.
1738 # Should be called before any actual call to normalize_type().
1740 # We do not want to read ./typemap by obvios reasons.
1741 my @tm = qw(../../../typemap ../../typemap ../typemap);
1742 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1743 unshift @tm, $stdtypemap;
1744 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1746 # Start with useful default values
1747 $typemap{float} = 'T_NV';
1749 foreach my $typemap (@tm) {
1750 next unless -e $typemap ;
1751 # skip directories, binary files etc.
1752 warn " Scanning $typemap\n";
1753 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1754 unless -T $typemap ;
1755 open(TYPEMAP, $typemap)
1756 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1757 my $mode = 'Typemap';
1760 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1761 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1762 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1763 elsif ($mode eq 'Typemap') {
1764 next if /^\s*($|\#)/ ;
1766 if ( ($type, $image) =
1767 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1768 # This may reference undefined functions:
1769 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1770 $typemap{normalize_type($type)} = $image;
1774 close(TYPEMAP) or die "Cannot close $typemap: $!";
1776 %std_types = %types_seen;
1781 sub normalize_type { # Second arg: do not strip const's before \*
1783 my $do_keep_deep_const = shift;
1784 # If $do_keep_deep_const this is heuristical only
1785 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1787 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1788 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1789 $type =~ s/$ignore_mods//go;
1792 $type =~ s/$ignore_mods//go;
1794 $type =~ s/([^\s\w])/ $1 /g;
1798 $type =~ s/\* (?=\*)/*/g;
1799 $type =~ s/\. \. \./.../g;
1801 $types_seen{$type}++
1802 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1808 sub assign_typemap_entry {
1812 if ($tmask and $type =~ /$tmask/) {
1813 print "Type $type matches -o mask\n" if $opt_d;
1814 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1816 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1817 $type = normalize_type $type;
1818 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1819 $entry = assign_typemap_entry($type);
1821 # XXX good do better if our UV happens to be long long
1822 return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/;
1823 $entry ||= $typemap{$otype}
1824 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1825 $typemap{$otype} = $entry;
1826 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1831 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1835 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1837 while (my($name, $struct) = each %structs) {
1838 print_accessors(\*XS, $name, $struct);
1847 warn "Writing $ext$modpname/typemap\n";
1848 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1850 for $type (sort keys %types_seen) {
1851 my $entry = assign_typemap_entry $type;
1852 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1855 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1856 #############################################################################
1859 if (sv_derived_from($arg, \"${ntype}\")) {
1861 char *s = SvPV((SV*)SvRV($arg), len);
1863 if (len != sizeof($var))
1864 croak(\"Size %d of packed data != expected %d\",
1869 croak(\"$var is not of type ${ntype}\")
1870 #############################################################################
1873 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1876 close TM or die "Cannot close typemap file for write: $!";
1881 warn "Writing $ext$modpname/Makefile.PL\n";
1882 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1886 if ( $compat_version < 5.00702 and $new_test )
1888 $prereq_pm = q%'Test::More' => 0%;
1896 use $compat_version;
1897 use ExtUtils::MakeMaker;
1898 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1899 # the contents of the Makefile that is written.
1902 VERSION_FROM => '$modfname.pm', # finds \$VERSION
1903 PREREQ_PM => {$prereq_pm}, # e.g., Module::Name => 1.1
1904 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1905 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1906 AUTHOR => '$author <$email>') : ()),
1908 if (!$opt_X) { # print C stuff, unless XS is disabled
1909 $opt_F = '' unless defined $opt_F;
1910 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1911 my $Ihelp = ($I ? '-I. ' : '');
1912 my $Icomment = ($I ? '' : <<EOC);
1913 # Insert -I. if you add *.h files later:
1917 LIBS => ['$extralibs'], # e.g., '-lm'
1918 DEFINE => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1919 $Icomment INC => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1922 my $C = grep {$_ ne "$modfname.c"}
1923 (glob '*.c'), (glob '*.cc'), (glob '*.C');
1924 my $Cpre = ($C ? '' : '# ');
1925 my $Ccomment = ($C ? '' : <<EOC);
1926 # Un-comment this if you add C files to link with later:
1930 $Ccomment ${Cpre}OBJECT => '\$(O_FILES)', # link all the C files too
1936 WriteMakefileSnippet ( C_FILE => $constscfname,
1937 XS_FILE => $constsxsfname,
1938 DEFAULT_TYPE => $opt_t,
1940 NAMES => \@const_names,
1943 if (eval {require ExtUtils::Constant; 1}) {
1944 # If you edit these definitions to change the constants used by this module,
1945 # you will need to use the generated $constscfname and $constsxsfname
1946 # files to replace their "fallback" counterparts before distributing your
1953 foreach my \$file ('$constscfname', '$constsxsfname') {
1954 my \$fallback = File::Spec->catfile('$fallbackdirname', \$file);
1955 copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!";
1960 eval $generate_code;
1963 Attempting to test constant code in $ext$modpname/Makefile.PL:
1966 gave unexpected error $@
1967 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1968 using the perlbug script.
1973 foreach my $file ($constscfname, $constsxsfname) {
1974 my $fallback = File::Spec->catfile($fallbackdirname, $file);
1975 if (compare($file, $fallback)) {
1977 Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ.
1983 warn fill ('','', <<"EOM") . "\n";
1984 It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
1985 the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname
1988 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1989 using the perlbug script.
1992 unlink $constscfname, $constsxsfname;
1996 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1998 # Create a simple README since this is a CPAN requirement
1999 # and it doesnt hurt to have one
2000 warn "Writing $ext$modpname/README\n";
2001 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
2002 my $thisyear = (gmtime)[5] + 1900;
2003 my $rmhead = "$modpname version $TEMPLATE_VERSION";
2004 my $rmheadeq = "=" x length($rmhead);
2008 if ( $compat_version < 5.00702 and $new_test )
2010 $rm_prereq = 'Test::More';
2014 $rm_prereq = 'blah blah blah';
2021 The README is used to introduce the module and provide instructions on
2022 how to install the module, any machine dependencies it may have (for
2023 example C compilers and installed libraries) and any other information
2024 that should be provided before the module is installed.
2026 A README file is required for CPAN modules since CPAN extracts the
2027 README file from a module distribution so that people browsing the
2028 archive can use it get an idea of the modules uses. It is usually a
2029 good idea to provide version information here so that people can
2030 decide whether fixes for the module are worth downloading.
2034 To install this module type the following:
2043 This module requires these other modules and libraries:
2047 COPYRIGHT AND LICENCE
2049 Put the correct copyright and licence information here.
2051 Copyright (C) $thisyear $author
2053 This library is free software; you can redistribute it and/or modify
2054 it under the same terms as Perl itself.
2057 close(RM) || die "Can't close $ext$modpname/README: $!\n";
2060 my $testfile = "$testdir/1.t";
2061 unless (-d "$testdir") {
2062 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
2064 warn "Writing $ext$modpname/$testfile\n";
2065 my $tests = @const_names ? 2 : 1;
2067 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
2070 # Before `make install' is performed this script should be runnable with
2071 # `make test'. After `make install' it should work as `perl 1.t'
2073 #########################
2075 # change 'tests => $tests' to 'tests => last_test_to_print';
2079 my $test_mod = 'Test::More';
2081 if ( $old_test or ($compat_version < 5.007 and not $new_test ))
2083 my $test_mod = 'Test';
2087 BEGIN { plan tests => $tests };
2089 ok(1); # If we made it this far, we're ok.
2094 my $const_names = join " ", @const_names;
2098 foreach my $constname (qw(
2101 print EX wrap ("\t", "\t", $const_names);
2102 print EX (")) {\n");
2105 next if (eval "my \\\$a = \$constname; 1");
2106 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2107 print "# pass: \$\@";
2109 print "# fail: \$\@";
2114 print "not ok 2\\n";
2125 use Test::More tests => $tests;
2126 BEGIN { use_ok('$module') };
2131 my $const_names = join " ", @const_names;
2135 foreach my $constname (qw(
2138 print EX wrap ("\t", "\t", $const_names);
2139 print EX (")) {\n");
2142 next if (eval "my \\\$a = \$constname; 1");
2143 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2144 print "# pass: \$\@";
2146 print "# fail: \$\@";
2152 ok( \$fail == 0 , 'Constants' );
2158 #########################
2160 # Insert your test code below, the $test_mod module is use()ed here so read
2161 # its man page ( perldoc $test_mod ) for help writing this test script.
2165 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
2168 warn "Writing $ext$modpname/Changes\n";
2170 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
2171 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
2173 Revision history for Perl extension $module.
2175 $TEMPLATE_VERSION @{[scalar localtime]}
2176 \t- original version; created by h2xs $H2XS_VERSION with options
2180 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
2183 warn "Writing $ext$modpname/MANIFEST\n";
2184 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
2185 my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>);
2187 eval {opendir(D,'.');};
2188 unless ($@) { @files = readdir(D); closedir(D); }
2190 if (!@files) { @files = map {chomp && $_} `ls`; }
2193 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
2195 # Fix up for case-sensitive file systems
2196 s/$modfname/$modfname/i && next;
2197 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
2198 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
2201 print MANI join("\n",@files), "\n";
2205 close OUT or die "Can't close $file: $!";
2206 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
2207 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';