Flag the VMS-problem-causing part of :encoding
[p5sagit/p5-mst-13.2.git] / utils / h2xs.PL
index b8b91e8..b35d769 100644 (file)
@@ -83,7 +83,8 @@ the POD template.
 =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>.
+function declarations.  Writes these options in the generated F<Makefile.PL>
+too.
 
 =item B<-M>, B<--func-mask>=I<regular expression>
 
@@ -126,7 +127,8 @@ For versions < 5.6.0, the changes are.
     - no 'use warnings'
 
 Specifying a compatibility version higher than the version of perl you
-are using to run h2xs will have no effect.
+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>
 
@@ -142,6 +144,11 @@ Turn on debugging messages.
 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.
@@ -208,6 +215,27 @@ C<Makefile.PL>.
 
 Will force the generation of test code that uses the older C<Test> module.
 
+=item B<--skip-exporter>
+
+Do not use C<Exporter> and/or export any symbol.
+
+=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
@@ -451,7 +479,7 @@ 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).
+    -F, --cpp-flags       Additional flags for C preprocessor/compile.
     -M, --func-mask       Mask to select C functions/macros
                           (default is select all).
     -O, --overwrite-ok    Allow overwriting of a pre-existing extension directory.
@@ -464,6 +492,7 @@ OPTIONS:
     -d, --debugging       Turn on debugging messages.
     -f, --force           Force creation of the extension even if the C header
                           does not exist.
+    -g, --global          Include code for safely storing static data in the .xs file. 
     -h, -?, --help        Display this help message
     -k, --omit-const-func Omit 'const' attribute on function arguments
                           (used with -x).
@@ -477,6 +506,11 @@ OPTIONS:
     -t, --default-type    Default type for autoloaded constants (default is IV)
         --use-new-tests   Use Test::More in backward compatible modules
         --use-old-tests   Use the module Test rather than Test::More
+        --skip-exporter   Do not export symbols
+        --skip-ppport     Do not use portability layer
+        --skip-autoloader Do not use the module C<AutoLoader>
+        --skip-strict     Do not use the pragma C<strict>
+        --skip-warnings   Do not use the pragma C<warnings>
     -v, --version         Specify a version number for this extension.
     -x, --autogen-xsubs   Autogenerate XSUBs using C::Scan.
 
@@ -497,6 +531,7 @@ my ($opt_A,
     $opt_c,
     $opt_d,
     $opt_f,
+    $opt_g,
     $opt_h,
     $opt_k,
     $opt_m,
@@ -509,7 +544,12 @@ my ($opt_A,
     $opt_b,
     $opt_t,
     $new_test,
-    $old_test
+    $old_test,
+    $skip_exporter,
+    $skip_ppport,
+    $skip_autoloader,
+    $skip_strict,
+    $skip_warnings,
    );
 
 Getopt::Long::Configure('bundling');
@@ -527,6 +567,7 @@ my %options = (
                 'omit-constant|c'    => \$opt_c,
                 'debugging|d'        => \$opt_d,
                 'force|f'            => \$opt_f,
+                'global|g'           => \$opt_g,
                 'help|h|?'           => \$opt_h,
                 'omit-const-func|k'  => \$opt_k,
                 'gen-tied-var|m'     => \$opt_m,
@@ -536,9 +577,14 @@ my %options = (
                 'const-subs|s=s'     => \$opt_s,
                 'default-type|t=s'   => \$opt_t,
                 'version|v=s'        => \$opt_v,
-                'autogen-xsubs|x=s'  => \$opt_x,
+                'autogen-xsubs|x'    => \$opt_x,
                 'use-new-tests'      => \$new_test,
-                'use-old-tests'      => \$old_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,
               );
 
 GetOptions(%options) || usage;
@@ -551,15 +597,27 @@ if( $opt_b ){
     usage "You must provide the backwards compatibility version in X.Y.Z form. "
           .  "(i.e. 5.5.0)\n";
     my ($maj,$min,$sub) = split(/\./,$opt_b,3);
-    $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
-} 
+    if ($maj < 5 || ($maj == 5 && $min < 6)) {
+        $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
+    } else {
+        $compat_version = sprintf("%d.%03d%03d",$maj,$min,$sub);
+    }
+} else {
+    my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d\d\d?)/;
+    warn sprintf <<'EOF', $maj,$min,$sub;
+Defaulting to backwards compatibility with perl %d.%d.%d
+If you intend this module to be compatible with earlier perl versions, please
+specify a minimum perl version with the -b option.
+
+EOF
+}
 
 if( $opt_v ){
        $TEMPLATE_VERSION = $opt_v;
 }
 
 # -A implies -c.
