NAME

Module::Used - Find modules loaded by Perl code without running it.

VERSION

This document describes Module::Used version 1.2.0.

SYNOPSIS

    use Module::Used qw< :all >;

    @modules = modules_used_in_files(@files);

    # "strict", "Find::Bin", "warnings"
    @modules = modules_used_in_string(
        'use strict; require Find::Bin; no warnings;'
    );

    # "Exporter"
    @modules = modules_used_in_string( 'use parent 0.221 qw< Exporter >;' );

DESCRIPTION

Modules are found statically based upon "use" and "require" statements. If use of the base or parent is found, both that module and the referenced ones will be returned. If Moose or Moose::Role are found, this will look for "extends" and "with" sugar will be looked for; presently, this will miss modules listed in parentheses.

Dynamically loaded modules will not be found.

INTERFACE

Nothing is exported by default, but you can import everything using the ":all" tag.

" modules_used_in_files( @files ) ": Return a list of modules used in the specified files.
"die"s if there is a problem reading a file.
" modules_used_in_string( $string ) ": Return a list of modules used in the code in the parameter.
" modules_used_in_document( $document ) ": Return a list of modules used in the specified PPI::Document.

DIAGNOSTICS

"%s" does not exist.: Cannot find the file.
"%s" is not readable.: Cannot read the file.
"%s" is a directory.: The "file" was actually a directory.
Could not parse "%s".: PPI could not interpret the file as a Perl document.

CONFIGURATION AND ENVIRONMENT

None, currently.

DEPENDENCIES

PPI::Document

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

None reported.

Please report any bugs or feature requests to "bug-module-used@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

AUTHOR

Elliot Shank "<perl@galumph.com>"

LICENSE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "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 SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

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 SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (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 SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.