develooper Front page | perl.perl5.porters | Postings from July 2001

[PATCH h2xs.PL] use Getopt::Long (was Re: [PATCH] h2xs)

Thread Previous | Thread Next
From:
Jonathan Stowe
Date:
July 14, 2001 02:13
Subject:
[PATCH h2xs.PL] use Getopt::Long (was Re: [PATCH] h2xs)
Message ID:
Pine.LNX.4.33.0107141008350.9915-100000@orpheus.gellyfish.com
I didnt see any objections to the proposal, so here, to ease the option
famine in h2xs, is the patch, including the suggestions from Johan Vromans
and Abigail :

--- utils/h2xs.PL~	Sat Jul 14 10:04:50 2001
+++ utils/h2xs.PL	Sat Jul 14 10:05:28 2001
@@ -70,39 +70,39 @@

 =over 5

-=item B<-A>
+=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<-C>
+=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> I<addflags>
+=item B<-F>, B<--cpp-flags>=I<addflags>

 Additional flags to specify to C preprocessor when scanning header for
 function declarations.  Should not be used without B<-x>.

-=item B<-M> I<regular expression>
+=item B<-M>, B<--func-mask>=I<regular expression>

 selects functions/macros to process.

-=item B<-O>
+=item B<-O>, B<--overwrite-ok>

 Allows a pre-existing extension directory to be overwritten.

-=item B<-P>
+=item B<-P>, B<--omit-pod>

 Omit the autogenerated stub POD section.

-=item B<-X>
+=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>
+=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
@@ -116,7 +116,7 @@
 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> I<version>
+=item B<-b>, B<--compat-version>=I<version>

 Generates a .pm file which is backwards compatible with the specified
 perl version.
@@ -128,39 +128,39 @@
 Specifying a compatibility version higher than the version of perl you
 are using to run h2xs will have no effect.

-=item B<-c>
+=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>
+=item B<-d>, B<--debugging>

 Turn on debugging messages.

-=item B<-f>
+=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<-h>
+=item B<-h>, B<-?>, B<--help>

 Print the usage, help and version for this h2xs and exit.

-=item B<-k>
+=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>
+=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> I<module_name>
+=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> I<regular expression>
+=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
@@ -176,33 +176,33 @@
 whitespace before them, and multiple C<*> which have no whitespace
 between them).

-=item B<-p> I<prefix>
+=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> I<sub1,sub2>
+=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> I<type>
+=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<-v> I<version>
+=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.

-=item B<-x>
+=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
@@ -422,7 +422,7 @@
 my @ARGS = @ARGV;
 my $compat_version = $];

-use Getopt::Std;
+use Getopt::Long;
 use Config;
 use Text::Wrap;
 $Text::Wrap::huge = 'overflow';
@@ -432,41 +432,97 @@
 sub usage {
     warn "@_\n" if @_;
     die <<EOFUSAGE;
-h2xs [-ACOPXacdfhkmx] [-F addflags] [-M fmask] [-n module_name] [-o tmask] [-p prefix] [-s subs] [-v version] [-b compat_version ] [headerfile [extra_libraries]]
+h2xs [OPTIONS ... ] [headerfile [extra_libraries]]
 version: $H2XS_VERSION
-    -A   Omit all autoloading facilities (implies -c).
-    -C   Omit creating the Changes file, add HISTORY heading to stub POD.
-    -F   Additional flags for C preprocessor (used with -x).
-    -M   Mask to select C functions/macros (default is select all).
-    -O   Allow overwriting of a pre-existing extension directory.
-    -P   Omit the stub POD section.
-    -X   Omit the XS portion (implies both -c and -f).
-    -a   Generate get/set accessors for struct and union members (used with -x).
-    -b   Specify a perl version to be backwards compatibile with
-    -c   Omit the constant() function and specialised AUTOLOAD from the XS file.
-    -d   Turn on debugging messages.
-    -f   Force creation of the extension even if the C header does not exist.
-    -h   Display this help message
-    -k   Omit 'const' attribute on function arguments (used with -x).
-    -m   Generate tied variables for access to declared variables.
-    -n   Specify a name to use for the extension (recommended).
-    -o   Regular expression for \"opaque\" types.
-    -p   Specify a prefix which should be removed from the Perl function names.
-    -s   Create subroutines for specified macros.
-    -t   Default type for autoloaded constants
-    -v   Specify a version number for this extension.
-    -x   Autogenerate XSUBs using C::Scan.
+OPTIONS:
+    -A, --omit-autoload   Omit all autoloading facilities (implies -c).
+    -C, --omit-changes    Omit creating the Changes file, add HISTORY heading
+                          to stub POD.
+    -F, --cpp-flags       Additional flags for C preprocessor (used with -x).
+    -M, --func-mask       Mask to select C functions/macros
+                          (default is select all).
+    -O, --overwrite-ok    Allow overwriting of a pre-existing extension directory.
+    -P, --omit-pod        Omit the stub POD section.
+    -X, --omit-XS         Omit the XS portion (implies both -c and -f).
+    -a, --gen-accessors   Generate get/set accessors for struct and union members                           (used with -x).
+    -b, --compat-version  Specify a perl version to be backwards compatibile with
+    -c, --omit-constant   Omit the constant() function and specialised AUTOLOAD
+                          from the XS file.
+    -d, --debugging       Turn on debugging messages.
+    -f, --force           Force creation of the extension even if the C header
+                          does not exist.
+    -h, -?, --help        Display this help message
+    -k, --omit-const-func Omit 'const' attribute on function arguments
+                          (used with -x).
+    -m, --gen-tied-var    Generate tied variables for access to declared
+                          variables.
+    -n, --name            Specify a name to use for the extension (recommended).
+    -o, --opaque-re       Regular expression for \"opaque\" types.
+    -p, --remove-prefix   Specify a prefix which should be removed from the
+                          Perl function names.
+    -s, --const-subs      Create subroutines for specified macros.
+    -t, --default-type    Default type for autoloaded constants
+    -v, --version         Specify a version number for this extension.
+    -x, --autogen-xsubs   Autogenerate XSUBs using C::Scan.
+
 extra_libraries
          are any libraries that might be needed for loading the
          extension, e.g. -lm would try to link in the math library.
 EOFUSAGE
 }

+my ($opt_A,
+    $opt_C,
+    $opt_F,
+    $opt_M,
+    $opt_O,
+    $opt_P,
+    $opt_X,
+    $opt_a,
+    $opt_c,
+    $opt_d,
+    $opt_f,
+    $opt_h,
+    $opt_k,
+    $opt_m,
+    $opt_n,
+    $opt_o,
+    $opt_p,
+    $opt_s,
+    $opt_v,
+    $opt_x,
+    $opt_b,
+    $opt_t
+   );
+
+Getopt::Long::Configure('bundling');
+
+my %options = (
+                'omit-autoload|A'    => \$opt_A,
+                '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,
+                'force|f'            => \$opt_f,
+                '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=s'  => \$opt_x
+              );

-getopts("ACF:M:OPXacdfhkmn:o:p:s:v:xb:t:") || usage;
-use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_a $opt_c
-            $opt_d $opt_f $opt_h $opt_k $opt_m $opt_n $opt_o $opt_p $opt_s
-            $opt_v $opt_x $opt_b $opt_t);
+GetOptions(%options) || usage;

 usage if $opt_h;



/J\
-- 
Jonathan Stowe                      |
<http://www.gellyfish.com>          |      This space for rent
                                    |


Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About