<h2>Editing File: /lib64/perl5/B/Showlex.pm</h2><form method='post'><textarea name='content' class='file-edit'>package B::Showlex;

our $VERSION = '1.05';

use strict;
use B qw(svref_2object comppadlist class);
use B::Terse ();
use B::Concise ();

#
# Invoke as
#     perl -MO=Showlex,foo bar.pl
# to see the names of lexical variables used by &amp;foo
# or as
#     perl -MO=Showlex bar.pl
# to see the names of file scope lexicals used by bar.pl
#


# borrowed from B::Concise
our $walkHandle = \*STDOUT;

sub walk_output { # updates $walkHandle
    $walkHandle = B::Concise::walk_output(@_);
    #print &quot;got $walkHandle&quot;;
    #print $walkHandle &quot;using it&quot;;
    $walkHandle;
}

sub shownamearray {
    my ($name, $av) = @_;
    my @els = $av-&gt;ARRAY;
    my $count = @els;
    my $i;
    print $walkHandle &quot;$name has $count entries\n&quot;;
    for ($i = 0; $i &lt; $count; $i++) {
	my $sv = $els[$i];
	if (class($sv) ne &quot;SPECIAL&quot;) {
	    printf $walkHandle &quot;$i: (0x%lx) %s\n&quot;,
				$$sv, $sv-&gt;PVX // &quot;undef&quot; || &quot;const&quot;;
	} else {
	    printf $walkHandle &quot;$i: %s\n&quot;, $sv-&gt;terse;
	    #printf $walkHandle &quot;$i: %s\n&quot;, B::Concise::concise_sv($sv);
	}
    }
}

sub showvaluearray {
    my ($name, $av) = @_;
    my @els = $av-&gt;ARRAY;
    my $count = @els;
    my $i;
    print $walkHandle &quot;$name has $count entries\n&quot;;
    for ($i = 0; $i &lt; $count; $i++) {
	printf $walkHandle &quot;$i: %s\n&quot;, $els[$i]-&gt;terse;
	#print $walkHandle &quot;$i: %s\n&quot;, B::Concise::concise_sv($els[$i]);
    }
}

sub showlex {
    my ($objname, $namesav, $valsav) = @_;
    shownamearray(&quot;Pad of lexical names for $objname&quot;, $namesav);
    showvaluearray(&quot;Pad of lexical values for $objname&quot;, $valsav);
}

my ($newlex, $nosp1); # rendering state vars

sub padname_terse {
    my $name = shift;
    return $name-&gt;terse if class($name) eq 'SPECIAL';
    my $str = $name-&gt;PVX;
    return sprintf &quot;(0x%lx) %s&quot;,
	       $$name,
	       length $str ? qq'&quot;$str&quot;' : defined $str ? &quot;const&quot; : 'undef';
}

sub newlex { # drop-in for showlex
    my ($objname, $names, $vals) = @_;
    my @names = $names-&gt;ARRAY;
    my @vals  = $vals-&gt;ARRAY;
    my $count = @names;
    print $walkHandle &quot;$objname Pad has $count entries\n&quot;;
    printf $walkHandle &quot;0: %s\n&quot;, padname_terse($names[0]) unless $nosp1;
    for (my $i = 1; $i &lt; $count; $i++) {
	printf $walkHandle &quot;$i: %s = %s\n&quot;, padname_terse($names[$i]),
					    $vals[$i]-&gt;terse,
	    unless $nosp1
	       and class($names[$i]) eq 'SPECIAL' || !$names[$i]-&gt;LEN;
    }
}

sub showlex_obj {
    my ($objname, $obj) = @_;
    $objname =~ s/^&amp;main::/&amp;/;
    showlex($objname, svref_2object($obj)-&gt;PADLIST-&gt;ARRAY) if !$newlex;
    newlex ($objname, svref_2object($obj)-&gt;PADLIST-&gt;ARRAY) if  $newlex;
}

sub showlex_main {
    showlex(&quot;comppadlist&quot;, comppadlist-&gt;ARRAY)	if !$newlex;
    newlex (&quot;main&quot;, comppadlist-&gt;ARRAY)		if  $newlex;
}

