The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Alien-Libarchive-Installer-0.11
River stage zero No dependents
1 ++
/ Alien::Libarchive::Installer

NAME

Alien::Libarchive::Installer - Installer for libarchive

VERSION

version 0.11

SYNOPSIS

Build.PL

 # as an optional dep
 use Alien::Libarchive::Installer;
 use Module::Build;
 
 my %build_args;
 
 my $installer = eval { Alien::Libarchive::Installer->system_install };
 if($installer)
 {
   $build_args{extra_compiler_flags} = $installer->cflags,
   $build_args{extra_linker_flags}   = $installer->libs,
 }
 
 my $build = Module::Build->new(%build_args);
 $build->create_build_script;

Build.PL

 # require 3.0
 use Alien::Libarchive::Installer;
 use Module::Build;
 
 my $installer = eval {
   my $system_installer = Alien::Libarchive::Installer->system_install;
   die "we require 3.0.x or better"
     if $system->version !~ /^([0-9]+)\./ && $1 >= 3;
   $system_installer;
      # reasonably assumes that build_install will never download
      # a version older that 3.0
 } || Alien::Libarchive::Installer->build_install("dir");
 
 my $build = Module::Build->new(
   extra_compiler_flags => $installer->cflags,
   extra_linker_flags   => $installer->libs,
 );
 $build->create_build_script;

FFI::Raw

 # as an optional dep
 use Alien::Libarchive::Installer;
 use FFI::Raw;
 
 eval {
   my($dll) = Alien::Libarchive::Installer->system_install->dlls;
   FFI::Raw->new($dll, 'archive_read_new', FFI::Raw::ptr);
 };
 if($@)
 {
   # handle it if libarchive is not available
 }

DESCRIPTION

This distribution contains the logic for finding existing libarchive installs, and building new ones. If you do not care much about the version of libarchive that you use, and libarchive is not an optional requirement, then you are probably more interested in using Alien::Libarchive.

Where Alien::Libarchive::Installer is useful is when you have specific version requirements (say you require 3.0.x but 2.7.x will not do), but would still like to use the system libarchive if it is available.

CLASS METHODS

Class methods can be executed without creating an instance of Alien::libarchive::Installer, and generally used to query status of libarchive availability (either via the system or the internet). Methods that discover a system libarchive or build a one from source code on the Internet will generally return an instance of Alien::Libarchive::Installer which can be queried to retrieve the settings needed to interact with libarchive via XS or FFI::Raw.

versions_available

 my @versions = Alien::Libarchive::Installer->versions_available;
 my $latest_version = $versions[-1];

Return the list of versions of libarchive available on the Internet. Will throw an exception if the libarchive.org website is unreachable. Versions will be sorted from oldest (smallest) to newest (largest).

fetch

 my($location, $version) = Alien::Libarchive::Installer->fetch(%options);
 my $location = Alien::Libarchive::Installer->fetch(%options);

NOTE: using this method may (and probably does) require modules returned by the build_requires method.

Download libarchive source from the internet. By default it will download the latest version to a temporary directory which will be removed when Perl exits. Will throw an exception on failure. Options include:

dir

Directory to download to

version

Version to download

build_requires

 my $prereqs = Alien::Libarchive::Installer->build_requires;
 while(my($module, $version) = each %$prereqs)
 {
   ...
 }

Returns a hash reference of the build requirements. The keys are the module names and the values are the versions.

The requirements may be different depending on your platform.

system_requires

This is like build_requires, except it is used when using the libarchive that comes with the operating system.

system_install

 my $installer = Alien::Libarchive::Installer->system_install(%options);

NOTE: using this method may require modules returned by the system_requires method.

NOTE: This form will also use the libarchive provided by Alien::Libarchive if version 0.21 or better is installed. This makes this method ideal for finding libarchive as an optional dependency.

Options:

test

Specifies the test type that should be used to verify the integrity of the system libarchive. Generally this should be set according to the needs of your module. Should be one of:

compile

use test_compile_run to verify. This is the default.

ffi

use test_ffi to verify

both

use both test_compile_run and test_ffi to verify

alien

If true (the default) then an existing Alien::Libarchive will be used if version 0.21 or better is found. Usually this is what you want.

build_install

 my $installer = Alien::Libarchive::Installer->build_install( '/usr/local', %options );

NOTE: using this method may (and probably does) require modules returned by the build_requires method.

Build and install libarchive into the given directory. If there is an error an exception will be thrown. On a successful build, an instance of Alien::Libarchive::Installer will be returned.

These options may be passed into build_install:

tar

Filename where the libarchive source tar is located. If not specified the latest version will be downloaded from the Internet.

dir

Empty directory to be used to extract the libarchive source and to build from.

test

Specifies the test type that should be used to verify the integrity of the build after it has been installed. Generally this should be set according to the needs of your module. Should be one of:

compile

use test_compile_run to verify. This is the default.

ffi

use test_ffi to verify

both

use both test_compile_run and test_ffi to verify

ATTRIBUTES

Attributes of an Alien::Libarchive::Installer provide the information needed to use an existing libarchive (which may either be provided by the system, or have just been built using build_install.

cflags

The compiler flags required to use libarchive.

libs

The linker flags and libraries required to use libarchive.

dlls

List of DLL or .so (or other dynamic library) files that can be used by FFI::Raw or similar.

version

The version of libarchive

INSTANCE METHODS

test_compile_run

 if($installer->test_compile_run(%options))
 {
   # You have a working Alien::Libarchive as
   # specified by %options
 }
 else
 {
   die $installer->error;
 }

Tests the compiler to see if you can build and run a simple libarchive program. On success it will return the libarchive version. Other options include

cbuilder

The ExtUtils::CBuilder instance that you want to use. If not specified, then a new one will be created.

dir

Directory to use for building the executable. If not specified, a temporary directory will be created and removed when Perl terminates.

quiet

Passed into ExtUtils::CBuilder if you do not provide your own instance. The default is true (unlike ExtUtils::CBuilder itself).

test_ffi

 if($installer->test_ffi(%options))
 {
   # You have a working Alien::Libarchive as
   # specified by %options
 }
 else
 {
   die $installer->error;
 }

Test libarchive to see if it can be used with FFI::Raw (or similar). On success it will return the libarchive version.

error

Returns the error from the previous call to test_compile_run or test_ffi.

SEE ALSO

Alien::Libarchive
Archive::Libarchive::XS
Archive::Libarchive::FFI
Archive::Libarchive::Any
Archive::Ar::Libarchive
Archive::Peek::Libarchive
Archive::Extract::Libarchive

AUTHOR

Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.