4 use File::Basename qw(&basename &dirname);
7 # List explicitly here the variables you want Configure to
8 # generate. Metaconfig only looks for shell variables, so you
9 # have to mention them as if they were shell variables, not
10 # %Config entries. Thus you write
12 # to ensure Configure will look for $Config{startperl}.
14 # This forces PL files to create target in same directory as PL file.
15 # This is so that make depend always knows where to find PL derivatives.
18 my $file = basename($0, '.PL');
19 $file .= '.com' if $^O eq 'VMS';
21 open OUT,">$file" or die "Can't create $file: $!";
23 print "Extracting $file (with variable substitutions)\n";
25 # In this section, perl variables will be expanded during extraction.
26 # You can use $Config{...} to use Configure variables.
28 print OUT <<"!GROK!THIS!";
30 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
31 if \$running_under_some_shell;
34 # In the following, perl variables are not expanded during extraction.
36 print OUT <<'!NO!SUBS!';
42 h2xs - convert .h C header files to Perl extensions
46 B<h2xs> [B<OPTIONS> ...] [headerfile ... [extra_libraries]]
48 B<h2xs> B<-h>|B<-?>|B<--help>
52 I<h2xs> builds a Perl extension from C header files. The extension
53 will include functions which can be used to retrieve the value of any
54 #define statement which was in the C header files.
56 The I<module_name> will be used for the name of the extension. If
57 module_name is not supplied then the name of the first header file
58 will be used, with the first character capitalized.
60 If the extension might need extra libraries, they should be included
61 here. The extension Makefile.PL will take care of checking whether
62 the libraries actually exist and how they should be loaded. The extra
63 libraries should be specified in the form -lm -lposix, etc, just as on
64 the cc command line. By default, the Makefile.PL will search through
65 the library path determined by Configure. That path can be augmented
66 by including arguments of the form B<-L/another/library/path> in the
67 extra-libraries argument.
73 =item B<-A>, B<--omit-autoload>
75 Omit all autoload facilities. This is the same as B<-c> but also
76 removes the S<C<use AutoLoader>> statement from the .pm file.
78 =item B<-C>, B<--omit-changes>
80 Omits creation of the F<Changes> file, and adds a HISTORY section to
83 =item B<-F>, B<--cpp-flags>=I<addflags>
85 Additional flags to specify to C preprocessor when scanning header for
86 function declarations. Should not be used without B<-x>.
88 =item B<-M>, B<--func-mask>=I<regular expression>
90 selects functions/macros to process.
92 =item B<-O>, B<--overwrite-ok>
94 Allows a pre-existing extension directory to be overwritten.
96 =item B<-P>, B<--omit-pod>
98 Omit the autogenerated stub POD section.
100 =item B<-X>, B<--omit-XS>
102 Omit the XS portion. Used to generate templates for a module which is not
103 XS-based. C<-c> and C<-f> are implicitly enabled.
105 =item B<-a>, B<--gen-accessors>
107 Generate an accessor method for each element of structs and unions. The
108 generated methods are named after the element name; will return the current
109 value of the element if called without additional arguments; and will set
110 the element to the supplied value (and return the new value) if called with
111 an additional argument. Embedded structures and unions are returned as a
112 pointer rather than the complete structure, to facilitate chained calls.
114 These methods all apply to the Ptr type for the structure; additionally
115 two methods are constructed for the structure type itself, C<_to_ptr>
116 which returns a Ptr type pointing to the same structure, and a C<new>
117 method to construct and return a new structure, initialised to zeroes.
119 =item B<-b>, B<--compat-version>=I<version>
121 Generates a .pm file which is backwards compatible with the specified
124 For versions < 5.6.0, the changes are.
125 - no use of 'our' (uses 'use vars' instead)
128 Specifying a compatibility version higher than the version of perl you
129 are using to run h2xs will have no effect. If unspecified h2xs will default
130 to compatibility with the version of perl you are using to run h2xs.
132 =item B<-c>, B<--omit-constant>
134 Omit C<constant()> from the .xs file and corresponding specialised
135 C<AUTOLOAD> from the .pm file.
137 =item B<-d>, B<--debugging>
139 Turn on debugging messages.
141 =item B<-f>, B<--force>
143 Allows an extension to be created for a header even if that header is
144 not found in standard include directories.
146 =item B<-h>, B<-?>, B<--help>
148 Print the usage, help and version for this h2xs and exit.
150 =item B<-k>, B<--omit-const-func>
152 For function arguments declared as C<const>, omit the const attribute in the
155 =item B<-m>, B<--gen-tied-var>
157 B<Experimental>: for each variable declared in the header file(s), declare
158 a perl variable of the same name magically tied to the C variable.
160 =item B<-n>, B<--name>=I<module_name>
162 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
164 =item B<-o>, B<--opaque-re>=I<regular expression>
166 Use "opaque" data type for the C types matched by the regular
167 expression, even if these types are C<typedef>-equivalent to types
168 from typemaps. Should not be used without B<-x>.
170 This may be useful since, say, types which are C<typedef>-equivalent
171 to integers may represent OS-related handles, and one may want to work
172 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
173 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
176 The type-to-match is whitewashed (except for commas, which have no
177 whitespace before them, and multiple C<*> which have no whitespace
180 =item B<-p>, B<--remove-prefix>=I<prefix>
182 Specify a prefix which should be removed from the Perl function names,
183 e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
184 the prefix from functions that are autoloaded via the C<constant()>
187 =item B<-s>, B<--const-subs>=I<sub1,sub2>
189 Create a perl subroutine for the specified macros rather than autoload
190 with the constant() subroutine. These macros are assumed to have a
191 return type of B<char *>, e.g.,
192 S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
194 =item B<-t>, B<--default-type>=I<type>
196 Specify the internal type that the constant() mechanism uses for macros.
197 The default is IV (signed integer). Currently all macros found during the
198 header scanning process will be assumed to have this type. Future versions
199 of C<h2xs> may gain the ability to make educated guesses.
201 =item B<--use-new-tests>
203 When B<--compat-version> (B<-b>) is present the generated tests will use
204 C<Test::More> rather then C<Test> which is the default for versions before
205 5.7.2 . C<Test::More> will be added to PREREQ_PM in the generated
208 =item B<--use-old-tests>
210 Will force the generation of test code that uses the older C<Test> module.
212 =item B<-v>, B<--version>=I<version>
214 Specify a version number for this extension. This version number is added
215 to the templates. The default is 0.01.
217 =item B<-x>, B<--autogen-xsubs>
219 Automatically generate XSUBs basing on function declarations in the
220 header file. The package C<C::Scan> should be installed. If this
221 option is specified, the name of the header file may look like
222 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
223 string, but XSUBs are emitted only for the declarations included from
226 Note that some types of arguments/return-values for functions may
227 result in XSUB-declarations/typemap-entries which need
228 hand-editing. Such may be objects which cannot be converted from/to a
229 pointer (like C<long long>), pointers to functions, or arrays. See
230 also the section on L<LIMITATIONS of B<-x>>.
237 # Default behavior, extension is Rusers
240 # Same, but extension is RUSERS
241 h2xs -n RUSERS rpcsvc/rusers
243 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
246 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
247 h2xs -n ONC::RPC rpcsvc/rusers
249 # Without constant() or AUTOLOAD
250 h2xs -c rpcsvc/rusers
252 # Creates templates for an extension named RPC
255 # Extension is ONC::RPC.
258 # Makefile.PL will look for library -lrpc in
259 # additional directory /opt/net/lib
260 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
262 # Extension is DCE::rgynbase
263 # prefix "sec_rgy_" is dropped from perl function names
264 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
266 # Extension is DCE::rgynbase
267 # prefix "sec_rgy_" is dropped from perl function names
268 # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
269 h2xs -n DCE::rgynbase -p sec_rgy_ \
270 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
272 # Make XS without defines in perl.h, but with function declarations
273 # visible from perl.h. Name of the extension is perl1.
274 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
275 # Extra backslashes below because the string is passed to shell.
276 # Note that a directory with perl header files would
277 # be added automatically to include path.
278 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
280 # Same with function declaration in proto.h as visible from perl.h.
281 h2xs -xAn perl2 perl.h,proto.h
283 # Same but select only functions which match /^av_/
284 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
286 # Same but treat SV* etc as "opaque" types
287 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
289 =head2 Extension based on F<.h> and F<.c> files
291 Suppose that you have some C files implementing some functionality,
292 and the corresponding header files. How to create an extension which
293 makes this functionality accessable in Perl? The example below
294 assumes that the header files are F<interface_simple.h> and
295 I<interface_hairy.h>, and you want the perl module be named as
296 C<Ext::Ension>. If you need some preprocessor directives and/or
297 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
302 =item Find the directory name
304 Start with a dummy run of h2xs:
306 h2xs -Afn Ext::Ension
308 The only purpose of this step is to create the needed directories, and
309 let you know the names of these directories. From the output you can
310 see that the directory for the extension is F<Ext/Ension>.
314 Copy your header files and C files to this directory F<Ext/Ension>.
316 =item Create the extension
318 Run h2xs, overwriting older autogenerated files:
320 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
322 h2xs looks for header files I<after> changing to the extension
323 directory, so it will find your header files OK.
325 =item Archive and test
337 It is important to do C<make dist> as early as possible. This way you
338 can easily merge(1) your changes to autogenerated files if you decide
339 to edit your C<.h> files and rerun h2xs.
341 Do not forget to edit the documentation in the generated F<.pm> file.
343 Consider the autogenerated files as skeletons only, you may invent
344 better interfaces than what h2xs could guess.
346 Consider this section as a guideline only, some other options of h2xs
347 may better suit your needs.
353 No environment variables are used.
357 Larry Wall and others
361 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
365 The usual warnings if it cannot read or write the files involved.
367 =head1 LIMITATIONS of B<-x>
369 F<h2xs> would not distinguish whether an argument to a C function
370 which is of the form, say, C<int *>, is an input, output, or
371 input/output parameter. In particular, argument declarations of the
378 should be better rewritten as
384 if C<n> is an input parameter.
386 Additionally, F<h2xs> has no facilities to intuit that a function
393 takes a pair of address and length of data at this address, so it is better
394 to rewrite this function as
404 RETVAL = foo(s, len);
414 char *s = SvPV(sv,len);
419 MODULE = foo PACKAGE = foo PREFIX = my_
425 See L<perlxs> and L<perlxstut> for additional details.
433 my( $H2XS_VERSION ) = ' $Revision: 1.21 $ ' =~ /\$Revision:\s+([^\s]+)/;
434 my $TEMPLATE_VERSION = '0.01';
436 my $compat_version = $];
441 $Text::Wrap::huge = 'overflow';
442 $Text::Wrap::columns = 80;
443 use ExtUtils::Constant qw (WriteConstants WriteMakefileSnippet autoload);
449 h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
450 version: $H2XS_VERSION
452 -A, --omit-autoload Omit all autoloading facilities (implies -c).
453 -C, --omit-changes Omit creating the Changes file, add HISTORY heading
455 -F, --cpp-flags Additional flags for C preprocessor (used with -x).
456 -M, --func-mask Mask to select C functions/macros
457 (default is select all).
458 -O, --overwrite-ok Allow overwriting of a pre-existing extension directory.
459 -P, --omit-pod Omit the stub POD section.
460 -X, --omit-XS Omit the XS portion (implies both -c and -f).
461 -a, --gen-accessors Generate get/set accessors for struct and union members (used with -x).
462 -b, --compat-version Specify a perl version to be backwards compatibile with
463 -c, --omit-constant Omit the constant() function and specialised AUTOLOAD
465 -d, --debugging Turn on debugging messages.
466 -f, --force Force creation of the extension even if the C header
468 -h, -?, --help Display this help message
469 -k, --omit-const-func Omit 'const' attribute on function arguments
471 -m, --gen-tied-var Generate tied variables for access to declared
473 -n, --name Specify a name to use for the extension (recommended).
474 -o, --opaque-re Regular expression for \"opaque\" types.
475 -p, --remove-prefix Specify a prefix which should be removed from the
477 -s, --const-subs Create subroutines for specified macros.
478 -t, --default-type Default type for autoloaded constants (default is IV)
479 --use-new-tests Use Test::More in backward compatible modules
480 --use-old-tests Use the module Test rather than Test::More
481 -v, --version Specify a version number for this extension.
482 -x, --autogen-xsubs Autogenerate XSUBs using C::Scan.
485 are any libraries that might be needed for loading the
486 extension, e.g. -lm would try to link in the math library.
516 Getopt::Long::Configure('bundling');
519 'omit-autoload|A' => \$opt_A,
520 'omit-changes|C' => \$opt_C,
521 'cpp-flags|F=s' => \$opt_F,
522 'func-mask|M=s' => \$opt_M,
523 'overwrite_ok|O' => \$opt_O,
524 'omit-pod|P' => \$opt_P,
525 'omit-XS|X' => \$opt_X,
526 'gen-accessors|a' => \$opt_a,
527 'compat-version|b=s' => \$opt_b,
528 'omit-constant|c' => \$opt_c,
529 'debugging|d' => \$opt_d,
530 'force|f' => \$opt_f,
531 'help|h|?' => \$opt_h,
532 'omit-const-func|k' => \$opt_k,
533 'gen-tied-var|m' => \$opt_m,
534 'name|n=s' => \$opt_n,
535 'opaque-re|o=s' => \$opt_o,
536 'remove-prefix|p=s' => \$opt_p,
537 'const-subs|s=s' => \$opt_s,
538 'default-type|t=s' => \$opt_t,
539 'version|v=s' => \$opt_v,
540 'autogen-xsubs|x=s' => \$opt_x,
541 'use-new-tests' => \$new_test,
542 'use-old-tests' => \$old_test
545 GetOptions(%options) || usage;
550 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
551 $opt_b =~ /^\d+\.\d+\.\d+/ ||
552 usage "You must provide the backwards compatibility version in X.Y.Z form. "
554 my ($maj,$min,$sub) = split(/\./,$opt_b,3);
555 if ($maj < 5 || ($maj == 5 && $min < 6)) {
556 $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
558 $compat_version = sprintf("%d.%03d%03d",$maj,$min,$sub);
561 my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d\d\d?)/;
562 warn sprintf <<'EOF', $maj,$min,$sub;
563 Defaulting to backwards compatibility with perl %d.%d.%d
564 If you intend this module to be compatible with earlier perl versions, please
565 specify a minimum perl version with the -b option.
571 $TEMPLATE_VERSION = $opt_v;
575 $opt_c = 1 if $opt_A;
577 # -X implies -c and -f
578 $opt_c = $opt_f = 1 if $opt_X;
582 my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
588 while (my $arg = shift) {
589 if ($arg =~ /^-l/i) {
590 $extralibs = "$arg @ARGV";
596 usage "Must supply header file or module name\n"
597 unless (@path_h or $opt_n);
602 $fmask = qr{$opt_M} if defined $opt_M;
603 $tmask = qr{$opt_o} if defined $opt_o;
604 my $tmask_all = $tmask && $opt_o eq '.';
607 eval {require C::Scan; 1}
609 C::Scan required if you use -x option.
610 To install C::Scan, execute
611 perl -MCPAN -e "install C::Scan"
613 unless ($tmask_all) {
614 $C::Scan::VERSION >= 0.70
616 C::Scan v. 0.70 or later required unless you use -o . option.
617 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
618 To install C::Scan, execute
619 perl -MCPAN -e "install C::Scan"
622 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
624 C::Scan v. 0.73 or later required to use -m or -a options.
625 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
626 To install C::Scan, execute
627 perl -MCPAN -e "install C::Scan"
631 elsif ($opt_o or $opt_F) {
633 Options -o and -F do not make sense without -x.
637 my @path_h_ini = @path_h;
638 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
646 my $pre_sub_tri_graphs = 1;
647 if ($^O eq 'VMS') { # Consider overrides of default location
648 # XXXX This is not equivalent to what the older version did:
649 # it was looking at $hadsys header-file per header-file...
650 my($hadsys) = grep s!^sys/!!i , @path_h;
651 @paths = qw( Sys$Library VAXC$Include );
652 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
653 push @paths, qw( DECC$Library_Include DECC$System_Include );
656 @paths = (File::Spec->curdir(), $Config{usrinc},
657 (split ' ', $Config{locincpth}), '/usr/include');
659 foreach my $path_h (@path_h) {
663 if ( $name !~ /::/ ) {
670 if( $path_h =~ s#::#/#g && $opt_n ){
671 warn "Nesting of headerfile ignored with -n\n";
673 $path_h .= ".h" unless $path_h =~ /\.h$/;
674 my $fullpath = $path_h;
675 $path_h =~ s/,.*$// if $opt_x;
676 $fullpath{$path_h} = $fullpath;
678 # Minor trickery: we can't chdir() before we processed the headers
679 # (so know the name of the extension), but the header may be in the
680 # extension directory...
681 my $tmp_path_h = $path_h;
682 my $rel_path_h = $path_h;
684 if (not -f $path_h) {
686 for my $dir (@paths) {
688 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
691 $rel_path_h = $path_h;
693 (my $epath = $module) =~ s,::,/,g;
694 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
695 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
696 $path_h = $tmp_path_h; # Used during -x
702 die "Can't find $tmp_path_h in @dirs\n"
703 if ( ! $opt_f && ! -f "$rel_path_h" );
704 # Scan the header file (we should deal with nested header files)
705 # Record the names of simple #define constants into const_names
706 # Function prototypes are processed below.
707 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
710 if ($pre_sub_tri_graphs) {
711 # Preprocess all tri-graphs
712 # including things stuck in quoted string constants.
713 s/\?\?=/#/g; # | ??=| #|
714 s/\?\?\!/|/g; # | ??!| ||
715 s/\?\?'/^/g; # | ??'| ^|
716 s/\?\?\(/[/g; # | ??(| [|
717 s/\?\?\)/]/g; # | ??)| ]|
718 s/\?\?\-/~/g; # | ??-| ~|
719 s/\?\?\//\\/g; # | ??/| \|
720 s/\?\?</{/g; # | ??<| {|
721 s/\?\?>/}/g; # | ??>| }|
723 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
726 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
729 # Cannot do: (-1) and ((LHANDLE)3) are OK:
730 #print("Skip non-wordy $def => $rest\n"),
731 # next defines if $rest =~ /[^\w\$]/;
733 print("Skip stringy $def => $rest\n") if $opt_d;
736 print "Matched $_ ($def)\n" if $opt_d;
737 $seen_define{$def} = $rest;
739 next if /^_.*_h_*$/i; # special case, but for what?
740 if (defined $opt_p) {
741 if (!/^$opt_p(\d)/) {
742 ++$prefix{$_} if s/^$opt_p//;
745 warn "can't remove $opt_p prefix from '$_'!\n";
748 $prefixless{$def} = $_;
749 if (!$fmask or /$fmask/) {
750 print "... Passes mask of -M.\n" if $opt_d and $fmask;
760 # Save current directory so that C::Scan can use it
761 my $cwd = File::Spec->rel2abs( File::Spec->curdir );
763 my ($ext, $nested, @modparts, $modfname, $modpname, $constsfname);
765 $ext = chdir 'ext' ? 'ext/' : '';
767 if( $module =~ /::/ ){
769 @modparts = split(/::/,$module);
770 $modfname = $modparts[-1];
771 $modpname = join('/',@modparts);
776 $modfname = $modpname = $module;
778 # Don't trip up if someone calls their module 'constants'
779 $constsfname = $modfname eq 'constants' ? 'constdefs' : 'constants';
783 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
786 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
791 -d "$modpath$_" || mkdir("$modpath$_", 0777);
795 -d "$modpname" || mkdir($modpname, 0777);
796 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
801 my $fdecls_parsed = [];
808 my @fnames_no_prefix;
812 if( ! $opt_X ){ # use XS, unless it was disabled
813 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
815 require Config; # Run-time directive
816 warn "Scanning typemaps...\n";
820 my $addflags = $opt_F || '';
822 foreach my $filename (@path_h) {
826 if ($fullpath{$filename} =~ /,/) {
830 warn "Scanning $filename for functions...\n";
831 my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X);
832 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
833 'add_cppflags' => $addflags, 'c_styles' => \@styles;
834 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]);
836 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
837 push(@$fdecls, @{$c->get('fdecls')});
839 push @td, @{$c->get('typedefs_maybe')};
841 my $structs = $c->get('typedef_structs');
842 @structs{keys %$structs} = values %$structs;
846 %vdecl_hash = %{ $c->get('vdecl_hash') };
847 @vdecls = sort keys %vdecl_hash;
848 for (local $_ = 0; $_ < @vdecls; ++$_) {
849 my $var = $vdecls[$_];
850 my($type, $post) = @{ $vdecl_hash{$var} };
852 warn "Can't handle variable '$type $var $post', skipping.\n";
853 splice @vdecls, $_, 1;
856 $type = normalize_type($type);
857 $vdecl_hash{$var} = $type;
861 unless ($tmask_all) {
862 warn "Scanning $filename for typedefs...\n";
863 my $td = $c->get('typedef_hash');
864 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
865 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
866 push @good_td, @f_good_td;
867 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
871 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
873 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
876 for my $i (0..$#$fdecls_parsed) {
877 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
879 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
882 $fdecls = [@$fdecls[@good]];
883 $fdecls_parsed = [@$fdecls_parsed[@good]];
885 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
888 my %h = map( ($_->[1], $_), @$fdecls_parsed);
889 $fdecls_parsed = [ @h{@fnames} ];
891 @fnames_no_prefix = @fnames;
893 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix
895 # Remove macros which expand to typedefs
896 print "Typedefs are @td.\n" if $opt_d;
897 my %td = map {($_, $_)} @td;
898 # Add some other possible but meaningless values for macros
899 for my $k (qw(char double float int long short unsigned signed void)) {
900 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
902 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
905 while (keys %td > $n) {
908 while (($k, $v) = each %seen_define) {
909 # print("found '$k'=>'$v'\n"),
910 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
913 # Now %bad_macs contains names of bad macros
914 for my $k (keys %bad_macs) {
915 delete $const_names{$prefixless{$k}};
916 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
920 my @const_names = sort keys %const_names;
922 open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
925 warn "Writing $ext$modpname/$modfname.pm\n";
933 print PM "use warnings;\n" unless $compat_version < 5.006;
935 unless( $opt_X || $opt_c || $opt_A ){
936 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
948 print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled
953 # Are we using AutoLoader or not?
954 unless ($opt_A) { # no autoloader whatsoever.
955 unless ($opt_c) { # we're doing the AUTOLOAD
956 print PM "use AutoLoader;\n";
959 print PM "use AutoLoader qw(AUTOLOAD);\n"
963 if ( $compat_version < 5.006 ) {
964 if ( $opt_X || $opt_c || $opt_A ) {
965 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
967 print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
972 my $myISA = 'our @ISA = qw(Exporter'; # We seem to always want this.
973 $myISA .= ' DynaLoader' unless $opt_X; # no XS
975 $myISA =~ s/^our // if $compat_version < 5.006;
977 print PM "\n$myISA\n\n";
979 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
982 # Items to export into callers namespace by default. Note: do not export
983 # names by default without a very good reason. Use EXPORT_OK instead.
984 # Do not simply export all your public functions/methods/constants.
986 # This allows declaration use $module ':all';
987 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
989 our %EXPORT_TAGS = ( 'all' => [ qw(
993 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
998 our \$VERSION = '$TEMPLATE_VERSION';
1002 $tmp =~ s/^our //mg if $compat_version < 5.006;
1006 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
1010 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
1012 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
1014 bootstrap $module \$VERSION;
1018 # tying the variables can happen only after bootstrap
1022 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
1029 if( $opt_P ){ # if POD is disabled
1038 # Preloaded methods go here.
1041 print PM <<"END" unless $opt_A;
1043 # Autoload methods go after $after, and are processed by the autosplit program.
1052 my ($email,$author);
1056 ($user,$author) = (getpwuid($>))[0,6];
1057 $author =~ s/,.*$//; # in case of sub fields
1058 my $domain = $Config{'mydomain'};
1060 $email = "$user\@$domain";
1063 $author ||= "A. U. Thor";
1064 $email ||= 'a.u.thor@a.galaxy.far.far.away';
1067 $revhist = <<EOT if $opt_C;
1073 #=item $TEMPLATE_VERSION
1075 #Original version; created by h2xs $H2XS_VERSION with options
1083 my $exp_doc = <<EOD;
1091 if (@const_names and not $opt_P) {
1093 #=head2 Exportable constants
1095 # @{[join "\n ", @const_names]}
1100 if (defined $fdecls and @$fdecls and not $opt_P) {
1102 #=head2 Exportable functions
1106 # $exp_doc .= <<EOD if $opt_p;
1107 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1111 # @{[join "\n ", @known_fnames{@fnames}]}
1118 if ($opt_x && $opt_a) {
1120 $meth_doc .= accessor_docs($name, $struct)
1121 while ($name, $struct) = each %structs;
1124 my $pod = <<"END" unless $opt_P;
1125 ## Below is stub documentation for your module. You better edit it!
1129 #$module - Perl extension for blah blah blah
1138 # This should be the abstract for $module.
1139 # The abstract is used when making PPD (Perl Package Description) files.
1140 # If you don't want an ABSTRACT you should also edit Makefile.PL to
1141 # remove the ABSTRACT_FROM option.
1145 #Stub documentation for $module, created by h2xs. It looks like the
1146 #author of the extension was negligent enough to leave the stub
1150 $exp_doc$meth_doc$revhist
1154 #Mention other useful documentation such as the documentation of
1155 #related modules or operating system documentation (such as man pages
1156 #in UNIX), or any relevant external documentation such as RFCs or
1159 #If you have a mailing list set up for your module, mention it here.
1161 #If you have a web site set up for your module, mention it here.
1165 #$author, E<lt>${email}E<gt>
1167 #=head1 COPYRIGHT AND LICENSE
1169 #Copyright ${\(1900 + (localtime) [5])} by $author
1171 #This library is free software; you can redistribute it and/or modify
1172 #it under the same terms as Perl itself.
1177 $pod =~ s/^\#//gm unless $opt_P;
1178 print PM $pod unless $opt_P;
1183 if( ! $opt_X ){ # print XS, unless it is disabled
1184 warn "Writing $ext$modpname/$modfname.xs\n";
1193 foreach my $path_h (@path_h_ini) {
1195 $h =~ s#^/usr/include/##;
1196 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1197 print XS qq{#include <$h>\n};
1202 my %pointer_typedefs;
1203 my %struct_typedefs;
1207 my $out = $pointer_typedefs{$type};
1208 return $out if defined $out;
1210 $out = ($type =~ /\*$/);
1211 # This converts only the guys which do not have trailing part in the typedef
1213 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1214 $type = normalize_type($type);
1215 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1217 $out = td_is_pointer($type);
1219 return ($pointer_typedefs{$otype} = $out);
1224 my $out = $struct_typedefs{$type};
1225 return $out if defined $out;
1227 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1228 # This converts only the guys which do not have trailing part in the typedef
1230 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1231 $type = normalize_type($type);
1232 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1234 $out = td_is_struct($type);
1236 return ($struct_typedefs{$otype} = $out);
1239 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1242 # We write the "sample" files used when this module is built by perl without
1243 # ExtUtils::Constant.
1244 # h2xs will later check that these are the same as those generated by the
1245 # code embedded into Makefile.PL
1246 warn "Writing $ext$modpname/fallback.c\n";
1247 warn "Writing $ext$modpname/fallback.xs\n";
1248 WriteConstants ( C_FILE => "fallback.c",
1249 XS_FILE => "fallback.xs",
1250 DEFAULT_TYPE => $opt_t,
1252 NAMES => \@const_names,
1254 print XS "#include \"$constsfname.c\"\n";
1258 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1260 # Now switch from C to XS by issuing the first MODULE declaration:
1263 MODULE = $module PACKAGE = $module $prefix
1267 # If a constant() function was #included then output a corresponding
1269 print XS "INCLUDE: $constsfname.xs\n" unless $opt_c;
1271 foreach (sort keys %const_xsub) {
1280 croak("Your vendor has not defined the $module macro $_");
1295 my ($type, $name, $args) = @$decl;
1296 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1298 my @argnames = map {$_->[1]} @$args;
1299 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1301 s/^\s*const\b\s*// for @argtypes;
1303 my @argarrays = map { $_->[4] || '' } @$args;
1304 my $numargs = @$args;
1305 if ($numargs and $argtypes[-1] eq '...') {
1307 $argnames[-1] = '...';
1310 $type = normalize_type($type, 1);
1318 for my $arg (0 .. $numargs - 1) {
1320 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1325 sub print_tievar_subs {
1326 my($fh, $name, $type) = @_;
1329 _get_$name(IV index, SV *sv) {
1334 (void)call_pv("$module\::_get_$name", G_DISCARD);
1339 _set_$name(IV index, SV *sv) {
1344 (void)call_pv("$module\::_set_$name", G_DISCARD);
1351 sub print_tievar_xsubs {
1352 my($fh, $name, $type) = @_;
1360 uf.uf_val = &_get_$name;
1361 uf.uf_set = &_set_$name;
1362 uf.uf_index = (IV)&_get_$name;
1363 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1367 $type THIS = NO_INIT
1383 sub print_accessors {
1384 my($fh, $name, $struct) = @_;
1385 return unless defined $struct && $name !~ /\s|_ANON/;
1386 $name = normalize_type($name);
1387 my $ptrname = normalize_type("$name *");
1390 MODULE = $module PACKAGE = ${name} $prefix
1394 $name THIS = NO_INIT
1397 if (sv_derived_from(ST(0), "$name")) {
1399 char *s = SvPV((SV*)SvRV(ST(0)), len);
1400 if (len != sizeof(THIS))
1401 croak("Size \%d of packed data != expected \%d",
1403 RETVAL = ($name *)s;
1406 croak("THIS is not of type $name");
1412 char *CLASS = NO_INIT
1415 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1419 MODULE = $module PACKAGE = ${name}Ptr $prefix
1422 my @items = @$struct;
1424 my $item = shift @items;
1425 if ($item->[0] =~ /_ANON/) {
1426 if (defined $item->[2]) {
1428 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1429 ], @{ $structs{$item->[0]} };
1431 push @items, @{ $structs{$item->[0]} };
1434 my $type = normalize_type($item->[0]);
1435 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1438 $item->[2](THIS, __value = NO_INIT)
1444 THIS->$item->[-1] = __value;
1446 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1457 my($name, $struct) = @_;
1458 return unless defined $struct && $name !~ /\s|_ANON/;
1459 $name = normalize_type($name);
1460 my $ptrname = $name . 'Ptr';
1461 my @items = @$struct;
1464 my $item = shift @items;
1465 if ($item->[0] =~ /_ANON/) {
1466 if (defined $item->[2]) {
1468 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1469 ], @{ $structs{$item->[0]} };
1471 push @items, @{ $structs{$item->[0]} };
1474 push @list, $item->[2];
1477 my $methods = (join '(...)>, C<', @list) . '(...)';
1481 #=head2 Object and class methods for C<$name>/C<$ptrname>
1483 #The principal Perl representation of a C object of type C<$name> is an
1484 #object of class C<$ptrname> which is a reference to an integer
1485 #representation of a C pointer. To create such an object, one may use
1488 # my \$buffer = $name->new();
1489 # my \$obj = \$buffer->_to_ptr();
1491 #This exersizes the following two methods, and an additional class
1492 #C<$name>, the internal representation of which is a reference to a
1493 #packed string with the C structure. Keep in mind that \$buffer should
1494 #better survive longer than \$obj.
1498 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1500 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1502 #=item C<$name-E<gt>new()>
1504 #Creates an empty object of type C<$name>. The corresponding packed
1505 #string is zeroed out.
1509 #return the current value of the corresponding element if called
1510 #without additional arguments. Set the element to the supplied value
1511 #(and return the new value) if called with an additional argument.
1513 #Applicable to objects of type C<$ptrname>.
1522 # Should be called before any actual call to normalize_type().
1524 # We do not want to read ./typemap by obvios reasons.
1525 my @tm = qw(../../../typemap ../../typemap ../typemap);
1526 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1527 unshift @tm, $stdtypemap;
1528 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1530 # Start with useful default values
1531 $typemap{float} = 'T_NV';
1533 foreach my $typemap (@tm) {
1534 next unless -e $typemap ;
1535 # skip directories, binary files etc.
1536 warn " Scanning $typemap\n";
1537 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1538 unless -T $typemap ;
1539 open(TYPEMAP, $typemap)
1540 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1541 my $mode = 'Typemap';
1544 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1545 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1546 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1547 elsif ($mode eq 'Typemap') {
1548 next if /^\s*($|\#)/ ;
1550 if ( ($type, $image) =
1551 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1552 # This may reference undefined functions:
1553 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1554 $typemap{normalize_type($type)} = $image;
1558 close(TYPEMAP) or die "Cannot close $typemap: $!";
1560 %std_types = %types_seen;
1565 sub normalize_type { # Second arg: do not strip const's before \*
1567 my $do_keep_deep_const = shift;
1568 # If $do_keep_deep_const this is heuristical only
1569 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1571 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1572 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1573 $type =~ s/$ignore_mods//go;
1576 $type =~ s/$ignore_mods//go;
1578 $type =~ s/([^\s\w])/ $1 /g;
1582 $type =~ s/\* (?=\*)/*/g;
1583 $type =~ s/\. \. \./.../g;
1585 $types_seen{$type}++
1586 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1592 sub assign_typemap_entry {
1596 if ($tmask and $type =~ /$tmask/) {
1597 print "Type $type matches -o mask\n" if $opt_d;
1598 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1600 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1601 $type = normalize_type $type;
1602 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1603 $entry = assign_typemap_entry($type);
1605 # XXX good do better if our UV happens to be long long
1606 return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/;
1607 $entry ||= $typemap{$otype}
1608 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1609 $typemap{$otype} = $entry;
1610 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1615 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1619 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1621 while (my($name, $struct) = each %structs) {
1622 print_accessors(\*XS, $name, $struct);
1631 warn "Writing $ext$modpname/typemap\n";
1632 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1634 for $type (sort keys %types_seen) {
1635 my $entry = assign_typemap_entry $type;
1636 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1639 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1640 #############################################################################
1643 if (sv_derived_from($arg, \"${ntype}\")) {
1645 char *s = SvPV((SV*)SvRV($arg), len);
1647 if (len != sizeof($var))
1648 croak(\"Size %d of packed data != expected %d\",
1653 croak(\"$var is not of type ${ntype}\")
1654 #############################################################################
1657 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1660 close TM or die "Cannot close typemap file for write: $!";
1665 warn "Writing $ext$modpname/Makefile.PL\n";
1666 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1670 if ( $compat_version < 5.00702 and $new_test )
1672 $prereq_pm = q%'Test::More' => 0%;
1680 use $compat_version;
1681 use ExtUtils::MakeMaker;
1682 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1683 # the contents of the Makefile that is written.
1685 'NAME' => '$module',
1686 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION
1687 'PREREQ_PM' => {$prereq_pm}, # e.g., Module::Name => 1.1
1688 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1689 (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
1690 AUTHOR => '$author <$email>') : ()),
1692 if (!$opt_X) { # print C stuff, unless XS is disabled
1693 $opt_F = '' unless defined $opt_F;
1694 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1695 my $Ihelp = ($I ? '-I. ' : '');
1696 my $Icomment = ($I ? '' : <<EOC);
1697 # Insert -I. if you add *.h files later:
1701 'LIBS' => ['$extralibs'], # e.g., '-lm'
1702 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1703 $Icomment 'INC' => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1708 # Without this the constants xs files are spotted, and cause rules to be
1709 # added to delete the similarly names C files, which isn't what we want.
1710 'XS' => {'$modfname.xs' => '$modfname.c'},
1711 realclean => {FILES => '$constsfname.c $constsfname.xs'},
1715 my $C = grep {$_ ne "$modfname.c" && $_ ne "fallback.c"}
1716 (glob '*.c'), (glob '*.cc'), (glob '*.C');
1717 my $Cpre = ($C ? '' : '# ');
1718 my $Ccomment = ($C ? '' : <<EOC);
1719 # Un-comment this if you add C files to link with later:
1723 $Ccomment $Cpre\'OBJECT' => '\$(O_FILES)', # link all the C files too
1729 WriteMakefileSnippet ( C_FILE => "$constsfname.c",
1730 XS_FILE => "$constsfname.xs",
1731 DEFAULT_TYPE => $opt_t,
1733 NAMES => \@const_names,
1736 if (eval {require ExtUtils::Constant; 1}) {
1737 # If you edit these definitions to change the constants used by this module,
1738 # you will need to use the generated $constsfname.c and $constsfname.xs
1739 # files to replace their "fallback" counterparts before distributing your
1745 copy ('fallback.c', '$constsfname.c')
1746 or die "Can't copy fallback.c to $constsfname.c: \$!";
1747 copy ('fallback.xs', '$constsfname.xs')
1748 or die "Can't copy fallback.xs to $constsfname.xs: \$!";
1752 eval $generate_code;
1755 Attempting to test constant code in $ext$modpname/Makefile.PL:
1758 gave unexpected error $@
1759 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1760 using the perlbug script.
1765 foreach ('c', 'xs') {
1766 if (compare("fallback.$_", "$constsfname.$_")) {
1768 Files "$ext$modpname/fallback.$_" and "$ext$modpname/$constsfname.$_" differ.
1774 warn fill ('','', <<"EOM") . "\n";
1775 It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
1776 the files $ext$modpname/$constsfname.c and $ext$modpname/$constsfname.xs
1779 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1780 using the perlbug script.
1783 unlink "$constsfname.c", "$constsfname.xs";
1787 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
1789 # Create a simple README since this is a CPAN requirement
1790 # and it doesnt hurt to have one
1791 warn "Writing $ext$modpname/README\n";
1792 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
1793 my $thisyear = (gmtime)[5] + 1900;
1794 my $rmhead = "$modpname version $TEMPLATE_VERSION";
1795 my $rmheadeq = "=" x length($rmhead);
1799 if ( $compat_version < 5.00702 and $new_test )
1801 $rm_prereq = 'Test::More';
1805 $rm_prereq = 'blah blah blah';
1812 The README is used to introduce the module and provide instructions on
1813 how to install the module, any machine dependencies it may have (for
1814 example C compilers and installed libraries) and any other information
1815 that should be provided before the module is installed.
1817 A README file is required for CPAN modules since CPAN extracts the
1818 README file from a module distribution so that people browsing the
1819 archive can use it get an idea of the modules uses. It is usually a
1820 good idea to provide version information here so that people can
1821 decide whether fixes for the module are worth downloading.
1825 To install this module type the following:
1834 This module requires these other modules and libraries:
1838 COPYRIGHT AND LICENCE
1840 Put the correct copyright and licence information here.
1842 Copyright (C) $thisyear $author
1844 This library is free software; you can redistribute it and/or modify
1845 it under the same terms as Perl itself.
1848 close(RM) || die "Can't close $ext$modpname/README: $!\n";
1851 my $testfile = "$testdir/1.t";
1852 unless (-d "$testdir") {
1853 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
1855 warn "Writing $ext$modpname/$testfile\n";
1856 my $tests = @const_names ? 2 : 1;
1858 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
1861 # Before `make install' is performed this script should be runnable with
1862 # `make test'. After `make install' it should work as `perl 1.t'
1864 #########################
1866 # change 'tests => $tests' to 'tests => last_test_to_print';
1870 my $test_mod = 'Test::More';
1872 if ( $old_test or ($compat_version < 5.007 and not $new_test ))
1874 my $test_mod = 'Test';
1878 BEGIN { plan tests => $tests };
1880 ok(1); # If we made it this far, we're ok.
1885 my $const_names = join " ", @const_names;
1889 foreach my $constname (qw(
1892 print EX wrap ("\t", "\t", $const_names);
1893 print EX (")) {\n");
1896 next if (eval "my \\\$a = \$constname; 1");
1897 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
1898 print "# pass: \$\@";
1900 print "# fail: \$\@";
1905 print "not ok 2\\n";
1916 use Test::More tests => $tests;
1917 BEGIN { use_ok('$module') };
1922 my $const_names = join " ", @const_names;
1926 foreach my $constname (qw(
1929 print EX wrap ("\t", "\t", $const_names);
1930 print EX (")) {\n");
1933 next if (eval "my \\\$a = \$constname; 1");
1934 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
1935 print "# pass: \$\@";
1937 print "# fail: \$\@";
1943 ok( \$fail == 0 , 'Constants' );
1949 #########################
1951 # Insert your test code below, the $test_mod module is use()ed here so read
1952 # its man page ( perldoc $test_mod ) for help writing this test script.
1956 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
1959 warn "Writing $ext$modpname/Changes\n";
1961 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
1962 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
1964 Revision history for Perl extension $module.
1966 $TEMPLATE_VERSION @{[scalar localtime]}
1967 \t- original version; created by h2xs $H2XS_VERSION with options
1971 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
1974 warn "Writing $ext$modpname/MANIFEST\n";
1975 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
1976 my @files = grep { -f } (<*>, <t/*>);
1978 eval {opendir(D,'.');};
1979 unless ($@) { @files = readdir(D); closedir(D); }
1981 if (!@files) { @files = map {chomp && $_} `ls`; }
1984 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
1986 # Fix up for case-sensitive file systems
1987 s/$modfname/$modfname/i && next;
1988 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
1989 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
1993 @files = grep {$_ ne "$constsfname.c" and $_ ne "$constsfname.xs"} @files;
1995 print MANI join("\n",@files), "\n";
1999 close OUT or die "Can't close $file: $!";
2000 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
2001 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';