ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Devel-FindRef/FindRef.pm
(Generate patch)

Comparing Devel-FindRef/FindRef.pm (file contents):
Revision 1.12 by root, Fri Jul 11 21:09:30 2008 UTC vs.
Revision 1.16 by root, Fri Sep 19 05:07:56 2008 UTC

1package Devel::FindRef; 1package Devel::FindRef;
2 2
3no warnings; # I hate warning nazis
3use strict; 4use strict;
4 5
5use XSLoader; 6use XSLoader;
6use Scalar::Util; 7use Scalar::Util;
7 8
8BEGIN { 9BEGIN {
9 our $VERSION = '1.2'; 10 our $VERSION = '1.31';
10 XSLoader::load __PACKAGE__, $VERSION; 11 XSLoader::load __PACKAGE__, $VERSION;
11} 12}
12 13
13=head1 NAME 14=head1 NAME
14 15
15Devel::FindRef - where is that reference to my scalar hiding? 16Devel::FindRef - where is that reference to my variable hiding?
16 17
17=head1 SYNOPSIS 18=head1 SYNOPSIS
18 19
19 use Devel::FindRef; 20 use Devel::FindRef;
21
22 print Devel::FindRef::track \$some_variable;
20 23
21=head1 DESCRIPTION 24=head1 DESCRIPTION
22 25
23Tracking down reference problems (e.g. you expect some object to be 26Tracking down reference problems (e.g. you expect some object to be
24destroyed, but there are still references to it that keep it alive) can be 27destroyed, but there are still references to it that keep it alive) can be
… …
45 testsub; 48 testsub;
46 49
47The output is as follows (or similar to this, in case I forget to update 50The output is as follows (or similar to this, in case I forget to update
48the manpage after some changes): 51the manpage after some changes):
49 52
50 SCALAR(0x7bd2d0) is 53 SCALAR(0x814ece8) is
51 in the global $Test::var. 54 +- in the global $Test::var.
52 referenced by REF(0x7bd240), which is 55 +- referenced by REF(0x814f9e4), which is
53 in the member 'ukukey2' of HASH(0x7bd228), which is
54 referenced by REF(0x81dae8), which is
55 in the lexical '$local' in CODE(0x81da88), which is 56 | in the lexical '$x' in CODE(0x814ed78), which is
57 | the containing scope for CODE(0x820c4b0), which is
56 in the global &Test::testsub. 58 | in the global &Test::testsub.
59 +- referenced by REF(0x814ed6c), which is
60 | in the member 'ukukey' of HASH(0x81da20c), which is
61 | in the global %Test::hash.
62 +- referenced by REF(0x814ec28), which is
63 | not found anywhere I looked :(
64 +- referenced by REF(0x814eb44), which is
65 in the member 'ukukey2' of HASH(0x814f99c), which is
57 referenced by REF(0x81da40), which is 66 +- referenced by REF(0x820c450), which is
67 | in the lexical '$local' in CODE(0x820c4b0), which was seen before.
68 +- referenced by REF(0x820c204), which is
58 in the global $Test::hash2. 69 in the global $Test::hash2.
59 referenced by REF(0x79f3f8), which is
60 in the lexical '$x' in CODE(0x79f518), which is
61 the containing scope for CODE(0x81da88), which is
62 in the global &Test::testsub.
63 referenced by REF(0x79f2f0), which is
64 not found anywhere I looked :(
65 referenced by REF(0x79f140), which is
66 in the member 'ukukey' of HASH(0x81d698), which is
67 in the global %Test::hash.
68 70
69It is a bit convoluted to read, but basically it says that the value 71It is a bit convoluted to read, but basically it says that the value
70stored in C<$var> can be found: 72stored in C<$var> can be found:
71 73
72=over 4 74=over 4
… …
120 my (@about) = find $$refref; 122 my (@about) = find $$refref;
121 if (@about) { 123 if (@about) {
122 for my $about (@about) { 124 for my $about (@about) {
123 $buf .= "$indent" . (@about > 1 ? "+- " : " ") . $about->[0]; 125 $buf .= "$indent" . (@about > 1 ? "+- " : " ") . $about->[0];
124 if (@$about > 1) { 126 if (@$about > 1) {
125 if ($seen{$about->[1]+0}++) { 127 if ($seen{ref2ptr $about->[1]}++) {
126 $buf .= " $about->[1], which was seen before.\n"; 128 $buf .= " $about->[1], which was seen before.\n";
127 } else { 129 } else {
128 $buf .= " $about->[1], which is\n"; 130 $buf .= " $about->[1], which is\n";
129 $track->(\$about->[1], $depth - 1, $about == $about[-1] ? "$indent " : "$indent| "); 131 $track->(\$about->[1], $depth - 1, $about == $about[-1] ? "$indent " : "$indent| ");
130 } 132 }
… …
158=cut 160=cut
159 161
160sub find($) { 162sub find($) {
161 my ($about, $excl) = &find_; 163 my ($about, $excl) = &find_;
162 my %excl = map +($_ => undef), @$excl; 164 my %excl = map +($_ => undef), @$excl;
163 grep !exists $excl{$_->[1] + 0}, @$about 165 grep !exists $excl{ref2ptr $_->[1]}, @$about
164} 166}
165 167
166=item $ref = Devel::FindRef::ptr2ref $integer 168=item $ref = Devel::FindRef::ptr2ref $integer
167 169
168Sometimes you know (from debugging output) the address of a perl scalar 170Sometimes you know (from debugging output) the address of a perl scalar
… …
171call on valid addresses, but extremely dangerous to call on invalid ones. 173call on valid addresses, but extremely dangerous to call on invalid ones.
172 174
173 # we know that HASH(0x176ff70) exists, so turn it into a hashref: 175 # we know that HASH(0x176ff70) exists, so turn it into a hashref:
174 my $ref_to_hash = Devel::FindRef::ptr2ref 0x176ff70; 176 my $ref_to_hash = Devel::FindRef::ptr2ref 0x176ff70;
175 177
178=item $ref = Devel::FindRef::ref2ptr $reference
179
180The opposite of C<ptr2ref>, above: returns the internal address of the
181value pointed to by the passed reference. I<No checks whatsoever will be
182done>, so don't use this.
183
176=back 184=back
177 185
178=head1 ENVIRONMENT VARIABLES 186=head1 ENVIRONMENT VARIABLES
179 187
180You can set the environment variable C<PERL_DEVEL_FINDREF_DEPTH> to an 188You can set the environment variable C<PERL_DEVEL_FINDREF_DEPTH> to an

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines