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.10 by root, Sat Apr 26 03:15:28 2008 UTC vs.
Revision 1.15 by root, Sat Jul 19 01:38:57 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;
20 21
… …
45 testsub; 46 testsub;
46 47
47The output is as follows (or similar to this, in case I forget to update 48The output is as follows (or similar to this, in case I forget to update
48the manpage after some changes): 49the manpage after some changes):
49 50
50 SCALAR(0x7bd2d0) is 51 SCALAR(0x814ece8) is
51 in the global $Test::var. 52 +- in the global $Test::var.
52 referenced by REF(0x7bd240), which is 53 +- 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 54 | in the lexical '$x' in CODE(0x814ed78), which is
55 | the containing scope for CODE(0x820c4b0), which is
56 in the global &Test::testsub. 56 | in the global &Test::testsub.
57 +- referenced by REF(0x814ed6c), which is
58 | in the member 'ukukey' of HASH(0x81da20c), which is
59 | in the global %Test::hash.
60 +- referenced by REF(0x814ec28), which is
61 | not found anywhere I looked :(
62 +- referenced by REF(0x814eb44), which is
63 in the member 'ukukey2' of HASH(0x814f99c), which is
57 referenced by REF(0x81da40), which is 64 +- referenced by REF(0x820c450), which is
65 | in the lexical '$local' in CODE(0x820c4b0), which was seen before.
66 +- referenced by REF(0x820c204), which is
58 in the global $Test::hash2. 67 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 68
69It is a bit convoluted to read, but basically it says that the value 69It is a bit convoluted to read, but basically it says that the value
70stored in C<$var> can be found: 70stored in C<$var> can be found:
71 71
72=over 4 72=over 4
… …
107sub track { 107sub track {
108 my ($ref, $depth) = @_; 108 my ($ref, $depth) = @_;
109 @_ = (); 109 @_ = ();
110 110
111 my $buf = ""; 111 my $buf = "";
112 my %seen;
112 113
113 Scalar::Util::weaken $ref; 114 Scalar::Util::weaken $ref;
114 115
115 my $track; $track = sub { 116 my $track; $track = sub {
116 my ($refref, $depth, $indent) = @_; 117 my ($refref, $depth, $indent) = @_;
117 118
118 if ($depth) { 119 if ($depth) {
119 my (@about) = find $$refref; 120 my (@about) = find $$refref;
120 if (@about) { 121 if (@about) {
121 for my $about (@about) { 122 for my $about (@about) {
122 $buf .= (" ") x $indent; 123 $buf .= "$indent" . (@about > 1 ? "+- " : " ") . $about->[0];
123 $buf .= $about->[0];
124 if (@$about > 1) { 124 if (@$about > 1) {
125 if ($seen{ref2ptr $about->[1]}++) {
126 $buf .= " $about->[1], which was seen before.\n";
127 } else {
125 $buf .= " $about->[1], which is\n"; 128 $buf .= " $about->[1], which is\n";
126 $track->(\$about->[1], $depth - 1, $indent + 1); 129 $track->(\$about->[1], $depth - 1, $about == $about[-1] ? "$indent " : "$indent| ");
130 }
127 } else { 131 } else {
128 $buf .= ".\n"; 132 $buf .= ".\n";
129 } 133 }
130 } 134 }
131 } else { 135 } else {
132 $buf .= (" ") x $indent;
133 $buf .= "not found anywhere I looked :(\n"; 136 $buf .= "$indent not found anywhere I looked :(\n";
134 } 137 }
135 } else { 138 } else {
136 $buf .= (" ") x $indent;
137 $buf .= "not referenced within the search depth.\n"; 139 $buf .= "$indent not referenced within the search depth.\n";
138 } 140 }
139 }; 141 };
140 142
141 $buf .= "$ref is\n"; 143 $buf .= "$ref is\n";
142 $track->(\$ref, $depth || 10, 1); 144 $track->(\$ref, $depth || $ENV{PERL_DEVEL_FINDREF_DEPTH} || 10, "");
143 $buf 145 $buf
144} 146}
145 147
146=item @references = Devel::FindRef::find $ref 148=item @references = Devel::FindRef::find $ref
147 149
… …
156=cut 158=cut
157 159
158sub find($) { 160sub find($) {
159 my ($about, $excl) = &find_; 161 my ($about, $excl) = &find_;
160 my %excl = map +($_ => undef), @$excl; 162 my %excl = map +($_ => undef), @$excl;
161 grep !exists $excl{$_->[1] + 0}, @$about 163 grep !exists $excl{ref2ptr $_->[1]}, @$about
162} 164}
163 165
164=item $ref = Devel::FindRef::ptr2ref $integer 166=item $ref = Devel::FindRef::ptr2ref $integer
165 167
166Sometimes you know (from debugging output) the address of a perl scalar 168Sometimes you know (from debugging output) the address of a perl scalar
… …
169call on valid addresses, but extremely dangerous to call on invalid ones. 171call on valid addresses, but extremely dangerous to call on invalid ones.
170 172
171 # we know that HASH(0x176ff70) exists, so turn it into a hashref: 173 # we know that HASH(0x176ff70) exists, so turn it into a hashref:
172 my $ref_to_hash = Devel::FindRef::ptr2ref 0x176ff70; 174 my $ref_to_hash = Devel::FindRef::ptr2ref 0x176ff70;
173 175
176=item $ref = Devel::FindRef::ref2ptr $reference
177
178The opposite of C<ptr2ref>, above: returns the internal address of the
179value pointed to by the passed reference. I<No checks whatsoever will be
180done>, so don't use this.
181
174=back 182=back
183
184=head1 ENVIRONMENT VARIABLES
185
186You can set the environment variable C<PERL_DEVEL_FINDREF_DEPTH> to an
187integer to override the default depth in C<track>. If a call explicitly
188specified a depth it is not overridden.
175 189
176=head1 AUTHOR 190=head1 AUTHOR
177 191
178Marc Lehmann <pcg@goof.com>. 192Marc Lehmann <pcg@goof.com>.
179 193

Diff Legend

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