Module-Build-Using-PkgConfig-0.03000755001750001750 013453626731 15401 5ustar00leoleo000000000000Module-Build-Using-PkgConfig-0.03/Build.PL000444001750001750 77513453626731 17023 0ustar00leoleo000000000000use strict; use warnings; use Module::Build; my $build = Module::Build->new( module_name => 'Module::Build::Using::PkgConfig', configure_requires => { 'Module::Build' => '0.4004', # test_requires }, requires => { 'ExtUtils::PkgConfig' => 0, 'Module::Build' => 0, 'perl' => '5.010', # // }, test_requires => { 'Test::More' => '0.88', # done_testing }, license => 'perl', create_license => 1, create_readme => 1, ); $build->create_build_script; Module-Build-Using-PkgConfig-0.03/Changes000444001750001750 76213453626731 17016 0ustar00leoleo000000000000Revision history for Module-Build-Using-PkgConfig 0.03 2019-04-11 13:05:56 [CHANGES] * Declare dependency on perl 5.010 because of // operator * Spelling fixes from debian (thanks gregor herrmann) (RT128590) 0.02 2019-02-21 20:47:31 [BUGFIXES] * Declare Alien modules under 'requires', not 'build_requires' * Declare dependency on ExtUtils::PkgConfig 0.01 2019-02-20 21:58:32 First version, released on an unsuspecting world. Module-Build-Using-PkgConfig-0.03/LICENSE000444001750001750 4376213453626731 16577 0ustar00leoleo000000000000This software is copyright (c) 2019 by Paul Evans . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2019 by Paul Evans . This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2019 by Paul Evans . This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Module-Build-Using-PkgConfig-0.03/MANIFEST000444001750001750 21113453626731 16641 0ustar00leoleo000000000000Build.PL Changes lib/Module/Build/Using/PkgConfig.pm LICENSE MANIFEST This list of files META.json META.yml README t/00use.t t/99pod.t Module-Build-Using-PkgConfig-0.03/META.json000444001750001750 226513453626731 17164 0ustar00leoleo000000000000{ "abstract" : "extend C to more easily use platform libraries provided by F", "author" : [ "Paul Evans " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4224", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Module-Build-Using-PkgConfig", "prereqs" : { "configure" : { "requires" : { "Module::Build" : "0.4004" } }, "runtime" : { "requires" : { "ExtUtils::PkgConfig" : "0", "Module::Build" : "0", "perl" : "5.010" } }, "test" : { "requires" : { "Test::More" : "0.88" } } }, "provides" : { "Module::Build::Using::PkgConfig" : { "file" : "lib/Module/Build/Using/PkgConfig.pm", "version" : "0.03" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ] }, "version" : "0.03", "x_serialization_backend" : "JSON::PP version 2.97001" } Module-Build-Using-PkgConfig-0.03/META.yml000444001750001750 142713453626731 17013 0ustar00leoleo000000000000--- abstract: 'extend C to more easily use platform libraries provided by F' author: - 'Paul Evans ' build_requires: Test::More: '0.88' configure_requires: Module::Build: '0.4004' dynamic_config: 1 generated_by: 'Module::Build version 0.4224, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Module-Build-Using-PkgConfig provides: Module::Build::Using::PkgConfig: file: lib/Module/Build/Using/PkgConfig.pm version: '0.03' requires: ExtUtils::PkgConfig: '0' Module::Build: '0' perl: '5.010' resources: license: http://dev.perl.org/licenses/ version: '0.03' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Module-Build-Using-PkgConfig-0.03/README000444001750001750 1311013453626731 16432 0ustar00leoleo000000000000NAME Module::Build::Using::PkgConfig - extend Module::Build to more easily use platform libraries provided by pkg-config SYNOPSIS In Build.PL: use Module::Build::Using::PkgConfig; my $build = Module::Build::Using::PkgConfig->new( module_name => "Module::Here", ... # other arguments as per Module::Build ); # A platform library provided by pkg-config $build->use_pkgconfig( "libfoo" ); # We need at least a given version $build->use_pkgconfig( "libbar", atleast_version => "0.5", ); # A platform librariy that's also wrapped as an Alien module $build->use_pkgconfig( "libsplot", atleast_version => "1.0", alien => "Alien::libsplot", alien_version => "0.05", # Alien::libsplot 0.05 provides libsplot v1.0 ); $build->create_build_script; DESCRIPTION This subclass of Module::Build provides some handy methods to assist the Build.PL script of XS-based module distributions that make use of platform libraries managed by pkg-config. As well as supporting libraries installed on a platform-wide basis and thus visible to pkg-config itself, this subclass also assists with Alien::-based wrappers of these system libraries, allowing them to be dynamically installed at build time if the platform does not provide them. RPATH generation This module also provides some helper code to generate the required RPATH arguments needed to link against the libraries found by inspecting the extra_linker_flags. This attempts to duplicate the same logic performed by libtool when it would link a C program or library, as we don't get to use its code when linking dynamic libraries for Perl. PROPERTIES no_late_aliens => BOOL If true, applies the no_late_alien option to every use of use_pkgconfig that specifies an Alien module. METHODS use_pkgconfig $build->use_pkgconfig( $modname, ... ) Requires the given pkg-config module of the given version, and extends the compiler and linker arguments sufficient to build from it. Takes the following named options: atleast_version => $modver If given, the pkg-config module is required to be at least the given version. If unspecified, then any version is considered sufficient. alien => $alien If given and the pkg-config module does not exist, try to use the given Alien:: module to provide it instead. If this module is not yet available and the no_late_alien option is not true, the Alien module is added to the requires dynamic dependencies and checked again at build action time. no_late_alien => BOOL If true, suppresses the dynamic requires feature of Alien modules described above. alien_version => $version If the Alien:: module is not available, gives the module version of it that will be required to provide the pkg-config module of the required version. This gets added to requires. If neither the pkg-config module and no Alien:: module was requested (or none was found and no_late_alien was set), this method dies with an OS unsupported message, which is usually what is required for a Build.PL script. try_pkconfig $ok = $build->try_pkconfig( $modname, ... ) Boolean-returning version of "use_pkgconfig". If successful, returns true. If it fails it returns false rather than dying, allowing the Build.PL script to take alternative action. pkgconfig_atleast_version $ok = $build->pkgconfig_atleast_version( $modname, $modver ) Returns true if the pkg-config module name exists and has at least the given version. add_cflags_libs_from_pkgconfig $build->add_cflags_libs_from_pkgconfig( $modname ) Extend the extra_compiler_flags and extra_linker_flags arguments from the --cflags and --libs from the given pkg-config module name. alien_atleast_version $ok = $build->alien_atleast_version( $alien, $modver ) Returns true if the given Alien:: module provides a pkg-config module version at least the given version. add_cflags_libs_from_alien $build->add_cflags_libs_from_alien( $alien ) Extend the extra_compiler_flags and extra_linker_flags arguments from the --cflags and --libs from the given Alien:: module name. use_late_alien $ok = $build->use_late_alien( $alien, ... ) Adds an Alien module directly to the requires hash, and makes a note to use its cflags and libraries later at build time. Normally this method would not be necessary as it is automatically called from use_pkgconfig if required, but one use-case may be to provide a final last-ditch attempt after trying some other possible attempts, after an earlier call to use_pkgconfig with no_late_alien set. push_extra_compiler_flags $build->push_extra_compiler_flags( @flags ) Appends more values onto the extra_compiler_flags. push_extra_linker_flags $build->push_extra_linker_flags( @flags ) Appends more values onto the extra_linker_flags. TODO * Consider a quiet option to suppress verbose printing * Consider defining a constructor argument, perhaps build_requires_pkgconfig, to neaten the common case of simple requirements. * Consider further stealing the various helper methods from ExtUtils::CChecker and possibly splitting this class into a lower "C-using XS modules" and higher-level pkg-config+Alien layer. AUTHOR Paul Evans Module-Build-Using-PkgConfig-0.03/lib000755001750001750 013453626731 16147 5ustar00leoleo000000000000Module-Build-Using-PkgConfig-0.03/lib/Module000755001750001750 013453626731 17374 5ustar00leoleo000000000000Module-Build-Using-PkgConfig-0.03/lib/Module/Build000755001750001750 013453626731 20433 5ustar00leoleo000000000000Module-Build-Using-PkgConfig-0.03/lib/Module/Build/Using000755001750001750 013453626731 21520 5ustar00leoleo000000000000Module-Build-Using-PkgConfig-0.03/lib/Module/Build/Using/PkgConfig.pm000444001750001750 3101013453626731 24075 0ustar00leoleo000000000000# You may distribute under the terms of either the GNU General Public License # or the Artistic License (the same terms as Perl itself) # # (C) Paul Evans, 2019 -- leonerd@leonerd.org.uk package Module::Build::Using::PkgConfig; use strict; use warnings; use 5.010; # // use base qw( Module::Build ); use ExtUtils::PkgConfig; our $VERSION = '0.03'; =head1 NAME C - extend C to more easily use platform libraries provided by F =head1 SYNOPSIS In F: use Module::Build::Using::PkgConfig; my $build = Module::Build::Using::PkgConfig->new( module_name => "Module::Here", ... # other arguments as per Module::Build ); # A platform library provided by pkg-config $build->use_pkgconfig( "libfoo" ); # We need at least a given version $build->use_pkgconfig( "libbar", atleast_version => "0.5", ); # A platform librariy that's also wrapped as an Alien module $build->use_pkgconfig( "libsplot", atleast_version => "1.0", alien => "Alien::libsplot", alien_version => "0.05", # Alien::libsplot 0.05 provides libsplot v1.0 ); $build->create_build_script; =head1 DESCRIPTION This subclass of L provides some handy methods to assist the F script of XS-based module distributions that make use of platform libraries managed by F. As well as supporting libraries installed on a platform-wide basis and thus visible to F itself, this subclass also assists with C-based wrappers of these system libraries, allowing them to be dynamically installed at build time if the platform does not provide them. =head2 RPATH generation This module also provides some helper code to generate the required C arguments needed to link against the libraries found by inspecting the C. This attempts to duplicate the same logic performed by F when it would link a C program or library, as we don't get to use its code when linking dynamic libraries for Perl. =head1 PROPERTIES =over 4 =item no_late_aliens => BOOL If true, applies the C option to every use of C that specifies an Alien module. =back =cut =head1 METHODS =cut __PACKAGE__->add_property( 'no_late_aliens' ); sub new { my $class = shift; my $self = $class->SUPER::new( @_ ); $self->configure_requires->{ +__PACKAGE__ } //= 0; $self->configure_requires->{ $_ } //= 0 for our @ISA; if( $self->notes( 'late_aliens' ) ) { $self->notes( 'late_aliens' => undef ); } return $self; } =head2 use_pkgconfig $build->use_pkgconfig( $modname, ... ) Requires the given F module of the given version, and extends the compiler and linker arguments sufficient to build from it. Takes the following named options: =over 4 =item atleast_version => $modver If given, the F module is required to be at least the given version. If unspecified, then any version is considered sufficient. =item alien => $alien If given and the F module does not exist, try to use the given C module to provide it instead. If this module is not yet available and the C option is not true, the Alien module is added to the C dynamic dependencies and checked again at C action time. =item no_late_alien => BOOL If true, suppresses the dynamic C feature of Alien modules described above. =item alien_version => $version If the C module is not available, gives the module version of it that will be required to provide the F module of the required version. This gets added to C. =back If neither the F module and no C module was requested (or none was found and C was set), this method dies with an C message, which is usually what is required for a F script. =head2 try_pkconfig $ok = $build->try_pkconfig( $modname, ... ) Boolean-returning version of L. If successful, returns true. If it fails it returns false rather than dying, allowing the F script to take alternative action. =cut sub try_pkgconfig { my $self = shift; my ( $modname, %args ) = @_; my $atleast_version = $args{atleast_version} // 0; if( $self->pkgconfig_atleast_version( $modname, $atleast_version ) ) { print "Using $modname from pkg-config\n"; $self->add_cflags_libs_from_pkgconfig( $modname ); return 1; } if( defined( my $alien = $args{alien} ) ) { if( $self->alien_atleast_version( $alien, $atleast_version ) ) { print "Using $modname from $alien\n"; $self->add_cflags_libs_from_alien( $alien ); return 1; } return 0 if $args{no_late_alien} or $self->no_late_aliens; return $self->use_late_alien( $alien, %args ); } return 0; } sub use_pkgconfig { my $self = shift; my ( $modname ) = @_; $self->try_pkgconfig( @_ ) or die "OS unsupported - $modname unavailable in pkg-config\n"; } =head2 pkgconfig_atleast_version $ok = $build->pkgconfig_atleast_version( $modname, $modver ) Returns true if the F module name exists and has at least the given version. =cut sub pkgconfig_atleast_version { my $self = shift; my ( $modname, $modver ) = @_; # Silence its scary errors local *STDERR; open STDERR, ">>", "/dev/null" or die "Cannot reopen STDERR - $!"; print "Checking pkg-config $modname ", ( $modver ? "--atleast_version $modver" : "" ), "... "; my $ret = eval { ExtUtils::PkgConfig->atleast_version( $modname, $modver ) }; print $ret ? "yes\n" : "no\n"; return $ret; } =head2 add_cflags_libs_from_pkgconfig $build->add_cflags_libs_from_pkgconfig( $modname ) Extend the C and C arguments from the C<--cflags> and C<--libs> from the given F module name. =cut sub add_cflags_libs_from_pkgconfig { my $self = shift; my ( $modname ) = @_; my $cflags = ExtUtils::PkgConfig->cflags( $modname ); my $libs = ExtUtils::PkgConfig->libs( $modname ); $self->push_extra_compiler_flags( split( m/ +/, $cflags // '' ) ); $self->push_extra_linker_flags( split( m/ +/, $libs // '' ) ); } =head2 alien_atleast_version $ok = $build->alien_atleast_version( $alien, $modver ) Returns true if the given C module provides a F module version at least the given version. =cut sub alien_atleast_version { my $self = shift; my ( $alien, $modver ) = @_; print "Checking $alien ", ( $modver ? "atleast-version $modver" : "" ), "... "; ( my $file = "$alien.pm" ) =~ s{::}{/}g; my $ret = eval { require $file and $alien->atleast_version( $modver ) }; print $ret ? "yes\n" : "no\n"; return $ret; } =head2 add_cflags_libs_from_alien $build->add_cflags_libs_from_alien( $alien ) Extend the C and C arguments from the C<--cflags> and C<--libs> from the given C module name. =cut sub add_cflags_libs_from_alien { my $self = shift; my ( $alien ) = @_; $self->push_extra_compiler_flags( split( m/ +/, $alien->cflags // '' ) ); $self->push_extra_linker_flags( split( m/ +/, $alien->libs // '' ) ); } =head2 use_late_alien $ok = $build->use_late_alien( $alien, ... ) Adds an Alien module directly to the C hash, and makes a note to use its cflags and libraries later at build time. Normally this method would not be necessary as it is automatically called from L if required, but one use-case may be to provide a final last-ditch attempt after trying some other possible attempts, after an earlier call to C with C set. =cut sub use_late_alien { my $self = shift; my ( $alien, %args ) = @_; # No Alien module yet print "Adding $alien to build_depends\n"; # Order might matter my $late_aliens = $self->notes( 'late_aliens' ) // []; push @$late_aliens, { alien => $alien, atleast_version => $args{atleast_version} }; $self->requires->{$alien} = $args{alien_version} // 0; $self->notes( 'late_aliens' => $late_aliens ); return 1; } =head2 push_extra_compiler_flags $build->push_extra_compiler_flags( @flags ) Appends more values onto the C. =cut sub push_extra_compiler_flags { my $self = shift; # Eugh; M::B's API here takes lists to set, but returns ARRAYrefs $self->extra_compiler_flags( @{ $self->extra_compiler_flags }, @_ ); } =head2 push_extra_linker_flags $build->push_extra_linker_flags( @flags ) Appends more values onto the C. =cut sub push_extra_linker_flags { my $self = shift; # Eugh; M::B's API here takes lists to set, but returns ARRAYrefs $self->extra_linker_flags( @{ $self->extra_linker_flags }, @_ ); } sub ACTION_build { my $self = shift; my @args = @_; if( my $late_aliens = $self->notes( 'late_aliens' ) ) { foreach ( @$late_aliens ) { my ( $alien, $modver ) = delete @{$_}{qw( alien atleast_version )}; $self->alien_atleast_version( $alien, $modver ) or die "Unable to find $alien providing pkg-config version $modver\n"; $self->add_cflags_libs_from_alien( $alien ); } } if( @{ $self->extra_linker_flags } ) { $self->_generate_rpaths; } $self->SUPER::ACTION_build( @args ); } sub _generate_rpaths { my $self = shift; # This is all a bit of a mess. # In general, if we're being asked to link against libraries that aren't on # the system search path, we'll have to invent extra -rpath arguments to # pass to the linker to set RPATH in the resultant library. # # To work out what we need, we'll have to recreate the linker's search # strategy, looking for actual libFOO.so.NUM files, and accumulate what # paths they live in. Subtract from that any standard system locations, and # whatever we've got left gets added as RUNPATH # # Also, none of this is specific to using pkg-config, and could apply # equally to any C-library-using code. This probably wants moving to a more # generic "Module::Build::Using::C" or somesuch if one ever gets built. # # Further, this is very GNU/ELF-specific. Likely different logic would # apply on Mac OSX, Windows or other platforms. # TODO: Hunt /etc/ld.so.conf for more of these my @system_libdirs = qw( /lib /usr/lib ); my @libdirs = @system_libdirs; my @rpaths; my @ldflags = @{ $self->extra_linker_flags }; my @extra_linker_flags; FLAG: while( @ldflags ) { my $flag = shift @ldflags; if( $flag =~ m/^-L(.*)$/ ) { # Another -LDIR to search in push @extra_linker_flags, $flag; push @libdirs, $1; next FLAG; } if( $flag =~ m/^-l(.*)$/ ) { # Another libFOO.so to hunt for push @extra_linker_flags, $flag; my $soname = "lib$1.so"; my $libdir; -f "$_/$soname" and $libdir = $_ and last for @libdirs; defined $libdir or next FLAG; # Skip if it's a system one, or already known $_ eq $libdir and next FLAG for @system_libdirs, @rpaths; push @rpaths, $libdir; next FLAG; } if( $flag =~ m/^-Wl,-R(.+)$/ or $flag =~ m/^-Wl,-rpath[=,](.*)$/ or $flag =~ m/^-Wl,-rpath$/ && $ldflags[0] =~ m/^-Wl,(.*)$/ && shift @ldflags ) { # Another RPATH is specified. Don't necessarily add it to # @extra_linker_flags yet in case it's a duplicate my $libdir = $1; # Don't try to validate if it's needed though; presume the linker # flags generally know best. # Skip if it's a system one, or already known $_ eq $libdir and next FLAG for @system_libdirs, @rpaths; push @rpaths, $libdir; next FLAG; } push @extra_linker_flags, $flag; } foreach my $rpath ( @rpaths ) { push @extra_linker_flags, "-Wl,-rpath=$rpath"; } # Reset the flags to remove any duplicates $self->extra_linker_flags( @extra_linker_flags ); } =head1 TODO =over 4 =item * Consider a C option to suppress verbose printing =item * Consider defining a constructor argument, perhaps C, to neaten the common case of simple requirements. =item * Consider further stealing the various helper methods from L and possibly splitting this class into a lower "C-using XS modules" and higher-level F+Alien layer. =back =cut =head1 AUTHOR Paul Evans =cut 0x55AA; Module-Build-Using-PkgConfig-0.03/t000755001750001750 013453626731 15644 5ustar00leoleo000000000000Module-Build-Using-PkgConfig-0.03/t/00use.t000444001750001750 17113453626731 17101 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use_ok( 'Module::Build::Using::PkgConfig' ); done_testing; Module-Build-Using-PkgConfig-0.03/t/99pod.t000444001750001750 25713453626731 17116 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok();