4 use File::Basename qw(&basename &dirname);
7 # List explicitly here the variables you want Configure to
8 # generate. Metaconfig only looks for shell variables, so you
9 # have to mention them as if they were shell variables, not
10 # %Config entries. Thus you write
12 # to ensure Configure will look for $Config{startperl}.
14 # This forces PL files to create target in same directory as PL file.
15 # This is so that make depend always knows where to find PL derivatives.
18 my $file = basename($0, '.PL');
19 $file .= '.com' if $^O eq 'VMS';
21 open OUT,">$file" or die "Can't create $file: $!";
23 print "Extracting $file (with variable substitutions)\n";
25 # In this section, perl variables will be expanded during extraction.
26 # You can use $Config{...} to use Configure variables.
28 print OUT <<"!GROK!THIS!";
30 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
31 if \$running_under_some_shell;
34 # In the following, perl variables are not expanded during extraction.
36 print OUT <<'!NO!SUBS!';
42 h2xs - convert .h C header files to Perl extensions
46 B<h2xs> [B<OPTIONS> ...] [headerfile ... [extra_libraries]]
48 B<h2xs> B<-h>|B<-?>|B<--help>
52 I<h2xs> builds a Perl extension from C header files. The extension
53 will include functions which can be used to retrieve the value of any
54 #define statement which was in the C header files.
56 The I<module_name> will be used for the name of the extension. If
57 module_name is not supplied then the name of the first header file
58 will be used, with the first character capitalized.
60 If the extension might need extra libraries, they should be included
61 here. The extension Makefile.PL will take care of checking whether
62 the libraries actually exist and how they should be loaded. The extra
63 libraries should be specified in the form -lm -lposix, etc, just as on
64 the cc command line. By default, the Makefile.PL will search through
65 the library path determined by Configure. That path can be augmented
66 by including arguments of the form B<-L/another/library/path> in the
67 extra-libraries argument.
73 =item B<-A>, B<--omit-autoload>
75 Omit all autoload facilities. This is the same as B<-c> but also
76 removes the S<C<use AutoLoader>> statement from the .pm file.
78 =item B<-B>, B<--beta-version>
80 Use an alpha/beta style version number. Causes version number to
81 be "0.00_01" unless B<-v> is specified.
83 =item B<-C>, B<--omit-changes>
85 Omits creation of the F<Changes> file, and adds a HISTORY section to
88 =item B<-F>, B<--cpp-flags>=I<addflags>
90 Additional flags to specify to C preprocessor when scanning header for
91 function declarations. Writes these options in the generated F<Makefile.PL>
94 =item B<-M>, B<--func-mask>=I<regular expression>
96 selects functions/macros to process.
98 =item B<-O>, B<--overwrite-ok>
100 Allows a pre-existing extension directory to be overwritten.
102 =item B<-P>, B<--omit-pod>
104 Omit the autogenerated stub POD section.
106 =item B<-X>, B<--omit-XS>
108 Omit the XS portion. Used to generate templates for a module which is not
109 XS-based. C<-c> and C<-f> are implicitly enabled.
111 =item B<-a>, B<--gen-accessors>
113 Generate an accessor method for each element of structs and unions. The
114 generated methods are named after the element name; will return the current
115 value of the element if called without additional arguments; and will set
116 the element to the supplied value (and return the new value) if called with
117 an additional argument. Embedded structures and unions are returned as a
118 pointer rather than the complete structure, to facilitate chained calls.
120 These methods all apply to the Ptr type for the structure; additionally
121 two methods are constructed for the structure type itself, C<_to_ptr>
122 which returns a Ptr type pointing to the same structure, and a C<new>
123 method to construct and return a new structure, initialised to zeroes.
125 =item B<-b>, B<--compat-version>=I<version>
127 Generates a .pm file which is backwards compatible with the specified
130 For versions < 5.6.0, the changes are.
131 - no use of 'our' (uses 'use vars' instead)
134 Specifying a compatibility version higher than the version of perl you
135 are using to run h2xs will have no effect. If unspecified h2xs will default
136 to compatibility with the version of perl you are using to run h2xs.
138 =item B<-c>, B<--omit-constant>
140 Omit C<constant()> from the .xs file and corresponding specialised
141 C<AUTOLOAD> from the .pm file.
143 =item B<-d>, B<--debugging>
145 Turn on debugging messages.
147 =item B<-e>, B<--omit-enums>=[I<regular expression>]
149 If I<regular expression> is not given, skip all constants that are defined in
150 a C enumeration. Otherwise skip only those constants that are defined in an
151 enum whose name matches I<regular expression>.
153 Since I<regular expression> is optional, make sure that this switch is followed
154 by at least one other switch if you omit I<regular expression> and have some
155 pending arguments such as header-file names. This is ok:
157 h2xs -e -n Module::Foo foo.h
161 h2xs -n Module::Foo -e foo.h
163 In the latter, foo.h is taken as I<regular expression>.
165 =item B<-f>, B<--force>
167 Allows an extension to be created for a header even if that header is
168 not found in standard include directories.
170 =item B<-g>, B<--global>
172 Include code for safely storing static data in the .xs file.
173 Extensions that do no make use of static data can ignore this option.
175 =item B<-h>, B<-?>, B<--help>
177 Print the usage, help and version for this h2xs and exit.
179 =item B<-k>, B<--omit-const-func>
181 For function arguments declared as C<const>, omit the const attribute in the
184 =item B<-m>, B<--gen-tied-var>
186 B<Experimental>: for each variable declared in the header file(s), declare
187 a perl variable of the same name magically tied to the C variable.
189 =item B<-n>, B<--name>=I<module_name>
191 Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
193 =item B<-o>, B<--opaque-re>=I<regular expression>
195 Use "opaque" data type for the C types matched by the regular
196 expression, even if these types are C<typedef>-equivalent to types
197 from typemaps. Should not be used without B<-x>.
199 This may be useful since, say, types which are C<typedef>-equivalent
200 to integers may represent OS-related handles, and one may want to work
201 with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
202 Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
205 The type-to-match is whitewashed (except for commas, which have no
206 whitespace before them, and multiple C<*> which have no whitespace
209 =item B<-p>, B<--remove-prefix>=I<prefix>
211 Specify a prefix which should be removed from the Perl function names,
212 e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
213 the prefix from functions that are autoloaded via the C<constant()>
216 =item B<-s>, B<--const-subs>=I<sub1,sub2>
218 Create a perl subroutine for the specified macros rather than autoload
219 with the constant() subroutine. These macros are assumed to have a
220 return type of B<char *>, e.g.,
221 S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
223 =item B<-t>, B<--default-type>=I<type>
225 Specify the internal type that the constant() mechanism uses for macros.
226 The default is IV (signed integer). Currently all macros found during the
227 header scanning process will be assumed to have this type. Future versions
228 of C<h2xs> may gain the ability to make educated guesses.
230 =item B<--use-new-tests>
232 When B<--compat-version> (B<-b>) is present the generated tests will use
233 C<Test::More> rather than C<Test> which is the default for versions before
234 5.7.2 . C<Test::More> will be added to PREREQ_PM in the generated
237 =item B<--use-old-tests>
239 Will force the generation of test code that uses the older C<Test> module.
241 =item B<--skip-exporter>
243 Do not use C<Exporter> and/or export any symbol.
245 =item B<--skip-ppport>
247 Do not use C<Devel::PPPort>: no portability to older version.
249 =item B<--skip-autoloader>
251 Do not use the module C<AutoLoader>; but keep the constant() function
252 and C<sub AUTOLOAD> for constants.
254 =item B<--skip-strict>
256 Do not use the pragma C<strict>.
258 =item B<--skip-warnings>
260 Do not use the pragma C<warnings>.
262 =item B<-v>, B<--version>=I<version>
264 Specify a version number for this extension. This version number is added
265 to the templates. The default is 0.01, or 0.00_01 if C<-B> is specified.
266 The version specified should be numeric.
268 =item B<-x>, B<--autogen-xsubs>
270 Automatically generate XSUBs basing on function declarations in the
271 header file. The package C<C::Scan> should be installed. If this
272 option is specified, the name of the header file may look like
273 C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
274 string, but XSUBs are emitted only for the declarations included from
277 Note that some types of arguments/return-values for functions may
278 result in XSUB-declarations/typemap-entries which need
279 hand-editing. Such may be objects which cannot be converted from/to a
280 pointer (like C<long long>), pointers to functions, or arrays. See
281 also the section on L<LIMITATIONS of B<-x>>.
288 # Default behavior, extension is Rusers
291 # Same, but extension is RUSERS
292 h2xs -n RUSERS rpcsvc/rusers
294 # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
297 # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h>
298 h2xs -n ONC::RPC rpcsvc/rusers
300 # Without constant() or AUTOLOAD
301 h2xs -c rpcsvc/rusers
303 # Creates templates for an extension named RPC
306 # Extension is ONC::RPC.
309 # Extension is Lib::Foo which works at least with Perl5.005_03.
310 # Constants are created for all #defines and enums h2xs can find
312 h2xs -b 5.5.3 -n Lib::Foo foo.h
314 # Extension is Lib::Foo which works at least with Perl5.005_03.
315 # Constants are created for all #defines but only for enums
316 # whose names do not start with 'bar_'.
317 h2xs -b 5.5.3 -e '^bar_' -n Lib::Foo foo.h
319 # Makefile.PL will look for library -lrpc in
320 # additional directory /opt/net/lib
321 h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
323 # Extension is DCE::rgynbase
324 # prefix "sec_rgy_" is dropped from perl function names
325 h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
327 # Extension is DCE::rgynbase
328 # prefix "sec_rgy_" is dropped from perl function names
329 # subroutines are created for sec_rgy_wildcard_name and
330 # sec_rgy_wildcard_sid
331 h2xs -n DCE::rgynbase -p sec_rgy_ \
332 -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
334 # Make XS without defines in perl.h, but with function declarations
335 # visible from perl.h. Name of the extension is perl1.
336 # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
337 # Extra backslashes below because the string is passed to shell.
338 # Note that a directory with perl header files would
339 # be added automatically to include path.
340 h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
342 # Same with function declaration in proto.h as visible from perl.h.
343 h2xs -xAn perl2 perl.h,proto.h
345 # Same but select only functions which match /^av_/
346 h2xs -M '^av_' -xAn perl2 perl.h,proto.h
348 # Same but treat SV* etc as "opaque" types
349 h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
351 =head2 Extension based on F<.h> and F<.c> files
353 Suppose that you have some C files implementing some functionality,
354 and the corresponding header files. How to create an extension which
355 makes this functionality accessible in Perl? The example below
356 assumes that the header files are F<interface_simple.h> and
357 I<interface_hairy.h>, and you want the perl module be named as
358 C<Ext::Ension>. If you need some preprocessor directives and/or
359 linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
364 =item Find the directory name
366 Start with a dummy run of h2xs:
368 h2xs -Afn Ext::Ension
370 The only purpose of this step is to create the needed directories, and
371 let you know the names of these directories. From the output you can
372 see that the directory for the extension is F<Ext/Ension>.
376 Copy your header files and C files to this directory F<Ext/Ension>.
378 =item Create the extension
380 Run h2xs, overwriting older autogenerated files:
382 h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
384 h2xs looks for header files I<after> changing to the extension
385 directory, so it will find your header files OK.
387 =item Archive and test
399 It is important to do C<make dist> as early as possible. This way you
400 can easily merge(1) your changes to autogenerated files if you decide
401 to edit your C<.h> files and rerun h2xs.
403 Do not forget to edit the documentation in the generated F<.pm> file.
405 Consider the autogenerated files as skeletons only, you may invent
406 better interfaces than what h2xs could guess.
408 Consider this section as a guideline only, some other options of h2xs
409 may better suit your needs.
415 No environment variables are used.
419 Larry Wall and others
423 L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
427 The usual warnings if it cannot read or write the files involved.
429 =head1 LIMITATIONS of B<-x>
431 F<h2xs> would not distinguish whether an argument to a C function
432 which is of the form, say, C<int *>, is an input, output, or
433 input/output parameter. In particular, argument declarations of the
440 should be better rewritten as
446 if C<n> is an input parameter.
448 Additionally, F<h2xs> has no facilities to intuit that a function
455 takes a pair of address and length of data at this address, so it is better
456 to rewrite this function as
466 RETVAL = foo(s, len);
476 char *s = SvPV(sv,len);
481 MODULE = foo PACKAGE = foo PREFIX = my_
487 See L<perlxs> and L<perlxstut> for additional details.
495 my( $H2XS_VERSION ) = ' $Revision: 1.23 $ ' =~ /\$Revision:\s+([^\s]+)/;
496 my $TEMPLATE_VERSION = '0.01';
498 my $compat_version = $];
503 $Text::Wrap::huge = 'overflow';
504 $Text::Wrap::columns = 80;
505 use ExtUtils::Constant qw (WriteConstants WriteMakefileSnippet autoload);
512 h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
513 version: $H2XS_VERSION
515 -A, --omit-autoload Omit all autoloading facilities (implies -c).
516 -B, --beta-version Use beta \$VERSION of 0.00_01 (ignored if -v).
517 -C, --omit-changes Omit creating the Changes file, add HISTORY heading
519 -F, --cpp-flags Additional flags for C preprocessor/compile.
520 -M, --func-mask Mask to select C functions/macros
521 (default is select all).
522 -O, --overwrite-ok Allow overwriting of a pre-existing extension directory.
523 -P, --omit-pod Omit the stub POD section.
524 -X, --omit-XS Omit the XS portion (implies both -c and -f).
525 -a, --gen-accessors Generate get/set accessors for struct and union members
527 -b, --compat-version Specify a perl version to be backwards compatibile with.
528 -c, --omit-constant Omit the constant() function and specialised AUTOLOAD
530 -d, --debugging Turn on debugging messages.
531 -e, --omit-enums Omit constants from enums in the constant() function.
532 If a pattern is given, only the matching enums are
534 -f, --force Force creation of the extension even if the C header
536 -g, --global Include code for safely storing static data in the .xs file.
537 -h, -?, --help Display this help message.
538 -k, --omit-const-func Omit 'const' attribute on function arguments
540 -m, --gen-tied-var Generate tied variables for access to declared
542 -n, --name Specify a name to use for the extension (recommended).
543 -o, --opaque-re Regular expression for \"opaque\" types.
544 -p, --remove-prefix Specify a prefix which should be removed from the
546 -s, --const-subs Create subroutines for specified macros.
547 -t, --default-type Default type for autoloaded constants (default is IV).
548 --use-new-tests Use Test::More in backward compatible modules.
549 --use-old-tests Use the module Test rather than Test::More.
550 --skip-exporter Do not export symbols.
551 --skip-ppport Do not use portability layer.
552 --skip-autoloader Do not use the module C<AutoLoader>.
553 --skip-strict Do not use the pragma C<strict>.
554 --skip-warnings Do not use the pragma C<warnings>.
555 -v, --version Specify a version number for this extension.
556 -x, --autogen-xsubs Autogenerate XSUBs using C::Scan.
557 --use-xsloader Use XSLoader in backward compatible modules (ignored
561 are any libraries that might be needed for loading the
562 extension, e.g. -lm would try to link in the math library.
601 Getopt::Long::Configure('bundling');
602 Getopt::Long::Configure('pass_through');
605 'omit-autoload|A' => \$opt_A,
606 'beta-version|B' => \$opt_B,
607 'omit-changes|C' => \$opt_C,
608 'cpp-flags|F=s' => \$opt_F,
609 'func-mask|M=s' => \$opt_M,
610 'overwrite_ok|O' => \$opt_O,
611 'omit-pod|P' => \$opt_P,
612 'omit-XS|X' => \$opt_X,
613 'gen-accessors|a' => \$opt_a,
614 'compat-version|b=s' => \$opt_b,
615 'omit-constant|c' => \$opt_c,
616 'debugging|d' => \$opt_d,
617 'omit-enums|e:s' => \$opt_e,
618 'force|f' => \$opt_f,
619 'global|g' => \$opt_g,
620 'help|h|?' => \$opt_h,
621 'omit-const-func|k' => \$opt_k,
622 'gen-tied-var|m' => \$opt_m,
623 'name|n=s' => \$opt_n,
624 'opaque-re|o=s' => \$opt_o,
625 'remove-prefix|p=s' => \$opt_p,
626 'const-subs|s=s' => \$opt_s,
627 'default-type|t=s' => \$opt_t,
628 'version|v=s' => \$opt_v,
629 'autogen-xsubs|x' => \$opt_x,
630 'use-new-tests' => \$new_test,
631 'use-old-tests' => \$old_test,
632 'skip-exporter' => \$skip_exporter,
633 'skip-ppport' => \$skip_ppport,
634 'skip-autoloader' => \$skip_autoloader,
635 'skip-warnings' => \$skip_warnings,
636 'skip-strict' => \$skip_strict,
637 'use-xsloader' => \$use_xsloader,
640 GetOptions(%options) || usage;
645 usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
646 $opt_b =~ /^v?(\d+)\.(\d+)\.(\d+)/ ||
647 usage "You must provide the backwards compatibility version in X.Y.Z form. "
649 my ($maj,$min,$sub) = ($1,$2,$3);
650 if ($maj < 5 || ($maj == 5 && $min < 6)) {
652 $sub ? sprintf("%d.%03d%02d",$maj,$min,$sub) :
653 sprintf("%d.%03d", $maj,$min);
656 $sub ? sprintf("%d.%03d%03d",$maj,$min,$sub) :
657 sprintf("%d.%03d", $maj,$min);
660 my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d*)/;
662 warn sprintf <<'EOF', $maj,$min,$sub;
663 Defaulting to backwards compatibility with perl %d.%d.%d
664 If you intend this module to be compatible with earlier perl versions, please
665 specify a minimum perl version with the -b option.
671 $TEMPLATE_VERSION = '0.00_01';
675 $TEMPLATE_VERSION = $opt_v;
677 # check if it is numeric
678 my $temp_version = $TEMPLATE_VERSION;
679 my $beta_version = $temp_version =~ s/(\d)_(\d\d)/$1$2/;
682 local $SIG{__WARN__} = sub { $notnum = 1 };
683 use warnings 'numeric';
684 $temp_version = 0+$temp_version;
688 my $module = $opt_n || 'Your::Module';
690 You have specified a non-numeric version. Unless you supply an
691 appropriate VERSION class method, users may not be able to specify a
692 minimum required version with C<use $module versionnum>.
697 $opt_B = $beta_version;
702 $skip_autoloader = $opt_c = 1 if $opt_A;
704 # -X implies -c and -f
705 $opt_c = $opt_f = 1 if $opt_X;
710 %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
716 while (my $arg = shift) {
717 if ($arg =~ /^-l/i) {
718 $extralibs .= "$arg ";
725 usage "Must supply header file or module name\n"
726 unless (@path_h or $opt_n);
731 $fmask = qr{$opt_M} if defined $opt_M;
732 $tmask = qr{$opt_o} if defined $opt_o;
733 my $tmask_all = $tmask && $opt_o eq '.';
736 eval {require C::Scan; 1}
738 C::Scan required if you use -x option.
739 To install C::Scan, execute
740 perl -MCPAN -e "install C::Scan"
742 unless ($tmask_all) {
743 $C::Scan::VERSION >= 0.70
745 C::Scan v. 0.70 or later required unless you use -o . option.
746 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
747 To install C::Scan, execute
748 perl -MCPAN -e "install C::Scan"
751 if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
753 C::Scan v. 0.73 or later required to use -m or -a options.
754 You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
755 To install C::Scan, execute
756 perl -MCPAN -e "install C::Scan"
760 elsif ($opt_o or $opt_F) {
761 warn <<EOD if $opt_o;
762 Option -o does not make sense without -x.
764 warn <<EOD if $opt_F and $opt_X ;
765 Option -F does not make sense with -X.
769 my @path_h_ini = @path_h;
770 my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
777 my $pre_sub_tri_graphs = 1;
778 if ($^O eq 'VMS') { # Consider overrides of default location
779 # XXXX This is not equivalent to what the older version did:
780 # it was looking at $hadsys header-file per header-file...
781 my($hadsys) = grep s!^sys/!!i , @path_h;
782 @paths = qw( Sys$Library VAXC$Include );
783 push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
784 push @paths, qw( DECC$Library_Include DECC$System_Include );
787 @paths = (File::Spec->curdir(), $Config{usrinc},
788 (split ' ', $Config{locincpth}), '/usr/include');
790 foreach my $path_h (@path_h) {
794 if ( $name !~ /::/ ) {
801 if( $path_h =~ s#::#/#g && $opt_n ){
802 warn "Nesting of headerfile ignored with -n\n";
804 $path_h .= ".h" unless $path_h =~ /\.h$/;
805 my $fullpath = $path_h;
806 $path_h =~ s/,.*$// if $opt_x;
807 $fullpath{$path_h} = $fullpath;
809 # Minor trickery: we can't chdir() before we processed the headers
810 # (so know the name of the extension), but the header may be in the
811 # extension directory...
812 my $tmp_path_h = $path_h;
813 my $rel_path_h = $path_h;
815 if (not -f $path_h) {
817 for my $dir (@paths) {
819 if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
822 $rel_path_h = $path_h;
823 $fullpath{$path_h} = $fullpath;
825 (my $epath = $module) =~ s,::,/,g;
826 $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
827 $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
828 $path_h = $tmp_path_h; # Used during -x
834 die "Can't find $tmp_path_h in @dirs\n"
835 if ( ! $opt_f && ! -f "$rel_path_h" );
836 # Scan the header file (we should deal with nested header files)
837 # Record the names of simple #define constants into const_names
838 # Function prototypes are processed below.
839 open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
842 if ($pre_sub_tri_graphs) {
843 # Preprocess all tri-graphs
844 # including things stuck in quoted string constants.
845 s/\?\?=/#/g; # | ??=| #|
846 s/\?\?\!/|/g; # | ??!| ||
847 s/\?\?'/^/g; # | ??'| ^|
848 s/\?\?\(/[/g; # | ??(| [|
849 s/\?\?\)/]/g; # | ??)| ]|
850 s/\?\?\-/~/g; # | ??-| ~|
851 s/\?\?\//\\/g; # | ??/| \|
852 s/\?\?</{/g; # | ??<| {|
853 s/\?\?>/}/g; # | ??>| }|
855 if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
858 $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
861 # Cannot do: (-1) and ((LHANDLE)3) are OK:
862 #print("Skip non-wordy $def => $rest\n"),
863 # next defines if $rest =~ /[^\w\$]/;
865 print("Skip stringy $def => $rest\n") if $opt_d;
868 print "Matched $_ ($def)\n" if $opt_d;
869 $seen_define{$def} = $rest;
871 next if /^_.*_h_*$/i; # special case, but for what?
872 if (defined $opt_p) {
873 if (!/^$opt_p(\d)/) {
874 ++$prefix{$_} if s/^$opt_p//;
877 warn "can't remove $opt_p prefix from '$_'!\n";
880 $prefixless{$def} = $_;
881 if (!$fmask or /$fmask/) {
882 print "... Passes mask of -M.\n" if $opt_d and $fmask;
887 if (defined $opt_e and !$opt_e) {
891 # Work from miniperl too - on "normal" systems
892 my $SEEK_SET = eval 'use Fcntl qw/SEEK_SET/; SEEK_SET' or 0;
893 seek CH, 0, $SEEK_SET;
894 my $src = do { local $/; <CH> };
896 no warnings 'uninitialized';
898 # Remove C and C++ comments
899 $src =~ s#/\*[^*]*\*+([^/*][^*]*\*+)*/|("(\\.|[^"\\])*"|'(\\.|[^'\\])*'|.[^/"'\\]*)#$2#gs;
901 while ($src =~ /\benum\s*([\w_]*)\s*\{\s([^}]+)\}/gsc) {
902 my ($enum_name, $enum_body) = ($1, $2);
903 # skip enums matching $opt_e
904 next if $opt_e && $enum_name =~ /$opt_e/;
906 for my $item (split /,/, $enum_body) {
907 next if $item =~ /\A\s*\Z/;
908 my ($key, $declared_val) = $item =~ /(\w+)\s*(?:=\s*(.*))?/;
909 $val = defined($declared_val) && length($declared_val) ? $declared_val : 1 + $val;
910 $seen_define{$key} = $val;
911 $const_names{$key}++;
914 } # if (!defined $opt_e or $opt_e)
919 # Save current directory so that C::Scan can use it
920 my $cwd = File::Spec->rel2abs( File::Spec->curdir );
922 # As Ilya suggested, use a name that contains - and then it can't clash with
923 # the names of any packages. A directory 'fallback' will clash with any
924 # new pragmata down the fallback:: tree, but that seems unlikely.
925 my $constscfname = 'const-c.inc';
926 my $constsxsfname = 'const-xs.inc';
927 my $fallbackdirname = 'fallback';
929 my $ext = chdir 'ext' ? 'ext/' : '';
931 my @modparts = split(/::/,$module);
932 my $modpname = join('-', @modparts);
933 my $modfname = pop @modparts;
934 my $modpmdir = join '/', 'lib', @modparts;
935 my $modpmname = join '/', $modpmdir, $modfname.'.pm';
938 warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
941 die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
943 -d "$modpname" || mkpath([$modpname], 0, 0775);
944 chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
949 my $fdecls_parsed = [];
956 my @fnames_no_prefix;
960 if( ! $opt_X ){ # use XS, unless it was disabled
961 unless ($skip_ppport) {
962 require Devel::PPPort;
963 warn "Writing $ext$modpname/ppport.h\n";
964 Devel::PPPort::WriteFile('ppport.h')
965 || die "Can't create $ext$modpname/ppport.h: $!\n";
967 open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
969 warn "Scanning typemaps...\n";
973 my $addflags = $opt_F || '';
975 foreach my $filename (@path_h) {
979 if ($fullpath{$filename} =~ /,/) {
983 warn "Scanning $filename for functions...\n";
984 my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X);
985 $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
986 'add_cppflags' => $addflags, 'c_styles' => \@styles;
987 $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]);
989 $c->get('keywords')->{'__restrict'} = 1;
991 push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
992 push(@$fdecls, @{$c->get('fdecls')});
994 push @td, @{$c->get('typedefs_maybe')};
996 my $structs = $c->get('typedef_structs');
997 @structs{keys %$structs} = values %$structs;
1001 %vdecl_hash = %{ $c->get('vdecl_hash') };
1002 @vdecls = sort keys %vdecl_hash;
1003 for (local $_ = 0; $_ < @vdecls; ++$_) {
1004 my $var = $vdecls[$_];
1005 my($type, $post) = @{ $vdecl_hash{$var} };
1006 if (defined $post) {
1007 warn "Can't handle variable '$type $var $post', skipping.\n";
1008 splice @vdecls, $_, 1;
1011 $type = normalize_type($type);
1012 $vdecl_hash{$var} = $type;
1016 unless ($tmask_all) {
1017 warn "Scanning $filename for typedefs...\n";
1018 my $td = $c->get('typedef_hash');
1019 # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
1020 my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
1021 push @good_td, @f_good_td;
1022 @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td};
1026 $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
1028 %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
1031 for my $i (0..$#$fdecls_parsed) {
1032 next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
1034 print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
1037 $fdecls = [@$fdecls[@good]];
1038 $fdecls_parsed = [@$fdecls_parsed[@good]];
1040 @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
1041 # Sort declarations:
1043 my %h = map( ($_->[1], $_), @$fdecls_parsed);
1044 $fdecls_parsed = [ @h{@fnames} ];
1046 @fnames_no_prefix = @fnames;
1048 = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix
1050 # Remove macros which expand to typedefs
1051 print "Typedefs are @td.\n" if $opt_d;
1052 my %td = map {($_, $_)} @td;
1053 # Add some other possible but meaningless values for macros
1054 for my $k (qw(char double float int long short unsigned signed void)) {
1055 $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
1057 # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
1060 while (keys %td > $n) {
1063 while (($k, $v) = each %seen_define) {
1064 # print("found '$k'=>'$v'\n"),
1065 $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
1068 # Now %bad_macs contains names of bad macros
1069 for my $k (keys %bad_macs) {
1070 delete $const_names{$prefixless{$k}};
1071 print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
1075 my @const_names = sort keys %const_names;
1077 -d $modpmdir || mkpath([$modpmdir], 0, 0775);
1078 open(PM, ">$modpmname") || die "Can't create $ext$modpname/$modpmname: $!\n";
1081 warn "Writing $ext$modpname/$modpmname\n";
1086 use $compat_version;
1089 print PM <<"END" unless $skip_strict;
1093 print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006;
1095 unless( $opt_X || $opt_c || $opt_A ){
1096 # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
1103 print PM <<'END' unless $skip_exporter;
1108 my $use_Dyna = (not $opt_X and $compat_version < 5.006 and not $use_xsloader);
1109 print PM <<"END" if $use_Dyna; # use DynaLoader, unless XS was disabled
1114 # Are we using AutoLoader or not?
1115 unless ($skip_autoloader) { # no autoloader whatsoever.
1116 unless ($opt_c) { # we're doing the AUTOLOAD
1117 print PM "use AutoLoader;\n";
1120 print PM "use AutoLoader qw(AUTOLOAD);\n"
1124 if ( $compat_version < 5.006 ) {
1125 my $vars = '$VERSION @ISA';
1126 $vars .= ' @EXPORT @EXPORT_OK %EXPORT_TAGS' unless $skip_exporter;
1127 $vars .= ' $AUTOLOAD' unless $opt_X || $opt_c || $opt_A;
1128 $vars .= ' $XS_VERSION' if $opt_B && !$opt_X;
1129 print PM "use vars qw($vars);";
1134 push @modISA, 'Exporter' unless $skip_exporter;
1135 push @modISA, 'DynaLoader' if $use_Dyna; # no XS
1136 my $myISA = "our \@ISA = qw(@modISA);";
1137 $myISA =~ s/^our // if $compat_version < 5.006;
1139 print PM "\n$myISA\n\n";
1141 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
1144 $tmp .= <<"END" unless $skip_exporter;
1145 # Items to export into callers namespace by default. Note: do not export
1146 # names by default without a very good reason. Use EXPORT_OK instead.
1147 # Do not simply export all your public functions/methods/constants.
1149 # This allows declaration use $module ':all';
1150 # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
1152 our %EXPORT_TAGS = ( 'all' => [ qw(
1156 our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
1164 $tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n";
1166 $tmp .= "our \$XS_VERSION = \$VERSION;\n" unless $opt_X;
1167 $tmp .= "\$VERSION = eval \$VERSION; # see L<perlmodstyle>\n";
1171 $tmp =~ s/^our //mg if $compat_version < 5.006;
1175 printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
1179 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
1181 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
1184 bootstrap $module \$VERSION;
1189 XSLoader::load('$module', \$VERSION);
1192 $tmp =~ s:\$VERSION:\$XS_VERSION:g if $opt_B;
1196 # tying the variables can happen only after bootstrap
1200 @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]}
1207 if( $opt_P ){ # if POD is disabled
1216 # Preloaded methods go here.
1219 print PM <<"END" unless $opt_A;
1221 # Autoload methods go after $after, and are processed by the autosplit program.
1230 my ($email,$author,$licence);
1234 ($username,$author) = (getpwuid($>))[0,6];
1235 if (defined $username && defined $author) {
1236 $author =~ s/,.*$//; # in case of sub fields
1237 my $domain = $Config{'mydomain'};
1239 $email = "$username\@$domain";
1243 $author =~ s/'/\\'/g if defined $author;
1244 $author ||= "A. U. Thor";
1245 $email ||= 'a.u.thor@a.galaxy.far.far.away';
1247 $licence = sprintf << "DEFAULT", $^V;
1248 Copyright (C) ${\(1900 + (localtime) [5])} by $author
1250 This library is free software; you can redistribute it and/or modify
1251 it under the same terms as Perl itself, either Perl version %vd or,
1252 at your option, any later version of Perl 5 you may have available.
1256 $revhist = <<EOT if $opt_C;
1262 #=item $TEMPLATE_VERSION
1264 #Original version; created by h2xs $H2XS_VERSION with options
1272 my $exp_doc = $skip_exporter ? '' : <<EOD;
1280 if (@const_names and not $opt_P) {
1281 $exp_doc .= <<EOD unless $skip_exporter;
1282 #=head2 Exportable constants
1284 # @{[join "\n ", @const_names]}
1289 if (defined $fdecls and @$fdecls and not $opt_P) {
1290 $exp_doc .= <<EOD unless $skip_exporter;
1291 #=head2 Exportable functions
1295 # $exp_doc .= <<EOD if $opt_p;
1296 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
1299 $exp_doc .= <<EOD unless $skip_exporter;
1300 # @{[join "\n ", @known_fnames{@fnames}]}
1307 if ($opt_x && $opt_a) {
1309 $meth_doc .= accessor_docs($name, $struct)
1310 while ($name, $struct) = each %structs;
1313 # Prefix the default licence with hash symbols.
1314 # Is this just cargo cult - it seems that the first thing that happens to this
1315 # block is that all the hashes are then s///g out.
1316 my $licence_hash = $licence;
1317 $licence_hash =~ s/^/#/gm;
1320 $pod = <<"END" unless $opt_P;
1321 ## Below is stub documentation for your module. You'd better edit it!
1325 #$module - Perl extension for blah blah blah
1334 #Stub documentation for $module, created by h2xs. It looks like the
1335 #author of the extension was negligent enough to leave the stub
1339 $exp_doc$meth_doc$revhist
1343 #Mention other useful documentation such as the documentation of
1344 #related modules or operating system documentation (such as man pages
1345 #in UNIX), or any relevant external documentation such as RFCs or
1348 #If you have a mailing list set up for your module, mention it here.
1350 #If you have a web site set up for your module, mention it here.
1354 #$author, E<lt>${email}E<gt>
1356 #=head1 COPYRIGHT AND LICENSE
1363 $pod =~ s/^\#//gm unless $opt_P;
1364 print PM $pod unless $opt_P;
1369 if( ! $opt_X ){ # print XS, unless it is disabled
1370 warn "Writing $ext$modpname/$modfname.xs\n";
1379 print XS <<"END" unless $skip_ppport;
1385 foreach my $path_h (@path_h_ini) {
1387 $h =~ s#^/usr/include/##;
1388 if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
1389 print XS qq{#include <$h>\n};
1394 print XS <<"END" if $opt_g;
1398 #define MY_CXT_KEY "${module}::_guts" XS_VERSION
1401 /* Put Global Data in here */
1402 int dummy; /* you can access this elsewhere as MY_CXT.dummy */
1409 my %pointer_typedefs;
1410 my %struct_typedefs;
1414 my $out = $pointer_typedefs{$type};
1415 return $out if defined $out;
1417 $out = ($type =~ /\*$/);
1418 # This converts only the guys which do not have trailing part in the typedef
1420 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1421 $type = normalize_type($type);
1422 print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
1424 $out = td_is_pointer($type);
1426 return ($pointer_typedefs{$otype} = $out);
1431 my $out = $struct_typedefs{$type};
1432 return $out if defined $out;
1434 $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
1435 # This converts only the guys which do not have trailing part in the typedef
1437 and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1438 $type = normalize_type($type);
1439 print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
1441 $out = td_is_struct($type);
1443 return ($struct_typedefs{$otype} = $out);
1446 print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
1449 # We write the "sample" files used when this module is built by perl without
1450 # ExtUtils::Constant.
1451 # h2xs will later check that these are the same as those generated by the
1452 # code embedded into Makefile.PL
1453 unless (-d $fallbackdirname) {
1454 mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n";
1456 warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n";
1457 warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n";
1458 my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname);
1459 my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname);
1460 WriteConstants ( C_FILE => $cfallback,
1461 XS_FILE => $xsfallback,
1462 DEFAULT_TYPE => $opt_t,
1464 NAMES => \@const_names,
1466 print XS "#include \"$constscfname\"\n";
1470 my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
1472 # Now switch from C to XS by issuing the first MODULE declaration:
1475 MODULE = $module PACKAGE = $module $prefix
1479 # If a constant() function was #included then output a corresponding
1481 print XS "INCLUDE: $constsxsfname\n" unless $opt_c;
1483 print XS <<"END" if $opt_g;
1488 /* If any of the fields in the my_cxt_t struct need
1489 to be initialised, do it here.
1495 foreach (sort keys %const_xsub) {
1504 croak("Your vendor has not defined the $module macro $_");
1519 my ($type, $name, $args) = @$decl;
1520 return if $seen_decl{$name}++; # Need to do the same for docs as well?
1522 my @argnames = map {$_->[1]} @$args;
1523 my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
1525 s/^\s*const\b\s*// for @argtypes;
1527 my @argarrays = map { $_->[4] || '' } @$args;
1528 my $numargs = @$args;
1529 if ($numargs and $argtypes[-1] eq '...') {
1531 $argnames[-1] = '...';
1534 $type = normalize_type($type, 1);
1542 for my $arg (0 .. $numargs - 1) {
1544 $argtypes[$arg] $argnames[$arg]$argarrays[$arg]
1549 sub print_tievar_subs {
1550 my($fh, $name, $type) = @_;
1553 _get_$name(IV index, SV *sv) {
1558 (void)call_pv("$module\::_get_$name", G_DISCARD);
1563 _set_$name(IV index, SV *sv) {
1568 (void)call_pv("$module\::_set_$name", G_DISCARD);
1575 sub print_tievar_xsubs {
1576 my($fh, $name, $type) = @_;
1584 uf.uf_val = &_get_$name;
1585 uf.uf_set = &_set_$name;
1586 uf.uf_index = (IV)&_get_$name;
1587 sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
1591 $type THIS = NO_INIT
1607 sub print_accessors {
1608 my($fh, $name, $struct) = @_;
1609 return unless defined $struct && $name !~ /\s|_ANON/;
1610 $name = normalize_type($name);
1611 my $ptrname = normalize_type("$name *");
1614 MODULE = $module PACKAGE = ${name} $prefix
1618 $name THIS = NO_INIT
1621 if (sv_derived_from(ST(0), "$name")) {
1623 char *s = SvPV((SV*)SvRV(ST(0)), len);
1624 if (len != sizeof(THIS))
1625 croak("Size \%d of packed data != expected \%d",
1627 RETVAL = ($name *)s;
1630 croak("THIS is not of type $name");
1636 char *CLASS = NO_INIT
1639 Zero((void*)&RETVAL, sizeof(RETVAL), char);
1643 MODULE = $module PACKAGE = ${name}Ptr $prefix
1646 my @items = @$struct;
1648 my $item = shift @items;
1649 if ($item->[0] =~ /_ANON/) {
1650 if (defined $item->[2]) {
1652 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1653 ], @{ $structs{$item->[0]} };
1655 push @items, @{ $structs{$item->[0]} };
1658 my $type = normalize_type($item->[0]);
1659 my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
1662 $item->[2](THIS, __value = NO_INIT)
1668 THIS->$item->[-1] = __value;
1670 $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
1681 my($name, $struct) = @_;
1682 return unless defined $struct && $name !~ /\s|_ANON/;
1683 $name = normalize_type($name);
1684 my $ptrname = $name . 'Ptr';
1685 my @items = @$struct;
1688 my $item = shift @items;
1689 if ($item->[0] =~ /_ANON/) {
1690 if (defined $item->[2]) {
1692 @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
1693 ], @{ $structs{$item->[0]} };
1695 push @items, @{ $structs{$item->[0]} };
1698 push @list, $item->[2];
1701 my $methods = (join '(...)>, C<', @list) . '(...)';
1705 #=head2 Object and class methods for C<$name>/C<$ptrname>
1707 #The principal Perl representation of a C object of type C<$name> is an
1708 #object of class C<$ptrname> which is a reference to an integer
1709 #representation of a C pointer. To create such an object, one may use
1712 # my \$buffer = $name->new();
1713 # my \$obj = \$buffer->_to_ptr();
1715 #This exersizes the following two methods, and an additional class
1716 #C<$name>, the internal representation of which is a reference to a
1717 #packed string with the C structure. Keep in mind that \$buffer should
1718 #better survive longer than \$obj.
1722 #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
1724 #Converts an object of type C<$name> to an object of type C<$ptrname>.
1726 #=item C<$name-E<gt>new()>
1728 #Creates an empty object of type C<$name>. The corresponding packed
1729 #string is zeroed out.
1733 #return the current value of the corresponding element if called
1734 #without additional arguments. Set the element to the supplied value
1735 #(and return the new value) if called with an additional argument.
1737 #Applicable to objects of type C<$ptrname>.
1746 # Should be called before any actual call to normalize_type().
1748 # We do not want to read ./typemap by obvios reasons.
1749 my @tm = qw(../../../typemap ../../typemap ../typemap);
1750 my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
1751 unshift @tm, $stdtypemap;
1752 my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
1754 # Start with useful default values
1755 $typemap{float} = 'T_NV';
1757 foreach my $typemap (@tm) {
1758 next unless -e $typemap ;
1759 # skip directories, binary files etc.
1760 warn " Scanning $typemap\n";
1761 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
1762 unless -T $typemap ;
1763 open(TYPEMAP, $typemap)
1764 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
1765 my $mode = 'Typemap';
1768 if (/^INPUT\s*$/) { $mode = 'Input'; next; }
1769 elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; }
1770 elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
1771 elsif ($mode eq 'Typemap') {
1772 next if /^\s*($|\#)/ ;
1774 if ( ($type, $image) =
1775 /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
1776 # This may reference undefined functions:
1777 and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
1778 $typemap{normalize_type($type)} = $image;
1782 close(TYPEMAP) or die "Cannot close $typemap: $!";
1784 %std_types = %types_seen;
1789 sub normalize_type { # Second arg: do not strip const's before \*
1791 my $do_keep_deep_const = shift;
1792 # If $do_keep_deep_const this is heuristical only
1793 my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
1795 = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
1796 if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
1797 $type =~ s/$ignore_mods//go;
1800 $type =~ s/$ignore_mods//go;
1802 $type =~ s/([^\s\w])/ $1 /g;
1806 $type =~ s/\* (?=\*)/*/g;
1807 $type =~ s/\. \. \./.../g;
1809 $types_seen{$type}++
1810 unless $type eq '...' or $type eq 'void' or $std_types{$type};
1816 sub assign_typemap_entry {
1820 if ($tmask and $type =~ /$tmask/) {
1821 print "Type $type matches -o mask\n" if $opt_d;
1822 $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1824 elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
1825 $type = normalize_type $type;
1826 print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
1827 $entry = assign_typemap_entry($type);
1829 # XXX good do better if our UV happens to be long long
1830 return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/;
1831 $entry ||= $typemap{$otype}
1832 || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
1833 $typemap{$otype} = $entry;
1834 $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
1839 print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
1843 for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
1845 while (my($name, $struct) = each %structs) {
1846 print_accessors(\*XS, $name, $struct);
1855 warn "Writing $ext$modpname/typemap\n";
1856 open TM, ">typemap" or die "Cannot open typemap file for write: $!";
1858 for $type (sort keys %types_seen) {
1859 my $entry = assign_typemap_entry $type;
1860 print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
1863 print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
1864 #############################################################################
1867 if (sv_derived_from($arg, \"${ntype}\")) {
1869 char *s = SvPV((SV*)SvRV($arg), len);
1871 if (len != sizeof($var))
1872 croak(\"Size %d of packed data != expected %d\",
1877 croak(\"$var is not of type ${ntype}\")
1878 #############################################################################
1881 sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
1884 close TM or die "Cannot close typemap file for write: $!";
1889 warn "Writing $ext$modpname/Makefile.PL\n";
1890 open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
1894 if ( $compat_version < 5.00702 and $new_test )
1896 $prereq_pm .= q%'Test::More' => 0, %;
1899 if ( $compat_version < 5.00600 and !$opt_X and $use_xsloader)
1901 $prereq_pm .= q%'XSLoader' => 0, %;
1905 use $compat_version;
1906 use ExtUtils::MakeMaker;
1907 # See lib/ExtUtils/MakeMaker.pm for details of how to influence
1908 # the contents of the Makefile that is written.
1911 VERSION_FROM => '$modpmname', # finds \$VERSION
1912 PREREQ_PM => {$prereq_pm}, # e.g., Module::Name => 1.1
1913 (\$] >= 5.005 ? ## Add these new keywords supported since 5.005
1914 (ABSTRACT_FROM => '$modpmname', # retrieve abstract from module
1915 AUTHOR => '$author <$email>') : ()),
1917 if (!$opt_X) { # print C stuff, unless XS is disabled
1918 $opt_F = '' unless defined $opt_F;
1919 my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
1920 my $Ihelp = ($I ? '-I. ' : '');
1921 my $Icomment = ($I ? '' : <<EOC);
1922 # Insert -I. if you add *.h files later:
1926 LIBS => ['$extralibs'], # e.g., '-lm'
1927 DEFINE => '$opt_F', # e.g., '-DHAVE_SOMETHING'
1928 $Icomment INC => '$I', # e.g., '${Ihelp}-I/usr/include/other'
1931 my $C = grep {$_ ne "$modfname.c"}
1932 (glob '*.c'), (glob '*.cc'), (glob '*.C');
1933 my $Cpre = ($C ? '' : '# ');
1934 my $Ccomment = ($C ? '' : <<EOC);
1935 # Un-comment this if you add C files to link with later:
1939 $Ccomment ${Cpre}OBJECT => '\$(O_FILES)', # link all the C files too
1945 WriteMakefileSnippet ( C_FILE => $constscfname,
1946 XS_FILE => $constsxsfname,
1947 DEFAULT_TYPE => $opt_t,
1949 NAMES => \@const_names,
1952 if (eval {require ExtUtils::Constant; 1}) {
1953 # If you edit these definitions to change the constants used by this module,
1954 # you will need to use the generated $constscfname and $constsxsfname
1955 # files to replace their "fallback" counterparts before distributing your
1962 foreach my \$file ('$constscfname', '$constsxsfname') {
1963 my \$fallback = File::Spec->catfile('$fallbackdirname', \$file);
1964 copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!";
1969 eval $generate_code;
1972 Attempting to test constant code in $ext$modpname/Makefile.PL:
1975 gave unexpected error $@
1976 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1977 using the perlbug script.
1982 foreach my $file ($constscfname, $constsxsfname) {
1983 my $fallback = File::Spec->catfile($fallbackdirname, $file);
1984 if (compare($file, $fallback)) {
1986 Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ.
1992 warn fill ('','', <<"EOM") . "\n";
1993 It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
1994 the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname
1997 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
1998 using the perlbug script.
2001 unlink $constscfname, $constsxsfname;
2005 close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
2007 # Create a simple README since this is a CPAN requirement
2008 # and it doesnt hurt to have one
2009 warn "Writing $ext$modpname/README\n";
2010 open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
2011 my $thisyear = (gmtime)[5] + 1900;
2012 my $rmhead = "$modpname version $TEMPLATE_VERSION";
2013 my $rmheadeq = "=" x length($rmhead);
2017 if ( $compat_version < 5.00702 and $new_test )
2019 $rm_prereq = 'Test::More';
2023 $rm_prereq = 'blah blah blah';
2030 The README is used to introduce the module and provide instructions on
2031 how to install the module, any machine dependencies it may have (for
2032 example C compilers and installed libraries) and any other information
2033 that should be provided before the module is installed.
2035 A README file is required for CPAN modules since CPAN extracts the
2036 README file from a module distribution so that people browsing the
2037 archive can use it get an idea of the modules uses. It is usually a
2038 good idea to provide version information here so that people can
2039 decide whether fixes for the module are worth downloading.
2043 To install this module type the following:
2052 This module requires these other modules and libraries:
2056 COPYRIGHT AND LICENCE
2058 Put the correct copyright and licence information here.
2063 close(RM) || die "Can't close $ext$modpname/README: $!\n";
2066 my $testfile = "$testdir/$modpname.t";
2067 unless (-d "$testdir") {
2068 mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
2070 warn "Writing $ext$modpname/$testfile\n";
2071 my $tests = @const_names ? 2 : 1;
2073 open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
2076 # Before `make install' is performed this script should be runnable with
2077 # `make test'. After `make install' it should work as `perl $modpname.t'
2079 #########################
2081 # change 'tests => $tests' to 'tests => last_test_to_print';
2085 my $test_mod = 'Test::More';
2087 if ( $old_test or ($compat_version < 5.007 and not $new_test ))
2089 my $test_mod = 'Test';
2093 BEGIN { plan tests => $tests };
2095 ok(1); # If we made it this far, we're ok.
2100 my $const_names = join " ", @const_names;
2104 foreach my $constname (qw(
2107 print EX wrap ("\t", "\t", $const_names);
2108 print EX (")) {\n");
2111 next if (eval "my \\\$a = \$constname; 1");
2112 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2113 print "# pass: \$\@";
2115 print "# fail: \$\@";
2120 print "not ok 2\\n";
2131 use Test::More tests => $tests;
2132 BEGIN { use_ok('$module') };
2137 my $const_names = join " ", @const_names;
2141 foreach my $constname (qw(
2144 print EX wrap ("\t", "\t", $const_names);
2145 print EX (")) {\n");
2148 next if (eval "my \\\$a = \$constname; 1");
2149 if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
2150 print "# pass: \$\@";
2152 print "# fail: \$\@";
2158 ok( \$fail == 0 , 'Constants' );
2164 #########################
2166 # Insert your test code below, the $test_mod module is use()ed here so read
2167 # its man page ( perldoc $test_mod ) for help writing this test script.
2171 close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
2174 warn "Writing $ext$modpname/Changes\n";
2176 open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
2177 @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
2179 Revision history for Perl extension $module.
2181 $TEMPLATE_VERSION @{[scalar localtime]}
2182 \t- original version; created by h2xs $H2XS_VERSION with options
2186 close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
2189 warn "Writing $ext$modpname/MANIFEST\n";
2190 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
2191 my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>, <$modpmdir/*>);
2193 eval {opendir(D,'.');};
2194 unless ($@) { @files = readdir(D); closedir(D); }
2196 if (!@files) { @files = map {chomp && $_} `ls`; }
2199 # Clip trailing '.' for portability -- non-VMS OSs don't expect it
2201 # Fix up for case-sensitive file systems
2202 s/$modfname/$modfname/i && next;
2203 $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
2204 $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
2207 print MANI join("\n",@files), "\n";
2211 close OUT or die "Can't close $file: $!";
2212 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
2213 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';