.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "PPIx::EditorTools::RenameVariable 3pm" .TH PPIx::EditorTools::RenameVariable 3pm "2017-12-30" "perl v5.26.1" "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::RenameVariable \- Lexically replace a variable name in Perl code .SH "VERSION" .IX Header "VERSION" version 0.21 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 9 \& my $munged = PPIx::EditorTools::RenameVariable\->new\->rename( \& code => $code, \& line => 15, \& column => 13, \& replacement => \*(Aqstuff\*(Aq, \& ); \& my $code_as_strig = $munged\->code; \& my $code_as_ppi = $munged\->ppi; \& my $location = $munged\->element\->location; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module will lexically replace a variable name. .SH "METHODS" .IX Header "METHODS" .IP "\fInew()\fR" 4 .IX Item "new()" Constructor. Generally shouldn't be called with any arguments. .ie n .IP "rename( ppi => PPI::Document $ppi, line => Int, column => Int, replacement => Str )" 4 .el .IP "rename( ppi => PPI::Document \f(CW$ppi\fR, line => Int, column => Int, replacement => Str )" 4 .IX Item "rename( ppi => PPI::Document $ppi, line => Int, column => Int, replacement => Str )" .PD 0 .ie n .IP "rename( code => Str $code, line => Int, column => Int, replacement => Str )" 4 .el .IP "rename( code => Str \f(CW$code\fR, line => Int, column => Int, replacement => Str )" 4 .IX Item "rename( code => Str $code, line => Int, column => Int, replacement => Str )" .ie n .IP "rename( code => Str $code, line => Int, column => Int, to_camel_case => Bool, [ucfirst => Bool] )" 4 .el .IP "rename( code => Str \f(CW$code\fR, line => Int, column => Int, to_camel_case => Bool, [ucfirst => Bool] )" 4 .IX Item "rename( code => Str $code, line => Int, column => Int, to_camel_case => Bool, [ucfirst => Bool] )" .ie n .IP "rename( code => Str $code, line => Int, column => Int, from_camel_case => Bool, [ucfirst => Bool] )" 4 .el .IP "rename( code => Str \f(CW$code\fR, line => Int, column => Int, from_camel_case => Bool, [ucfirst => Bool] )" 4 .IX Item "rename( code => Str $code, line => Int, column => Int, from_camel_case => Bool, [ucfirst => Bool] )" .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. Renames the variable found at line, column with that supplied in the \f(CW\*(C`replacement\*(C'\fR parameter and returns a \f(CW\*(C`PPIx::EditorTools::ReturnObject\*(C'\fR with the new code available via the \f(CW\*(C`ppi\*(C'\fR or \f(CW\*(C`code\*(C'\fR accessors, as a \&\f(CW\*(C`PPI::Document\*(C'\fR or \f(CW\*(C`string\*(C'\fR, respectively. The \f(CW\*(C`PPI::Token\*(C'\fR found at line, column is available via the \f(CW\*(C`element\*(C'\fR accessor. .Sp Instead of specifying an explicit replacement variable name, you may choose to use the \f(CW\*(C`to_camel_case\*(C'\fR or \f(CW\*(C`from_camel_case\*(C'\fR options that automatically convert to/from camelCase. In that mode, the \f(CW\*(C`ucfirst\*(C'\fR option will force uppercasing of the first letter. .Sp You can not specify a replacement name and use the \f(CW\*(C`to/from_camel_case\*(C'\fR options. .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 .IP "\(bu" 4 Gabor Szabo .IP "\(bu" 4 Yanick Champoux .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.