-$opt_c = 1 if $opt_A;
+$skip_autoloader = $opt_c = 1 if $opt_A;
 
 # -X implies -c and -f
 $opt_c = $opt_f = 1 if $opt_X;
@@ -616,8 +674,11 @@ EOD
   }
 }
 elsif ($opt_o or $opt_F) {
-  warn <<EOD;
-Options -o and -F do not make sense without -x.
+  warn <<EOD if $opt_o;
+Option -o does not make sense without -x.
+EOD
+  warn <<EOD if $opt_F and $opt_X ;
+Option -F does not make sense with -X.
 EOD
 }
 
@@ -627,7 +688,6 @@ my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
 my $module = $opt_n;
 
 if( @path_h ){
-    use Config;
     use File::Spec;
     my @paths;
     my $pre_sub_tri_graphs = 1;
@@ -676,6 +736,7 @@ if( @path_h ){
       }
       if ($found) {
        $rel_path_h = $path_h;
+       $fullpath{$path_h} = $fullpath;
       } else {
        (my $epath = $module) =~ s,::,/,g;
        $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
@@ -707,7 +768,7 @@ if( @path_h ){
            s/\?\?</{/g;                         # | ??<|  {|
            s/\?\?>/}/g;                         # | ??>|  }|
        }
-       if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
+       if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) {
            my $def = $1;
            my $rest = $2;
            $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
@@ -747,7 +808,13 @@ if( @path_h ){
 # Save current directory so that C::Scan can use it
 my $cwd = File::Spec->rel2abs( File::Spec->curdir );
 
-my ($ext, $nested, @modparts, $modfname, $modpname, $constsfname);
+my ($ext, $nested, @modparts, $modfname, $modpname);
+# 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';
 
 $ext = chdir 'ext' ? 'ext/' : '';
 
@@ -762,8 +829,6 @@ else {
        @modparts = ();
        $modfname = $modpname = $module;
 }
-# Don't trip up if someone calls their module 'constants'
-$constsfname = $modfname eq 'constants' ? 'constdefs' : 'constants';
 
 
 if ($opt_O) {
@@ -797,9 +862,14 @@ my %vdecl_hash;
 my @vdecls;
 
 if( ! $opt_X ){  # use XS, unless it was disabled
+  unless ($skip_ppport) {
+    require Devel::PPPort;
+    warn "Writing $ext$modpname/ppport.h\n";
+    Devel::PPPort::WriteFile('ppport.h')
+        || die "Can't create $ext$modpname/ppport.h: $!\n";
+  }
   open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
   if ($opt_x) {
-    require Config;            # Run-time directive
     warn "Scanning typemaps...\n";
     get_typemap();
     my @td;
@@ -915,9 +985,13 @@ print PM <<"END";
 package $module;
 
 use $compat_version;
+END
+
+print PM <<"END" unless $skip_strict;
 use strict;
 END
-print PM "use warnings;\n" unless $compat_version < 5.006;
+
+print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006;
 
 unless( $opt_X || $opt_c || $opt_A ){
        # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
@@ -927,18 +1001,19 @@ use Carp;
 END
 }
 
-print PM <<'END';
+print PM <<'END' unless $skip_exporter;
 
 require Exporter;
 END
 
-print PM <<"END" if ! $opt_X;  # use DynaLoader, unless XS was disabled
+my $use_Dyna = (not $opt_X and $compat_version < 5.006);
+print PM <<"END" if $use_Dyna;  # use DynaLoader, unless XS was disabled
 require DynaLoader;
 END
 
 
 # Are we using AutoLoader or not?
-unless ($opt_A) { # no autoloader whatsoever.
+unless ($skip_autoloader) { # no autoloader whatsoever.
        unless ($opt_c) { # we're doing the AUTOLOAD
                print PM "use AutoLoader;\n";
        }
@@ -949,23 +1024,33 @@ unless ($opt_A) { # no autoloader whatsoever.
 
 if ( $compat_version < 5.006 ) {
     if ( $opt_X || $opt_c || $opt_A ) {
-       print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
+       if ($skip_exporter) {
+         print PM 'use vars qw($VERSION @ISA);';
+       } else {
+         print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
+       }
     } else {
-       print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
+       if ($skip_exporter) {
+         print PM 'use vars qw($VERSION @ISA $AUTOLOAD);';
+       } else {
+         print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
+       }
     }
 }
 
 # Determine @ISA.
-my $myISA = 'our @ISA = qw(Exporter';  # We seem to always want this.
-$myISA .= ' DynaLoader'        unless $opt_X;  # no XS
-$myISA .= ');';
+my @modISA;
+push @modISA, 'Exporter'       unless $skip_exporter; 
+push @modISA, 'DynaLoader'     if $use_Dyna;  # no XS
+my $myISA = "our \@ISA = qw(@modISA);";
 $myISA =~ s/^our // if $compat_version < 5.006;
 
 print PM "\n$myISA\n\n";
 
 my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
 
-my $tmp=<<"END";
+my $tmp='';
+$tmp .= <<"END" unless $skip_exporter;
 # Items to export into callers namespace by default. Note: do not export
 # names by default without a very good reason. Use EXPORT_OK instead.
 # Do not simply export all your public functions/methods/constants.
@@ -982,6 +1067,10 @@ our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
 our \@EXPORT = qw(
        @const_names
 );
+
+END
+
+$tmp .= <<"END";
 our \$VERSION = '$TEMPLATE_VERSION';
 
 END
@@ -997,9 +1086,16 @@ if (@vdecls) {
 print PM autoload ($module, $compat_version) unless $opt_c or $opt_X;
 
 if( ! $opt_X ){ # print bootstrap, unless XS is disabled
+  if ($use_Dyna) {
        print PM <<"END";
 bootstrap $module \$VERSION;
 END
+  } else {
+       print PM <<"END";
+require XSLoader;
+XSLoader::load('$module', \$VERSION);
+END
+  }
 }
 
 # tying the variables can happen only after bootstrap
@@ -1039,12 +1135,14 @@ END
 my ($email,$author);
 
 eval {
-       my $user;
-       ($user,$author) = (getpwuid($>))[0,6];
-       $author =~ s/,.*$//; # in case of sub fields
-       my $domain = $Config{'mydomain'};
-       $domain =~ s/^\.//;
-       $email = "$user\@$domain";
+       my $username;
+       ($username,$author) = (getpwuid($>))[0,6];
+       if (defined $username && defined $author) {
+          $author =~ s/,.*$//; # in case of sub fields
+          my $domain = $Config{'mydomain'};
+          $domain =~ s/^\.//;
+          $email = "$username\@$domain";
+       }
      };
 
 $author ||= "A. U. Thor";
@@ -1067,7 +1165,7 @@ $revhist = <<EOT if $opt_C;
 #
 EOT
 
-my $exp_doc = <<EOD;
+my $exp_doc = $skip_exporter ? '' : <<EOD;
 #
 #=head2 EXPORT
 #
@@ -1076,7 +1174,7 @@ my $exp_doc = <<EOD;
 EOD
 
 if (@const_names and not $opt_P) {
-  $exp_doc .= <<EOD;
+  $exp_doc .= <<EOD unless $skip_exporter;
 #=head2 Exportable constants
 #
 #  @{[join "\n  ", @const_names]}
@@ -1085,7 +1183,7 @@ EOD
 }
 
 if (defined $fdecls and @$fdecls and not $opt_P) {
-  $exp_doc .= <<EOD;
+  $exp_doc .= <<EOD unless $skip_exporter;
 #=head2 Exportable functions
 #
 EOD
@@ -1094,7 +1192,7 @@ EOD
 #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
 #
 #EOD
-  $exp_doc .= <<EOD;
+  $exp_doc .= <<EOD unless $skip_exporter;
 #  @{[join "\n  ", @known_fnames{@fnames}]}
 #
 EOD
@@ -1109,7 +1207,7 @@ if ($opt_x && $opt_a) {
 }
 
 my $pod = <<"END" unless $opt_P;
-## Below is stub documentation for your module. You better edit it!
+## Below is stub documentation for your module. You'd better edit it!
 #
 #=head1 NAME
 #
@@ -1176,6 +1274,12 @@ print XS <<"END";
 #include "XSUB.h"
 
 END
+
+print XS <<"END" unless $skip_ppport;
+#include "ppport.h"
+
+END
+
 if( @path_h ){
     foreach my $path_h (@path_h_ini) {
        my($h) = $path_h;
@@ -1186,6 +1290,21 @@ if( @path_h ){
     print XS "\n";
 }
 
+print XS <<"END" if $opt_g;
+
+/* Global Data */
+
+#define MY_CXT_KEY "${module}::_guts" XS_VERSION
+
+typedef struct {
+    /* Put Global Data in here */
+    int dummy;         /* you can access this elsewhere as MY_CXT.dummy */
+} my_cxt_t;
+
+START_MY_CXT
+
+END
+
 my %pointer_typedefs;
 my %struct_typedefs;
 
@@ -1230,15 +1349,20 @@ if( ! $opt_c ) {
   # ExtUtils::Constant.
   # h2xs will later check that these are the same as those generated by the
   # code embedded into Makefile.PL
-  warn "Writing $ext$modpname/fallback.c\n";
-  warn "Writing $ext$modpname/fallback.xs\n";
-  WriteConstants ( C_FILE =>       "fallback.c",
-                   XS_FILE =>      "fallback.xs",
+  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";
+  my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname);
+  my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname);
+  WriteConstants ( C_FILE =>       $cfallback,
+                   XS_FILE =>      $xsfallback,
                    DEFAULT_TYPE => $opt_t,
                    NAME =>         $module,
                    NAMES =>        \@const_names,
                  );
-  print XS "#include \"$constsfname.c\"\n";
+  print XS "#include \"$constscfname\"\n";
 }
 
 
@@ -1253,7 +1377,19 @@ END
 
 # If a constant() function was #included then output a corresponding
 # XS declaration:
-print XS "INCLUDE: $constsfname.xs\n" unless $opt_c;
+print XS "INCLUDE: $constsxsfname\n" unless $opt_c;
+
+print XS <<"END" if $opt_g;
+
+BOOT:
+{
+    MY_CXT_INIT;
+    /* If any of the fields in the my_cxt_t struct need
+       to be initialised, do it here.
+     */
+}
+
+END
 
 foreach (sort keys %const_xsub) {
     print XS <<"END";
@@ -1690,16 +1826,7 @@ EOC
 $Icomment    'INC'             => '$I', # e.g., '${Ihelp}-I/usr/include/other'
 END
 
-  if (!$opt_c) {
-    print PL <<"END";
-    # Without this the constants xs files are spotted, and cause rules to be
-    # added to delete the similarly names C files, which isn't what we want.
-    'XS'               => {'$modfname.xs' => '$modfname.c'},
-    realclean          => {FILES => '$constsfname.c $constsfname.xs'},
-END
-  }
-
-  my $C = grep {$_ ne "$modfname.c" && $_ ne "fallback.c"}
+  my $C = grep {$_ ne "$modfname.c"}
     (glob '*.c'), (glob '*.cc'), (glob '*.C');
   my $Cpre = ($C ? '' : '# ');
   my $Ccomment = ($C ? '' : <<EOC);
@@ -1713,8 +1840,8 @@ END
 print PL ");\n";
 if (!$opt_c) {
   my $generate_code =
-    WriteMakefileSnippet ( C_FILE =>       "$constsfname.c",
-                           XS_FILE =>      "$constsfname.xs",
+    WriteMakefileSnippet ( C_FILE =>       $constscfname,
+                           XS_FILE =>      $constsxsfname,
                            DEFAULT_TYPE => $opt_t,
                            NAME =>         $module,
                            NAMES =>        \@const_names,
@@ -1722,17 +1849,18 @@ if (!$opt_c) {
   print PL <<"END";
 if  (eval {require ExtUtils::Constant; 1}) {
   # If you edit these definitions to change the constants used by this module,
-  # you will need to use the generated $constsfname.c and $constsfname.xs
+  # you will need to use the generated $constscfname and $constsxsfname
   # files to replace their "fallback" counterparts before distributing your
   # changes.
 $generate_code
 }
 else {
   use File::Copy;
-  copy ('fallback.c', '$constsfname.c')
-    or die "Can't copy fallback.c to $constsfname.c: \$!";
-  copy ('fallback.xs', '$constsfname.xs')
-    or die "Can't copy fallback.xs to $constsfname.xs: \$!";
+  use File::Spec;
+  foreach my \$file ('$constscfname', '$constsxsfname') {
+    my \$fallback = File::Spec->catfile('$fallbackdirname', \$file);
+    copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!";
+  }
 }
 END
 
@@ -1749,10 +1877,11 @@ EOM
   } else {
     my $fail;
 
-    foreach ('c', 'xs') {
-      if (compare("fallback.$_", "$constsfname.$_")) {
+    foreach my $file ($constscfname, $constsxsfname) {
+      my $fallback = File::Spec->catfile($fallbackdirname, $file);
+      if (compare($file, $fallback)) {
         warn << "EOM";
-Files "$ext$modpname/fallback.$_" and "$ext$modpname/$constsfname.$_" differ.
+Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ.
 EOM
         $fail++;
       }
@@ -1760,14 +1889,14 @@ EOM
     if ($fail) {
       warn fill ('','', <<"EOM") . "\n";
 It appears that the code in $ext$modpname/Makefile.PL does not autogenerate
-the files $ext$modpname/$constsfname.c and $ext$modpname/$constsfname.xs
+the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname
 correctly.
+
 Please report the circumstances of this bug in h2xs version $H2XS_VERSION
 using the perlbug script.
 EOM
     } else {
-      unlink "$constsfname.c", "$constsfname.xs";
+      unlink $constscfname, $constsxsfname;
     }
   }
 }
@@ -1960,7 +2089,7 @@ EOP
 
 warn "Writing $ext$modpname/MANIFEST\n";
 open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
-my @files = grep { -f } (<*>, <t/*>);
+my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>);
 if (!@files) {
   eval {opendir(D,'.');};
   unless ($@) { @files = readdir(D); closedir(D); }
@@ -1976,9 +2105,6 @@ if ($^O eq 'VMS') {
     $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
   }
 }
-if (!$opt_c) {
-  @files = grep {$_ ne "$constsfname.c" and $_ ne "$constsfname.xs"} @files;
-}
 print MANI join("\n",@files), "\n";
 close MANI;
 !NO!SUBS!