.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PPIx::EditorTools::FindVariableDeclaration 3pm"
.TH PPIx::EditorTools::FindVariableDeclaration 3pm "2022-06-17" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
PPIx::EditorTools::FindVariableDeclaration \- Finds where a variable was declared using PPI
.SH "VERSION"
.IX Header "VERSION"
version 0.21
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&  # finds declaration of variable at cursor
\&  my $declaration = PPIx::EditorTools::FindVariableDeclaration\->new\->find(
\&    code =>
\&      "package TestPackage;\enuse strict;\enBEGIN {
\&    \e$^W = 1;
\&}\enmy \e$x=1;\en\e$x++;"
\&    line => 5,
\&    column => 2,
\&  );
\&  my $location = $declaration\->element\->location;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Finds the location of a variable declaration.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew()\fR" 4
.IX Item "new()"
Constructor. Generally shouldn't be called with any arguments.
.ie n .IP "find( ppi => PPI::Document $ppi, line => $line, column => $column )" 4
.el .IP "find( ppi => PPI::Document \f(CW$ppi\fR, line => \f(CW$line\fR, column => \f(CW$column\fR )" 4
.IX Item "find( ppi => PPI::Document $ppi, line => $line, column => $column )"
.PD 0
.ie n .IP "find( code => Str $code, line => $line, column => $column )" 4
.el .IP "find( code => Str \f(CW$code\fR, line => \f(CW$line\fR, column => \f(CW$column\fR )" 4
.IX Item "find( code => Str $code, line => $line, column => $column )"
.PD
Accepts either a \f(CW\*(C`PPI::Document\*(C'\fR to process or a string containing
the code (which will be converted into a \f(CW\*(C`PPI::Document\*(C'\fR) to process.
Searches for the variable declaration and returns a
\&\f(CW\*(C`PPIx::EditorTools::ReturnObject\*(C'\fR with the declaration
(\f(CW\*(C`PPI::Statement::Variable\*(C'\fR) available via the \f(CW\*(C`element\*(C'\fR accessor.
.Sp
Croaks with a \*(L"no token\*(R" exception if no token is found at the location.
Croaks with a \*(L"no declaration\*(R" exception if unable to find the declaration.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This class inherits from \f(CW\*(C`PPIx::EditorTools\*(C'\fR.
Also see App::EditorTools, Padre, and \s-1PPI\s0.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Steffen Mueller \f(CW\*(C`smueller@cpan.org\*(C'\fR
.IP "\(bu" 4
Mark Grimes \f(CW\*(C`mgrimes@cpan.org\*(C'\fR
.IP "\(bu" 4
Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
.IP "\(bu" 4
Gabor Szabo  <gabor@szabgab.com>
.IP "\(bu" 4
Yanick Champoux <yanick@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017, 2014, 2012 by The Padre development team as listed in Padre.pm..
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.