.\" 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::ReturnObject 3pm"
.TH PPIx::EditorTools::ReturnObject 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::ReturnObject \- Simple object to return values from PPIx::EditorTools
.SH "VERSION"
.IX Header "VERSION"
version 0.21
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  my $brace = PPIx::EditorTools::FindUnmatchedBrace\->new\->find(
\&        code => "package TestPackage;\ensub x { 1;\en"
\&      );
\&  my $location = $brace\->element\->location;
\&  my $ppi      = $brace\->element\->ppi;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Retuning a simple \f(CW\*(C`PPI::Element\*(C'\fR from many of the \f(CW\*(C`PPIx::EditorTools\*(C'\fR
methods often results in the loss of the overall context for that element.
\&\f(CW\*(C`PPIx::EditorTools::ReturnObject\*(C'\fR provides an object that can be passed
around which retains the overall context.
.PP
For example, in \f(CW\*(C`PPIx::EditorTools::FindUnmatchedBrace\*(C'\fR if the unmatched
brace were returned by its \f(CW\*(C`PPI::Structure::Block\*(C'\fR the containing
\&\f(CW\*(C`PPI::Document\*(C'\fR is likely to go out of scope, thus the \f(CW\*(C`location\*(C'\fR
method no longer returns a valid location (rather it returns undef).
Using the \f(CW\*(C`ReturnObject\*(C'\fR preserves the \f(CW\*(C`PPI::Document\*(C'\fR and the containing
context.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew()\fR" 4
.IX Item "new()"
Constructor which should be used by \f(CW\*(C`PPIx::EditorTools\*(C'\fR. Accepts the following
named parameters:
.RS 4
.IP "ppi" 4
.IX Item "ppi"
A \f(CW\*(C`PPI::Document\*(C'\fR representing the (possibly modified) code.
.IP "code" 4
.IX Item "code"
A string representing the (possibly modified) code.
.IP "element" 4
.IX Item "element"
A \f(CW\*(C`PPI::Element\*(C'\fR or a subclass thereof representing the interesting element.
.RE
.RS 4
.RE
.IP "ppi" 4
.IX Item "ppi"
Accessor to retrieve the \f(CW\*(C`PPI::Document\*(C'\fR. May create the \f(CW\*(C`PPI::Document\*(C'\fR
from the \f(CW$code\fR string (lazily) if needed.
.IP "code" 4
.IX Item "code"
Accessor to retrieve the string representation of the code. May be retrieved
from the \f(CW\*(C`PPI::Document\*(C'\fR via the serialize method (lazily) if needed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`PPIx::EditorTools\*(C'\fR, 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.