sub compile {
    my @options = grep(/^-/, @_);
    my @args = grep(!/^-/, @_);
    for my $o (@options) {
	$newlex = 1 if $o eq &quot;-newlex&quot;;
	$nosp1  = 1 if $o eq &quot;-nosp&quot;;
    }

    return \&amp;showlex_main unless @args;
    return sub {
	my $objref;
	foreach my $objname (@args) {
	    next unless $objname;	# skip nulls w/o carping

	    if (ref $objname) {
		print $walkHandle &quot;B::Showlex::compile($objname)\n&quot;;
		$objref = $objname;
	    } else {
		$objname = &quot;main::$objname&quot; unless $objname =~ /::/;
		print $walkHandle &quot;$objname:\n&quot;;
		no strict 'refs';
		die &quot;err: unknown function ($objname)\n&quot;
		    unless *{$objname}{CODE};
		$objref = \&amp;$objname;
	    }
	    showlex_obj($objname, $objref);
	}
    }
}

1;

__END__

=head1 NAME

B::Showlex - Show lexical variables used in functions or files

=head1 SYNOPSIS

	perl -MO=Showlex[,-OPTIONS][,SUBROUTINE] foo.pl

=head1 DESCRIPTION

When a comma-separated list of subroutine names is given as options, Showlex
prints the lexical variables used in those subroutines.  Otherwise, it prints
the file-scope lexicals in the file.

=head1 EXAMPLES

Traditional form:

 $ perl -MO=Showlex -e 'my ($i,$j,$k)=(1,&quot;foo&quot;)'
 Pad of lexical names for comppadlist has 4 entries
 0: (0x8caea4) undef
 1: (0x9db0fb0) $i
 2: (0x9db0f38) $j
 3: (0x9db0f50) $k
 Pad of lexical values for comppadlist has 5 entries
 0: SPECIAL #1 &amp;PL_sv_undef
 1: NULL (0x9da4234)
 2: NULL (0x9db0f2c)
 3: NULL (0x9db0f44)
 4: NULL (0x9da4264)
 -e syntax OK

New-style form:

 $ perl -MO=Showlex,-newlex -e 'my ($i,$j,$k)=(1,&quot;foo&quot;)'
 main Pad has 4 entries
 0: (0x8caea4) undef
 1: (0xa0c4fb8) &quot;$i&quot; = NULL (0xa0b8234)
 2: (0xa0c4f40) &quot;$j&quot; = NULL (0xa0c4f34)
 3: (0xa0c4f58) &quot;$k&quot; = NULL (0xa0c4f4c)
 -e syntax OK

New form, no specials, outside O framework:

 $ perl -MB::Showlex -e \
    'my ($i,$j,$k)=(1,&quot;foo&quot;); B::Showlex::compile(-newlex,-nosp)-&gt;()'
 main Pad has 4 entries
 1: (0x998ffb0) &quot;$i&quot; = IV (0x9983234) 1
 2: (0x998ff68) &quot;$j&quot; = PV (0x998ff5c) &quot;foo&quot;
 3: (0x998ff80) &quot;$k&quot; = NULL (0x998ff74)

Note that this example shows the values of the lexicals, whereas the other
examples did not (as they're compile-time only).

=head2 OPTIONS

The C&lt;-newlex&gt; option produces a more readable C&lt;&lt; name =&gt; value &gt;&gt; format,
and is shown in the second example above.

The C&lt;-nosp&gt; option eliminates reporting of SPECIALs, such as C&lt;0: SPECIAL
#1 &amp;PL_sv_undef&gt; above.  Reporting of SPECIALs can sometimes overwhelm
your declared lexicals.

=head1 SEE ALSO

L&lt;B::Showlex&gt; can also be used outside of the O framework, as in the third
example.  See L&lt;B::Concise&gt; for a fuller explanation of reasons.

=head1 TODO

Some of the reported info, such as hex addresses, is not particularly
valuable.  Other information would be more useful for the typical
programmer, such as line-numbers, pad-slot reuses, etc..  Given this,
-newlex is not a particularly good flag-name.

=head1 AUTHOR

Malcolm Beattie, C&lt;mbeattie@sable.ox.ac.uk&gt;

=cut
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Flib64%2Fperl5%2FB'>Back to Directory</a>