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<-f>, B<--force>
149 Allows an extension to be created for a header even if that header is
150 not found in standard include directories.
152 =item B<-g>, B<--global>
154 Include code for safely storing static data in the .xs file.
155 Extensions that do no make use of static data can ignore this option.
157 =item B<-h>, B<-?>, B<--help>
159 Print the usage, help and version for this h2xs and exit.
161 =item B<-k>, B<--omit-const-func>
163 For function arguments declared as C<const>, omit the const attribute in the
166 =item B<-m>, B<--gen-tied-var>
168 B<Experimental>: for each variable declared in the header file(s), declare
169 a perl variable of the same name magically tied to the C variable.
171 =item B<-n>, B<--name>=I<module_name>
173 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
175 =item B<-o>, B<--opaque-re>=I<regular expression>
177 Use "opaque" data type for the C types matched by the regular
178 expression, even if these types are C<typedef>-equivalent to types
179 from typemaps. Should not be used without B<-x>.
181 This may be useful since, say, types which are C<typedef>-equivalent
182 to integers may represent OS-related handles, and one may want to work
183 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
184 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
187 The type-to-match is whitewashed (except for commas, which have no
188 whitespace before them, and multiple C<*> which have no whitespace
191 =item B<-p>, B<--remove-prefix>=I<prefix>
193 Specify a prefix which should be removed from the Perl function names,
194 e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
195 the prefix from functions that are autoloaded via the C<constant()>
198 =item B<-s>, B<--const-subs>=I<sub1,sub2>
200 Create a perl subroutine for the specified macros rather than autoload
201 with the constant() subroutine. These macros are assumed to have a
202 return type of B<char *>, e.g.,
203 S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
205 =item B<-t>, B<--default-type>=I<type>
207 Specify the internal type that the constant() mechanism uses for macros.
208 The default is IV (signed integer). Currently all macros found during the
209 header scanning process will be assumed to have this type. Future versions
210 of C<h2xs> may gain the ability to make educated guesses.
212 =item B<--use-new-tests>
214 When B<--compat-version> (B<-b>) is present the generated tests will use
215 C<Test::More> rather than C<Test> which is the default for versions before
216 5.7.2 . C<Test::More> will be added to PREREQ_PM in the generated
219 =item B<--use-old-tests>
221 Will force the generation of test code that uses the older C<Test> module.
223 =item B<--skip-exporter>
225 Do not use C<Exporter> and/or export any symbol.
227 =item B<--skip-ppport>
229 Do not use C<Devel::PPPort>: no portability to older version.
231 =item B<--skip-autoloader>
233 Do not use the module C<AutoLoader>; but keep the constant() function
234 and C<sub AUTOLOAD> for constants.
236 =item B<--skip-strict>
238 Do not use the pragma C<strict>.
240 =item B<--skip-warnings>
242 Do not use the pragma C<warnings>.
244 =item B<-v>, B<--version>=I<version>
246 Specify a version number for this extension. This version number is added
247 to the templates. The default is 0.01, or 0.00_01 if C<-B> is specified.
248 The version specified should be numeric.
250 =item B<-x>, B<--autogen-xsubs>
252 Automatically generate XSUBs basing on function declarations in the
253 header file. The package C<C::Scan> should be installed. If this
254 option is specified, the name of the header file may look like
255 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
256 string, but XSUBs are emitted only for the declarations included from
259 Note that some types of arguments/return-values for functions may
260 result in XSUB-declarations/typemap-entries which need
261 hand-editing. Such may be objects which cannot be converted from/to a
262 pointer (like C<long long>), pointers to functions, or arrays. See
263 also the section on L<LIMITATIONS of B<-x>>.
270 # Default behavior, extension is Rusers
273 # Same, but extension is RUSERS
274 h2xs -n RUSERS rpcsvc/rusers
276 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
279 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
280 h2xs -n ONC::RPC rpcsvc/rusers
282 # Without constant() or AUTOLOAD
283 h2xs -c rpcsvc/rusers
285 # Creates templates for an extension named RPC
288 # Extension is ONC::RPC.
291 # Makefile.PL will look for library -lrpc in
292 # additional directory /opt/net/lib
293 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
295 # Extension is DCE::rgynbase
296 # prefix "sec_rgy_" is dropped from perl function names
297 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
299 # Extension is DCE::rgynbase
300 # prefix "sec_rgy_" is dropped from perl function names
301 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
302 h2xs -n DCE::rgynbase -p sec_rgy_ \
303 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
305 # Make XS without defines in perl.h, but with function declarations
306 # visible from perl.h. Name of the extension is perl1.
307 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
308 # Extra backslashes below because the string is passed to shell.
309 # Note that a directory with perl header files would
310 # be added automatically to include path.
311 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
313 # Same with function declaration in proto.h as visible from perl.h.
314 h2xs -xAn perl2 perl.h,proto.h
316 # Same but select only functions which match /^av_/
317 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
319 # Same but treat SV* etc as "opaque" types
320 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
322 =head2 Extension based on F<.h> and F<.c> files
324 Suppose that you have some C files implementing some functionality,
325 and the corresponding header files. How to create an extension which
326 makes this functionality accessable in Perl? The example below
327 assumes that the header files are F<interface_simple.h> and
328 I<interface_hairy.h>, and you want the perl module be named as
329 C<Ext::Ension>. If you need some preprocessor directives and/or
330 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
335 =item Find the directory name
337 Start with a dummy run of h2xs:
339 h2xs -Afn Ext::Ension
341 The only purpose of this step is to create the needed directories, and
342 let you know the names of these directories. From the output you can
343 see that the directory for the extension is F<Ext/Ension>.
347 Copy your header files and C files to this directory F<Ext/Ension>.
349 =item Create the extension
351 Run h2xs, overwriting older autogenerated files:
353 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
355 h2xs looks for header files I<after> changing to the extension
356 directory, so it will find your header files OK.
358 =item Archive and test
370 It is important to do C<make dist> as early as possible. This way you
371 can easily merge(1) your changes to autogenerated files if you decide
372 to edit your C<.h> files and rerun h2xs.
374 Do not forget to edit the documentation in the generated F<.pm> file.
376 Consider the autogenerated files as skeletons only, you may invent
377 better interfaces than what h2xs could guess.
379 Consider this section as a guideline only, some other options of h2xs
380 may better suit your needs.
386 No environment variables are used.
390 Larry Wall and others
394 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
398 The usual warnings if it cannot read or write the files involved.
400 =head1 LIMITATIONS of B<-x>
402 F<h2xs> would not distinguish whether an argument to a C function
403 which is of the form, say, C<int *>, is an input, output, or
404 input/output parameter. In particular, argument declarations of the
411 should be better rewritten as
417 if C<n> is an input parameter.
419 Additionally, F<h2xs> has no facilities to intuit that a function
426 takes a pair of address and length of data at this address, so it is better
427 to rewrite this function as
437 RETVAL = foo(s, len);
447 char *s = SvPV(sv,len);
452 MODULE = foo PACKAGE = foo PREFIX = my_
458 See L<perlxs> and L<perlxstut> for additional details.
466 my( $H2XS_VERSION ) = ' $Revision: 1.22 $ ' =~ /\$Revision:\s+([^\s]+)/;
467 my $TEMPLATE_VERSION = '0.01';
469 my $compat_version = $];
474 $Text::Wrap::huge = 'overflow';
475 $Text::Wrap::columns = 80;
476 use ExtUtils::Constant qw (WriteConstants WriteMakefileSnippet autoload);
482 h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
483 version: $H2XS_VERSION
485 -A, --omit-autoload Omit all autoloading facilities (implies -c).
486 -B, --beta-version Use beta \$VERSION of 0.00_01 (ignored if -v).
487 -C, --omit-changes Omit creating the Changes file, add HISTORY heading
489 -F, --cpp-flags Additional flags for C preprocessor/compile.
490 -M, --func-mask Mask to select C functions/macros
491 (default is select all).
492 -O, --overwrite-ok Allow overwriting of a pre-existing extension directory.
493 -P, --omit-pod Omit the stub POD section.
494 -X, --omit-XS Omit the XS portion (implies both -c and -f).
495 -a, --gen-accessors Generate get/set accessors for struct and union members (used with -x).
496 -b, --compat-version Specify a perl version to be backwards compatibile with
497 -c, --omit-constant Omit the constant() function and specialised AUTOLOAD
499 -d, --debugging Turn on debugging messages.
500 -f, --force Force creation of the extension even if the C header
502 -g, --global Include code for safely storing static data in the .xs file.
503 -h, -?, --help Display this help message
504 -k, --omit-const-func Omit 'const' attribute on function arguments
506 -m, --gen-tied-var Generate tied variables for access to declared
508 -n, --name Specify a name to use for the extension (recommended).
509 -o, --opaque-re Regular expression for \"opaque\" types.
510 -p, --remove-prefix Specify a prefix which should be removed from the
512 -s, --const-subs Create subroutines for specified macros.
513 -t, --default-type Default type for autoloaded constants (default is IV)
514 --use-new-tests Use Test::More in backward compatible modules
515 --use-old-tests Use the module Test rather than Test::More
516 --skip-exporter Do not export symbols
517 --skip-ppport Do not use portability layer
518 --skip-autoloader Do not use the module C<AutoLoader>
519 --skip-strict Do not use the pragma C<strict>
520 --skip-warnings Do not use the pragma C<warnings>
521 -v, --version Specify a version number for this extension.
522 -x, --autogen-xsubs Autogenerate XSUBs using C::Scan.
525 are any libraries that might be needed for loading the
526 extension, e.g. -lm would try to link in the math library.
563 Getopt::Long::Configure('bundling');
566 'omit-autoload|A' => \$opt_A,
567 'beta-version|B' => \$opt_B,
568 'omit-changes|C' => \$opt_C,
569 'cpp-flags|F=s' => \$opt_F,
570 'func-mask|M=s' => \$opt_M,
571 'overwrite_ok|O' => \$opt_O,
572 'omit-pod|P' => \$opt_P,
573 'omit-XS|X' => \$opt_X,
574 'gen-accessors|a' => \$opt_a,
575 'compat-version|b=s' => \$opt_b,
576 'omit-constant|c' => \$opt_c,
577 'debugging|d' => \$opt_d,
578 'force|f' => \$opt_f,
579 'global|g' => \$opt_g,
580 'help|h|?' => \$opt_h,
581 'omit-const-func|k' => \$opt_k,
582 'gen-tied-var|m' => \$opt_m,
583 'name|n=s' => \$opt_n,
584 'opaque-re|o=s' => \$opt_o,
585 'remove-prefix|p=s' => \$opt_p,
586 'const-subs|s=s' => \$opt_s,
587 'default-type|t=s' => \$opt_t,
588 'version|v=s' => \$opt_v,
589 'autogen-xsubs|x' => \$opt_x,
590 'use-new-tests' => \$new_test,
591 'use-old-tests' => \$old_test,
592 'skip-exporter' => \$skip_exporter,
593 'skip-ppport' => \$skip_ppport,
594 'skip-autoloader' => \$skip_autoloader,
595 'skip-warnings' => \$skip_warnings,
596 'skip-strict' => \$skip_strict,
599 GetOptions(%options) || usage;
604 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
605 $opt_b =~ /^\d+\.\d+\.\d+/ ||
606 usage "You must provide the backwards compatibility version in X.Y.Z form. "
608 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
609 if ($maj < 5 || ($maj == 5 && $min < 6)) {
611 $sub ? sprintf("%d.%03d%02d",$maj,$min,$sub) :
612 sprintf("%d.%03d", $maj,$min);
615 $sub ? sprintf("%d.%03d%03d",$maj,$min,$sub) :
616 sprintf("%d.%03d", $maj,$min);
619 my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d*)/;
621 warn sprintf <<'EOF', $maj,$min,$sub;
622 Defaulting to backwards compatibility with perl %d.%d.%d
623 If you intend this module to be compatible with earlier perl versions, please
624 specify a minimum perl version with the -b option.
630 $TEMPLATE_VERSION = '0.00_01';
634 $TEMPLATE_VERSION = $opt_v;
636 # check if it is numeric
637 my $temp_version = $TEMPLATE_VERSION;
638 my $beta_version = $temp_version =~ s/(\d)_(\d\d)/$1$2/;
641 local $SIG{__WARN__} = sub { $notnum = 1 };
642 use warnings 'numeric';
643 $temp_version = 0+$temp_version;
647 my $module = $opt_n || 'Your::Module';
649 You have specified a non-numeric version. Unless you supply an
650 appropriate VERSION class method, users may not be able to specify a
651 minimum required version with C<use $module versionnum>.
656 $opt_B = $beta_version;
661 $skip_autoloader = $opt_c = 1 if $opt_A;
663 # -X implies -c and -f
664 $opt_c = $opt_f = 1 if $opt_X;
668 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
674 while (my $arg = shift) {
675 if ($arg =~ /^-l/i) {
676 $extralibs = "$arg @ARGV";
682 usage "Must supply header file or module name\n"
683 unless (@path_h or $opt_n);
688 $fmask = qr{$opt_M} if defined $opt_M;
689 $tmask = qr{$opt_o} if defined $opt_o;
690 my $tmask_all = $tmask && $opt_o eq '.';
693 eval {require C::Scan; 1}
695 C::Scan required if you use -x option.
696 To install C::Scan, execute
697 perl -MCPAN -e "install C::Scan"
699 unless ($tmask_all) {
700 $C::Scan::VERSION >= 0.70
702 C::Scan v. 0.70 or later required unless you use -o . option.
703 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
704 To install C::Scan, execute
705 perl -MCPAN -e "install C::Scan"
708 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
710 C::Scan v. 0.73 or later required to use -m or -a options.
711 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
712 To install C::Scan, execute
713 perl -MCPAN -e "install C::Scan"
717 elsif ($opt_o or $opt_F) {
718 warn <<EOD if $opt_o;
719 Option -o does not make sense without -x.
721 warn <<EOD if $opt_F and $opt_X ;
722 Option -F does not make sense with -X.
726 my @path_h_ini = @path_h;
727 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
734 my $pre_sub_tri_graphs = 1;
735 if ($^O eq 'VMS') { # Consider overrides of default location
736 # XXXX This is not equivalent to what the older version did:
737 # it was looking at $hadsys header-file per header-file...
738 my($hadsys) = grep s!^sys/!!i , @path_h;
739 @paths = qw( Sys$Library VAXC$Include );
740 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
741 push @paths, qw( DECC$Library_Include DECC$System_Include );
744 @paths = (File::Spec->curdir(), $Config{usrinc},
745 (split ' ', $Config{locincpth}), '/usr/include');
747 foreach my $path_h (@path_h) {
751 if ( $name !~ /::/ ) {
758 if( $path_h =~ s#::#/#g && $opt_n ){
759 warn "Nesting of headerfile ignored with -n\n";
761 $path_h .= ".h" unless $path_h =~ /\.h$/;
762 my $fullpath = $path_h;
763 $path_h =~ s/,.*$// if $opt_x;
764 $fullpath{$path_h} = $fullpath;
766 # Minor trickery: we can't chdir() before we processed the headers
767 # (so know the name of the extension), but the header may be in the
768 # extension directory...
769 my $tmp_path_h = $path_h;
770 my $rel_path_h = $path_h;
772 if (not -f $path_h) {
774 for my $dir (@paths) {
776 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
779 $rel_path_h = $path_h;
780 $fullpath{$path_h} = $fullpath;
782 (my $epath = $module) =~ s,::,/,g;
783 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
784 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
785 $path_h = $tmp_path_h; # Used during -x
791 die "Can't find $tmp_path_h in @dirs\n"
792 if ( ! $opt_f && ! -f "$rel_path_h" );
793 # Scan the header file (we should deal with nested header files)
794 # Record the names of simple #define constants into const_names
795 # Function prototypes are processed below.
796 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
799 if ($pre_sub_tri_graphs) {
800 # Preprocess all tri-graphs
801 # including things stuck in quoted string constants.
802 s/\?\?=/#/g; # | ??=| #|
803 s/\?\?\!/|/g; # | ??!| ||
804 s/\?\?'/^/g; # | ??'| ^|
805 s/\?\?\(/[/g; # | ??(| [|
806 s/\?\?\)/]/g; # | ??)| ]|
807 s/\?\?\-/~/g; # | ??-| ~|
808 s/\?\?\//\\/g; # | ??/| \|
809 s/\?\?</{/g; # | ??<| {|
810 s/\?\?>/}/g; # | ??>| }|
812 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
815 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
818 # Cannot do: (-1) and ((LHANDLE)3) are OK:
819 #print("Skip non-wordy $def => $rest\n"),
820 # next defines if $rest =~ /[^\w\$]/;
822 print("Skip stringy $def => $rest\n") if $opt_d;
825 print "Matched $_ ($def)\n" if $opt_d;
826 $seen_define{$def} = $rest;
828 next if /^_.*_h_*$/i; # special case, but for what?
829 if (defined $opt_p) {
830 if (!/^$opt_p(\d)/) {
831 ++$prefix{$_} if s/^$opt_p//;
834 warn "can't remove $opt_p prefix from '$_'!\n";
837 $prefixless{$def} = $_;
838 if (!$fmask or /$fmask/) {
839 print "... Passes mask of -M.\n" if $opt_d and $fmask;
849 # Save current directory so that C::Scan can use it
850 my $cwd = File::Spec->rel2abs( File::Spec->curdir );
852 my ($ext, $nested, @modparts, $modfname, $modpname);
853 # As Ilya suggested, use a name that contains - and then it can't clash with
854 # the names of any packages. A directory 'fallback' will clash with any
855 # new pragmata down the fallback:: tree, but that seems unlikely.
856 my $constscfname = 'const-c.inc';
857 my $constsxsfname = 'const-xs.inc';
858 my $fallbackdirname = 'fallback';
860 $ext = chdir 'ext' ? 'ext/' : '';
862 if( $module =~ /::/ ){
864 @modparts = split(/::/,$module);
865 $modfname = $modparts[-1];
866 $modpname = join('/',@modparts);
871 $modfname = $modpname = $module;
876 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
879 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
884 -d "$modpath$_" || mkdir("$modpath$_", 0777);
888 -d "$modpname" || mkdir($modpname, 0777);
889 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
894 my $fdecls_parsed = [];
901 my @fnames_no_prefix;
905 if( ! $opt_X ){ # use XS, unless it was disabled
906 unless ($skip_ppport) {
907 require Devel::PPPort;
908 warn "Writing $ext$modpname/ppport.h\n";
909 Devel::PPPort::WriteFile('ppport.h')
910 || die "Can't create $ext$modpname/ppport.h: $!\n";
912 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
914 warn "Scanning typemaps...\n";
918 my $addflags = $opt_F || '';
920 foreach my $filename (@path_h) {
924 if ($fullpath{$filename} =~ /,/) {
928 warn "Scanning $filename for functions...\n";
929 my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X);
930 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
931 'add_cppflags' => $addflags, 'c_styles' => \@styles;
932 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]);
934 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
935 push(@$fdecls, @{$c->get('fdecls')});
937 push @td, @{$c->get('typedefs_maybe')};
939 my $structs = $c->get('typedef_structs');
940 @structs{keys %$structs} = values %$structs;
944 %vdecl_hash = %{ $c->get('vdecl_hash') };
945 @vdecls = sort keys %vdecl_hash;
946 for (local $_ = 0; $_ < @vdecls; ++$_) {
947 my $var = $vdecls[$_];
948 my($type, $post) = @{ $vdecl_hash{$var} };
950 warn "Can't handle variable '$type $var $post', skipping.\n";
951 splice @vdecls, $_, 1;
954 $type = normalize_type($type);
955 $vdecl_hash{$var} = $type;
959 unless ($tmask_all) {
960 warn "Scanning $filename for typedefs...\n";
961 my $td = $c->get('typedef_hash');
962 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
963 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
964 push @good_td, @f_good_td;
965 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
969 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
971 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
974 for my $i (0..$#$fdecls_parsed) {
975 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
977 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
980 $fdecls = [@$fdecls[@good]];
981 $fdecls_parsed = [@$fdecls_parsed[@good]];
983 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
986 my %h = map( ($_->[1], $_), @$fdecls_parsed);
987 $fdecls_parsed = [ @h{@fnames} ];
989 @fnames_no_prefix = @fnames;
991 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix
993 # Remove macros which expand to typedefs
994 print "Typedefs are @td.\n" if $opt_d;
995 my %td = map {($_, $_)} @td;
996 # Add some other possible but meaningless values for macros
997 for my $k (qw(char double float int long short unsigned signed void)) {
998 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
1000 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
1003 while (keys %td > $n) {
1006 while (($k, $v) = each %seen_define) {
1007 # print("found '$k'=>'$v'\n"),
1008 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
1011 # Now %bad_macs contains names of bad macros
1012 for my $k (keys %bad_macs) {
1013 delete $const_names{$prefixless{$k}};
1014 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
1018 my @const_names = sort keys %const_names;
1020 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
1023 warn "Writing $ext$modpname/$modfname.pm\n";
1028 use $compat_version;
1031 print PM <<"END" unless $skip_strict;
1035 print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006;
1037 unless( $opt_X || $opt_c || $opt_A ){
1038 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
1045 print PM <<'END' unless $skip_exporter;
1050 my $use_Dyna = (not $opt_X and $compat_version < 5.006);
1051 print PM <<"END" if $use_Dyna; # use DynaLoader, unless XS was disabled
1056 # Are we using AutoLoader or not?
1057 unless ($skip_autoloader) { # no autoloader whatsoever.
1058 unless ($opt_c) { # we're doing the AUTOLOAD
1059 print PM "use AutoLoader;\n";
1062 print PM "use AutoLoader qw(AUTOLOAD);\n"
1066 if ( $compat_version < 5.006 ) {
1067 my $vars = '$VERSION @ISA';
1068 $vars .= ' @EXPORT @EXPORT_OK %EXPORT_TAGS' unless $skip_exporter;
1069 $vars .= ' $AUTOLOAD' unless $opt_X || $opt_c || $opt_A;
1070 $vars .= ' $XS_VERSION' if $opt_B && !$opt_X;
1071 print PM "use vars qw($vars);";
1076 push @modISA, 'Exporter' unless $skip_exporter;
1077 push @modISA, 'DynaLoader' if $use_Dyna; # no XS
1078 my $myISA = "our \@ISA = qw(@modISA);";
1079 $myISA =~ s/^our // if $compat_version < 5.006;
1081 print PM "\n$myISA\n\n";
1083 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
1086 $tmp .= <<"END" unless $skip_exporter;
1087 # Items to export into callers namespace by default. Note: do not export
1088 # names by default without a very good reason. Use EXPORT_OK instead.
1089 # Do not simply export all your public functions/methods/constants.
1091 # This allows declaration use $module ':all';
1092 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
1094 our %EXPORT_TAGS = ( 'all' => [ qw(
1098 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
1106 $tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n";
1108 $tmp .= "our \$XS_VERSION = \$VERSION;\n" unless $opt_X;
1109 $tmp .= "\$VERSION = eval \$VERSION; # see L<perlmodstyle>\n";
1113 $tmp =~ s/^our //mg if $compat_version < 5.006;
1117 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
1121 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
1123 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
1126 bootstrap $module \$VERSION;
1131 XSLoader::load('$module', \$VERSION);
1134 $tmp =~ s:\$VERSION:\$XS_VERSION:g if $opt_B;
1138 # tying the variables can happen only after bootstrap
1142 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
1149 if( $opt_P ){ # if POD is disabled
1158 # Preloaded methods go here.
1161 print PM <<"END" unless $opt_A;
1163 # Autoload methods go after $after, and are processed by the autosplit program.
1172 my ($email,$author);
1176 ($username,$author) = (getpwuid($>))[0,6];
1177 if (defined $username && defined $author) {
1178 $author =~ s/,.*$//; # in case of sub fields
1179 my $domain = $Config{'mydomain'};
1181 $email = "$username\@$domain";
1185 $author ||= "A. U. Thor";
1186 $email ||= 'a.u.thor@a.galaxy.far.far.away';
1189 $revhist = <<EOT if $opt_C;
1195 #=item $TEMPLATE_VERSION
1197 #Original version; created by h2xs $H2XS_VERSION with options
1205 my $exp_doc = $skip_exporter ? '' : <<EOD;
1213 if (@const_names and not $opt_P) {
1214 $exp_doc .= <<EOD unless $skip_exporter;
1215 #=head2 Exportable constants
1217 # @{[join "\n ", @const_names]}
1222 if (defined $fdecls and @$fdecls and not $opt_P) {
1223 $exp_doc .= <<EOD unless $skip_exporter;
1224 #=head2 Exportable functions
1228 # $exp_doc .= <<EOD if $opt_p;
1229 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1232 $exp_doc .= <<EOD unless $skip_exporter;
1233 # @{[join "\n ", @known_fnames{@fnames}]}
1240 if ($opt_x && $opt_a) {
1242 $meth_doc .= accessor_docs($name, $struct)
1243 while ($name, $struct) = each %structs;
1246 my $pod = <<"END" unless $opt_P;
1247 ## Below is stub documentation for your module. You'd better edit it!
1251 #$module - Perl extension for blah blah blah
1260 # This should be the abstract for $module.
1261 # The abstract is used when making PPD (Perl Package Description) files.
1262 # If you don't want an ABSTRACT you should also edit Makefile.PL to
1263 # remove the ABSTRACT_FROM option.
1267 #Stub documentation for $module, created by h2xs. It looks like the
1268 #author of the extension was negligent enough to leave the stub
1272 $exp_doc$meth_doc$revhist
1276 #Mention other useful documentation such as the documentation of
1277 #related modules or operating system documentation (such as man pages
1278 #in UNIX), or any relevant external documentation such as RFCs or
1281 #If you have a mailing list set up for your module, mention it here.
1283 #If you have a web site set up for your module, mention it here.
1287 #$author, E<lt>${email}E<gt>
1289 #=head1 COPYRIGHT AND LICENSE
1291 #Copyright ${\(1900 + (localtime) [5])} by $author
1293 #This library is free software; you can redistribute it and/or modify
1294 #it under the same terms as Perl itself.
1299 $pod =~ s/^\#//gm unless $opt_P;
1300 print PM $pod unless $opt_P;
1305 if( ! $opt_X ){ # print XS, unless it is disabled
1306 warn "Writing $ext$modpname/$modfname.xs\n";
1315 print XS <<"END" unless $skip_ppport;
1321 foreach my $path_h (@path_h_ini) {
1323 $h =~ s#^/usr/include/##;
1324 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1325 print XS qq{#include <$h>\n};
1330 print XS <<"END" if $opt_g;
1334 #define MY_CXT_KEY "${module}::_guts" XS_VERSION
1337 /* Put Global Data in here */
1338 int dummy; /* you can access this elsewhere as MY_CXT.dummy */
1345 my %pointer_typedefs;
1346 my %struct_typedefs;
1350 my $out = $pointer_typedefs{$type};
1351 return $out if defined $out;
1353 $out = ($type =~ /\*$/);
1354 # This converts only the guys which do not have trailing part in the typedef
1356 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1357 $type = normalize_type($type);
1358 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1360 $out = td_is_pointer($type);
1362 return ($pointer_typedefs{$otype} = $out);
1367 my $out = $struct_typedefs{$type};
1368 return $out if defined $out;
1370 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1371 # This converts only the guys which do not have trailing part in the typedef
1373 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1374 $type = normalize_type($type);
1375 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1377 $out = td_is_struct($type);
1379 return ($struct_typedefs{$otype} = $out);
1382 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1385 # We write the "sample" files used when this module is built by perl without
1386 # ExtUtils::Constant.
1387 # h2xs will later check that these are the same as those generated by the
1388 # code embedded into Makefile.PL
1389 unless (-d $fallbackdirname) {
1390 mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n";
1392 warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n";
1393 warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n";
1394 my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname);
1395 my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname);
1396 WriteConstants ( C_FILE => $cfallback,
1397 XS_FILE => $xsfallback,
1398 DEFAULT_TYPE => $opt_t,
1400 NAMES => \@const_names,
1402 print XS "#include \"$constscfname\"\n";
1406 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1408 # Now switch from C to XS by issuing the first MODULE declaration:
1411 MODULE = $module PACKAGE = $module $prefix
1415 # If a constant() function was #included then output a corresponding
1417 print XS "INCLUDE: $constsxsfname\n" unless $opt_c;
1419 print XS <<"END" if $opt_g;
1424 /* If any of the fields in the my_cxt_t struct need
1425 to be initialised, do it here.
1431 foreach (sort keys %const_xsub) {
1440 croak("Your vendor has not defined the $module macro $_");
1455 my ($type, $name, $args) = @$decl;
1456 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1458 my @argnames = map {$_->[1]} @$args;
1459 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1461 s/^\s*const\b\s*// for @argtypes;
1463 my @argarrays = map { $_->[4] || '' } @$args;
1464 my $numargs = @$args;
1465 if ($numargs and $argtypes[-1] eq '...') {
1467 $argnames[-1] = '...';
1470 $type = normalize_type($type, 1);
1478 for my $arg (0 .. $numargs - 1) {
1480 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1485 sub print_tievar_subs {
1486 my($fh, $name, $type) = @_;
1489 _get_$name(IV index, SV *sv) {
1494 (void)call_pv("$module\::_get_$name", G_DISCARD);
1499 _set_$name(IV index, SV *sv) {
1504 (void)call_pv("$module\::_set_$name", G_DISCARD);
1511 sub print_tievar_xsubs {
1512 my($fh, $name, $type) = @_;
1520 uf.uf_val = &_get_$name;
1521 uf.uf_set = &_set_$name;
1522 uf.uf_index = (IV)&_get_$name;
1523 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1527 $type THIS = NO_INIT
1543 sub print_accessors {
1544 my($fh, $name, $struct) = @_;
1545 return unless defined $struct && $name !~ /\s|_ANON/;
1546 $name = normalize_type($name);
1547 my $ptrname = normalize_type("$name *");
1550 MODULE = $module PACKAGE = ${name} $prefix
1554 $name THIS = NO_INIT
1557 if (sv_derived_from(ST(0), "$name")) {
1559 char *s = SvPV((SV*)SvRV(ST(0)), len);
1560 if (len != sizeof(THIS))
1561 croak("Size \%d of packed data != expected \%d",
1563 RETVAL = ($name *)s;
1566 croak("THIS is not of type $name");
1572 char *CLASS = NO_INIT
1575 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1579 MODULE = $module PACKAGE = ${name}Ptr $prefix
1582 my @items = @$struct;
1584 my $item = shift @items;
1585 if ($item->[0] =~ /_ANON/) {
1586 if (defined $item->[2]) {
1588 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1589 ], @{ $structs{$item->[0]} };
1591 push @items, @{ $structs{$item->[0]} };
1594 my $type = normalize_type($item->[0]);
1595 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1598 $item->[2](THIS, __value = NO_INIT)
1604 THIS->$item->[-1] = __value;
1606 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1617 my($name, $struct) = @_;
1618 return unless defined $struct && $name !~ /\s|_ANON/;
1619 $name = normalize_type($name);
1620 my $ptrname = $name . 'Ptr';
1621 my @items = @$struct;
1624 my $item = shift @items;
1625 if ($item->[0] =~ /_ANON/) {
1626 if (defined $item->[2]) {
1628 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1629 ], @{ $structs{$item->[0]} };
1631 push @items, @{ $structs{$item->[0]} };
1634 push @list, $item->[2];
1637 my $methods = (join '(...)>, C<', @list) . '(...)';
1641 #=head2 Object and class methods for C<$name>/C<$ptrname>
1643 #The principal Perl representation of a C object of type C<$name> is an
1644 #object of class C<$ptrname> which is a reference to an integer
1645 #representation of a C pointer. To create such an object, one may use
1648 # my \$buffer = $name->new();
1649 # my \$obj = \$buffer->_to_ptr();
1651 #This exersizes the following two methods, and an additional class
1652 #C<$name>, the internal representation of which is a reference to a
1653 #packed string with the C structure. Keep in mind that \$buffer should
1654 #better survive longer than \$obj.
1658 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1660 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1662 #=item C<$name-E<gt>new()>
1664 #Creates an empty object of type C<$name>. The corresponding packed
1665 #string is zeroed out.
1669 #return the current value of the corresponding element if called
1670 #without additional arguments. Set the element to the supplied value
1671 #(and return the new value) if called with an additional argument.
1673 #Applicable to objects of type C<$ptrname>.
1682 # Should be called before any actual call to normalize_type().
1684 # We do not want to read ./typemap by obvios reasons.
1685 my @tm = qw(../../../typemap ../../typemap ../typemap);
1686 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1687 unshift @tm, $stdtypemap;
1688 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1690 # Start with useful default values
1691 $typemap{float} = 'T_NV';
1693 foreach my $typemap (@tm) {
1694 next unless -e $typemap ;
1695 # skip directories, binary files etc.
1696 warn " Scanning $typemap\n";
1697 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1698 unless -T $typemap ;
1699 open(TYPEMAP, $typemap)
1700 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1701 my $mode = 'Typemap';
1704 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1705 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1706 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1707 elsif ($mode eq 'Typemap') {
1708 next if /^\s*($|\#)/ ;
1710 if ( ($type, $image) =
1711 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1712 # This may reference undefined functions:
1713 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1714 $typemap{normalize_type($type)} = $image;
1718 close(TYPEMAP) or die "Cannot close $typemap: $!";
1720 %std_types = %types_seen;
1725 sub normalize_type { # Second arg: do not strip const's before \*
1727 my $do_keep_deep_const = shift;
1728 # If $do_keep_deep_const this is heuristical only
1729 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1731 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1732 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1733 $type =~ s/$ignore_mods//go;
1736 $type =~ s/$ignore_mods//go;
1738 $type =~ s/([^\s\w])/ $1 /g;
1742 $type =~ s/\* (?=\*)/*/g;
1743 $type =~ s/\. \. \./.../g;
1745 $types_seen{$type}++
1746 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1752 sub assign_typemap_entry {
1756 if ($tmask and $type =~ /$tmask/) {
1757 print "Type $type matches -o mask\n" if $opt_d;
1758 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1760 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1761 $type = normalize_type $type;
1762 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1763 $entry = assign_typemap_entry($type);
1765 # XXX good do better if our UV happens to be long long
1766 return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/;
1767 $entry ||= $typemap{$otype}
1768 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1769 $typemap{$otype} = $entry;
1770 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1775 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1779 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1781 while (my($name, $struct) = each %structs) {
1782 print_accessors(\*XS, $name, $struct);
1791 warn "Writing $ext$modpname/typemap\n";
1792 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1794 for $type (sort keys %types_seen) {
1795 my $entry = assign_typemap_entry $type;
1796 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1799 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1800 #############################################################################
1803 if (sv_derived_from($arg, \"${ntype}\")) {
1805 char *s = SvPV((SV*)SvRV($arg), len);
1807 if (len != sizeof($var))
1808 croak(\"Size %d of packed data != expected %d\",
1813 croak(\"$var is not of type ${ntype}\")
1814 #############################################################################
1817 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1820 close TM or die "Cannot close typemap file for write: $!";
1825 warn "Writing $ext$modpname/Makefile.PL\n";
1826 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1830 if ( $compat_version < 5.00702 and $new_test )
1832 $prereq_pm = q%'Test::More' => 0%;
1840 use $compat_version;
1841 use ExtUtils::MakeMaker;
1842 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1843 # the contents of the Makefile that is written.
1845 'NAME' => '$module',
1846 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION
1847 'PREREQ_PM' => {$prereq_pm}, # e.g., Module::Name => 1.1
1848 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1849 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1850 AUTHOR => '$author <$email>') : ()),
1852 if (!$opt_X) { # print C stuff, unless XS is disabled
1853 $opt_F = '' unless defined $opt_F;
1854 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1855 my $Ihelp = ($I ? '-I. ' : '');
1856 my $Icomment = ($I ? '' : <<EOC);
1857 # Insert -I. if you add *.h files later:
1861 'LIBS' => ['$extralibs'], # e.g., '-lm'
1862 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1863 $Icomment 'INC' => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1866 my $C = grep {$_ ne "$modfname.c"}
1867 (glob '*.c'), (glob '*.cc'), (glob '*.C');
1868 my $Cpre = ($C ? '' : '# ');
1869 my $Ccomment = ($C ? '' : <<EOC);
1870 # Un-comment this if you add C files to link with later:
1874 $Ccomment $Cpre\'OBJECT' => '\$(O_FILES)', # link all the C files too
1880 WriteMakefileSnippet ( C_FILE => $constscfname,
1881 XS_FILE => $constsxsfname,
1882 DEFAULT_TYPE => $opt_t,
1884 NAMES => \@const_names,
1887 if (eval {require ExtUtils::Constant; 1}) {
1888 # If you edit these definitions to change the constants used by this module,
1889 # you will need to use the generated $constscfname and $constsxsfname
1890 # files to replace their "fallback" counterparts before distributing your
1897 foreach my \$file ('$constscfname', '$constsxsfname') {
1898 my \$fallback = File::Spec->catfile('$fallbackdirname', \$file);
1899 copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!";
1904 eval $generate_code;
1907 Attempting to test constant code in $ext$modpname/Makefile.PL:
1910 gave unexpected error $@
1911 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1912 using the perlbug script.
1917 foreach my $file ($constscfname, $constsxsfname) {
1918 my $fallback = File::Spec->catfile($fallbackdirname, $file);
1919 if (compare($file, $fallback)) {
1921 Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ.
1927 warn fill ('','', <<"EOM") . "\n";
1928 It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
1929 the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname
1932 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1933 using the perlbug script.
1936 unlink $constscfname, $constsxsfname;
1940 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1942 # Create a simple README since this is a CPAN requirement
1943 # and it doesnt hurt to have one
1944 warn "Writing $ext$modpname/README\n";
1945 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
1946 my $thisyear = (gmtime)[5] + 1900;
1947 my $rmhead = "$modpname version $TEMPLATE_VERSION";
1948 my $rmheadeq = "=" x length($rmhead);
1952 if ( $compat_version < 5.00702 and $new_test )
1954 $rm_prereq = 'Test::More';
1958 $rm_prereq = 'blah blah blah';
1965 The README is used to introduce the module and provide instructions on
1966 how to install the module, any machine dependencies it may have (for
1967 example C compilers and installed libraries) and any other information
1968 that should be provided before the module is installed.
1970 A README file is required for CPAN modules since CPAN extracts the
1971 README file from a module distribution so that people browsing the
1972 archive can use it get an idea of the modules uses. It is usually a
1973 good idea to provide version information here so that people can
1974 decide whether fixes for the module are worth downloading.
1978 To install this module type the following:
1987 This module requires these other modules and libraries:
1991 COPYRIGHT AND LICENCE
1993 Put the correct copyright and licence information here.
1995 Copyright (C) $thisyear $author
1997 This library is free software; you can redistribute it and/or modify
1998 it under the same terms as Perl itself.
2001 close(RM) || die "Can't close $ext$modpname/README: $!\n";
2004 my $testfile = "$testdir/1.t";
2005 unless (-d "$testdir") {
2006 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
2008 warn "Writing $ext$modpname/$testfile\n";
2009 my $tests = @const_names ? 2 : 1;
2011 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
2014 # Before `make install' is performed this script should be runnable with
2015 # `make test'. After `make install' it should work as `perl 1.t'
2017 #########################
2019 # change 'tests => $tests' to 'tests => last_test_to_print';
2023 my $test_mod = 'Test::More';
2025 if ( $old_test or ($compat_version < 5.007 and not $new_test ))
2027 my $test_mod = 'Test';
2031 BEGIN { plan tests => $tests };
2033 ok(1); # If we made it this far, we're ok.
2038 my $const_names = join " ", @const_names;
2042 foreach my $constname (qw(
2045 print EX wrap ("\t", "\t", $const_names);
2046 print EX (")) {\n");
2049 next if (eval "my \\\$a = \$constname; 1");
2050 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2051 print "# pass: \$\@";
2053 print "# fail: \$\@";
2058 print "not ok 2\\n";
2069 use Test::More tests => $tests;
2070 BEGIN { use_ok('$module') };
2075 my $const_names = join " ", @const_names;
2079 foreach my $constname (qw(
2082 print EX wrap ("\t", "\t", $const_names);
2083 print EX (")) {\n");
2086 next if (eval "my \\\$a = \$constname; 1");
2087 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2088 print "# pass: \$\@";
2090 print "# fail: \$\@";
2096 ok( \$fail == 0 , 'Constants' );
2102 #########################
2104 # Insert your test code below, the $test_mod module is use()ed here so read
2105 # its man page ( perldoc $test_mod ) for help writing this test script.
2109 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
2112 warn "Writing $ext$modpname/Changes\n";
2114 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
2115 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
2117 Revision history for Perl extension $module.
2119 $TEMPLATE_VERSION @{[scalar localtime]}
2120 \t- original version; created by h2xs $H2XS_VERSION with options
2124 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
2127 warn "Writing $ext$modpname/MANIFEST\n";
2128 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
2129 my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>);
2131 eval {opendir(D,'.');};
2132 unless ($@) { @files = readdir(D); closedir(D); }
2134 if (!@files) { @files = map {chomp && $_} `ls`; }
2137 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
2139 # Fix up for case-sensitive file systems
2140 s/$modfname/$modfname/i && next;
2141 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
2142 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
2145 print MANI join("\n",@files), "\n";
2149 close OUT or die "Can't close $file: $!";
2150 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
2151 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';