Perl-Sensitive Sunglasses | |
PerlMonks |
comment on |
( [id://3333]=superdoc: print w/replies, xml ) | Need Help?? |
I already wrote several XS modules, especially library bindings, and the most painful part usually was the task of making the modules portable between different library versions and operating systems. It's not very funny try to compile c or c++ programs in a portable way using perl, even if there are some helpers like ExtUtils::CBuilder available. I always wished there would be something like autoconf and autoheader for perl, but I doubt it'll ever exist in a way that is comparable to GNU autotools. Therefor I decided to write some perl glue around autoconf and autoheader so those tools are easy to use from Makefile.PLs and such. The current source code of ExtUtils::Autoconf is available here: http://files.perldition.org/ExtUtils-Autoconf-0.01.tar.gz 22962 08b9f68758b25b7d38d5a401f9bc499f The documentation follows: I'd be glad to get some feedback! Cheers, Flo
NAMEExtUtils::Autoconf - Perl interface to GNU autoconf
VERSIONVersion 0.01
SYNOPSISuse ExtUtils::Autoconf; my $ac = ExtUtils::Autoconf->new; $foo->reconf; $foo->configure; $foo->clean; $foo->realclean;
DESCRIPTIONExtUtils::Autoconf is a thin wrapper around GNU autoconf/autoheader which allows to run those tools easily from perl. This allows using autoconf for configuring perl modules and especially extensions in a portable way without messing around with the compilation of C code from perl.
TYPICAL USAGETypically ExtUtils::Autoconf is being used from Makefile.PLs in Perl module distributions.
AUTOCONFTo use it in your module you first need to create a directory called autoconf (or call it something else and set wd accordingly. This is the working directory for ExtUtils::Autoconf and the programs it invokes. Create a configure.ac (or configure.in and set configure_ac accordingly) fine in this directory. This file contains invocations of autoconf macros that test the system features your package needs or can use. Autoconf macros already exist to check for many features; see Existing Tests, for heir descriptions. For most other features, you can use Autoconf template macros to produce custom checks; see Writing Tests, for information about them. A typical configure.ac might look like this: AC_PREREQ(2.59) AC_INIT AC_CONFIG_HEADERS(config.h) AC_DEFINE_UNQUOTED(PERL_OSNAME, "$osname", The operating system perl was ocnfigured for) AC_OUTPUT In this script we first require autoconf version 2.59, then initialize the system and tell it to create a config header file called config.h with the results it gathered while running the configure script. In this script we only have one result called PERL_OSNAME. This is simply set to the value of the environment variable $osname, which corresponds to perls $Config{osname}. After our tests we do AC_OUTPUT to write our results to config.h. That's it for the configure.ac part. Now include the autoconf/config.h file in your C or C++ code of the module and use the defines in there.
MAKEFILE.PLExecute the configure script which will be generated from the above configure.ac when someone tries to build your module you'll need to modify your Makefile.PL script. It's better to assume that the user of your module doesn't have autoconf and autoheader installed so you need to generate configure and config.h before rolling your distribution together. This is easily done by using the dist target of your generated Makefile: package MY; sub dist_core { my $self = shift; my $inherited = $self->SUPER::dist_core(@_); $inherited =~ s/^(dist\s*:\s*)/$1autogen /m; return $inherited; } sub postamble { return <<"EOM"; autogen : \t\$(PERLRUN) -MExtUtils::Autoconf -e 'ExtUtils::Autoconf->run_autogen' EOM } autogen() and configure() automatically generate some files. To clean those up automatically when doing make clean or make realclean extend the postamble section like that: sub postamble { return <<"EOM"; autogen : \t\$(PERLRUN) -MExtUtils::Autoconf -e 'ExtUtils::Autoconf->run_autogen' realclean :: \t\$(PERLRUN) -MExtUtils::Autoconf -e 'ExtUtils::Autoconf->run_realclean' clean :: \t\$(PERLRUN) -MExtUtils::Autoconf -e 'ExtUtils::Autoconf->run_clean' EOM } Now everything will work, except for the actual execution of the configure script during perl Makefile.PL. To make it work do something like this in Makefile.PL: use strict; use warnings; use ExtUtils::MakeMaker; if (!eval 'use ExtUtils::Autoconf;') { print STDERR $@, "\n"; WriteMakefile( PREREQ_FATAL => 1, PREREQ_PM => { 'ExtUtils::Autoconf' => 0, }, ); exit 1; # not reached } my $ac = ExtUtils::Autoconf->new; $ac->configure; # rest of the usual Makefile.PL here.. The if condition covers those cases where ExtUtils::Autoconf isn't installed yet. I'll raise a fatal error which will hopefully tell CPAN to install it and rerun Makefile.PL.
SUBROUTINES/METHODS
newmy $ac = ExtUtils::Autoconf->new($arguments); This is the constructor.. Takes an optional hashref with additional $arguments. Returns a new ExtUtils::Autoconf instance. The following arguments are supported:
configure$ac->configure; Runs the configure script. If the configure script doesn't exist yet it'll run reconf(). Returns 1 on success or croaks on failure.
reconf$ac->reconf; Runs autoheader and autoconf to generate config.h.in and configure from configure.ac or configure.in. Returns 1 on success or croaks on failure.
clean$ac->clean; Cleans up files which were generated during configure(). Always returns something true.
realcleanmy $success = $ac->realclean; Cleans up files which were generated during reconf() and configure(). Always returns something true.
wdmy $wd = $ac->wd; $ac->wd($new_wd); Accessor for the wd (working directory) option. When called without any argument it returns the current working directory. When called with one argument the working directory is set to $new_wd and the new working directory is returned.
autoconfmy $autoconf = $ac->autoconf; $ac->autoconf($new_autoconf); Accessor for the name of the autoconf executable.
autoheadermy $autoheader = $ac->autoheader; $ac->autoheader($new_autoheader); Accessor for the name of the autoheader executable.
envmy $env = $ac->env; my $value = $ac->env($key); $ac->env($key => $value); Accessor for the environment option. When called without any option it returns a hash reference with all the environment variables that will be set when running any command. When called with one argument it'll return the value of the environment variable corresponding to a given $key. When called with two arguments the environment variable $key will be set to $value.
run_configureperl -MExtUtils::Autoconf -e'ExtUtils::Autoconf->run_configure' $wd This class method is intended to be used from Makefiles and similar things and reads its arguments from @ARGV. It constructs a new ExtUtils::Autoconf instance with the given $wd and runs configure().
run_autogenperl -MExtUtils::Autoconf -e'ExtUtils::Autoconf->run_autogen' $wd, $autoconf, $autoheader, $configure_ac This class method is intended to be used from Makefiles and similar things and reads its arguments from @ARGV. It constructs a new ExtUtils::Autoconf instance with the given $wd, $autoconf, $autoheader and $configure_ac and runs autogen().
run_cleanperl -MExtUtils::Autoconf -e'ExtUtils::Autoconf->run_clean' $wd This class method is intended to be used from Makefiles and similar things and reads its arguments from @ARGV. It constructs a new ExtUtils::Autoconf instance with the given $wd and runs clean().
run_realcleanperl -MExtUtils::Autoconf -e'ExtUtils::Autoconf->run_realclean' $wd This class method is intended to be used from Makefiles and similar things and reads its arguments from @ARGV. It constructs a new ExtUtils::Autoconf instance with the given $wd and runs realclean().
DIAGNOSTICS
AUTHORFlorian Ragwitz <rafl@debian.org>
BUGSPlease report any bugs or feature requests to <bug-extutils-autoconf@rt.cpan.org>, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORTYou can find documentation for this module with the perldoc command. perldoc ExtUtils::Autoconf You can also look for information at:
ACKNOWLEDGEMENTSMarc Lehmann <schmorp@schmorp.de> for the idea and a prof-of-concept implementation (autoconf.pm) in the IO::AIO manpage.
LICENSE AND COPYRIGHTCopyright 2006 Florian Ragwitz, all rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. In reply to RFC: ExtUtils::Autoconf by rafl
|
|