home *** CD-ROM | disk | FTP | other *** search
/ PC World 2004 November / PCWorld_2004-11_cd.bin / software / topware / activeperl / ActivePerl-5.8.4.810-MSWin32-x86.exe / ActivePerl-5.8.4.810 / Perl / bin / h2xs.bat < prev    next >
DOS Batch File  |  2004-06-01  |  62KB  |  2,183 lines
  1. @rem = '--*-Perl-*--
  2. @echo off
  3. if "%OS%" == "Windows_NT" goto WinNT
  4. perl -x -S "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
  5. goto endofperl
  6. :WinNT
  7. perl -x -S %0 %*
  8. if NOT "%COMSPEC%" == "%SystemRoot%\system32\cmd.exe" goto endofperl
  9. if %errorlevel% == 9009 echo You do not have Perl in your PATH.
  10. if errorlevel 1 goto script_failed_so_exit_with_non_zero_val 2>nul
  11. goto endofperl
  12. @rem ';
  13. #!perl
  14. #line 15
  15.     eval 'exec C:\TEMP\perl--------------------------------please-run-the-install-script--------------------------------\bin\perl.exe -S $0 ${1+"$@"}'
  16.     if $running_under_some_shell;
  17.  
  18. use warnings;
  19.  
  20. =head1 NAME
  21.  
  22. h2xs - convert .h C header files to Perl extensions
  23.  
  24. =head1 SYNOPSIS
  25.  
  26. B<h2xs> [B<OPTIONS> ...] [headerfile ... [extra_libraries]]
  27.  
  28. B<h2xs> B<-h>|B<-?>|B<--help>
  29.  
  30. =head1 DESCRIPTION
  31.  
  32. I<h2xs> builds a Perl extension from C header files.  The extension
  33. will include functions which can be used to retrieve the value of any
  34. #define statement which was in the C header files.
  35.  
  36. The I<module_name> will be used for the name of the extension.  If
  37. module_name is not supplied then the name of the first header file
  38. will be used, with the first character capitalized.
  39.  
  40. If the extension might need extra libraries, they should be included
  41. here.  The extension Makefile.PL will take care of checking whether
  42. the libraries actually exist and how they should be loaded.  The extra
  43. libraries should be specified in the form -lm -lposix, etc, just as on
  44. the cc command line.  By default, the Makefile.PL will search through
  45. the library path determined by Configure.  That path can be augmented
  46. by including arguments of the form B<-L/another/library/path> in the
  47. extra-libraries argument.
  48.  
  49. =head1 OPTIONS
  50.  
  51. =over 5
  52.  
  53. =item B<-A>, B<--omit-autoload>
  54.  
  55. Omit all autoload facilities.  This is the same as B<-c> but also
  56. removes the S<C<use AutoLoader>> statement from the .pm file.
  57.  
  58. =item B<-B>, B<--beta-version>
  59.  
  60. Use an alpha/beta style version number.  Causes version number to
  61. be "0.00_01" unless B<-v> is specified.
  62.  
  63. =item B<-C>, B<--omit-changes>
  64.  
  65. Omits creation of the F<Changes> file, and adds a HISTORY section to
  66. the POD template.
  67.  
  68. =item B<-F>, B<--cpp-flags>=I<addflags>
  69.  
  70. Additional flags to specify to C preprocessor when scanning header for
  71. function declarations.  Writes these options in the generated F<Makefile.PL>
  72. too.
  73.  
  74. =item B<-M>, B<--func-mask>=I<regular expression>
  75.  
  76. selects functions/macros to process.
  77.  
  78. =item B<-O>, B<--overwrite-ok>
  79.  
  80. Allows a pre-existing extension directory to be overwritten.
  81.  
  82. =item B<-P>, B<--omit-pod>
  83.  
  84. Omit the autogenerated stub POD section.
  85.  
  86. =item B<-X>, B<--omit-XS>
  87.  
  88. Omit the XS portion.  Used to generate templates for a module which is not
  89. XS-based.  C<-c> and C<-f> are implicitly enabled.
  90.  
  91. =item B<-a>, B<--gen-accessors>
  92.  
  93. Generate an accessor method for each element of structs and unions. The
  94. generated methods are named after the element name; will return the current
  95. value of the element if called without additional arguments; and will set
  96. the element to the supplied value (and return the new value) if called with
  97. an additional argument. Embedded structures and unions are returned as a
  98. pointer rather than the complete structure, to facilitate chained calls.
  99.  
  100. These methods all apply to the Ptr type for the structure; additionally
  101. two methods are constructed for the structure type itself, C<_to_ptr>
  102. which returns a Ptr type pointing to the same structure, and a C<new>
  103. method to construct and return a new structure, initialised to zeroes.
  104.  
  105. =item B<-b>, B<--compat-version>=I<version>
  106.  
  107. Generates a .pm file which is backwards compatible with the specified
  108. perl version.
  109.  
  110. For versions < 5.6.0, the changes are.
  111.     - no use of 'our' (uses 'use vars' instead)
  112.     - no 'use warnings'
  113.  
  114. Specifying a compatibility version higher than the version of perl you
  115. are using to run h2xs will have no effect.  If unspecified h2xs will default
  116. to compatibility with the version of perl you are using to run h2xs.
  117.  
  118. =item B<-c>, B<--omit-constant>
  119.  
  120. Omit C<constant()> from the .xs file and corresponding specialised
  121. C<AUTOLOAD> from the .pm file.
  122.  
  123. =item B<-d>, B<--debugging>
  124.  
  125. Turn on debugging messages.
  126.  
  127. =item B<-e>, B<--omit-enums>=[I<regular expression>]
  128.  
  129. If I<regular expression> is not given, skip all constants that are defined in
  130. a C enumeration. Otherwise skip only those constants that are defined in an
  131. enum whose name matches I<regular expression>.
  132.  
  133. Since I<regular expression> is optional, make sure that this switch is followed
  134. by at least one other switch if you omit I<regular expression> and have some
  135. pending arguments such as header-file names. This is ok:
  136.  
  137.     h2xs -e -n Module::Foo foo.h
  138.  
  139. This is not ok:
  140.  
  141.     h2xs -n Module::Foo -e foo.h
  142.  
  143. In the latter, foo.h is taken as I<regular expression>.
  144.  
  145. =item B<-f>, B<--force>
  146.  
  147. Allows an extension to be created for a header even if that header is
  148. not found in standard include directories.
  149.  
  150. =item B<-g>, B<--global>
  151.  
  152. Include code for safely storing static data in the .xs file.
  153. Extensions that do no make use of static data can ignore this option.
  154.  
  155. =item B<-h>, B<-?>, B<--help>
  156.  
  157. Print the usage, help and version for this h2xs and exit.
  158.  
  159. =item B<-k>, B<--omit-const-func>
  160.  
  161. For function arguments declared as C<const>, omit the const attribute in the
  162. generated XS code.
  163.  
  164. =item B<-m>, B<--gen-tied-var>
  165.  
  166. B<Experimental>: for each variable declared in the header file(s), declare
  167. a perl variable of the same name magically tied to the C variable.
  168.  
  169. =item B<-n>, B<--name>=I<module_name>
  170.  
  171. Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
  172.  
  173. =item B<-o>, B<--opaque-re>=I<regular expression>
  174.  
  175. Use "opaque" data type for the C types matched by the regular
  176. expression, even if these types are C<typedef>-equivalent to types
  177. from typemaps.  Should not be used without B<-x>.
  178.  
  179. This may be useful since, say, types which are C<typedef>-equivalent
  180. to integers may represent OS-related handles, and one may want to work
  181. with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
  182. Use C<-o .> if you want to handle all the C<typedef>ed types as opaque
  183. types.
  184.  
  185. The type-to-match is whitewashed (except for commas, which have no
  186. whitespace before them, and multiple C<*> which have no whitespace
  187. between them).
  188.  
  189. =item B<-p>, B<--remove-prefix>=I<prefix>
  190.  
  191. Specify a prefix which should be removed from the Perl function names,
  192. e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes
  193. the prefix from functions that are autoloaded via the C<constant()>
  194. mechanism.
  195.  
  196. =item B<-s>, B<--const-subs>=I<sub1,sub2>
  197.  
  198. Create a perl subroutine for the specified macros rather than autoload
  199. with the constant() subroutine.  These macros are assumed to have a
  200. return type of B<char *>, e.g.,
  201. S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
  202.  
  203. =item B<-t>, B<--default-type>=I<type>
  204.  
  205. Specify the internal type that the constant() mechanism uses for macros.
  206. The default is IV (signed integer).  Currently all macros found during the
  207. header scanning process will be assumed to have this type.  Future versions
  208. of C<h2xs> may gain the ability to make educated guesses.
  209.  
  210. =item B<--use-new-tests>
  211.  
  212. When B<--compat-version> (B<-b>) is present the generated tests will use
  213. C<Test::More> rather than C<Test> which is the default for versions before
  214. 5.7.2 .   C<Test::More> will be added to PREREQ_PM in the generated
  215. C<Makefile.PL>.
  216.  
  217. =item B<--use-old-tests>
  218.  
  219. Will force the generation of test code that uses the older C<Test> module.
  220.  
  221. =item B<--skip-exporter>
  222.  
  223. Do not use C<Exporter> and/or export any symbol.
  224.  
  225. =item B<--skip-ppport>
  226.  
  227. Do not use C<Devel::PPPort>: no portability to older version.
  228.  
  229. =item B<--skip-autoloader>
  230.  
  231. Do not use the module C<AutoLoader>; but keep the constant() function
  232. and C<sub AUTOLOAD> for constants.
  233.  
  234. =item B<--skip-strict>
  235.  
  236. Do not use the pragma C<strict>.
  237.  
  238. =item B<--skip-warnings>
  239.  
  240. Do not use the pragma C<warnings>.
  241.  
  242. =item B<-v>, B<--version>=I<version>
  243.  
  244. Specify a version number for this extension.  This version number is added
  245. to the templates.  The default is 0.01, or 0.00_01 if C<-B> is specified.
  246. The version specified should be numeric.
  247.  
  248. =item B<-x>, B<--autogen-xsubs>
  249.  
  250. Automatically generate XSUBs basing on function declarations in the
  251. header file.  The package C<C::Scan> should be installed. If this
  252. option is specified, the name of the header file may look like
  253. C<NAME1,NAME2>. In this case NAME1 is used instead of the specified
  254. string, but XSUBs are emitted only for the declarations included from
  255. file NAME2.
  256.  
  257. Note that some types of arguments/return-values for functions may
  258. result in XSUB-declarations/typemap-entries which need
  259. hand-editing. Such may be objects which cannot be converted from/to a
  260. pointer (like C<long long>), pointers to functions, or arrays.  See
  261. also the section on L<LIMITATIONS of B<-x>>.
  262.  
  263. =back
  264.  
  265. =head1 EXAMPLES
  266.  
  267.  
  268.     # Default behavior, extension is Rusers
  269.     h2xs rpcsvc/rusers
  270.  
  271.     # Same, but extension is RUSERS
  272.     h2xs -n RUSERS rpcsvc/rusers
  273.  
  274.     # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
  275.     h2xs rpcsvc::rusers
  276.  
  277.     # Extension is ONC::RPC.  Still finds <rpcsvc/rusers.h>
  278.     h2xs -n ONC::RPC rpcsvc/rusers
  279.  
  280.     # Without constant() or AUTOLOAD
  281.     h2xs -c rpcsvc/rusers
  282.  
  283.     # Creates templates for an extension named RPC
  284.     h2xs -cfn RPC
  285.  
  286.     # Extension is ONC::RPC.
  287.     h2xs -cfn ONC::RPC
  288.  
  289.     # Extension is Lib::Foo which works at least with Perl5.005_03.
  290.     # Constants are created for all #defines and enums h2xs can find
  291.     # in foo.h.
  292.     h2xs -b 5.5.3 -n Lib::Foo foo.h
  293.  
  294.     # Extension is Lib::Foo which works at least with Perl5.005_03.
  295.     # Constants are created for all #defines but only for enums
  296.     # whose names do not start with 'bar_'.
  297.     h2xs -b 5.5.3 -e '^bar_' -n Lib::Foo foo.h
  298.  
  299.     # Makefile.PL will look for library -lrpc in
  300.     # additional directory /opt/net/lib
  301.     h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
  302.  
  303.     # Extension is DCE::rgynbase
  304.     # prefix "sec_rgy_" is dropped from perl function names
  305.     h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
  306.  
  307.     # Extension is DCE::rgynbase
  308.     # prefix "sec_rgy_" is dropped from perl function names
  309.     # subroutines are created for sec_rgy_wildcard_name and
  310.     # sec_rgy_wildcard_sid
  311.     h2xs -n DCE::rgynbase -p sec_rgy_ \
  312.     -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
  313.  
  314.     # Make XS without defines in perl.h, but with function declarations
  315.     # visible from perl.h. Name of the extension is perl1.
  316.     # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
  317.     # Extra backslashes below because the string is passed to shell.
  318.     # Note that a directory with perl header files would
  319.     #  be added automatically to include path.
  320.     h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
  321.  
  322.     # Same with function declaration in proto.h as visible from perl.h.
  323.     h2xs -xAn perl2 perl.h,proto.h
  324.  
  325.     # Same but select only functions which match /^av_/
  326.     h2xs -M '^av_' -xAn perl2 perl.h,proto.h
  327.  
  328.     # Same but treat SV* etc as "opaque" types
  329.     h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
  330.  
  331. =head2 Extension based on F<.h> and F<.c> files
  332.  
  333. Suppose that you have some C files implementing some functionality,
  334. and the corresponding header files.  How to create an extension which
  335. makes this functionality accessable in Perl?  The example below
  336. assumes that the header files are F<interface_simple.h> and
  337. I<interface_hairy.h>, and you want the perl module be named as
  338. C<Ext::Ension>.  If you need some preprocessor directives and/or
  339. linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
  340. in L<"OPTIONS">.
  341.  
  342. =over
  343.  
  344. =item Find the directory name
  345.  
  346. Start with a dummy run of h2xs:
  347.  
  348.   h2xs -Afn Ext::Ension
  349.  
  350. The only purpose of this step is to create the needed directories, and
  351. let you know the names of these directories.  From the output you can
  352. see that the directory for the extension is F<Ext/Ension>.
  353.  
  354. =item Copy C files
  355.  
  356. Copy your header files and C files to this directory F<Ext/Ension>.
  357.  
  358. =item Create the extension
  359.  
  360. Run h2xs, overwriting older autogenerated files:
  361.  
  362.   h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
  363.  
  364. h2xs looks for header files I<after> changing to the extension
  365. directory, so it will find your header files OK.
  366.  
  367. =item Archive and test
  368.  
  369. As usual, run
  370.  
  371.   cd Ext/Ension
  372.   perl Makefile.PL
  373.   make dist
  374.   make
  375.   make test
  376.  
  377. =item Hints
  378.  
  379. It is important to do C<make dist> as early as possible.  This way you
  380. can easily merge(1) your changes to autogenerated files if you decide
  381. to edit your C<.h> files and rerun h2xs.
  382.  
  383. Do not forget to edit the documentation in the generated F<.pm> file.
  384.  
  385. Consider the autogenerated files as skeletons only, you may invent
  386. better interfaces than what h2xs could guess.
  387.  
  388. Consider this section as a guideline only, some other options of h2xs
  389. may better suit your needs.
  390.  
  391. =back
  392.  
  393. =head1 ENVIRONMENT
  394.  
  395. No environment variables are used.
  396.  
  397. =head1 AUTHOR
  398.  
  399. Larry Wall and others
  400.  
  401. =head1 SEE ALSO
  402.  
  403. L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
  404.  
  405. =head1 DIAGNOSTICS
  406.  
  407. The usual warnings if it cannot read or write the files involved.
  408.  
  409. =head1 LIMITATIONS of B<-x>
  410.  
  411. F<h2xs> would not distinguish whether an argument to a C function
  412. which is of the form, say, C<int *>, is an input, output, or
  413. input/output parameter.  In particular, argument declarations of the
  414. form
  415.  
  416.     int
  417.     foo(n)
  418.     int *n
  419.  
  420. should be better rewritten as
  421.  
  422.     int
  423.     foo(n)
  424.     int &n
  425.  
  426. if C<n> is an input parameter.
  427.  
  428. Additionally, F<h2xs> has no facilities to intuit that a function
  429.  
  430.    int
  431.    foo(addr,l)
  432.     char *addr
  433.     int   l
  434.  
  435. takes a pair of address and length of data at this address, so it is better
  436. to rewrite this function as
  437.  
  438.     int
  439.     foo(sv)
  440.         SV *addr
  441.     PREINIT:
  442.         STRLEN len;
  443.         char *s;
  444.     CODE:
  445.         s = SvPV(sv,len);
  446.         RETVAL = foo(s, len);
  447.     OUTPUT:
  448.         RETVAL
  449.  
  450. or alternately
  451.  
  452.     static int
  453.     my_foo(SV *sv)
  454.     {
  455.     STRLEN len;
  456.     char *s = SvPV(sv,len);
  457.  
  458.     return foo(s, len);
  459.     }
  460.  
  461.     MODULE = foo    PACKAGE = foo    PREFIX = my_
  462.  
  463.     int
  464.     foo(sv)
  465.     SV *sv
  466.  
  467. See L<perlxs> and L<perlxstut> for additional details.
  468.  
  469. =cut
  470.  
  471. # ' # Grr
  472. use strict;
  473.  
  474.  
  475. my( $H2XS_VERSION ) = ' $Revision: 1.23 $ ' =~ /\$Revision:\s+([^\s]+)/;
  476. my $TEMPLATE_VERSION = '0.01';
  477. my @ARGS = @ARGV;
  478. my $compat_version = $];
  479.  
  480. use Getopt::Long;
  481. use Config;
  482. use Text::Wrap;
  483. $Text::Wrap::huge = 'overflow';
  484. $Text::Wrap::columns = 80;
  485. use ExtUtils::Constant qw (WriteConstants WriteMakefileSnippet autoload);
  486. use File::Compare;
  487. use File::Path;
  488.  
  489. sub usage {
  490.     warn "@_\n" if @_;
  491.     die <<EOFUSAGE;
  492. h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
  493. version: $H2XS_VERSION
  494. OPTIONS:
  495.     -A, --omit-autoload   Omit all autoloading facilities (implies -c).
  496.     -B, --beta-version    Use beta \$VERSION of 0.00_01 (ignored if -v).
  497.     -C, --omit-changes    Omit creating the Changes file, add HISTORY heading
  498.                           to stub POD.
  499.     -F, --cpp-flags       Additional flags for C preprocessor/compile.
  500.     -M, --func-mask       Mask to select C functions/macros
  501.                           (default is select all).
  502.     -O, --overwrite-ok    Allow overwriting of a pre-existing extension directory.
  503.     -P, --omit-pod        Omit the stub POD section.
  504.     -X, --omit-XS         Omit the XS portion (implies both -c and -f).
  505.     -a, --gen-accessors   Generate get/set accessors for struct and union members                           (used with -x).
  506.     -b, --compat-version  Specify a perl version to be backwards compatibile with
  507.     -c, --omit-constant   Omit the constant() function and specialised AUTOLOAD
  508.                           from the XS file.
  509.     -d, --debugging       Turn on debugging messages.
  510.     -e, --omit-enums      Omit constants from enums in the constant() function.
  511.                           If a pattern is given, only the matching enums are
  512.                           ignored.
  513.     -f, --force           Force creation of the extension even if the C header
  514.                           does not exist.
  515.     -g, --global          Include code for safely storing static data in the .xs file.
  516.     -h, -?, --help        Display this help message
  517.     -k, --omit-const-func Omit 'const' attribute on function arguments
  518.                           (used with -x).
  519.     -m, --gen-tied-var    Generate tied variables for access to declared
  520.                           variables.
  521.     -n, --name            Specify a name to use for the extension (recommended).
  522.     -o, --opaque-re       Regular expression for \"opaque\" types.
  523.     -p, --remove-prefix   Specify a prefix which should be removed from the
  524.                           Perl function names.
  525.     -s, --const-subs      Create subroutines for specified macros.
  526.     -t, --default-type    Default type for autoloaded constants (default is IV)
  527.         --use-new-tests   Use Test::More in backward compatible modules
  528.         --use-old-tests   Use the module Test rather than Test::More
  529.         --skip-exporter   Do not export symbols
  530.         --skip-ppport     Do not use portability layer
  531.         --skip-autoloader Do not use the module C<AutoLoader>
  532.         --skip-strict     Do not use the pragma C<strict>
  533.         --skip-warnings   Do not use the pragma C<warnings>
  534.     -v, --version         Specify a version number for this extension.
  535.     -x, --autogen-xsubs   Autogenerate XSUBs using C::Scan.
  536.  
  537. extra_libraries
  538.          are any libraries that might be needed for loading the
  539.          extension, e.g. -lm would try to link in the math library.
  540. EOFUSAGE
  541. }
  542.  
  543. my ($opt_A,
  544.     $opt_B,
  545.     $opt_C,
  546.     $opt_F,
  547.     $opt_M,
  548.     $opt_O,
  549.     $opt_P,
  550.     $opt_X,
  551.     $opt_a,
  552.     $opt_c,
  553.     $opt_d,
  554.     $opt_e,
  555.     $opt_f,
  556.     $opt_g,
  557.     $opt_h,
  558.     $opt_k,
  559.     $opt_m,
  560.     $opt_n,
  561.     $opt_o,
  562.     $opt_p,
  563.     $opt_s,
  564.     $opt_v,
  565.     $opt_x,
  566.     $opt_b,
  567.     $opt_t,
  568.     $new_test,
  569.     $old_test,
  570.     $skip_exporter,
  571.     $skip_ppport,
  572.     $skip_autoloader,
  573.     $skip_strict,
  574.     $skip_warnings,
  575.    );
  576.  
  577. Getopt::Long::Configure('bundling');
  578. Getopt::Long::Configure('pass_through');
  579.  
  580. my %options = (
  581.                 'omit-autoload|A'    => \$opt_A,
  582.                 'beta-version|B'     => \$opt_B,
  583.                 'omit-changes|C'     => \$opt_C,
  584.                 'cpp-flags|F=s'      => \$opt_F,
  585.                 'func-mask|M=s'      => \$opt_M,
  586.                 'overwrite_ok|O'     => \$opt_O,
  587.                 'omit-pod|P'         => \$opt_P,
  588.                 'omit-XS|X'          => \$opt_X,
  589.                 'gen-accessors|a'    => \$opt_a,
  590.                 'compat-version|b=s' => \$opt_b,
  591.                 'omit-constant|c'    => \$opt_c,
  592.                 'debugging|d'        => \$opt_d,
  593.                 'omit-enums|e:s'     => \$opt_e,
  594.                 'force|f'            => \$opt_f,
  595.                 'global|g'           => \$opt_g,
  596.                 'help|h|?'           => \$opt_h,
  597.                 'omit-const-func|k'  => \$opt_k,
  598.                 'gen-tied-var|m'     => \$opt_m,
  599.                 'name|n=s'           => \$opt_n,
  600.                 'opaque-re|o=s'      => \$opt_o,
  601.                 'remove-prefix|p=s'  => \$opt_p,
  602.                 'const-subs|s=s'     => \$opt_s,
  603.                 'default-type|t=s'   => \$opt_t,
  604.                 'version|v=s'        => \$opt_v,
  605.                 'autogen-xsubs|x'    => \$opt_x,
  606.                 'use-new-tests'      => \$new_test,
  607.                 'use-old-tests'      => \$old_test,
  608.                 'skip-exporter'      => \$skip_exporter,
  609.                 'skip-ppport'        => \$skip_ppport,
  610.                 'skip-autoloader'    => \$skip_autoloader,
  611.                 'skip-warnings'      => \$skip_warnings,
  612.                 'skip-strict'        => \$skip_strict,
  613.               );
  614.  
  615. GetOptions(%options) || usage;
  616.  
  617. usage if $opt_h;
  618.  
  619. if( $opt_b ){
  620.     usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
  621.     $opt_b =~ /^\d+\.\d+\.\d+/ ||
  622.     usage "You must provide the backwards compatibility version in X.Y.Z form. "
  623.           .  "(i.e. 5.5.0)\n";
  624.     my ($maj,$min,$sub) = split(/\./,$opt_b,3);
  625.     if ($maj < 5 || ($maj == 5 && $min < 6)) {
  626.         $compat_version =
  627.         $sub ? sprintf("%d.%03d%02d",$maj,$min,$sub) :
  628.                sprintf("%d.%03d",    $maj,$min);
  629.     } else {
  630.         $compat_version =
  631.         $sub ? sprintf("%d.%03d%03d",$maj,$min,$sub) :
  632.            sprintf("%d.%03d",    $maj,$min);
  633.     }
  634. } else {
  635.     my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d*)/;
  636.     $sub ||= 0;
  637.     warn sprintf <<'EOF', $maj,$min,$sub;
  638. Defaulting to backwards compatibility with perl %d.%d.%d
  639. If you intend this module to be compatible with earlier perl versions, please
  640. specify a minimum perl version with the -b option.
  641.  
  642. EOF
  643. }
  644.  
  645. if( $opt_B ){
  646.     $TEMPLATE_VERSION = '0.00_01';
  647. }
  648.  
  649. if( $opt_v ){
  650.     $TEMPLATE_VERSION = $opt_v;
  651.  
  652.     # check if it is numeric
  653.     my $temp_version = $TEMPLATE_VERSION;
  654.     my $beta_version = $temp_version =~ s/(\d)_(\d\d)/$1$2/;
  655.     my $notnum;
  656.     {
  657.         local $SIG{__WARN__} = sub { $notnum = 1 };
  658.         use warnings 'numeric';
  659.         $temp_version = 0+$temp_version;
  660.     }
  661.  
  662.     if ($notnum) {
  663.         my $module = $opt_n || 'Your::Module';
  664.         warn <<"EOF";
  665. You have specified a non-numeric version.  Unless you supply an
  666. appropriate VERSION class method, users may not be able to specify a
  667. minimum required version with C<use $module versionnum>.
  668.  
  669. EOF
  670.     }
  671.     else {
  672.         $opt_B = $beta_version;
  673.     }
  674. }
  675.  
  676. # -A implies -c.
  677. $skip_autoloader = $opt_c = 1 if $opt_A;
  678.  
  679. # -X implies -c and -f
  680. $opt_c = $opt_f = 1 if $opt_X;
  681.  
  682. $opt_t ||= 'IV';
  683.  
  684. my %const_xsub;
  685. %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
  686.  
  687. my $extralibs = '';
  688.  
  689. my @path_h;
  690.  
  691. while (my $arg = shift) {
  692.     if ($arg =~ /^-l/i) {
  693.         $extralibs .= "$arg ";
  694.         next;
  695.     }
  696.     last if $extralibs;
  697.     push(@path_h, $arg);
  698. }
  699.  
  700. usage "Must supply header file or module name\n"
  701.         unless (@path_h or $opt_n);
  702.  
  703. my $fmask;
  704. my $tmask;
  705.  
  706. $fmask = qr{$opt_M} if defined $opt_M;
  707. $tmask = qr{$opt_o} if defined $opt_o;
  708. my $tmask_all = $tmask && $opt_o eq '.';
  709.  
  710. if ($opt_x) {
  711.   eval {require C::Scan; 1}
  712.     or die <<EOD;
  713. C::Scan required if you use -x option.
  714. To install C::Scan, execute
  715.    perl -MCPAN -e "install C::Scan"
  716. EOD
  717.   unless ($tmask_all) {
  718.     $C::Scan::VERSION >= 0.70
  719.       or die <<EOD;
  720. C::Scan v. 0.70 or later required unless you use -o . option.
  721. You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
  722. To install C::Scan, execute
  723.    perl -MCPAN -e "install C::Scan"
  724. EOD
  725.   }
  726.   if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
  727.     die <<EOD;
  728. C::Scan v. 0.73 or later required to use -m or -a options.
  729. You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
  730. To install C::Scan, execute
  731.    perl -MCPAN -e "install C::Scan"
  732. EOD
  733.   }
  734. }
  735. elsif ($opt_o or $opt_F) {
  736.   warn <<EOD if $opt_o;
  737. Option -o does not make sense without -x.
  738. EOD
  739.   warn <<EOD if $opt_F and $opt_X ;
  740. Option -F does not make sense with -X.
  741. EOD
  742. }
  743.  
  744. my @path_h_ini = @path_h;
  745. my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
  746.  
  747. my $module = $opt_n;
  748.  
  749. if( @path_h ){
  750.     use File::Spec;
  751.     my @paths;
  752.     my $pre_sub_tri_graphs = 1;
  753.     if ($^O eq 'VMS') {  # Consider overrides of default location
  754.       # XXXX This is not equivalent to what the older version did:
  755.       #        it was looking at $hadsys header-file per header-file...
  756.       my($hadsys) = grep s!^sys/!!i , @path_h;
  757.       @paths = qw( Sys$Library VAXC$Include );
  758.       push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
  759.       push @paths, qw( DECC$Library_Include DECC$System_Include );
  760.     }
  761.     else {
  762.       @paths = (File::Spec->curdir(), $Config{usrinc},
  763.         (split ' ', $Config{locincpth}), '/usr/include');
  764.     }
  765.     foreach my $path_h (@path_h) {
  766.         $name ||= $path_h;
  767.     $module ||= do {
  768.       $name =~ s/\.h$//;
  769.       if ( $name !~ /::/ ) {
  770.     $name =~ s#^.*/##;
  771.     $name = "\u$name";
  772.       }
  773.       $name;
  774.     };
  775.  
  776.     if( $path_h =~ s#::#/#g && $opt_n ){
  777.     warn "Nesting of headerfile ignored with -n\n";
  778.     }
  779.     $path_h .= ".h" unless $path_h =~ /\.h$/;
  780.     my $fullpath = $path_h;
  781.     $path_h =~ s/,.*$// if $opt_x;
  782.     $fullpath{$path_h} = $fullpath;
  783.  
  784.     # Minor trickery: we can't chdir() before we processed the headers
  785.     # (so know the name of the extension), but the header may be in the
  786.     # extension directory...
  787.     my $tmp_path_h = $path_h;
  788.     my $rel_path_h = $path_h;
  789.     my @dirs = @paths;
  790.     if (not -f $path_h) {
  791.       my $found;
  792.       for my $dir (@paths) {
  793.     $found++, last
  794.       if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
  795.       }
  796.       if ($found) {
  797.     $rel_path_h = $path_h;
  798.     $fullpath{$path_h} = $fullpath;
  799.       } else {
  800.     (my $epath = $module) =~ s,::,/,g;
  801.     $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
  802.     $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
  803.     $path_h = $tmp_path_h;    # Used during -x
  804.     push @dirs, $epath;
  805.       }
  806.     }
  807.  
  808.     if (!$opt_c) {
  809.       die "Can't find $tmp_path_h in @dirs\n"
  810.     if ( ! $opt_f && ! -f "$rel_path_h" );
  811.       # Scan the header file (we should deal with nested header files)
  812.       # Record the names of simple #define constants into const_names
  813.             # Function prototypes are processed below.
  814.       open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
  815.     defines:
  816.       while (<CH>) {
  817.     if ($pre_sub_tri_graphs) {
  818.         # Preprocess all tri-graphs
  819.         # including things stuck in quoted string constants.
  820.         s/\?\?=/#/g;                         # | ??=|  #|
  821.         s/\?\?\!/|/g;                        # | ??!|  ||
  822.         s/\?\?'/^/g;                         # | ??'|  ^|
  823.         s/\?\?\(/[/g;                        # | ??(|  [|
  824.         s/\?\?\)/]/g;                        # | ??)|  ]|
  825.         s/\?\?\-/~/g;                        # | ??-|  ~|
  826.         s/\?\?\//\\/g;                       # | ??/|  \|
  827.         s/\?\?</{/g;                         # | ??<|  {|
  828.         s/\?\?>/}/g;                         # | ??>|  }|
  829.     }
  830.     if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
  831.         my $def = $1;
  832.         my $rest = $2;
  833.         $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
  834.         $rest =~ s/^\s+//;
  835.         $rest =~ s/\s+$//;
  836.         # Cannot do: (-1) and ((LHANDLE)3) are OK:
  837.         #print("Skip non-wordy $def => $rest\n"),
  838.         #  next defines if $rest =~ /[^\w\$]/;
  839.         if ($rest =~ /"/) {
  840.           print("Skip stringy $def => $rest\n") if $opt_d;
  841.           next defines;
  842.         }
  843.         print "Matched $_ ($def)\n" if $opt_d;
  844.         $seen_define{$def} = $rest;
  845.         $_ = $def;
  846.         next if /^_.*_h_*$/i; # special case, but for what?
  847.         if (defined $opt_p) {
  848.           if (!/^$opt_p(\d)/) {
  849.         ++$prefix{$_} if s/^$opt_p//;
  850.           }
  851.           else {
  852.         warn "can't remove $opt_p prefix from '$_'!\n";
  853.           }
  854.         }
  855.         $prefixless{$def} = $_;
  856.         if (!$fmask or /$fmask/) {
  857.         print "... Passes mask of -M.\n" if $opt_d and $fmask;
  858.         $const_names{$_}++;
  859.         }
  860.       }
  861.       }
  862.       if (defined $opt_e and !$opt_e) {
  863.         close(CH);
  864.       }
  865.       else {
  866.     # Work from miniperl too - on "normal" systems
  867.         my $SEEK_SET = eval 'use Fcntl qw/SEEK_SET/; SEEK_SET' or 0;
  868.         seek CH, 0, $SEEK_SET;
  869.         my $src = do { local $/; <CH> };
  870.         close CH;
  871.         no warnings 'uninitialized';
  872.  
  873.         # Remove C and C++ comments
  874.         $src =~ s#/\*[^*]*\*+([^/*][^*]*\*+)*/|("(\\.|[^"\\])*"|'(\\.|[^'\\])*'|.[^/"'\\]*)#$2#gs;
  875.  
  876.         while ($src =~ /(\benum\s*([\w_]*)\s*\{\s([\s\w=,]+)\})/gsc) {
  877.             my ($enum_name, $enum_body) =
  878.                 $1 =~ /enum\s*([\w_]*)\s*\{\s([\s\w=,]+)\}/gs;
  879.             # skip enums matching $opt_e
  880.             next if $opt_e && $enum_name =~ /$opt_e/;
  881.             my $val = 0;
  882.             for my $item (split /,/, $enum_body) {
  883.                 my ($key, $declared_val) = $item =~ /(\w*)\s*=\s*(.*)/;
  884.                 $val = length($declared_val) ? $declared_val : 1 + $val;
  885.                 $seen_define{$key} = $declared_val;
  886.                 $const_names{$key}++;
  887.             }
  888.         } # while (...)
  889.       } # if (!defined $opt_e or $opt_e)
  890.     }
  891.     }
  892. }
  893.  
  894. # Save current directory so that C::Scan can use it
  895. my $cwd = File::Spec->rel2abs( File::Spec->curdir );
  896.  
  897. # As Ilya suggested, use a name that contains - and then it can't clash with
  898. # the names of any packages. A directory 'fallback' will clash with any
  899. # new pragmata down the fallback:: tree, but that seems unlikely.
  900. my $constscfname = 'const-c.inc';
  901. my $constsxsfname = 'const-xs.inc';
  902. my $fallbackdirname = 'fallback';
  903.  
  904. my $ext = chdir 'ext' ? 'ext/' : '';
  905.  
  906. my @modparts  = split(/::/,$module);
  907. my $modpname  = join('-', @modparts);
  908. my $modfname  = pop @modparts;
  909. my $modpmdir  = join '/', 'lib', @modparts;
  910. my $modpmname = join '/', $modpmdir, $modfname.'.pm';
  911.  
  912. if ($opt_O) {
  913.     warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
  914. }
  915. else {
  916.     die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
  917. }
  918. -d "$modpname"   || mkpath([$modpname], 0, 0775);
  919. chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
  920.  
  921. my %types_seen;
  922. my %std_types;
  923. my $fdecls = [];
  924. my $fdecls_parsed = [];
  925. my $typedef_rex;
  926. my %typedefs_pre;
  927. my %known_fnames;
  928. my %structs;
  929.  
  930. my @fnames;
  931. my @fnames_no_prefix;
  932. my %vdecl_hash;
  933. my @vdecls;
  934.  
  935. if( ! $opt_X ){  # use XS, unless it was disabled
  936.   unless ($skip_ppport) {
  937.     require Devel::PPPort;
  938.     warn "Writing $ext$modpname/ppport.h\n";
  939.     Devel::PPPort::WriteFile('ppport.h')
  940.         || die "Can't create $ext$modpname/ppport.h: $!\n";
  941.   }
  942.   open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
  943.   if ($opt_x) {
  944.     warn "Scanning typemaps...\n";
  945.     get_typemap();
  946.     my @td;
  947.     my @good_td;
  948.     my $addflags = $opt_F || '';
  949.  
  950.     foreach my $filename (@path_h) {
  951.       my $c;
  952.       my $filter;
  953.  
  954.       if ($fullpath{$filename} =~ /,/) {
  955.     $filename = $`;
  956.     $filter = $';
  957.       }
  958.       warn "Scanning $filename for functions...\n";
  959.       my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X);
  960.       $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
  961.     'add_cppflags' => $addflags, 'c_styles' => \@styles;
  962.       $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]);
  963.  
  964.       push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
  965.       push(@$fdecls, @{$c->get('fdecls')});
  966.  
  967.       push @td, @{$c->get('typedefs_maybe')};
  968.       if ($opt_a) {
  969.     my $structs = $c->get('typedef_structs');
  970.     @structs{keys %$structs} = values %$structs;
  971.       }
  972.  
  973.       if ($opt_m) {
  974.     %vdecl_hash = %{ $c->get('vdecl_hash') };
  975.     @vdecls = sort keys %vdecl_hash;
  976.     for (local $_ = 0; $_ < @vdecls; ++$_) {
  977.       my $var = $vdecls[$_];
  978.       my($type, $post) = @{ $vdecl_hash{$var} };
  979.       if (defined $post) {
  980.         warn "Can't handle variable '$type $var $post', skipping.\n";
  981.         splice @vdecls, $_, 1;
  982.         redo;
  983.       }
  984.       $type = normalize_type($type);
  985.       $vdecl_hash{$var} = $type;
  986.     }
  987.       }
  988.  
  989.       unless ($tmask_all) {
  990.     warn "Scanning $filename for typedefs...\n";
  991.     my $td = $c->get('typedef_hash');
  992.     # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
  993.     my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
  994.     push @good_td, @f_good_td;
  995.     @typedefs_pre{@f_good_td}  = map $_->[0], @$td{@f_good_td};
  996.       }
  997.     }
  998.     { local $" = '|';
  999.       $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
  1000.     }
  1001.     %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
  1002.     if ($fmask) {
  1003.       my @good;
  1004.       for my $i (0..$#$fdecls_parsed) {
  1005.     next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
  1006.     push @good, $i;
  1007.     print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
  1008.       if $opt_d;
  1009.       }
  1010.       $fdecls = [@$fdecls[@good]];
  1011.       $fdecls_parsed = [@$fdecls_parsed[@good]];
  1012.     }
  1013.     @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
  1014.     # Sort declarations:
  1015.     {
  1016.       my %h = map( ($_->[1], $_), @$fdecls_parsed);
  1017.       $fdecls_parsed = [ @h{@fnames} ];
  1018.     }
  1019.     @fnames_no_prefix = @fnames;
  1020.     @fnames_no_prefix
  1021.       = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix
  1022.          if defined $opt_p;
  1023.     # Remove macros which expand to typedefs
  1024.     print "Typedefs are @td.\n" if $opt_d;
  1025.     my %td = map {($_, $_)} @td;
  1026.     # Add some other possible but meaningless values for macros
  1027.     for my $k (qw(char double float int long short unsigned signed void)) {
  1028.       $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
  1029.     }
  1030.     # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
  1031.     my $n = 0;
  1032.     my %bad_macs;
  1033.     while (keys %td > $n) {
  1034.       $n = keys %td;
  1035.       my ($k, $v);
  1036.       while (($k, $v) = each %seen_define) {
  1037.     # print("found '$k'=>'$v'\n"),
  1038.     $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
  1039.       }
  1040.     }
  1041.     # Now %bad_macs contains names of bad macros
  1042.     for my $k (keys %bad_macs) {
  1043.       delete $const_names{$prefixless{$k}};
  1044.       print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
  1045.     }
  1046.   }
  1047. }
  1048. my @const_names = sort keys %const_names;
  1049.  
  1050. -d $modpmdir || mkpath([$modpmdir], 0, 0775);
  1051. open(PM, ">$modpmname") || die "Can't create $ext$modpname/$modpmname: $!\n";
  1052.  
  1053. $" = "\n\t";
  1054. warn "Writing $ext$modpname/$modpmname\n";
  1055.  
  1056. print PM <<"END";
  1057. package $module;
  1058.  
  1059. use $compat_version;
  1060. END
  1061.  
  1062. print PM <<"END" unless $skip_strict;
  1063. use strict;
  1064. END
  1065.  
  1066. print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006;
  1067.  
  1068. unless( $opt_X || $opt_c || $opt_A ){
  1069.     # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
  1070.     # will want Carp.
  1071.     print PM <<'END';
  1072. use Carp;
  1073. END
  1074. }
  1075.  
  1076. print PM <<'END' unless $skip_exporter;
  1077.  
  1078. require Exporter;
  1079. END
  1080.  
  1081. my $use_Dyna = (not $opt_X and $compat_version < 5.006);
  1082. print PM <<"END" if $use_Dyna;  # use DynaLoader, unless XS was disabled
  1083. require DynaLoader;
  1084. END
  1085.  
  1086.  
  1087. # Are we using AutoLoader or not?
  1088. unless ($skip_autoloader) { # no autoloader whatsoever.
  1089.     unless ($opt_c) { # we're doing the AUTOLOAD
  1090.         print PM "use AutoLoader;\n";
  1091.     }
  1092.     else {
  1093.         print PM "use AutoLoader qw(AUTOLOAD);\n"
  1094.     }
  1095. }
  1096.  
  1097. if ( $compat_version < 5.006 ) {
  1098.     my $vars = '$VERSION @ISA';
  1099.     $vars .= ' @EXPORT @EXPORT_OK %EXPORT_TAGS' unless $skip_exporter;
  1100.     $vars .= ' $AUTOLOAD' unless $opt_X || $opt_c || $opt_A;
  1101.     $vars .= ' $XS_VERSION' if $opt_B && !$opt_X;
  1102.     print PM "use vars qw($vars);";
  1103. }
  1104.  
  1105. # Determine @ISA.
  1106. my @modISA;
  1107. push @modISA, 'Exporter'    unless $skip_exporter;
  1108. push @modISA, 'DynaLoader'     if $use_Dyna;  # no XS
  1109. my $myISA = "our \@ISA = qw(@modISA);";
  1110. $myISA =~ s/^our // if $compat_version < 5.006;
  1111.  
  1112. print PM "\n$myISA\n\n";
  1113.  
  1114. my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
  1115.  
  1116. my $tmp='';
  1117. $tmp .= <<"END" unless $skip_exporter;
  1118. # Items to export into callers namespace by default. Note: do not export
  1119. # names by default without a very good reason. Use EXPORT_OK instead.
  1120. # Do not simply export all your public functions/methods/constants.
  1121.  
  1122. # This allows declaration    use $module ':all';
  1123. # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
  1124. # will save memory.
  1125. our %EXPORT_TAGS = ( 'all' => [ qw(
  1126.     @exported_names
  1127. ) ] );
  1128.  
  1129. our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
  1130.  
  1131. our \@EXPORT = qw(
  1132.     @const_names
  1133. );
  1134.  
  1135. END
  1136.  
  1137. $tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n";
  1138. if ($opt_B) {
  1139.     $tmp .= "our \$XS_VERSION = \$VERSION;\n" unless $opt_X;
  1140.     $tmp .= "\$VERSION = eval \$VERSION;  # see L<perlmodstyle>\n";
  1141. }
  1142. $tmp .= "\n";
  1143.  
  1144. $tmp =~ s/^our //mg if $compat_version < 5.006;
  1145. print PM $tmp;
  1146.  
  1147. if (@vdecls) {
  1148.     printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
  1149. }
  1150.  
  1151.  
  1152. print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
  1153.  
  1154. if( ! $opt_X ){ # print bootstrap, unless XS is disabled
  1155.   if ($use_Dyna) {
  1156.     $tmp = <<"END";
  1157. bootstrap $module \$VERSION;
  1158. END
  1159.   } else {
  1160.     $tmp = <<"END";
  1161. require XSLoader;
  1162. XSLoader::load('$module', \$VERSION);
  1163. END
  1164.   }
  1165.   $tmp =~ s:\$VERSION:\$XS_VERSION:g if $opt_B;
  1166.   print PM $tmp;
  1167. }
  1168.  
  1169. # tying the variables can happen only after bootstrap
  1170. if (@vdecls) {
  1171.     printf PM <<END;
  1172. {
  1173. @{[ join "\n", map "    _tievar_$_(\$$_);", @vdecls ]}
  1174. }
  1175.  
  1176. END
  1177. }
  1178.  
  1179. my $after;
  1180. if( $opt_P ){ # if POD is disabled
  1181.     $after = '__END__';
  1182. }
  1183. else {
  1184.     $after = '=cut';
  1185. }
  1186.  
  1187. print PM <<"END";
  1188.  
  1189. # Preloaded methods go here.
  1190. END
  1191.  
  1192. print PM <<"END" unless $opt_A;
  1193.  
  1194. # Autoload methods go after $after, and are processed by the autosplit program.
  1195. END
  1196.  
  1197. print PM <<"END";
  1198.  
  1199. 1;
  1200. __END__
  1201. END
  1202.  
  1203. my ($email,$author,$licence);
  1204.  
  1205. eval {
  1206.        my $username;
  1207.        ($username,$author) = (getpwuid($>))[0,6];
  1208.        if (defined $username && defined $author) {
  1209.        $author =~ s/,.*$//; # in case of sub fields
  1210.        my $domain = $Config{'mydomain'};
  1211.        $domain =~ s/^\.//;
  1212.        $email = "$username\@$domain";
  1213.        }
  1214.      };
  1215.  
  1216. $author ||= "A. U. Thor";
  1217. $email  ||= 'a.u.thor@a.galaxy.far.far.away';
  1218.  
  1219. $licence = sprintf << "DEFAULT", $^V;
  1220. Copyright (C) ${\(1900 + (localtime) [5])} by $author
  1221.  
  1222. This library is free software; you can redistribute it and/or modify
  1223. it under the same terms as Perl itself, either Perl version %vd or,
  1224. at your option, any later version of Perl 5 you may have available.
  1225. DEFAULT
  1226.  
  1227. my $revhist = '';
  1228. $revhist = <<EOT if $opt_C;
  1229. #
  1230. #=head1 HISTORY
  1231. #
  1232. #=over 8
  1233. #
  1234. #=item $TEMPLATE_VERSION
  1235. #
  1236. #Original version; created by h2xs $H2XS_VERSION with options
  1237. #
  1238. #  @ARGS
  1239. #
  1240. #=back
  1241. #
  1242. EOT
  1243.  
  1244. my $exp_doc = $skip_exporter ? '' : <<EOD;
  1245. #
  1246. #=head2 EXPORT
  1247. #
  1248. #None by default.
  1249. #
  1250. EOD
  1251.  
  1252. if (@const_names and not $opt_P) {
  1253.   $exp_doc .= <<EOD unless $skip_exporter;
  1254. #=head2 Exportable constants
  1255. #
  1256. #  @{[join "\n  ", @const_names]}
  1257. #
  1258. EOD
  1259. }
  1260.  
  1261. if (defined $fdecls and @$fdecls and not $opt_P) {
  1262.   $exp_doc .= <<EOD unless $skip_exporter;
  1263. #=head2 Exportable functions
  1264. #
  1265. EOD
  1266.  
  1267. #  $exp_doc .= <<EOD if $opt_p;
  1268. #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
  1269. #
  1270. #EOD
  1271.   $exp_doc .= <<EOD unless $skip_exporter;
  1272. #  @{[join "\n  ", @known_fnames{@fnames}]}
  1273. #
  1274. EOD
  1275. }
  1276.  
  1277. my $meth_doc = '';
  1278.  
  1279. if ($opt_x && $opt_a) {
  1280.   my($name, $struct);
  1281.   $meth_doc .= accessor_docs($name, $struct)
  1282.     while ($name, $struct) = each %structs;
  1283. }
  1284.  
  1285. # Prefix the default licence with hash symbols.
  1286. # Is this just cargo cult - it seems that the first thing that happens to this
  1287. # block is that all the hashes are then s///g out.
  1288. my $licence_hash = $licence;
  1289. $licence_hash =~ s/^/#/gm;
  1290.  
  1291. my $pod;
  1292. $pod = <<"END" unless $opt_P;
  1293. ## Below is stub documentation for your module. You'd better edit it!
  1294. #
  1295. #=head1 NAME
  1296. #
  1297. #$module - Perl extension for blah blah blah
  1298. #
  1299. #=head1 SYNOPSIS
  1300. #
  1301. #  use $module;
  1302. #  blah blah blah
  1303. #
  1304. #=head1 DESCRIPTION
  1305. #
  1306. #Stub documentation for $module, created by h2xs. It looks like the
  1307. #author of the extension was negligent enough to leave the stub
  1308. #unedited.
  1309. #
  1310. #Blah blah blah.
  1311. $exp_doc$meth_doc$revhist
  1312. #
  1313. #=head1 SEE ALSO
  1314. #
  1315. #Mention other useful documentation such as the documentation of
  1316. #related modules or operating system documentation (such as man pages
  1317. #in UNIX), or any relevant external documentation such as RFCs or
  1318. #standards.
  1319. #
  1320. #If you have a mailing list set up for your module, mention it here.
  1321. #
  1322. #If you have a web site set up for your module, mention it here.
  1323. #
  1324. #=head1 AUTHOR
  1325. #
  1326. #$author, E<lt>${email}E<gt>
  1327. #
  1328. #=head1 COPYRIGHT AND LICENSE
  1329. #
  1330. $licence_hash
  1331. #
  1332. #=cut
  1333. END
  1334.  
  1335. $pod =~ s/^\#//gm unless $opt_P;
  1336. print PM $pod unless $opt_P;
  1337.  
  1338. close PM;
  1339.  
  1340.  
  1341. if( ! $opt_X ){ # print XS, unless it is disabled
  1342. warn "Writing $ext$modpname/$modfname.xs\n";
  1343.  
  1344. print XS <<"END";
  1345. #include "EXTERN.h"
  1346. #include "perl.h"
  1347. #include "XSUB.h"
  1348.  
  1349. END
  1350.  
  1351. print XS <<"END" unless $skip_ppport;
  1352. #include "ppport.h"
  1353.  
  1354. END
  1355.  
  1356. if( @path_h ){
  1357.     foreach my $path_h (@path_h_ini) {
  1358.     my($h) = $path_h;
  1359.     $h =~ s#^/usr/include/##;
  1360.     if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
  1361.         print XS qq{#include <$h>\n};
  1362.     }
  1363.     print XS "\n";
  1364. }
  1365.  
  1366. print XS <<"END" if $opt_g;
  1367.  
  1368. /* Global Data */
  1369.  
  1370. #define MY_CXT_KEY "${module}::_guts" XS_VERSION
  1371.  
  1372. typedef struct {
  1373.     /* Put Global Data in here */
  1374.     int dummy;        /* you can access this elsewhere as MY_CXT.dummy */
  1375. } my_cxt_t;
  1376.  
  1377. START_MY_CXT
  1378.  
  1379. END
  1380.  
  1381. my %pointer_typedefs;
  1382. my %struct_typedefs;
  1383.  
  1384. sub td_is_pointer {
  1385.   my $type = shift;
  1386.   my $out = $pointer_typedefs{$type};
  1387.   return $out if defined $out;
  1388.   my $otype = $type;
  1389.   $out = ($type =~ /\*$/);
  1390.   # This converts only the guys which do not have trailing part in the typedef
  1391.   if (not $out
  1392.       and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1393.     $type = normalize_type($type);
  1394.     print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
  1395.       if $opt_d;
  1396.     $out = td_is_pointer($type);
  1397.   }
  1398.   return ($pointer_typedefs{$otype} = $out);
  1399. }
  1400.  
  1401. sub td_is_struct {
  1402.   my $type = shift;
  1403.   my $out = $struct_typedefs{$type};
  1404.   return $out if defined $out;
  1405.   my $otype = $type;
  1406.   $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
  1407.   # This converts only the guys which do not have trailing part in the typedef
  1408.   if (not $out
  1409.       and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1410.     $type = normalize_type($type);
  1411.     print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
  1412.       if $opt_d;
  1413.     $out = td_is_struct($type);
  1414.   }
  1415.   return ($struct_typedefs{$otype} = $out);
  1416. }
  1417.  
  1418. print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
  1419.  
  1420. if( ! $opt_c ) {
  1421.   # We write the "sample" files used when this module is built by perl without
  1422.   # ExtUtils::Constant.
  1423.   # h2xs will later check that these are the same as those generated by the
  1424.   # code embedded into Makefile.PL
  1425.   unless (-d $fallbackdirname) {
  1426.     mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n";
  1427.   }
  1428.   warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n";
  1429.   warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n";
  1430.   my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname);
  1431.   my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname);
  1432.   WriteConstants ( C_FILE =>       $cfallback,
  1433.                    XS_FILE =>      $xsfallback,
  1434.                    DEFAULT_TYPE => $opt_t,
  1435.                    NAME =>         $module,
  1436.                    NAMES =>        \@const_names,
  1437.                  );
  1438.   print XS "#include \"$constscfname\"\n";
  1439. }
  1440.  
  1441.  
  1442. my $prefix = defined $opt_p ? "PREFIX = $opt_p" : '';
  1443.  
  1444. # Now switch from C to XS by issuing the first MODULE declaration:
  1445. print XS <<"END";
  1446.  
  1447. MODULE = $module        PACKAGE = $module        $prefix
  1448.  
  1449. END
  1450.  
  1451. # If a constant() function was #included then output a corresponding
  1452. # XS declaration:
  1453. print XS "INCLUDE: $constsxsfname\n" unless $opt_c;
  1454.  
  1455. print XS <<"END" if $opt_g;
  1456.  
  1457. BOOT:
  1458. {
  1459.     MY_CXT_INIT;
  1460.     /* If any of the fields in the my_cxt_t struct need
  1461.        to be initialised, do it here.
  1462.      */
  1463. }
  1464.  
  1465. END
  1466.  
  1467. foreach (sort keys %const_xsub) {
  1468.     print XS <<"END";
  1469. char *
  1470. $_()
  1471.  
  1472.     CODE:
  1473. #ifdef $_
  1474.     RETVAL = $_;
  1475. #else
  1476.     croak("Your vendor has not defined the $module macro $_");
  1477. #endif
  1478.  
  1479.     OUTPUT:
  1480.     RETVAL
  1481.  
  1482. END
  1483. }
  1484.  
  1485. my %seen_decl;
  1486. my %typemap;
  1487.  
  1488. sub print_decl {
  1489.   my $fh = shift;
  1490.   my $decl = shift;
  1491.   my ($type, $name, $args) = @$decl;
  1492.   return if $seen_decl{$name}++; # Need to do the same for docs as well?
  1493.  
  1494.   my @argnames = map {$_->[1]} @$args;
  1495.   my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
  1496.   if ($opt_k) {
  1497.     s/^\s*const\b\s*// for @argtypes;
  1498.   }
  1499.   my @argarrays = map { $_->[4] || '' } @$args;
  1500.   my $numargs = @$args;
  1501.   if ($numargs and $argtypes[-1] eq '...') {
  1502.     $numargs--;
  1503.     $argnames[-1] = '...';
  1504.   }
  1505.   local $" = ', ';
  1506.   $type = normalize_type($type, 1);
  1507.  
  1508.   print $fh <<"EOP";
  1509.  
  1510. $type
  1511. $name(@argnames)
  1512. EOP
  1513.  
  1514.   for my $arg (0 .. $numargs - 1) {
  1515.     print $fh <<"EOP";
  1516.     $argtypes[$arg]    $argnames[$arg]$argarrays[$arg]
  1517. EOP
  1518.   }
  1519. }
  1520.  
  1521. sub print_tievar_subs {
  1522.   my($fh, $name, $type) = @_;
  1523.   print $fh <<END;
  1524. I32
  1525. _get_$name(IV index, SV *sv) {
  1526.     dSP;
  1527.     PUSHMARK(SP);
  1528.     XPUSHs(sv);
  1529.     PUTBACK;
  1530.     (void)call_pv("$module\::_get_$name", G_DISCARD);
  1531.     return (I32)0;
  1532. }
  1533.  
  1534. I32
  1535. _set_$name(IV index, SV *sv) {
  1536.     dSP;
  1537.     PUSHMARK(SP);
  1538.     XPUSHs(sv);
  1539.     PUTBACK;
  1540.     (void)call_pv("$module\::_set_$name", G_DISCARD);
  1541.     return (I32)0;
  1542. }
  1543.  
  1544. END
  1545. }
  1546.  
  1547. sub print_tievar_xsubs {
  1548.   my($fh, $name, $type) = @_;
  1549.   print $fh <<END;
  1550. void
  1551. _tievar_$name(sv)
  1552.     SV* sv
  1553.     PREINIT:
  1554.     struct ufuncs uf;
  1555.     CODE:
  1556.     uf.uf_val = &_get_$name;
  1557.     uf.uf_set = &_set_$name;
  1558.     uf.uf_index = (IV)&_get_$name;
  1559.     sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
  1560.  
  1561. void
  1562. _get_$name(THIS)
  1563.     $type THIS = NO_INIT
  1564.     CODE:
  1565.     THIS = $name;
  1566.     OUTPUT:
  1567.     SETMAGIC: DISABLE
  1568.     THIS
  1569.  
  1570. void
  1571. _set_$name(THIS)
  1572.     $type THIS
  1573.     CODE:
  1574.     $name = THIS;
  1575.  
  1576. END
  1577. }
  1578.  
  1579. sub print_accessors {
  1580.   my($fh, $name, $struct) = @_;
  1581.   return unless defined $struct && $name !~ /\s|_ANON/;
  1582.   $name = normalize_type($name);
  1583.   my $ptrname = normalize_type("$name *");
  1584.   print $fh <<"EOF";
  1585.  
  1586. MODULE = $module        PACKAGE = ${name}        $prefix
  1587.  
  1588. $name *
  1589. _to_ptr(THIS)
  1590.     $name THIS = NO_INIT
  1591.     PROTOTYPE: \$
  1592.     CODE:
  1593.     if (sv_derived_from(ST(0), "$name")) {
  1594.         STRLEN len;
  1595.         char *s = SvPV((SV*)SvRV(ST(0)), len);
  1596.         if (len != sizeof(THIS))
  1597.         croak("Size \%d of packed data != expected \%d",
  1598.             len, sizeof(THIS));
  1599.         RETVAL = ($name *)s;
  1600.     }
  1601.     else
  1602.         croak("THIS is not of type $name");
  1603.     OUTPUT:
  1604.     RETVAL
  1605.  
  1606. $name
  1607. new(CLASS)
  1608.     char *CLASS = NO_INIT
  1609.     PROTOTYPE: \$
  1610.     CODE:
  1611.     Zero((void*)&RETVAL, sizeof(RETVAL), char);
  1612.     OUTPUT:
  1613.     RETVAL
  1614.  
  1615. MODULE = $module        PACKAGE = ${name}Ptr        $prefix
  1616.  
  1617. EOF
  1618.   my @items = @$struct;
  1619.   while (@items) {
  1620.     my $item = shift @items;
  1621.     if ($item->[0] =~ /_ANON/) {
  1622.       if (defined $item->[2]) {
  1623.     push @items, map [
  1624.       @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
  1625.     ], @{ $structs{$item->[0]} };
  1626.       } else {
  1627.     push @items, @{ $structs{$item->[0]} };
  1628.       }
  1629.     } else {
  1630.       my $type = normalize_type($item->[0]);
  1631.       my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
  1632.       print $fh <<"EOF";
  1633. $ttype
  1634. $item->[2](THIS, __value = NO_INIT)
  1635.     $ptrname THIS
  1636.     $type __value
  1637.     PROTOTYPE: \$;\$
  1638.     CODE:
  1639.     if (items > 1)
  1640.         THIS->$item->[-1] = __value;
  1641.     RETVAL = @{[
  1642.         $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
  1643.     ]};
  1644.     OUTPUT:
  1645.     RETVAL
  1646.  
  1647. EOF
  1648.     }
  1649.   }
  1650. }
  1651.  
  1652. sub accessor_docs {
  1653.   my($name, $struct) = @_;
  1654.   return unless defined $struct && $name !~ /\s|_ANON/;
  1655.   $name = normalize_type($name);
  1656.   my $ptrname = $name . 'Ptr';
  1657.   my @items = @$struct;
  1658.   my @list;
  1659.   while (@items) {
  1660.     my $item = shift @items;
  1661.     if ($item->[0] =~ /_ANON/) {
  1662.       if (defined $item->[2]) {
  1663.     push @items, map [
  1664.       @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
  1665.     ], @{ $structs{$item->[0]} };
  1666.       } else {
  1667.     push @items, @{ $structs{$item->[0]} };
  1668.       }
  1669.     } else {
  1670.       push @list, $item->[2];
  1671.     }
  1672.   }
  1673.   my $methods = (join '(...)>, C<', @list) . '(...)';
  1674.  
  1675.   my $pod = <<"EOF";
  1676. #
  1677. #=head2 Object and class methods for C<$name>/C<$ptrname>
  1678. #
  1679. #The principal Perl representation of a C object of type C<$name> is an
  1680. #object of class C<$ptrname> which is a reference to an integer
  1681. #representation of a C pointer.  To create such an object, one may use
  1682. #a combination
  1683. #
  1684. #  my \$buffer = $name->new();
  1685. #  my \$obj = \$buffer->_to_ptr();
  1686. #
  1687. #This exersizes the following two methods, and an additional class
  1688. #C<$name>, the internal representation of which is a reference to a
  1689. #packed string with the C structure.  Keep in mind that \$buffer should
  1690. #better survive longer than \$obj.
  1691. #
  1692. #=over
  1693. #
  1694. #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
  1695. #
  1696. #Converts an object of type C<$name> to an object of type C<$ptrname>.
  1697. #
  1698. #=item C<$name-E<gt>new()>
  1699. #
  1700. #Creates an empty object of type C<$name>.  The corresponding packed
  1701. #string is zeroed out.
  1702. #
  1703. #=item C<$methods>
  1704. #
  1705. #return the current value of the corresponding element if called
  1706. #without additional arguments.  Set the element to the supplied value
  1707. #(and return the new value) if called with an additional argument.
  1708. #
  1709. #Applicable to objects of type C<$ptrname>.
  1710. #
  1711. #=back
  1712. #
  1713. EOF
  1714.   $pod =~ s/^\#//gm;
  1715.   return $pod;
  1716. }
  1717.  
  1718. # Should be called before any actual call to normalize_type().
  1719. sub get_typemap {
  1720.   # We do not want to read ./typemap by obvios reasons.
  1721.   my @tm =  qw(../../../typemap ../../typemap ../typemap);
  1722.   my $stdtypemap =  "$Config::Config{privlib}/ExtUtils/typemap";
  1723.   unshift @tm, $stdtypemap;
  1724.   my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
  1725.  
  1726.   # Start with useful default values
  1727.   $typemap{float} = 'T_NV';
  1728.  
  1729.   foreach my $typemap (@tm) {
  1730.     next unless -e $typemap ;
  1731.     # skip directories, binary files etc.
  1732.     warn " Scanning $typemap\n";
  1733.     warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
  1734.       unless -T $typemap ;
  1735.     open(TYPEMAP, $typemap)
  1736.       or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
  1737.     my $mode = 'Typemap';
  1738.     while (<TYPEMAP>) {
  1739.       next if /^\s*\#/;
  1740.       if (/^INPUT\s*$/)   { $mode = 'Input'; next; }
  1741.       elsif (/^OUTPUT\s*$/)  { $mode = 'Output'; next; }
  1742.       elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
  1743.       elsif ($mode eq 'Typemap') {
  1744.     next if /^\s*($|\#)/ ;
  1745.     my ($type, $image);
  1746.     if ( ($type, $image) =
  1747.          /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
  1748.          # This may reference undefined functions:
  1749.          and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
  1750.       $typemap{normalize_type($type)} = $image;
  1751.     }
  1752.       }
  1753.     }
  1754.     close(TYPEMAP) or die "Cannot close $typemap: $!";
  1755.   }
  1756.   %std_types = %types_seen;
  1757.   %types_seen = ();
  1758. }
  1759.  
  1760.  
  1761. sub normalize_type {        # Second arg: do not strip const's before \*
  1762.   my $type = shift;
  1763.   my $do_keep_deep_const = shift;
  1764.   # If $do_keep_deep_const this is heuristical only
  1765.   my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
  1766.   my $ignore_mods
  1767.     = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
  1768.   if ($do_keep_deep_const) {    # Keep different compiled /RExen/o separately!
  1769.     $type =~ s/$ignore_mods//go;
  1770.   }
  1771.   else {
  1772.     $type =~ s/$ignore_mods//go;
  1773.   }
  1774.   $type =~ s/([^\s\w])/ $1 /g;
  1775.   $type =~ s/\s+$//;
  1776.   $type =~ s/^\s+//;
  1777.   $type =~ s/\s+/ /g;
  1778.   $type =~ s/\* (?=\*)/*/g;
  1779.   $type =~ s/\. \. \./.../g;
  1780.   $type =~ s/ ,/,/g;
  1781.   $types_seen{$type}++
  1782.     unless $type eq '...' or $type eq 'void' or $std_types{$type};
  1783.   $type;
  1784. }
  1785.  
  1786. my $need_opaque;
  1787.  
  1788. sub assign_typemap_entry {
  1789.   my $type = shift;
  1790.   my $otype = $type;
  1791.   my $entry;
  1792.   if ($tmask and $type =~ /$tmask/) {
  1793.     print "Type $type matches -o mask\n" if $opt_d;
  1794.     $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
  1795.   }
  1796.   elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1797.     $type = normalize_type $type;
  1798.     print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
  1799.     $entry = assign_typemap_entry($type);
  1800.   }
  1801.   # XXX good do better if our UV happens to be long long
  1802.   return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/;
  1803.   $entry ||= $typemap{$otype}
  1804.     || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
  1805.   $typemap{$otype} = $entry;
  1806.   $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
  1807.   return $entry;
  1808. }
  1809.  
  1810. for (@vdecls) {
  1811.   print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
  1812. }
  1813.  
  1814. if ($opt_x) {
  1815.   for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
  1816.   if ($opt_a) {
  1817.     while (my($name, $struct) = each %structs) {
  1818.       print_accessors(\*XS, $name, $struct);
  1819.     }
  1820.   }
  1821. }
  1822.  
  1823. close XS;
  1824.  
  1825. if (%types_seen) {
  1826.   my $type;
  1827.   warn "Writing $ext$modpname/typemap\n";
  1828.   open TM, ">typemap" or die "Cannot open typemap file for write: $!";
  1829.  
  1830.   for $type (sort keys %types_seen) {
  1831.     my $entry = assign_typemap_entry $type;
  1832.     print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
  1833.   }
  1834.  
  1835.   print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
  1836. #############################################################################
  1837. INPUT
  1838. T_OPAQUE_STRUCT
  1839.     if (sv_derived_from($arg, \"${ntype}\")) {
  1840.         STRLEN len;
  1841.         char  *s = SvPV((SV*)SvRV($arg), len);
  1842.  
  1843.         if (len != sizeof($var))
  1844.         croak(\"Size %d of packed data != expected %d\",
  1845.             len, sizeof($var));
  1846.         $var = *($type *)s;
  1847.     }
  1848.     else
  1849.         croak(\"$var is not of type ${ntype}\")
  1850. #############################################################################
  1851. OUTPUT
  1852. T_OPAQUE_STRUCT
  1853.     sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
  1854. EOP
  1855.  
  1856.   close TM or die "Cannot close typemap file for write: $!";
  1857. }
  1858.  
  1859. } # if( ! $opt_X )
  1860.  
  1861. warn "Writing $ext$modpname/Makefile.PL\n";
  1862. open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
  1863.  
  1864. my $prereq_pm;
  1865.  
  1866. if ( $compat_version < 5.00702 and $new_test )
  1867. {
  1868.   $prereq_pm = q%'Test::More'  =>  0%;
  1869. }
  1870. else
  1871. {
  1872.   $prereq_pm = '';
  1873. }
  1874.  
  1875. print PL <<"END";
  1876. use $compat_version;
  1877. use ExtUtils::MakeMaker;
  1878. # See lib/ExtUtils/MakeMaker.pm for details of how to influence
  1879. # the contents of the Makefile that is written.
  1880. WriteMakefile(
  1881.     NAME              => '$module',
  1882.     VERSION_FROM      => '$modpmname', # finds \$VERSION
  1883.     PREREQ_PM         => {$prereq_pm}, # e.g., Module::Name => 1.1
  1884.     (\$] >= 5.005 ?     ## Add these new keywords supported since 5.005
  1885.       (ABSTRACT_FROM  => '$modpmname', # retrieve abstract from module
  1886.        AUTHOR         => '$author <$email>') : ()),
  1887. END
  1888. if (!$opt_X) { # print C stuff, unless XS is disabled
  1889.   $opt_F = '' unless defined $opt_F;
  1890.   my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
  1891.   my $Ihelp = ($I ? '-I. ' : '');
  1892.   my $Icomment = ($I ? '' : <<EOC);
  1893.     # Insert -I. if you add *.h files later:
  1894. EOC
  1895.  
  1896.   print PL <<END;
  1897.     LIBS              => ['$extralibs'], # e.g., '-lm'
  1898.     DEFINE            => '$opt_F', # e.g., '-DHAVE_SOMETHING'
  1899. $Icomment    INC               => '$I', # e.g., '${Ihelp}-I/usr/include/other'
  1900. END
  1901.  
  1902.   my $C = grep {$_ ne "$modfname.c"}
  1903.     (glob '*.c'), (glob '*.cc'), (glob '*.C');
  1904.   my $Cpre = ($C ? '' : '# ');
  1905.   my $Ccomment = ($C ? '' : <<EOC);
  1906.     # Un-comment this if you add C files to link with later:
  1907. EOC
  1908.  
  1909.   print PL <<END;
  1910. $Ccomment    ${Cpre}OBJECT            => '\$(O_FILES)', # link all the C files too
  1911. END
  1912. } # ' # Grr
  1913. print PL ");\n";
  1914. if (!$opt_c) {
  1915.   my $generate_code =
  1916.     WriteMakefileSnippet ( C_FILE =>       $constscfname,
  1917.                            XS_FILE =>      $constsxsfname,
  1918.                            DEFAULT_TYPE => $opt_t,
  1919.                            NAME =>         $module,
  1920.                            NAMES =>        \@const_names,
  1921.                  );
  1922.   print PL <<"END";
  1923. if  (eval {require ExtUtils::Constant; 1}) {
  1924.   # If you edit these definitions to change the constants used by this module,
  1925.   # you will need to use the generated $constscfname and $constsxsfname
  1926.   # files to replace their "fallback" counterparts before distributing your
  1927.   # changes.
  1928. $generate_code
  1929. }
  1930. else {
  1931.   use File::Copy;
  1932.   use File::Spec;
  1933.   foreach my \$file ('$constscfname', '$constsxsfname') {
  1934.     my \$fallback = File::Spec->catfile('$fallbackdirname', \$file);
  1935.     copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!";
  1936.   }
  1937. }
  1938. END
  1939.  
  1940.   eval $generate_code;
  1941.   if ($@) {
  1942.     warn <<"EOM";
  1943. Attempting to test constant code in $ext$modpname/Makefile.PL:
  1944. $generate_code
  1945. __END__
  1946. gave unexpected error $@
  1947. Please report the circumstances of this bug in h2xs version $H2XS_VERSION
  1948. using the perlbug script.
  1949. EOM
  1950.   } else {
  1951.     my $fail;
  1952.  
  1953.     foreach my $file ($constscfname, $constsxsfname) {
  1954.       my $fallback = File::Spec->catfile($fallbackdirname, $file);
  1955.       if (compare($file, $fallback)) {
  1956.         warn << "EOM";
  1957. Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ.
  1958. EOM
  1959.         $fail++;
  1960.       }
  1961.     }
  1962.     if ($fail) {
  1963.       warn fill ('','', <<"EOM") . "\n";
  1964. It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
  1965. the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname
  1966. correctly.
  1967.  
  1968. Please report the circumstances of this bug in h2xs version $H2XS_VERSION
  1969. using the perlbug script.
  1970. EOM
  1971.     } else {
  1972.       unlink $constscfname, $constsxsfname;
  1973.     }
  1974.   }
  1975. }
  1976. close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
  1977.  
  1978. # Create a simple README since this is a CPAN requirement
  1979. # and it doesnt hurt to have one
  1980. warn "Writing $ext$modpname/README\n";
  1981. open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
  1982. my $thisyear = (gmtime)[5] + 1900;
  1983. my $rmhead = "$modpname version $TEMPLATE_VERSION";
  1984. my $rmheadeq = "=" x length($rmhead);
  1985.  
  1986. my $rm_prereq;
  1987.  
  1988. if ( $compat_version < 5.00702 and $new_test )
  1989. {
  1990.    $rm_prereq = 'Test::More';
  1991. }
  1992. else
  1993. {
  1994.    $rm_prereq = 'blah blah blah';
  1995. }
  1996.  
  1997. print RM <<_RMEND_;
  1998. $rmhead
  1999. $rmheadeq
  2000.  
  2001. The README is used to introduce the module and provide instructions on
  2002. how to install the module, any machine dependencies it may have (for
  2003. example C compilers and installed libraries) and any other information
  2004. that should be provided before the module is installed.
  2005.  
  2006. A README file is required for CPAN modules since CPAN extracts the
  2007. README file from a module distribution so that people browsing the
  2008. archive can use it get an idea of the modules uses. It is usually a
  2009. good idea to provide version information here so that people can
  2010. decide whether fixes for the module are worth downloading.
  2011.  
  2012. INSTALLATION
  2013.  
  2014. To install this module type the following:
  2015.  
  2016.    perl Makefile.PL
  2017.    make
  2018.    make test
  2019.    make install
  2020.  
  2021. DEPENDENCIES
  2022.  
  2023. This module requires these other modules and libraries:
  2024.  
  2025.   $rm_prereq
  2026.  
  2027. COPYRIGHT AND LICENCE
  2028.  
  2029. Put the correct copyright and licence information here.
  2030.  
  2031. $licence
  2032.  
  2033. _RMEND_
  2034. close(RM) || die "Can't close $ext$modpname/README: $!\n";
  2035.  
  2036. my $testdir  = "t";
  2037. my $testfile = "$testdir/$modpname.t";
  2038. unless (-d "$testdir") {
  2039.   mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n";
  2040. }
  2041. warn "Writing $ext$modpname/$testfile\n";
  2042. my $tests = @const_names ? 2 : 1;
  2043.  
  2044. open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n";
  2045.  
  2046. print EX <<_END_;
  2047. # Before `make install' is performed this script should be runnable with
  2048. # `make test'. After `make install' it should work as `perl $modpname.t'
  2049.  
  2050. #########################
  2051.  
  2052. # change 'tests => $tests' to 'tests => last_test_to_print';
  2053.  
  2054. _END_
  2055.  
  2056. my $test_mod = 'Test::More';
  2057.  
  2058. if ( $old_test or ($compat_version < 5.007 and not $new_test ))
  2059. {
  2060.   my $test_mod = 'Test';
  2061.  
  2062.   print EX <<_END_;
  2063. use Test;
  2064. BEGIN { plan tests => $tests };
  2065. use $module;
  2066. ok(1); # If we made it this far, we're ok.
  2067.  
  2068. _END_
  2069.  
  2070.    if (@const_names) {
  2071.      my $const_names = join " ", @const_names;
  2072.      print EX <<'_END_';
  2073.  
  2074. my $fail;
  2075. foreach my $constname (qw(
  2076. _END_
  2077.  
  2078.      print EX wrap ("\t", "\t", $const_names);
  2079.      print EX (")) {\n");
  2080.  
  2081.      print EX <<_END_;
  2082.   next if (eval "my \\\$a = \$constname; 1");
  2083.   if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
  2084.     print "# pass: \$\@";
  2085.   } else {
  2086.     print "# fail: \$\@";
  2087.     \$fail = 1;
  2088.   }
  2089. }
  2090. if (\$fail) {
  2091.   print "not ok 2\\n";
  2092. } else {
  2093.   print "ok 2\\n";
  2094. }
  2095.  
  2096. _END_
  2097.   }
  2098. }
  2099. else
  2100. {
  2101.   print EX <<_END_;
  2102. use Test::More tests => $tests;
  2103. BEGIN { use_ok('$module') };
  2104.  
  2105. _END_
  2106.  
  2107.    if (@const_names) {
  2108.      my $const_names = join " ", @const_names;
  2109.      print EX <<'_END_';
  2110.  
  2111. my $fail = 0;
  2112. foreach my $constname (qw(
  2113. _END_
  2114.  
  2115.      print EX wrap ("\t", "\t", $const_names);
  2116.      print EX (")) {\n");
  2117.  
  2118.      print EX <<_END_;
  2119.   next if (eval "my \\\$a = \$constname; 1");
  2120.   if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) {
  2121.     print "# pass: \$\@";
  2122.   } else {
  2123.     print "# fail: \$\@";
  2124.     \$fail = 1;
  2125.   }
  2126.  
  2127. }
  2128.  
  2129. ok( \$fail == 0 , 'Constants' );
  2130. _END_
  2131.   }
  2132. }
  2133.  
  2134. print EX <<_END_;
  2135. #########################
  2136.  
  2137. # Insert your test code below, the $test_mod module is use()ed here so read
  2138. # its man page ( perldoc $test_mod ) for help writing this test script.
  2139.  
  2140. _END_
  2141.  
  2142. close(EX) || die "Can't close $ext$modpname/$testfile: $!\n";
  2143.  
  2144. unless ($opt_C) {
  2145.   warn "Writing $ext$modpname/Changes\n";
  2146.   $" = ' ';
  2147.   open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
  2148.   @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
  2149.   print EX <<EOP;
  2150. Revision history for Perl extension $module.
  2151.  
  2152. $TEMPLATE_VERSION  @{[scalar localtime]}
  2153. \t- original version; created by h2xs $H2XS_VERSION with options
  2154. \t\t@ARGS
  2155.  
  2156. EOP
  2157.   close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
  2158. }
  2159.  
  2160. warn "Writing $ext$modpname/MANIFEST\n";
  2161. open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
  2162. my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>, <$modpmdir/*>);
  2163. if (!@files) {
  2164.   eval {opendir(D,'.');};
  2165.   unless ($@) { @files = readdir(D); closedir(D); }
  2166. }
  2167. if (!@files) { @files = map {chomp && $_} `ls`; }
  2168. if ($^O eq 'VMS') {
  2169.   foreach (@files) {
  2170.     # Clip trailing '.' for portability -- non-VMS OSs don't expect it
  2171.     s%\.$%%;
  2172.     # Fix up for case-sensitive file systems
  2173.     s/$modfname/$modfname/i && next;
  2174.     $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
  2175.     $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
  2176.   }
  2177. }
  2178. print MANI join("\n",@files), "\n";
  2179. close MANI;
  2180.  
  2181. __END__
  2182. :endofperl
  2183.