Doc, test, implement XSBUILD: control XSMULTI

Author: mohawk2

lib/ExtUtils/MM_Unix.pm

@@ -940,9 +940,12 @@ sub dynamic_lib {
             shift @d if $d[0] eq 'lib';
             my $instdir = File::Spec->catdir('$(INST_ARCHLIB)', 'auto', @d, $f);
             my $instfile = File::Spec->catfile($instdir, "$f.\$(DLEXT)");
-            my $objfile = "$ext\$(OBJ_EXT)";
+            my $objfile = $self->_xsbuild_value('xs', $ext, 'OBJECT');
+            $objfile = "$ext\$(OBJ_EXT)" unless defined $objfile;
+            my $ldfrom = $self->_xsbuild_value('xs', $ext, 'LDFROM');
+            $ldfrom = $objfile unless defined $ldfrom;
             my $exportlist = "$ext.def";
-            push @libs, [ $objfile, $instfile, $instdir, $objfile, $exportlist ];
+            push @libs, [ $objfile, $instfile, $instdir, $ldfrom, $exportlist ];
         }
     } else {
         @libs = ([ qw($(OBJECT) $(INST_DYNAMIC) $(INST_ARCHAUTODIR) $(LDFROM) $(EXPORT_LIST)) ]);
@@ -1012,7 +1015,6 @@ sub xs_make_dynamic_lib {
     push(@m,"	\$(RM_F) \$\@\n");
 
     my $libs = '$(LDLOADLIBS)';
-
     if (($Is{NetBSD} || $Is{Interix} || $Is{Android}) && $Config{'useshrplib'} eq 'true') {
         # Use nothing on static perl platforms, and to the flags needed
         # to link against the shared libperl library on shared perl
@@ -3928,19 +3930,38 @@ EOF
 	    $cccmd =~ s/^\s*CCCMD\s*=\s*//;
 	    $cccmd =~ s/\$\(DEFINE_VERSION\)/-DVERSION=\\"$version\\"/;
 	    $cccmd =~ s/\$\(XS_DEFINE_VERSION\)/-DXS_VERSION=\\"$version\\"/;
-	    #                             1     2       3
-	    $frag .= _sprintf562 <<'EOF', $ext, $cccmd, $minus_o;
+            $self->_xsbuild_replace_macro($cccmd, 'xs', $ext, 'INC');
+            my $define = '$(DEFINE)';
+            $self->_xsbuild_replace_macro($define, 'xs', $ext, 'DEFINE');
+            #                             1     2       3         4
+            $frag .= _sprintf562 <<'EOF', $ext, $cccmd, $minus_o, $define;
 
 %1$s$(OBJ_EXT): %1$s.xs
 	$(XSUBPPRUN) $(XSPROTOARG) $(XSUBPPARGS) $*.xs > $*.xsc
 	$(MV) $*.xsc $*.c
-	%2$s $(CCCDLFLAGS) "-I$(PERL_INC)" $(PASTHRU_DEFINE) $(DEFINE) $*.c %3$s
+	%2$s $(CCCDLFLAGS) "-I$(PERL_INC)" $(PASTHRU_DEFINE) %4$s $*.c %3$s
 EOF
 	}
     }
     $frag;
 }
 
+# param gets modified
+sub _xsbuild_replace_macro {
+    my ($self, undef, $xstype, $ext, $varname) = @_;
+    my $value = $self->_xsbuild_value($xstype, $ext, $varname);
+    return unless defined $value;
+    $_[1] =~ s/\$\($varname\)/$value/;
+}
+
+sub _xsbuild_value {
+    my ($self, $xstype, $ext, $varname) = @_;
+    return $self->{XSBUILD}{$xstype}{$ext}{$varname}
+        if $self->{XSBUILD}{$xstype}{$ext}{$varname};
+    return $self->{XSBUILD}{$xstype}{all}{$varname}
+        if $self->{XSBUILD}{$xstype}{all}{$varname};
+    ();
+}
 
 1;
 

lib/ExtUtils/MakeMaker.pm

