Panda::Install - ExtUtils::MakeMaker based module installer for XS modules.
Panda::Install makes it much easier to write MakeMaker's makefiles especially for XS modules. It provides dependecies support between XS modules, so that one could easily use header files, code, compilation options, ...etc of another. Panda::Install also lets you put source files in subdirectories any level deep (MakeMaker doesn't handle that) and easily compile-in external C libraries.
The params for Panda::Install are compatible with MakeMaker with some additions.
Also it supports typemap inheritance and C-like XS synopsis.
# Makefile.PL use Panda::Install; write_makefile( NAME => 'My::XS', INC => '-Isrc -I/usr/local/libevent/include', LIBS => '-levent', SRC => 'src', # all source files (code,header,xs) under 'src' are included in build C => 'src2/foo.cc src2/bar.cc src3/baz/*.c', # plus src2/foo.cc, src2/bar.cc, and first-level c files in src3/baz/ CPLUS => 1, PAYLOAD => { # implements File::ShareDir functionality 'data.txt' => '/data.txt', 'list.txt' => '/', 'abc.dat' => '/mydir/bca.dat', 'payloaddir' => '/', }, BIN_DEPS => ['XS::Module1', 'XS::Module2'], BIN_SHARE => { # modules that depend on My::XS will compile with this INC, LIBS, etc set. TYPEMAPS => {'typemap1.map' => '/typemap.map'}, INC => '-I/usr/local/libevent/include', INCLUDE => {'src' => '/'}, LIBS => '-levent', DEFINE => '-DHELLO_FROM_MYXS', CCFLAGS => 'something', }, postamble => 'mytarget: blah-blah; echo "hello"', CLIB => [{ DIR => 'libuv', FILE => 'libuv.a', TARGET => 'libuv.a', FLAGS => 'CFLAGS="-fPIC -O2"', }], );
package MyXSModule; use Panda::XSLoader; our $VERSION = '1.0.0'; Panda::XSLoader::load(); # same as Panda::XSLoader::load('MyXSModule', $VERSION, 0x01);
see Panda::XSLoader
T_TYPE1 mycode1; T_TYPE2 : T_TYPE1 mycode2;
char* my_xs_sub (SV* sv) { // CODE if (badsv(sv)) XSRETURN_UNDEF; RETVAL = process(sv); } void other_xs_sub (SV* sv) : ALIAS(other_name=1, yet_another=2) { // PPCODE xPUSHi(1); xPUSHi(2); }
my $payload_dir = Panda::Install::Payload::payload_dir('My::Module');
see Panda::Install::Payload
Same as WriteMakefile(makemaker_args(%params))
Processes %params, does all the neccessary job and returns final parameters for passing to MakeMaker's WriteMakefile.
Only differences from MakeMaker params are listed.
Sets ABSTRACT_FROM and VERSION_FROM to value of ALL_FROM.
If not defined, defaults to NAME. That means that if you have version and abstract in your module's main package, then you don't need to define anything.
Sets source files for xsubpp. If you define this param, defaults are aborted.
XS => 'myxs/*.xs' XS => 'file1.xs folder/file2.xs folder2/*.xs' XS => ['file1.xs', 'folder/file2.xs folder2/*.xs']
Sets source files to compile. If you define this param, defaults are aborted, however C files created by xsubpp are still included.
Usage: see "XS".
Sets header files for makefile's dependencies (forces module to recompile if any of these changes). Useful during development. If you define this param, defaults are aborted.
Scans specified folder(s), finds all XS, C and H files and includes them in build. No matter whether you define XS/C/H parameters or not, SRCs are always added to them.
SRC => 'src' SRC => 'src src2 src3', SRC => ['src src2', 'src3'],
If true, will use c++ to build current extension.
Passed unchanged to Makefile. Can be HASHREF for your convenience, in which case keys are ignored, values are concatenated.
postamble => 'sayhello: ; echo "hello"' postamble => { memd_dep => 'linkext:: libmemd/libmemd.a; cd libmemd && $(MAKE) static', memd_clean => 'clean:: ; cd libmemd && $(MAKE) clean', }
Is set to 5.10.0 if you don't provide it.
Implements File::ShareDir functionality. Specified files are installed together with module and can later be accessed at runtime by the module itself or by other modules (via Panda::Install::Payload's payload_dir()).
Value is a HASHREF where key is a file or directory path relative to module's dist dir and value is relative to payload's installation dir. If key is a directory then all content of that directory is installed to the destination path. If value is not specified (undef, '') then dest path is the same as source path.
Examples (given that $payload is a directory where payload is installed and $dist is a module's dist dir):
'file.txt' => '' # $dist/file.txt => $payload/file.txt 'file.txt' => 'a.txt' # $dist/file.txt => $payload/a.txt 'mydir' => '', # $dist/mydir => $payload/mydir 'mydir' => 'a/b/c', # $dist/mydir/* => $payload/a/b/c/* 'mydir' => '/', # $dist/mydir/* => $payload/*
List of modules current module binary depends on. That means all that those modules specified in BIN_SHARE section will be applied while building current module. It also adds those modules to CONFIGURE_REQUIRES and PREREQ_PM sections.
Also if your module has BIN_SHARE section then all modules in BIN_DEPS goes to BIN_SHARE/PASSTHROUGH unless module name is prefixed with '-' (minus).
Examples:
BIN_DEPS => 'Module1' BIN_DEPS => ['Module1', '-Module2']
In this section you put values that you want to be applied to any module which specified your module as a dependency.
Installs specified typemaps and also adds it to the list of typemaps when building descendant modules.
Receives HASHREF, format is the same as for PAYLOAD, the only difference is that it scans folders for *.map files only.
Adds include file dirs to INC when building descendant modules.
Installs specified include files/dirs into module's installation include directory and adds that directory to INC when building descendant modules.
Receives HASHREF, format is the same as for PAYLOAD, the only difference is that it scans folders for header files only.
Added to LIBS when building descendant modules.
Added to DEFINE when building descendant modules.
Added to CCFLAGS when building descendant modules.
Added to XSOPT when building descendant modules.
Merge 'BIN_SHARE' of this module with 'BIN_SHARE' of specified modules. Everything gets concatenated (strings, arrays, etc) while merging. You don't need to manually manage this setting as it's managed automatically (see BIN_DEPS section).
List of external C libraries that need to be built and compiled into the extension.
Directory where external library is. Makefile must present in that directory!
Static library file which is built by the library (relative to CLIB/DIR).
Name of the target for Makefile to built static library.
Flags to build external library with.
T_TYPE2 will have mycode1 inserted after mycode2 as if it was written
T_TYPE2 mycode2; mycode1;
T_TYPE2 will have mycode1 inserted before mycode2 as if it was written
T_TYPE2 mycode1; mycode2;
You can pass params when inheriting typemaps. These params can be accessed in parent typemap via %p hash.
T_TYPE1 int $p{varname} = 150; mycode1; $p{expr}; T_TYPE2 : T_TYPE1(varname=myvar, expr="myvar = a + b") mycode2;
will result in (for input typemap)
T_TYPE2 int myvar = 150; mycode1; myvar = a + b; mycode2;
In OUTPUT typemaps you can use 'INIT: expr;' expressions. These expressions later will be moved to the top of the XS function like INIT: section of XS function itself. It is useful for typemaps which want to predefine some variable, so that user has a chance to change it. Such typemaps then use this variable in its code. For example:
TYPEMAP int MY_TYPE OUTPUT MY_TYPE INIT: int lolo = 0; sv_setiv($arg, $var + lolo); #XS int myfunc () CODE: lolo = 10; RETVAL = 20; // returns 30 OUTPUT: RETVAL;
If you're using Panda::Install then all of your XS files support C-like XS. It means that code
is replaced with code
char* my_xs_sub (SV* sv) CODE: if (badsv(sv)) XSRETURN_UNDEF; RETVAL = process(sv); OUTPUT: RETVAL void other_xs_sub (SV* sv) ALIAS: other_name=1 yet_another=2 PPCODE: xPUSHi(1); xPUSHi(2);
Pronin Oleg <syber@crazypanda.ru>, Crazy Panda, CP Decision LTD
You may distribute this code under the same terms as Perl itself.
1 POD Error
The following errors were encountered while parsing the POD:
Unknown directive: =head
To install Panda::Install, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Panda::Install
CPAN shell
perl -MCPAN -e shell install Panda::Install
For more information on module installation, please visit the detailed CPAN module installation guide.