++ed by:
ZMUGHAL PABLROD

2 PAUSE users
2 non-PAUSE users.

Graham Ollis ✈✈
and 18 contributors

NAME

alienfile - Specification for defining an external dependency for CPAN

VERSION

version 0.95

SYNOPSIS

Do-it-yourself approach:

 use alienfile;
 
 probe [ 'pkg-config --exists libarchive' ];
 
 share {

   # the first one which succeeds will be used
   download [ 'wget http://libarchive.org/downloads/libarchive-3.2.2.tar.gz' ];
   download [ 'curl -o http://libarchive.org/downloads/libarchive-3.2.2.tar.gz' ];
   
   extract [ 'tar xf %{.install.download}' ];
   
   build [ 
     # Note: will not work on Windows, better to use Build::Autoconf plugin
     # if you need windows support
     './configure --prefix=%{.install.prefix} --disable-shared',
     '%{make}',
     '%{make} install',
   ];   
 }
 
 gather [
   [ 'pkg-config', '--modversion', 'libarchive', \'%{.runtime.version}' ],
   [ 'pkg-config', '--cflags',     'libarchive', \'%{.runtime.cflags}'  ],
   [ 'pkg-config', '--libs',       'libarchive', \'%{.runtime.libs}'    ],
 ];

With plugins (better):

 use alienfile;
 
 plugin 'PkgConfig' => 'libarchive';
 
 share {
   plugin Download => (
     url => 'http://libarchive.org/downloads/',
     filter => qr/^libarchive-.*\.tar\.gz$/,
     version => qr/([0-9\.]+)/,
   );
   plugin Extract => 'tar.gz';
   plugin 'Build::Autoconf' => ();
   build [
     '%{configure} --disable-shared',
     '%{make}',
     '%{make} install',
   ];
 };

DESCRIPTION

An alienfile is a recipe used by Alien::Build to, probe for system libraries or download from the internet, and build source for those libraries.

DIRECTIVES

requires

"any" requirement (either share or system):

 requires $module;
 requires $module => $verson;

configure time requirement:

 configure {
   requires $module;
   requires $module => $verson;
 };

system requirement:

 sys {
   requires $module;
   requires $module => $verson;
 };

share requirement:

 share {
   requires $module;
   requires $module => $verson;
 };

specifies a requirement. Alien::Build takes advantage of dynamic requirements, so only modules that are needed for the specific type of install need to be loaded. Here are the different types of requirements:

configure

Configure requirements should already be installed before the alienfile is loaded.

any

"Any" requirements are those that are needed either for the probe stage, or in either the system or share installs.

share

Share requirements are those modules needed when downloading and building from source.

system

System requirements are those modules needed when the system provides the library or tool.

plugin

 plugin $name => (%args);
 plugin $name => $arg;

Load the given plugin. If you prefix the plugin name with an = sign, then it will be assumed to be a fully qualified path name. Otherwise the plugin will be assumed to live in the Alien::Build::Plugin namespace. If there is an appropriate negotiate plugin, that one will be loaded. Examples:

 # Loads Alien::Build::Plugin::Fetch::Negotiate
 # which will pick the best Alien::Build::Plugin::Fetch
 # plugin based on the URL, and system configuration
 plugin 'Fetch' => 'http://ftp.gnu.org/gnu/gcc';
 
 # loads the plugin with the badly named class!
 plugin '=Badly::Named::Plugin::Not::In::Alien::Build::Namespace' => ();

 # explicitly loads Alien::Build::Plugin::Prefer::SortVersions
 plugin 'Prefer::SortVersions => (
   filter => qr/^gcc-.*\.tar\.gz$/,
   version => qr/([0-9\.]+)/,
 );

probe

 probe \&code;
 probe \@commandlist;

Instructions for the probe stage. May be either a code reference, or a command list.

configure

 configure {
   ...
 };

Configure block. The only directive allowed in a configure block is requires.

sys

 sys {
   ...
 };

System block. Allowed directives are: requires and gather.

share

 share {
   ...
 };

System block. Allowed directives are: download, fetch, decode, prefer, extract, build, gather.

download

 share {
   download \&code;
   download \@commandlist;
 };

Instructions for the download stage. May be either a code reference, or a command list.

fetch

 share {
   fetch \&code;
   fetch \@commandlist;
 };

Instructions for the fetch stage. May be either a code reference, or a command list.

decode

 share {
   decode \&code;
   decode \@commandlist;
 };

Instructions for the decode stage. May be either a code reference, or a command list.

prefer

 share {
   prefer \&code;
   prefer \@commandlist;
 };

Instructions for the prefer stage. May be either a code reference, or a command list.

extract

 share {
   extract \&code;
   extract \@commandlist;
 };

Instructions for the extract stage. May be either a code reference, or a command list.

patch

 share {
   patch \&code;
   patch \@commandlist;
 };

Instructions for the patch stage. May be either a code reference, or a command list.

patch_ffi

 share {
   patch_ffi \&code;
   patch_ffi \@commandlist;
 };

[DEPRECATED]

Instructions for the patch_ffi stage. May be either a code reference, or a command list.

build

 share {
   build \&code;
   build \@commandlist;
 };

Instructions for the build stage. May be either a code reference, or a command list.

build_ffi

 share {
   build \&code;
   build \@commandlist;
 };

[DEPRECATED]

Instructions for the build FFI stage. Builds shared libraries instead of static. This is optional, and is only necessary if a fresh and separate build needs to be done for FFI.

gather

 gather \&code;
 gather \@commandlist;
 
 share {
   gather \&code;
   gather \@commandlist;
 };
 
 sys {
   gather \&code;
   gather \@commandlist;
 };

Instructions for the gather stage. May be either a code reference, or a command list. In the root block of the alienfile it will trigger in both share and system build. In the share or sys block it will only trigger in the corresponding build.

gather_ffi

 share {
   gather_ffi \&code;
   gather_ffi \@commandlist;
 }

[DEPRECATED]

Gather specific to build_ffi. Not usually necessary.

ffi

 share {
   ffi {
     patch \&code;
     patch \@commandlist;
     build \&code;
     build \@commandlist;
     gather \&code;
     gather \@commandlist;
   }
 }

Specify patch, build or gather stages related to FFI.

meta_prop

 my $hash = meta_prop;

Get the meta_prop hash reference.

meta

 my $meta = meta;

Returns the meta object for your alienfile.

log

 log($message);

Prints the given log to stdout.

SEE ALSO

Alien
Alien::Build
Alien::Build::MM
Alien::Base

AUTHOR

Author: Graham Ollis <plicease@cpan.org>

Contributors:

Diab Jerius (DJERIUS)

Roy Storey

Ilya Pavlov

David Mertens (run4flat)

Mark Nunberg (mordy, mnunberg)

Christian Walde (Mithaldu)

Brian Wightman (MidLifeXis)

Zaki Mughal (zmughal)

mohawk2

Vikas N Kumar (vikasnkumar)

Flavio Poletti (polettix)

Salvador Fandiño (salva)

Gianni Ceccarelli (dakkar)

Pavel Shaydo (zwon, trinitum)

Kang-min Liu (劉康民, gugod)

Nicholas Shipp (nshp)

Juan Julián Merelo Guervós (JJ)

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 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.