.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Module::ExtractUse 3"
.TH Module::ExtractUse 3 "2008-01-07" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Module::ExtractUse \- Find out what modules are used
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Module::ExtractUse;
.Ve
.PP
.Vb 2
\&  # get a parser
\&  my $p=Module::ExtractUse->new;
.Ve
.PP
.Vb 2
\&  # parse from a file
\&  $p->extract_use('/path/to/module.pm');
.Ve
.PP
.Vb 2
\&  # or parse from a ref to a string in memory
\&  $p->extract_use(\e$string_containg_code);
.Ve
.PP
.Vb 3
\&  # use some reporting methods
\&  my $used=$p->used;           # $used is a HASHREF
\&  print $p->used('strict')     # true if code includes 'use strict'
.Ve
.PP
.Vb 2
\&  my @used=$p->array;
\&  my $used=$p->string;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Module::ExtractUse is basically a Parse::RecDescent grammar to parse
Perl code. It tries very hard to find all modules (whether pragmas,
Core, or from \s-1CPAN\s0) used by the parsed code.
.PP
\&\*(L"Usage\*(R" is defined by either calling \f(CW\*(C`use\*(C'\fR or \f(CW\*(C`require\*(C'\fR.
.Sh "Methods"
.IX Subsection "Methods"
\fInew\fR
.IX Subsection "new"
.PP
Returns a parser object
.PP
\fIextract_use\fR
.IX Subsection "extract_use"
.PP
\&\f(CW\*(C`extract_use($code_to_parse)\*(C'\fR
.PP
Runs the parser.
.PP
\&\f(CW$code_to_parse\fR can be either a \s-1SCALAR\s0, in which case
Module::ExtractUse tries to open the file specified in
\&\f(CW$code_to_parse\fR. Or a reference to a \s-1SCALAR\s0, in which case
Module::ExtractUse assumes the referenced scalar contains the source
code.
.PP
The code will be stripped from \s-1POD\s0 (using Pod::Strip) and splitted on \*(L";\*(R"
(semicolon). Each statement (i.e. the stuff between two semicolons) is
checked by a simple regular expression.
.PP
If the statement contains either 'use' or 'require', the statment is
handed over to the parser, who then tries to figure out, \fBwhat\fR is
used or required. The results will be saved in a data structure that
you can examine afterwards.
.PP
You can call \f(CW\*(C`extract_use\*(C'\fR several times on different files. It will
count how many files where examined and how often each module was used.
.Sh "Accessor Methods"
.IX Subsection "Accessor Methods"
Those are various ways to get at the result of the parse.
.PP
Note that \f(CW\*(C`extract_use\*(C'\fR returns the parser object, so you can say
.PP
.Vb 1
\&  print $p->extract_use($code_to_parse)->string;
.Ve
.PP
\fIused\fR
.IX Subsection "used"
.PP
If called without an argument, returns a reference to an hash of all
used modules. Keys are the names of the modules, values are the number
of times they were used.
.PP
If called with an argument, looks up the value of the argument in the
hash and returns the number of times it was found during parsing.
.PP
This is the prefered accessor.
.PP
\fIstring\fR
.IX Subsection "string"
.PP
string($seperator)
.PP
Returns a sorted string of all used modules, joined using the value of
\&\f(CW$seperator\fR or using a blank space as a default;
.PP
Module names are sorted by ascii value (i.e by \f(CW\*(C`sort\*(C'\fR)
.PP
\fIarray\fR
.IX Subsection "array"
.PP
Returns an array of all used modules.
.PP
\fIarrayref\fR
.IX Subsection "arrayref"
.PP
Returns a reference to an array of all used modules. Surprise!
.PP
\fIfiles\fR
.IX Subsection "files"
.PP
Returns the number of files parsed by the parser object.
.SH "RE-COMPILING THE GRAMMAR"
.IX Header "RE-COMPILING THE GRAMMAR"
If \- for some reasons \- you need to alter the grammar, edit the file
\&\fIgrammar\fR and afterwards run:
.PP
.Vb 1
\&  perl -MParse::RecDescent - grammar Module::ExtractUse::Grammar
.Ve
.PP
Make sure you're in the right directory, i.e. in \fI.../Module/ExtractUse/\fR
.SH "EXPORTS"
.IX Header "EXPORTS"
Nothing.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Parse::RecDescent, Module::ScanDeps, Module::Info, Module::CPANTS::Analyse
.SH "AUTHOR"
.IX Header "AUTHOR"
Thomas Klausner <domm@zsi.at>
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-module\-extractuse@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.  I will be notified, and then you'll automatically
be notified of progress on your bug as I make changes.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Module::ExtractUse is Copyright (c) 2003\-2007, Thomas Klausner.
.PP
You may use and distribute this module according to the same terms
that Perl is distributed under.