Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ppix::editortools::renamevariable(3pm) [debian man page]

PPIx::EditorTools::RenameVariable(3pm)			User Contributed Perl Documentation		    PPIx::EditorTools::RenameVariable(3pm)

NAME

       PPIx::EditorTools::RenameVariable - Lexically replace a variable name in Perl code

SYNOPSIS

	   my $munged = PPIx::EditorTools::RenameVariable->new->rename(
	       code	   => $code,
	       line	   => 15,
	       column	   => 13,
	       replacement => 'stuff',
	   );
	   my $code_as_strig = $munged->code;
	   my $code_as_ppi   = $munged->ppi;
	   my $location      = $munged->element->location;

DESCRIPTION

       This module will lexically replace a variable name.

METHODS

       new()
	   Constructor. Generally shouldn't be called with any arguments.

       rename( ppi => PPI::Document $ppi, line => Int, column => Int, replacement => Str ) =item rename( code => Str $code, line => Int, column =>
       Int, replacement => Str ) =item rename( code => Str $code, line => Int, column => Int, to_camel_case => Bool, [ucfirst => Bool] ) =item
       rename( code => Str $code, line => Int, column => Int, from_camel_case => Bool, [ucfirst => Bool] )
	   Accepts either a "PPI::Document" to process or a string containing the code (which will be converted into a "PPI::Document") to
	   process.  Renames the variable found at line, column with that supplied in the "replacement" parameter and returns a
	   "PPIx::EditorTools::ReturnObject" with the new code available via the "ppi" or "code" accessors, as a "PPI::Document" or "string",
	   respectively. The "PPI::Token" found at line, column is available via the "element" accessor.

	   Instead of specifying an explicit replacement variable name, you may choose to use the "to_camel_case" or "from_camel_case" options
	   that automatically convert to/from camelCase. In that mode, the "ucfirst" option will force uppercasing of the first letter.

	   You can not specify a replacement name and use the "to/from_camel_case" options.

	   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.

SEE ALSO

       This class inherits from "PPIx::EditorTools".  Also see App::EditorTools, Padre, and PPI.

perl v5.14.2							    2012-03-11				    PPIx::EditorTools::RenameVariable(3pm)

Check Out this Related Man Page

PPIx::EditorTools::ReturnObject(3pm)			User Contributed Perl Documentation		      PPIx::EditorTools::ReturnObject(3pm)

NAME

       PPIx::EditorTools::ReturnObject - Simple object to return values from PPIx::EditorTools

SYNOPSIS

	 my $brace = PPIx::EditorTools::FindUnmatchedBrace->new->find(
	       code => "package TestPackage;
sub x { 1;
"
	     );
	 my $location = $brace->element->location;
	 my $ppi      = $brace->element->ppi;

DESCRIPTION

       Retuning a simple "PPI::Element" from many of the "PPIx::EditorTools" methods often results in the loss of the overall context for that
       element.  "PPIx::EditorTools::ReturnObject" provides an object that can be passed around which retains the overall context.

       For example, in "PPIx::EditorTools::FindUnmatchedBrace" if the unmatched brace were returned by its "PPI::Structure::Block" the containing
       "PPI::Document" is likely to go out of scope, thus the "location" method no longer returns a valid location (rather it returns undef).
       Using the "ReturnObject" preserves the "PPI::Document" and the containing context.

METHODS

       new()
	   Constructor which should be used by "PPIx::EditorTools". Accepts the following named parameters:

	   ppi A "PPI::Document" representing the (possibly modified) code.

	   code
	       A string representing the (possibly modified) code.

	   element
	       A "PPI::Element" or a subclass thereof representing the interesting element.

       ppi Accessor to retrieve the "PPI::Document". May create the "PPI::Document" from the $code string (lazily) if needed.

       code
	   Accessor to retrieve the string representation of the code. May be retrieved from the "PPI::Document" via the serialize method (lazily)
	   if needed.

SEE ALSO

       "PPIx::EditorTools", App::EditorTools, Padre, and PPI.

perl v5.14.2							    2012-03-11				      PPIx::EditorTools::ReturnObject(3pm)
Man Page