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.7 by root, Mon Apr 30 21:08:14 2007 UTC vs.
Revision 1.10 by root, Sat Apr 26 03:15:28 2008 UTC

1package Devel::FindRef; 1package Devel::FindRef;
2 2
3use strict; 3use strict;
4 4
5use XSLoader; 5use XSLoader;
6 6use Scalar::Util;
7 7
8BEGIN { 8BEGIN {
9 our $VERSION = '0.2'; 9 our $VERSION = '1.2';
10 XSLoader::load __PACKAGE__, $VERSION; 10 XSLoader::load __PACKAGE__, $VERSION;
11} 11}
12 12
13=head1 NAME 13=head1 NAME
14 14
45 testsub; 45 testsub;
46 46
47The output is as follows (or similar to this, in case I forget to update 47The output is as follows (or similar to this, in case I forget to update
48the manpage after some changes): 48the manpage after some changes):
49 49
50 SCALAR(0x676fa0) is 50 SCALAR(0x7bd2d0) is
51 in the global $Test::var.
51 referenced by REF(0x676fb0), which is 52 referenced by REF(0x7bd240), 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 global &Test::testsub.
57 referenced by REF(0x81da40), which is
58 in the global $Test::hash2.
59 referenced by REF(0x79f3f8), which is
52 in the lexical '$x' in CODE(0x676370), 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
53 not found anywhere I looked :( 64 not found anywhere I looked :(
54 referenced by REF(0x676360), which is 65 referenced by REF(0x79f140), which is
55 in the member 'ukukey' of HASH(0x756660), which is 66 in the member 'ukukey' of HASH(0x81d698), which is
56 in the global %Test::hash. 67 in the global %Test::hash.
57 in the global $Test::var.
58 referenced by REF(0x6760e0), which is
59 in the member 'ukukey2' of HASH(0x676f30), which is
60 referenced by REF(0x77bcf0), which is
61 in the lexical '$local' in CODE(0x77bcb0), which is
62 in the global &Test::testsub.
63 referenced by REF(0x77bc80), which is
64 in the global $Test::hash2.
65
66 68
67It 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
68stored in C<$var> can be found: 70stored in C<$var> can be found:
69 71
70=over 4 72=over 4
101=cut 103=cut
102 104
103sub find($); 105sub find($);
104 106
105sub track { 107sub track {
108 my ($ref, $depth) = @_;
109 @_ = ();
110
106 my $buf = ""; 111 my $buf = "";
107 my %ignore; 112
113 Scalar::Util::weaken $ref;
108 114
109 my $track; $track = sub { 115 my $track; $track = sub {
110 my ($target, $depth, $indent) = @_; 116 my ($refref, $depth, $indent) = @_;
111 @_ = ();
112 local $ignore{$target+0} = undef;
113 117
114 if ($depth) { 118 if ($depth) {
115 my (@about) = grep !exists $ignore{$_->[1]}, find $target; 119 my (@about) = find $$refref;
116 if (@about) { 120 if (@about) {
117 local @ignore{map $_->[1]+0, @about} = ();
118 for my $about (@about) { 121 for my $about (@about) {
119 local $ignore{$about+0} = undef;
120 $buf .= (" ") x $indent; 122 $buf .= (" ") x $indent;
121 $buf .= $about->[0]; 123 $buf .= $about->[0];
122 if (@$about > 1) { 124 if (@$about > 1) {
123 $buf .= " $about->[1], which is\n"; 125 $buf .= " $about->[1], which is\n";
124 $track->($about->[1], $depth - 1, $indent + 1); 126 $track->(\$about->[1], $depth - 1, $indent + 1);
125 } else { 127 } else {
126 $buf .= ".\n"; 128 $buf .= ".\n";
127 } 129 }
128 } 130 }
129 } else { 131 } else {
134 $buf .= (" ") x $indent; 136 $buf .= (" ") x $indent;
135 $buf .= "not referenced within the search depth.\n"; 137 $buf .= "not referenced within the search depth.\n";
136 } 138 }
137 }; 139 };
138 140
139 $buf .= "$_[0] is\n"; 141 $buf .= "$ref is\n";
140 $track->($_[0], $_[1] || 10, 1); 142 $track->(\$ref, $depth || 10, 1);
141 $buf 143 $buf
142} 144}
143 145
144=item @references = Devel::FindRef::find $ref 146=item @references = Devel::FindRef::find $ref
145 147
146Return arrayrefs that contain [$message, $ref] pairs. The message 148Return arrayrefs that contain [$message, $ref] pairs. The message
147describes what kind of reference was found and the C<$ref> is the 149describes what kind of reference was found and the C<$ref> is the
148reference itself, which cna be omitted if C<find> decided to end the 150reference itself, which can be omitted if C<find> decided to end the
149search. 151search. The returned references are all weak references.
150 152
151The C<track> function uses this to find references to the value you are 153The C<track> function uses this to find references to the value you are
152interested in and recurses on the returned references. 154interested in and recurses on the returned references.
153 155
154=cut 156=cut

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines