h2xs.PL revision 7c478bd95313f5f23a4c958a745db2134aa03244
use Config;
use Cwd;
# List explicitly here the variables you want Configure to
# generate. Metaconfig only looks for shell variables, so you
# have to mention them as if they were shell variables, not
# %Config entries. Thus you write
# $startperl
# to ensure Configure will look for $Config{startperl}.
# This forces PL files to create target in same directory as PL file.
# This is so that make depend always knows where to find PL derivatives.
chdir dirname($0);
print "Extracting $file (with variable substitutions)\n";
# In this section, perl variables will be expanded during extraction.
# You can use $Config{...} to use Configure variables.
print OUT <<"!GROK!THIS!";
eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
if \$running_under_some_shell;
# In the following, perl variables are not expanded during extraction.
print OUT <<'!NO!SUBS!';
use warnings;
=head1 NAME
h2xs - convert .h C header files to Perl extensions
=head1 SYNOPSIS
B<h2xs> [B<OPTIONS> ...] [headerfile ... [extra_libraries]]
B<h2xs> B<-h>|B<-?>|B<--help>
=head1 DESCRIPTION
I<h2xs> builds a Perl extension from C header files. The extension
will include functions which can be used to retrieve the value of any
#define statement which was in the C header files.
The I<module_name> will be used for the name of the extension. If
module_name is not supplied then the name of the first header file
will be used, with the first character capitalized.
If the extension might need extra libraries, they should be included
here. The extension Makefile.PL will take care of checking whether
the libraries actually exist and how they should be loaded. The extra
libraries should be specified in the form -lm -lposix, etc, just as on
the cc command line. By default, the Makefile.PL will search through
the library path determined by Configure. That path can be augmented
extra-libraries argument.
=head1 OPTIONS
=over 5
=item B<-A>, B<--omit-autoload>
Omit all autoload facilities. This is the same as B<-c> but also
removes the S<C<use AutoLoader>> statement from the .pm file.
=item B<-B>, B<--beta-version>
be "0.00_01" unless B<-v> is specified.
=item B<-C>, B<--omit-changes>
Omits creation of the F<Changes> file, and adds a HISTORY section to
the POD template.
=item B<-F>, B<--cpp-flags>=I<addflags>
Additional flags to specify to C preprocessor when scanning header for
function declarations. Writes these options in the generated F<Makefile.PL>
too.
=item B<-M>, B<--func-mask>=I<regular expression>
=item B<-O>, B<--overwrite-ok>
Allows a pre-existing extension directory to be overwritten.
=item B<-P>, B<--omit-pod>
Omit the autogenerated stub POD section.
=item B<-X>, B<--omit-XS>
Omit the XS portion. Used to generate templates for a module which is not
XS-based. C<-c> and C<-f> are implicitly enabled.
=item B<-a>, B<--gen-accessors>
Generate an accessor method for each element of structs and unions. The
generated methods are named after the element name; will return the current
value of the element if called without additional arguments; and will set
the element to the supplied value (and return the new value) if called with
an additional argument. Embedded structures and unions are returned as a
pointer rather than the complete structure, to facilitate chained calls.
These methods all apply to the Ptr type for the structure; additionally
two methods are constructed for the structure type itself, C<_to_ptr>
which returns a Ptr type pointing to the same structure, and a C<new>
method to construct and return a new structure, initialised to zeroes.
=item B<-b>, B<--compat-version>=I<version>
Generates a .pm file which is backwards compatible with the specified
perl version.
For versions < 5.6.0, the changes are.
- no use of 'our' (uses 'use vars' instead)
- no 'use warnings'
Specifying a compatibility version higher than the version of perl you
are using to run h2xs will have no effect. If unspecified h2xs will default
to compatibility with the version of perl you are using to run h2xs.
=item B<-c>, B<--omit-constant>
Omit C<constant()> from the .xs file and corresponding specialised
C<AUTOLOAD> from the .pm file.
=item B<-d>, B<--debugging>
Turn on debugging messages.
=item B<-e>, B<--omit-enums>=[I<regular expression>]
If I<regular expression> is not given, skip all constants that are defined in
a C enumeration. Otherwise skip only those constants that are defined in an
enum whose name matches I<regular expression>.
Since I<regular expression> is optional, make sure that this switch is followed
by at least one other switch if you omit I<regular expression> and have some
pending arguments such as header-file names. This is ok:
h2xs -e -n Module::Foo foo.h
This is not ok:
h2xs -n Module::Foo -e foo.h
In the latter, foo.h is taken as I<regular expression>.
=item B<-f>, B<--force>
Allows an extension to be created for a header even if that header is
not found in standard include directories.
=item B<-g>, B<--global>
Include code for safely storing static data in the .xs file.
Extensions that do no make use of static data can ignore this option.
=item B<-h>, B<-?>, B<--help>
Print the usage, help and version for this h2xs and exit.
=item B<-k>, B<--omit-const-func>
For function arguments declared as C<const>, omit the const attribute in the
generated XS code.
=item B<-m>, B<--gen-tied-var>
B<Experimental>: for each variable declared in the header file(s), declare
a perl variable of the same name magically tied to the C variable.
=item B<-n>, B<--name>=I<module_name>
Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
=item B<-o>, B<--opaque-re>=I<regular expression>
Use "opaque" data type for the C types matched by the regular
expression, even if these types are C<typedef>-equivalent to types
from typemaps. Should not be used without B<-x>.
This may be useful since, say, types which are C<typedef>-equivalent
to integers may represent OS-related handles, and one may want to work
with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
types.
The type-to-match is whitewashed (except for commas, which have no
whitespace before them, and multiple C<*> which have no whitespace
between them).
=item B<-p>, B<--remove-prefix>=I<prefix>
Specify a prefix which should be removed from the Perl function names,
e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
the prefix from functions that are autoloaded via the C<constant()>
mechanism.
=item B<-s>, B<--const-subs>=I<sub1,sub2>
Create a perl subroutine for the specified macros rather than autoload
with the constant() subroutine. These macros are assumed to have a
return type of B<char *>, e.g.,
S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
=item B<-t>, B<--default-type>=I<type>
Specify the internal type that the constant() mechanism uses for macros.
The default is IV (signed integer). Currently all macros found during the
header scanning process will be assumed to have this type. Future versions
of C<h2xs> may gain the ability to make educated guesses.
=item B<--use-new-tests>
When B<--compat-version> (B<-b>) is present the generated tests will use
C<Test::More> rather than C<Test> which is the default for versions before
5.7.2 . C<Test::More> will be added to PREREQ_PM in the generated
C<Makefile.PL>.
=item B<--use-old-tests>
Will force the generation of test code that uses the older C<Test> module.
=item B<--skip-exporter>
=item B<--skip-ppport>
Do not use C<Devel::PPPort>: no portability to older version.
=item B<--skip-autoloader>
Do not use the module C<AutoLoader>; but keep the constant() function
and C<sub AUTOLOAD> for constants.
=item B<--skip-strict>
Do not use the pragma C<strict>.
=item B<--skip-warnings>
Do not use the pragma C<warnings>.
=item B<-v>, B<--version>=I<version>
Specify a version number for this extension. This version number is added
to the templates. The default is 0.01, or 0.00_01 if C<-B> is specified.
The version specified should be numeric.
=item B<-x>, B<--autogen-xsubs>
Automatically generate XSUBs basing on function declarations in the
header file. The package C<C::Scan> should be installed. If this
option is specified, the name of the header file may look like
C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
string, but XSUBs are emitted only for the declarations included from
file NAME2.
Note that some types of arguments/return-values for functions may
result in XSUB-declarations/typemap-entries which need
pointer (like C<long long>), pointers to functions, or arrays. See
also the section on L<LIMITATIONS of B<-x>>.
=back
=head1 EXAMPLES
# Default behavior, extension is Rusers
# Same, but extension is RUSERS
h2xs rpcsvc::rusers
# Without constant() or AUTOLOAD
# Creates templates for an extension named RPC
h2xs -cfn RPC
# Extension is ONC::RPC.
h2xs -cfn ONC::RPC
# Extension is Lib::Foo which works at least with Perl5.005_03.
# Constants are created for all #defines and enums h2xs can find
# in foo.h.
h2xs -b 5.5.3 -n Lib::Foo foo.h
# Extension is Lib::Foo which works at least with Perl5.005_03.
# Constants are created for all #defines but only for enums
# whose names do not start with 'bar_'.
h2xs -b 5.5.3 -e '^bar_' -n Lib::Foo foo.h
# Makefile.PL will look for library -lrpc in
# Extension is DCE::rgynbase
# prefix "sec_rgy_" is dropped from perl function names
# Extension is DCE::rgynbase
# prefix "sec_rgy_" is dropped from perl function names
# subroutines are created for sec_rgy_wildcard_name and
# sec_rgy_wildcard_sid
h2xs -n DCE::rgynbase -p sec_rgy_ \
# Make XS without defines in perl.h, but with function declarations
# visible from perl.h. Name of the extension is perl1.
# When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
# Extra backslashes below because the string is passed to shell.
# Note that a directory with perl header files would
# be added automatically to include path.
h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
# Same with function declaration in proto.h as visible from perl.h.
h2xs -xAn perl2 perl.h,proto.h
# Same but select only functions which match /^av_/
h2xs -M '^av_' -xAn perl2 perl.h,proto.h
# Same but treat SV* etc as "opaque" types
h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
=head2 Extension based on F<.h> and F<.c> files
Suppose that you have some C files implementing some functionality,
and the corresponding header files. How to create an extension which
makes this functionality accessable in Perl? The example below
assumes that the header files are F<interface_simple.h> and
I<interface_hairy.h>, and you want the perl module be named as
linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
in L<"OPTIONS">.
=over
=item Find the directory name
Start with a dummy run of h2xs:
h2xs -Afn Ext::Ension
The only purpose of this step is to create the needed directories, and
let you know the names of these directories. From the output you can
=item Copy C files
=item Create the extension
Run h2xs, overwriting older autogenerated files:
h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
h2xs looks for header files I<after> changing to the extension
directory, so it will find your header files OK.
=item Archive and test
As usual, run
perl Makefile.PL
make dist
make
make test
=item Hints
It is important to do C<make dist> as early as possible. This way you
can easily merge(1) your changes to autogenerated files if you decide
to edit your C<.h> files and rerun h2xs.
Do not forget to edit the documentation in the generated F<.pm> file.
Consider the autogenerated files as skeletons only, you may invent
better interfaces than what h2xs could guess.
Consider this section as a guideline only, some other options of h2xs
may better suit your needs.
=back
=head1 ENVIRONMENT
No environment variables are used.
=head1 AUTHOR
Larry Wall and others
=head1 SEE ALSO
L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
=head1 DIAGNOSTICS
The usual warnings if it cannot read or write the files involved.
=head1 LIMITATIONS of B<-x>
F<h2xs> would not distinguish whether an argument to a C function
which is of the form, say, C<int *>, is an input, output, or
form
int
foo(n)
int *n
should be better rewritten as
int
foo(n)
int &n
if C<n> is an input parameter.
Additionally, F<h2xs> has no facilities to intuit that a function
int
foo(addr,l)
char *addr
int l
takes a pair of address and length of data at this address, so it is better
to rewrite this function as
int
foo(sv)
SV *addr
PREINIT:
STRLEN len;
char *s;
CODE:
s = SvPV(sv,len);
RETVAL = foo(s, len);
OUTPUT:
RETVAL
or alternately
static int
my_foo(SV *sv)
{
STRLEN len;
char *s = SvPV(sv,len);
return foo(s, len);
}
MODULE = foo PACKAGE = foo PREFIX = my_
int
foo(sv)
SV *sv
See L<perlxs> and L<perlxstut> for additional details.
=cut
# ' # Grr
use strict;
my $TEMPLATE_VERSION = '0.01';
my $compat_version = $];
use Config;
sub usage {
warn "@_\n" if @_;
die <<EOFUSAGE;
}
my ($opt_A,
$opt_B,
$opt_C,
$opt_F,
$opt_M,
$opt_O,
$opt_P,
$opt_X,
$opt_a,
$opt_c,
$opt_d,
$opt_e,
$opt_f,
$opt_g,
$opt_h,
$opt_k,
$opt_m,
$opt_n,
$opt_o,
$opt_p,
$opt_s,
$opt_v,
$opt_x,
$opt_b,
$opt_t,
$new_test,
$old_test,
);
my %options = (
'omit-autoload|A' => \$opt_A,
'beta-version|B' => \$opt_B,
'omit-changes|C' => \$opt_C,
'cpp-flags|F=s' => \$opt_F,
'func-mask|M=s' => \$opt_M,
'overwrite_ok|O' => \$opt_O,
'omit-pod|P' => \$opt_P,
'omit-XS|X' => \$opt_X,
'gen-accessors|a' => \$opt_a,
'compat-version|b=s' => \$opt_b,
'omit-constant|c' => \$opt_c,
'debugging|d' => \$opt_d,
'omit-enums|e:s' => \$opt_e,
'force|f' => \$opt_f,
'global|g' => \$opt_g,
'help|h|?' => \$opt_h,
'omit-const-func|k' => \$opt_k,
'gen-tied-var|m' => \$opt_m,
'name|n=s' => \$opt_n,
'opaque-re|o=s' => \$opt_o,
'remove-prefix|p=s' => \$opt_p,
'const-subs|s=s' => \$opt_s,
'default-type|t=s' => \$opt_t,
'version|v=s' => \$opt_v,
'autogen-xsubs|x' => \$opt_x,
'use-new-tests' => \$new_test,
'use-old-tests' => \$old_test,
'skip-exporter' => \$skip_exporter,
'skip-ppport' => \$skip_ppport,
'skip-autoloader' => \$skip_autoloader,
'skip-warnings' => \$skip_warnings,
'skip-strict' => \$skip_strict,
);
if( $opt_b ){
$opt_b =~ /^\d+\.\d+\.\d+/ ||
usage "You must provide the backwards compatibility version in X.Y.Z form. "
. "(i.e. 5.5.0)\n";
} else {
}
} else {
$sub ||= 0;
}
if( $opt_B ){
$TEMPLATE_VERSION = '0.00_01';
}
if( $opt_v ){
$TEMPLATE_VERSION = $opt_v;
# check if it is numeric
my $temp_version = $TEMPLATE_VERSION;
my $notnum;
{
use warnings 'numeric';
}
if ($notnum) {
warn <<"EOF";
}
else {
$opt_B = $beta_version;
}
}
# -A implies -c.
# -X implies -c and -f
$opt_t ||= 'IV';
my %const_xsub;
my $extralibs = '';
my @path_h;
while (my $arg = shift) {
if ($arg =~ /^-l/i) {
$extralibs .= "$arg ";
next;
}
last if $extralibs;
}
usage "Must supply header file or module name\n"
my $fmask;
my $tmask;
if ($opt_x) {
eval {require C::Scan; 1}
or die <<EOD;
unless ($tmask_all) {
or die <<EOD;
}
die <<EOD;
}
}
}
my @path_h_ini = @path_h;
if( @path_h ){
my @paths;
my $pre_sub_tri_graphs = 1;
if ($^O eq 'VMS') { # Consider overrides of default location
# XXXX This is not equivalent to what the older version did:
# it was looking at $hadsys header-file per header-file...
}
else {
}
$module ||= do {
$name =~ s/\.h$//;
if ( $name !~ /::/ ) {
$name =~ s#^.*/##;
$name = "\u$name";
}
$name;
};
if( $path_h =~ s#::#/#g && $opt_n ){
warn "Nesting of headerfile ignored with -n\n";
}
# Minor trickery: we can't chdir() before we processed the headers
# (so know the name of the extension), but the header may be in the
# extension directory...
my $tmp_path_h = $path_h;
my $rel_path_h = $path_h;
if (not -f $path_h) {
my $found;
$found++, last
}
if ($found) {
$rel_path_h = $path_h;
} else {
}
}
if (!$opt_c) {
die "Can't find $tmp_path_h in @dirs\n"
if ( ! $opt_f && ! -f "$rel_path_h" );
# Scan the header file (we should deal with nested header files)
# Record the names of simple #define constants into const_names
# Function prototypes are processed below.
while (<CH>) {
if ($pre_sub_tri_graphs) {
# Preprocess all tri-graphs
# including things stuck in quoted string constants.
s/\?\?=/#/g; # | ??=| #|
s/\?\?\!/|/g; # | ??!| ||
s/\?\?'/^/g; # | ??'| ^|
s/\?\?\(/[/g; # | ??(| [|
s/\?\?\)/]/g; # | ??)| ]|
s/\?\?\-/~/g; # | ??-| ~|
s/\?\?\//\\/g; # | ??/| \|
s/\?\?</{/g; # | ??<| {|
s/\?\?>/}/g; # | ??>| }|
}
if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
my $def = $1;
my $rest = $2;
$rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
$rest =~ s/^\s+//;
$rest =~ s/\s+$//;
# Cannot do: (-1) and ((LHANDLE)3) are OK:
#print("Skip non-wordy $def => $rest\n"),
# next defines if $rest =~ /[^\w\$]/;
if ($rest =~ /"/) {
print("Skip stringy $def => $rest\n") if $opt_d;
next defines;
}
print "Matched $_ ($def)\n" if $opt_d;
$_ = $def;
next if /^_.*_h_*$/i; # special case, but for what?
if (defined $opt_p) {
if (!/^$opt_p(\d)/) {
}
else {
warn "can't remove $opt_p prefix from '$_'!\n";
}
}
$prefixless{$def} = $_;
$const_names{$_}++;
}
}
}
close(CH);
}
else {
# Work from miniperl too - on "normal" systems
close CH;
no warnings 'uninitialized';
# Remove C and C++ comments
$src =~ s#/\*[^*]*\*+([^/*][^*]*\*+)*/|("(\\.|[^"\\])*"|'(\\.|[^'\\])*'|.[^/"'\\]*)#$2#gs;
# skip enums matching $opt_e
my $val = 0;
$const_names{$key}++;
}
} # while (...)
} # if (!defined $opt_e or $opt_e)
}
}
}
# Save current directory so that C::Scan can use it
# As Ilya suggested, use a name that contains - and then it can't clash with
# the names of any packages. A directory 'fallback' will clash with any
# new pragmata down the fallback:: tree, but that seems unlikely.
my $constscfname = 'const-c.inc';
my $constsxsfname = 'const-xs.inc';
my $fallbackdirname = 'fallback';
if ($opt_O) {
warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
}
else {
die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
}
chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
my %types_seen;
my %std_types;
my $fdecls = [];
my $fdecls_parsed = [];
my $typedef_rex;
my %typedefs_pre;
my %known_fnames;
my %structs;
my @fnames;
my @fnames_no_prefix;
my %vdecl_hash;
my @vdecls;
if( ! $opt_X ){ # use XS, unless it was disabled
unless ($skip_ppport) {
}
if ($opt_x) {
warn "Scanning typemaps...\n";
get_typemap();
my @td;
my @good_td;
my $c;
my $filter;
$filename = $`;
$filter = $';
}
warn "Scanning $filename for functions...\n";
if ($opt_a) {
}
if ($opt_m) {
@vdecls = sort keys %vdecl_hash;
for (local $_ = 0; $_ < @vdecls; ++$_) {
if (defined $post) {
warn "Can't handle variable '$type $var $post', skipping.\n";
splice @vdecls, $_, 1;
redo;
}
}
}
unless ($tmask_all) {
warn "Scanning $filename for typedefs...\n";
# eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
}
}
{ local $" = '|';
}
if ($fmask) {
my @good;
for my $i (0..$#$fdecls_parsed) {
push @good, $i;
print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
if $opt_d;
}
}
# Sort declarations:
{
my %h = map( ($_->[1], $_), @$fdecls_parsed);
$fdecls_parsed = [ @h{@fnames} ];
}
@fnames_no_prefix = @fnames;
if defined $opt_p;
# Remove macros which expand to typedefs
print "Typedefs are @td.\n" if $opt_d;
# Add some other possible but meaningless values for macros
}
# eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
my $n = 0;
my %bad_macs;
while (keys %td > $n) {
$n = keys %td;
my ($k, $v);
while (($k, $v) = each %seen_define) {
# print("found '$k'=>'$v'\n"),
}
}
# Now %bad_macs contains names of bad macros
for my $k (keys %bad_macs) {
delete $const_names{$prefixless{$k}};
print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
}
}
}
my @const_names = sort keys %const_names;
$" = "\n\t";
warn "Writing $ext$modpname/$modpmname\n";
print PM <<"END";
package $module;
use $compat_version;
END
use strict;
END
# we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
# will want Carp.
print PM <<'END';
use Carp;
END
}
require Exporter;
END
require DynaLoader;
END
# Are we using AutoLoader or not?
unless ($skip_autoloader) { # no autoloader whatsoever.
unless ($opt_c) { # we're doing the AUTOLOAD
print PM "use AutoLoader;\n";
}
else {
print PM "use AutoLoader qw(AUTOLOAD);\n"
}
}
if ( $compat_version < 5.006 ) {
my $vars = '$VERSION @ISA';
print PM "use vars qw($vars);";
}
# Determine @ISA.
my @modISA;
my $myISA = "our \@ISA = qw(@modISA);";
print PM "\n$myISA\n\n";
my $tmp='';
# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# This allows declaration use $module ':all';
# If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
# will save memory.
our %EXPORT_TAGS = ( 'all' => [ qw(
) ] );
our \@EXPORT = qw(
);
END
$tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n";
if ($opt_B) {
$tmp .= "\$VERSION = eval \$VERSION; # see L<perlmodstyle>\n";
}
$tmp .= "\n";
if (@vdecls) {
printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
}
if( ! $opt_X ){ # print bootstrap, unless XS is disabled
if ($use_Dyna) {
$tmp = <<"END";
END
} else {
$tmp = <<"END";
require XSLoader;
END
}
}
# tying the variables can happen only after bootstrap
if (@vdecls) {
printf PM <<END;
{
}
END
}
my $after;
if( $opt_P ){ # if POD is disabled
$after = '__END__';
}
else {
$after = '=cut';
}
print PM <<"END";
# Preloaded methods go here.
END
# Autoload methods go after $after, and are processed by the autosplit program.
END
print PM <<"END";
1;
END
eval {
my $username;
$author =~ s/,.*$//; # in case of sub fields
$domain =~ s/^\.//;
$email = "$username\@$domain";
}
};
$author ||= "A. U. Thor";
$email ||= 'a.u.thor@a.galaxy.far.far.away';
$licence = sprintf << "DEFAULT", $^V;
my $revhist = '';
#
#=head1 HISTORY
#
#=over 8
#
#=item $TEMPLATE_VERSION
#
#Original version; created by h2xs $H2XS_VERSION with options
#
# @ARGS
#
#=back
#
#
#=head2 EXPORT
#
#None by default.
#
if (@const_names and not $opt_P) {
#=head2 Exportable constants
#
# @{[join "\n ", @const_names]}
#
}
#=head2 Exportable functions
#
# $exp_doc .= <<EOD if $opt_p;
#When accessing these functions from Perl, prefix C<$opt_p> should be removed.
#
#EOD
# @{[join "\n ", @known_fnames{@fnames}]}
#
}
my $meth_doc = '';
}
# Prefix the default licence with hash symbols.
# Is this just cargo cult - it seems that the first thing that happens to this
# block is that all the hashes are then s///g out.
my $licence_hash = $licence;
$licence_hash =~ s/^/#/gm;
my $pod;
## Below is stub documentation for your module. You'd better edit it!
#
#=head1 NAME
#
#$module - Perl extension for blah blah blah
#
#=head1 SYNOPSIS
#
# use $module;
# blah blah blah
#
#=head1 DESCRIPTION
#
#Stub documentation for $module, created by h2xs. It looks like the
#author of the extension was negligent enough to leave the stub
#unedited.
#
#Blah blah blah.
#
#=head1 SEE ALSO
#
#Mention other useful documentation such as the documentation of
#related modules or operating system documentation (such as man pages
#in UNIX), or any relevant external documentation such as RFCs or
#standards.
#
#If you have a mailing list set up for your module, mention it here.
#
#If you have a web site set up for your module, mention it here.
#
#=head1 AUTHOR
#
#$author, E<lt>${email}E<gt>
#
#=head1 COPYRIGHT AND LICENSE
#
#
#=cut
END
$pod =~ s/^\#//gm unless $opt_P;
close PM;
if( ! $opt_X ){ # print XS, unless it is disabled
warn "Writing $ext$modpname/$modfname.xs\n";
print XS <<"END";
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"
END
#include "ppport.h"
END
if( @path_h ){
foreach my $path_h (@path_h_ini) {
my($h) = $path_h;
if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
print XS qq{#include <$h>\n};
}
print XS "\n";
}
#define MY_CXT_KEY "${module}::_guts" XS_VERSION
} my_cxt_t;
END
my %pointer_typedefs;
my %struct_typedefs;
sub td_is_pointer {
my $type = shift;
# This converts only the guys which do not have trailing part in the typedef
if (not $out
print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
if $opt_d;
}
}
sub td_is_struct {
my $type = shift;
# This converts only the guys which do not have trailing part in the typedef
if (not $out
print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
if $opt_d;
}
}
if( ! $opt_c ) {
# We write the "sample" files used when this module is built by perl without
# ExtUtils::Constant.
# h2xs will later check that these are the same as those generated by the
# code embedded into Makefile.PL
unless (-d $fallbackdirname) {
mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n";
}
warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n";
warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n";
XS_FILE => $xsfallback,
DEFAULT_TYPE => $opt_t,
NAMES => \@const_names,
);
print XS "#include \"$constscfname\"\n";
}
# Now switch from C to XS by issuing the first MODULE declaration:
print XS <<"END";
END
# If a constant() function was #included then output a corresponding
# XS declaration:
BOOT:
{
*/
}
END
foreach (sort keys %const_xsub) {
print XS <<"END";
char *
$_()
CODE:
#ifdef $_
RETVAL = $_;
#else
croak("Your vendor has not defined the $module macro $_");
#endif
END
}
my %seen_decl;
my %typemap;
sub print_decl {
my $fh = shift;
my $decl = shift;
if ($opt_k) {
}
$numargs--;
}
local $" = ', ';
print $fh <<"EOP";
$type
print $fh <<"EOP";
}
}
sub print_tievar_subs {
print $fh <<END;
dSP;
return (I32)0;
}
dSP;
return (I32)0;
}
END
}
sub print_tievar_xsubs {
print $fh <<END;
CODE:
CODE:
CODE:
END
}
sub print_accessors {
print $fh <<"EOF";
$name *
PROTOTYPE: \$
CODE:
croak("Size \%d of packed data != expected \%d",
}
else
croak("THIS is not of type $name");
$name
new(CLASS)
PROTOTYPE: \$
CODE:
while (@items) {
if (defined $item->[2]) {
push @items, map [
@$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
} else {
}
} else {
print $fh <<"EOF";
PROTOTYPE: \$;\$
CODE:
if (items > 1)
RETVAL = @{[
]};
}
}
}
sub accessor_docs {
my @list;
while (@items) {
if (defined $item->[2]) {
push @items, map [
@$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
} else {
}
} else {
}
}
my $pod = <<"EOF";
#
#=head2 Object and class methods for C<$name>/C<$ptrname>
#
#The principal Perl representation of a C object of type C<$name> is an
#object of class C<$ptrname> which is a reference to an integer
#representation of a C pointer. To create such an object, one may use
#a combination
#
# my \$buffer = $name->new();
# my \$obj = \$buffer->_to_ptr();
#
#This exersizes the following two methods, and an additional class
#C<$name>, the internal representation of which is a reference to a
#packed string with the C structure. Keep in mind that \$buffer should
#better survive longer than \$obj.
#
#=over
#
#=item C<\$object_of_type_$name-E<gt>_to_ptr()>
#
#Converts an object of type C<$name> to an object of type C<$ptrname>.
#
#=item C<$name-E<gt>new()>
#
#Creates an empty object of type C<$name>. The corresponding packed
#string is zeroed out.
#
#=item C<$methods>
#
#return the current value of the corresponding element if called
#without additional arguments. Set the element to the supplied value
#(and return the new value) if called with an additional argument.
#
#Applicable to objects of type C<$ptrname>.
#
#=back
#
$pod =~ s/^\#//gm;
return $pod;
}
# Should be called before any actual call to normalize_type().
sub get_typemap {
# We do not want to read ./typemap by obvios reasons.
my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap";
unshift @tm, $stdtypemap;
# Start with useful default values
next unless -e $typemap ;
# skip directories, binary files etc.
warn " Scanning $typemap\n";
warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
unless -T $typemap ;
or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
my $mode = 'Typemap';
while (<TYPEMAP>) {
next if /^\s*\#/;
elsif ($mode eq 'Typemap') {
next if /^\s*($|\#)/ ;
/^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
# This may reference undefined functions:
}
}
}
close(TYPEMAP) or die "Cannot close $typemap: $!";
}
%std_types = %types_seen;
%types_seen = ();
}
sub normalize_type { # Second arg: do not strip const's before \*
my $type = shift;
my $do_keep_deep_const = shift;
# If $do_keep_deep_const this is heuristical only
my $ignore_mods
= "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately!
}
else {
}
$type =~ s/([^\s\w])/ $1 /g;
$type =~ s/\s+$//;
$type =~ s/^\s+//;
$type =~ s/\s+/ /g;
$type =~ s/\* (?=\*)/*/g;
$type =~ s/\. \. \./.../g;
$type =~ s/ ,/,/g;
$types_seen{$type}++
$type;
}
my $need_opaque;
sub assign_typemap_entry {
my $type = shift;
my $entry;
print "Type $type matches -o mask\n" if $opt_d;
}
print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
}
# XXX good do better if our UV happens to be long long
return $entry;
}
for (@vdecls) {
}
if ($opt_x) {
if ($opt_a) {
}
}
}
close XS;
if (%types_seen) {
my $type;
for $type (sort keys %types_seen) {
}
#############################################################################
croak(\"Size %d of packed data != expected %d\",
}
else
croak(\"$var is not of type ${ntype}\")
#############################################################################
close TM or die "Cannot close typemap file for write: $!";
}
} # if( ! $opt_X )
warn "Writing $ext$modpname/Makefile.PL\n";
my $prereq_pm;
{
}
else
{
$prereq_pm = '';
}
print PL <<"END";
use $compat_version;
# See lib/ExtUtils/MakeMaker.pm for details of how to influence
# the contents of the Makefile that is written.
NAME => '$module',
(\$] >= 5.005 ? ## Add these new keywords supported since 5.005
AUTHOR => '$author <$email>') : ()),
END
if (!$opt_X) { # print C stuff, unless XS is disabled
my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
# Insert -I. if you add *.h files later:
print PL <<END;
END
my $C = grep {$_ ne "$modfname.c"}
(glob '*.c'), (glob '*.cc'), (glob '*.C');
# Un-comment this if you add C files to link with later:
print PL <<END;
END
} # ' # Grr
print PL ");\n";
if (!$opt_c) {
my $generate_code =
XS_FILE => $constsxsfname,
DEFAULT_TYPE => $opt_t,
NAMES => \@const_names,
);
print PL <<"END";
# If you edit these definitions to change the constants used by this module,
# you will need to use the generated $constscfname and $constsxsfname
# files to replace their "fallback" counterparts before distributing your
# changes.
}
else {
}
}
END
eval $generate_code;
if ($@) {
warn <<"EOM";
} else {
my $fail;
warn << "EOM";
$fail++;
}
}
if ($fail) {
} else {
unlink $constscfname, $constsxsfname;
}
}
}
close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
# Create a simple README since this is a CPAN requirement
# and it doesnt hurt to have one
my $rmhead = "$modpname version $TEMPLATE_VERSION";
my $rm_prereq;
{
$rm_prereq = 'Test::More';
}
else
{
$rm_prereq = 'blah blah blah';
}
my $testdir = "t";
my $testfile = "$testdir/$modpname.t";
unless (-d "$testdir") {
mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
}
warn "Writing $ext$modpname/$testfile\n";
# Before `make install' is performed this script should be runnable with
# `make test'. After `make install' it should work as `perl $modpname.t'
#########################
# change 'tests => $tests' to 'tests => last_test_to_print';
my $test_mod = 'Test::More';
{
my $test_mod = 'Test';
use Test;
use $module;
if (@const_names) {
print EX <<'_END_';
my $fail;
foreach my $constname (qw(
print EX (")) {\n");
next if (eval "my \\\$a = \$constname; 1");
print "# pass: \$\@";
} else {
print "# fail: \$\@";
\$fail = 1;
}
}
if (\$fail) {
print "not ok 2\\n";
} else {
print "ok 2\\n";
}
}
}
else
{
BEGIN { use_ok('$module') };
if (@const_names) {
print EX <<'_END_';
my $fail = 0;
foreach my $constname (qw(
print EX (")) {\n");
next if (eval "my \\\$a = \$constname; 1");
print "# pass: \$\@";
} else {
print "# fail: \$\@";
\$fail = 1;
}
}
}
}
#########################
# Insert your test code below, the $test_mod module is use()ed here so read
# its man page ( perldoc $test_mod ) for help writing this test script.
close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
unless ($opt_C) {
$" = ' ';
$TEMPLATE_VERSION @{[scalar localtime]}
\t\t@ARGS
}
if (!@files) {
eval {opendir(D,'.');};
unless ($@) { @files = readdir(D); closedir(D); }
}
if ($^O eq 'VMS') {
foreach (@files) {
# Clip trailing '.' for portability -- non-VMS OSs don't expect it
s%\.$%%;
# Fix up for case-sensitive file systems
$_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
$_ = 'Makefile.PL' if $_ eq 'makefile.pl';
}
}
close MANI;
close OUT or die "Can't close $file: $!";
chdir $origdir;