1Module::ExtractUse(3) User Contributed Perl DocumentationModule::ExtractUse(3)
2
6 Module::ExtractUse - Find out what modules are used
7
9 version 0.345
10
12 use Module::ExtractUse;
13 # get a parser
15 my $p=Module::ExtractUse->new;
16 # parse from a file
18 $p->extract_use('/path/to/module.pm');
19 # or parse from a ref to a string in memory
21 $p->extract_use(\$string_containg_code);
22 # use some reporting methods
24 my $used=$p->used; # $used is a HASHREF
25 print $p->used('strict') # true if code includes 'use strict'
26 my @used=$p->array;
28 my $used=$p->string;
29 # you can get optional modules, that is used in eval context, in the same style
31 my $used=$p->used_in_eval; # $used is a HASHREF
32 print $p->used_in_eval('strict') # true if code includes 'use strict'
33 my @used=$p->array_in_eval;
35 my $used=$p->string_in_eval;
36 # and mandatory modules, that is used out of eval context, in the same style, also.
38 my $used=$p->used_out_of_eval; # $used is a HASHREF
39 print $p->used_out_of_eval('strict') # true if code includes 'use strict'
40 my @used=$p->array_out_of_eval;
42 my $used=$p->string_out_of_eval;
43
45 "Module::ExtractUse" is basically a Parse::RecDescent grammar to parse
46 Perl code. It tries very hard to find all modules (whether pragmas,
47 Core, or from CPAN) used by the parsed code.
48 "Usage" is defined by either calling "use" or "require".
50 Methods
52 new
53 my $p=Module::ExtractUse->new;
55 Returns a parser object
57 extract_use($code_to_parse)
59 $p->extract_use('/path/to/module.pm');
61 $p->extract_use(\$string_containg_code);
62 Runs the parser.
64 $code_to_parse can be either a SCALAR, in which case
66 "Module::ExtractUse" tries to open the file specified in
67 $code_to_parse. Or a reference to a SCALAR, in which case
68 "Module::ExtractUse" assumes the referenced scalar contains the source
69 code.
70 The code will be stripped from POD (using Pod::Strip) and split on ";"
72 (semicolon). Each statement (i.e. the stuff between two semicolons) is
73 checked by a simple regular expression.
74 If the statement contains either 'use' or 'require', the statement is
76 handed over to the parser, who then tries to figure out, what is used
77 or required. The results will be saved in a data structure that you can
78 examine afterwards.
79 You can call "extract_use" several times on different files. It will
81 count how many files were examined and how often each module was used.
82 Accessor Methods
84 Those are various ways to get at the result of the parse.
85 Note that "extract_use" returns the parser object, so you can say
87 print $p->extract_use($code_to_parse)->string;
89 used
91 my $used=$p->used; # $used is a HASHREF
93 print $p->used('strict') # true if code includes 'use strict'
94 If called without an argument, returns a reference to a hash of all
96 used modules. Keys are the names of the modules, values are the number
97 of times they were used.
98 If called with an argument, looks up the value of the argument in the
100 hash and returns the number of times it was found during parsing.
101 This is the preferred accessor.
103 used_in_eval
105 Same as "used", except for considering in-eval-context only.
107 used_out_of_eval
109 Same as "used", except for considering NOT-in-eval-context only.
111 required
113 Same as "used", except for considering 'require'd modules only.
115 required_in_eval
117 Same as "required", except for considering in-eval-context only.
119 required_out_of_eval
121 Same as "required", except for considering NOT-in-eval-context only.
123 noed
125 Same as "used", except for considering 'no'ed modules only.
127 noed_in_eval
129 Same as "noed", except for considering in-eval-context only.
131 noed_out_of_eval
133 Same as "noed", except for considering NOT-in-eval-context only.
135 string
137 print $p->string($seperator)
139 Returns a sorted string of all used modules, joined using the value of
141 $seperator or using a blank space as a default;
142 Module names are sorted by ascii value (i.e by "sort")
144 string_in_eval
146 Same as "string", except for considering in-eval-context only.
148 string_out_of_eval
150 Same as "string", except for considering NOT-in-eval-context only.
152 array
154 my @array = $p->array;
156 Returns an array of all used modules.
158 array_in_eval
160 Same as "array", except for considering in-eval-context only.
162 array_out_of_eval
164 Same as "array", except for considering NOT-in-eval-context only.
166 arrayref
168 my $arrayref = $p->arrayref;
170 Returns a reference to an array of all used modules. Surprise!
172 arrayref_in_eval
174 Same as "array_ref", except for considering in-eval-context only.
176 arrayref_out_of_eval
178 Same as "array_ref", except for considering NOT-in-eval-context only.
180 files
182 Returns the number of files parsed by the parser object.
184
186 If - for some reasons - you need to alter the grammar, edit the file
187 grammar and afterwards run:
188 perl -MParse::RecDescent - grammar Module::ExtractUse::Grammar
190 Make sure you're in the right directory, i.e. in .../Module/ExtractUse/
192
194 Nothing.
195
197 Parse::RecDescent, Module::Extract::Use, Module::ScanDeps,
198 Module::Info, Module::CPANTS::Analyse, Perl::PrereqScanner,
199 Perl::PrereqScanner::Lite, Perl::PrereqScanner::NotQuiteLite
200
202 • Anthony Brummett <https://github.com/brummett> implemented support
203 for "Module::Runtime" and "Class::Load" while participating in the
204 CPAN Pull Request Challenge <http://cpan-prc.org/>
205 • Jeremy Mates <https://github.com/thrig> fixed some documentation
207 errors
208 • Jonathan Yu provided a nice script, "example/extractuse.pl"
210 If I forgot to mention your contribution, please send an email or open
212 an issue / ticket.
213
215 • Thomas Klausner <domm@cpan.org>
216 • Kenichi Ishigaki <kishigaki@gmail.com>
218
220 This software is copyright (c) 2014 - 2021 by Thomas Klausner.
221 This is free software; you can redistribute it and/or modify it under
223 the same terms as the Perl 5 programming language system itself.
224perl v5.36.0 2023-01-20 Module::ExtractUse(3)