@@ -116,6 +116,7 @@ my %Special_Sigs = (
  SKIP               => 'ARRAY',
  TYPEMAPS           => 'ARRAY',
  XS                 => 'HASH',
+ XSBUILD            => 'HASH',
  VERSION            => ['version',''],
  _KEEP_AFTER_FLUSH  => '',
 
@@ -312,8 +313,8 @@ sub full_setup {
     PL_FILES PM PM_FILTER PMLIBDIRS PMLIBPARENTDIRS POLLUTE
     PREREQ_FATAL PREREQ_PM PREREQ_PRINT PRINT_PREREQ
     SIGN SKIP TEST_REQUIRES TYPEMAPS UNINST VERSION VERSION_FROM XS
-    XSMULTI XSOPT XSPROTOARG XS_VERSION clean depend dist dynamic_lib
-    linkext macro realclean tool_autosplit
+    XSBUILD XSMULTI XSOPT XSPROTOARG XS_VERSION
+    clean depend dist dynamic_lib linkext macro realclean tool_autosplit
 
     MAN1EXT MAN3EXT
 
@@ -2795,6 +2796,40 @@ Hashref of .xs files. MakeMaker will default this.  e.g.
 The .c files will automatically be included in the list of files
 deleted by a make clean.
 
+=item XSBUILD
+
+Hashref with options controlling the operation of C<XSMULTI>:
+
+  {
+    xs => {
+        all => {
+            # options applying to all .xs files for this distribution
+        },
+        'lib/Class/Name/File' => { # specifically for this file
+            DEFINE => '-Dfunktastic', # defines for only this file
+            INC => "-I$funkyliblocation", # include flags for only this file
+            # OBJECT => 'lib/Class/Name/File$(OBJ_EXT)', # default
+            LDFROM => "lib/Class/Name/File\$(OBJ_EXT) $otherfile\$(OBJ_EXT)", # what's linked
+        },
+    },
+  }
+
+Note C<xs> is the file-extension. More possibilities may arise in the
+future. Note that object names are specified without their XS extension -
+it is axiomatic that no extension will exist that has more than one type
+of XSUB code.
+
+C<LDFROM> defaults to the same as C<OBJECT>. C<OBJECT> defaults to,
+for C<XSMULTI>, just the XS filename with the extension replaced with
+the compiler-specific object-file extension.
+
+The distinction between C<OBJECT> and C<LDFROM>: C<OBJECT> is the make
+target, so make will try to build it. However, C<LDFROM> is what will
+actually be linked together to make the shared object or static library
+(SO/SL), so if you override it, make sure it includes what you want to
+make the final SO/SL, almost certainly including the XS basename with
+C<$(OBJ_EXT)> appended.
+
 =item XSMULTI
 
 When this is set to C<1>, multiple XS files may be placed under F<lib/>

t/lib/MakeMaker/Test/Setup/XS.pm

@@ -169,11 +169,7 @@ $label2files{multi} = +{
   'lib/XS/Other.pm' => $PM_OTHER,
   'lib/XS/Other.xs' => $XS_MULTI,
   't/is_odd.t' => $T_OTHER,
-
-  'lib/XS/header.h'              => <<'END',
-#define INVAR input
-END
-
+  'lib/XS/header.h' => "#define INVAR input\n",
 };
 virtual_rename('multi', $typemap, "lib/XS/$typemap");
 virtual_rename('multi', 'Test.xs', 'lib/XS/Test.xs');
@@ -194,6 +190,42 @@ $label2files{staticmulti} = +{
   ),
 };
 
+$label2files{xsbuild} = +{
+  %{ $label2files{'multi'} }, # make copy
+  'Makefile.PL' => sprintf(
+    $MAKEFILEPL, 'Test', 'lib/XS/Test.pm', qq{'$typemap'},
+    q{
+      XSMULTI => 1,
+      XSBUILD => {
+        xs => {
+          'lib/XS/Other' => {
+            DEFINE => '-DINVAR=input',
+            OBJECT => 'lib/XS/Other$(OBJ_EXT) lib/XS/plus1$(OBJ_EXT)'
+          }
+        },
+      },
+    },
+  ),
+  'lib/XS/Other.xs' => $XS_OTHER . <<EOF,
+\nint
+plus1(input)
+       int     input
+   CODE:
+       RETVAL = plus1(INVAR);
+   OUTPUT:
+       RETVAL
+EOF
+  'lib/XS/plus1.c' => 'int plus1(i) int i; { return i + 1; }',
+  't/is_odd.t' => <<'END',
+#!/usr/bin/perl -w
+use Test::More tests => 4;
+use_ok "XS::Other";
+ok is_odd(1);
+ok !is_odd(2);
+is XS::Other::plus1(3), 4;
+END
+};
+
 sub virtual_rename {
   my ($label, $oldfile, $newfile) = @_;
   $label2files{$label}->{$newfile} = delete $label2files{$label}->{$oldfile};
@@ -235,6 +267,7 @@ sub list_dynamic {
     [ 'multi', '', '' ],
     [ 'staticmulti', ' LINKTYPE=dynamic', ' LINKTYPE=dynamic' ],
     [ 'staticmulti', ' dynamic', '_dynamic' ],
+    [ 'xsbuild', '', '' ],
   );
 }
 
@@ -263,7 +296,7 @@ sub run_tests {
 
     my $test_cmd = "$make test" . (defined $add_testtarget ? $add_testtarget : '');
     my $test_out = run($test_cmd);
-    is( $?, 0, "$test_cmd exited normally" ) || diag $test_out;
+    is( $?, 0, "$test_cmd exited normally" ) || diag "$make_out\n$test_out";
   }
 
   chdir File::Spec->updir or die;