1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
package PPIx::EditorTools::FindVariableDeclaration;
our $AUTHORITY = 'cpan:YANICK';
# ABSTRACT: Finds where a variable was declared using PPI
$PPIx::EditorTools::FindVariableDeclaration::VERSION = '0.21';
use 5.008;
use strict;
use warnings;
use Carp;
use base 'PPIx::EditorTools';
use Class::XSAccessor accessors => { 'location' => 'location' };
sub find {
my ( $self, %args ) = @_;
$self->process_doc(%args);
my $column = $args{column} or croak "column required";
my $line = $args{line} or croak "line required";
my $location = [ $line, $column ];
my $ppi = $self->ppi;
$ppi->flush_locations;
my $token = PPIx::EditorTools::find_token_at_location( $ppi, $location );
croak "no token" unless $token;
my $declaration = PPIx::EditorTools::find_variable_declaration($token);
croak "no declaration" unless $declaration;
return PPIx::EditorTools::ReturnObject->new(
ppi => $ppi,
element => $declaration,
);
}
1;
=pod
=encoding UTF-8
=head1 NAME
PPIx::EditorTools::FindVariableDeclaration - Finds where a variable was declared using PPI
=head1 VERSION
version 0.21
=head1 SYNOPSIS
# finds declaration of variable at cursor
my $declaration = PPIx::EditorTools::FindVariableDeclaration->new->find(
code =>
"package TestPackage;\nuse strict;\nBEGIN {
\$^W = 1;
}\nmy \$x=1;\n\$x++;"
line => 5,
column => 2,
);
my $location = $declaration->element->location;
=head1 DESCRIPTION
Finds the location of a variable declaration.
=head1 METHODS
=over 4
=item new()
Constructor. Generally shouldn't be called with any arguments.
=item find( ppi => PPI::Document $ppi, line => $line, column => $column )
=item find( code => Str $code, line => $line, column => $column )
Accepts either a C<PPI::Document> to process or a string containing
the code (which will be converted into a C<PPI::Document>) to process.
Searches for the variable declaration and returns a
C<PPIx::EditorTools::ReturnObject> with the declaration
(C<PPI::Statement::Variable>) available via the C<element> accessor.
Croaks with a "no token" exception if no token is found at the location.
Croaks with a "no declaration" exception if unable to find the declaration.
=back
=head1 SEE ALSO
This class inherits from C<PPIx::EditorTools>.
Also see L<App::EditorTools>, L<Padre>, and L<PPI>.
=head1 AUTHORS
=over 4
=item *
Steffen Mueller C<smueller@cpan.org>
=item *
Mark Grimes C<mgrimes@cpan.org>
=item *
Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
=item *
Gabor Szabo <gabor@szabgab.com>
=item *
Yanick Champoux <yanick@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2017, 2014, 2012 by The Padre development team as listed in Padre.pm..
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__END__
# Copyright 2008-2009 The Padre development team as listed in Padre.pm.
# LICENSE
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl 5 itself.
|
