How can I examine a Perl file (utility or module), and get list of all of the subroutines used in it, and where they come
from?
Our utilities use a lot of in-house modules, and it's routine for developers to simply paste in a long list of
'use modX;' statements without checking whether or not the module is actually needed. This is the case not only for
utilities, but for the modules themselves. Or, if a subroutine is no longer used in file, the use statement that
pulled it in isn't updated or removed. The result is that we've accumulated a lot of unused functionality, and can't
identify what we don't need. I'd like to figure out which subroutines in an imported module are actually used, so we
can clean up or consolidate our libraries. I could also build a map of our entire repository of utilities and modules
and give awards to those subroutines/modules that are frequently referenced ... :)
A couple of considerations:
- I can't execute the utility/module I'm analyzing. (perl -c is ok, tho' -- see approach 2 below)
This constraint eliminated the use of some promising CPAN modules.
- I need to recognize object methods as subroutine calls. (Happily, we don't use class inheritance.)
There are two approaches I've considered:
- Write a parser to make a list of the subroutines defined or called within a file (utility or module).
I started with this, but it quickly got messy, since subroutine calls may or may not use parentheses, might be
nested in other calls, etc.
- Let Perl do the parsing, and examine the symbol table for CODE symbols. This is where perl -c is handy for
compiling everything, then executing BEGIN blocks, but not executing anything else:
cat <utility|module> begin.pl | perl -c
where begin.pl is something like:
BEGIN {
print "$_=$main::{$_}\n" foreach grep(*{$main::{$_}}{CODE}, sort keys %main::);
}
This does list all of the code symbols defined in the utility ... and, unfortunately, those defined in any imported
modules, all listed as if belonging to main::. I'm not sure how to distinguish the imported symbols from those
defined in the target file.
Note that begin.pl is actually more complicated than the above because I want to harvest module locations from %INC,
and potentially look at the module symbol tables as well.
Any ideas?
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|