.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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::QuoteLike::Utils 3" .TH PPIx::QuoteLike::Utils 3 2024-09-01 "perl v5.40.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::QuoteLike::Utils \- Utility subroutines for PPIx::QuoteLike; .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use PPIx::QuoteLike::Utils qw{ _\|_variables }; \& \& say for _\|_variables( PPI::Document\->new( \e\*(Aq$foo\*(Aq ); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This Perl module holds code for PPIx::QuoteLike that did not seem to fit anywhere else. .SH SUBROUTINES .IX Header "SUBROUTINES" This module supports the following public subroutines: .SS column_number .IX Subsection "column_number" This subroutine/method returns the column number of the first character in the element, or \f(CW\*(C`undef\*(C'\fR if that can not be determined. .SS is_ppi_quotelike_element .IX Subsection "is_ppi_quotelike_element" This subroutine returns true if its argument is a PPI::Element that this package is capable of dealing with. That is, one of the following: .PP .Vb 5 \& PPI::Token::Quote \& PPI::Token::QuoteLike::Backtick \& PPI::Token::QuoteLike::Command \& PPI::Token::QuoteLike::Readline \& PPI::Token::HereDoc .Ve .PP It returns false for unblessed references and for non-references. .SS line_number .IX Subsection "line_number" This subroutine/method returns the line number of the first character in the element, or \f(CW\*(C`undef\*(C'\fR if that can not be determined. .SS logical_filename .IX Subsection "logical_filename" This subroutine/method returns the logical file name (taking \f(CW\*(C`#line\*(C'\fR directives into account) of the file containing first character in the element, or \f(CW\*(C`undef\*(C'\fR if that can not be determined. .SS logical_line_number .IX Subsection "logical_line_number" This subroutine/method returns the logical line number (taking \f(CW\*(C`#line\*(C'\fR directives into account) of the first character in the element, or \&\f(CW\*(C`undef\*(C'\fR if that can not be determined. .SS _\|_normalize_interpolation_for_ppi .IX Subsection "__normalize_interpolation_for_ppi" Despite the leading underscores, this exportable subroutine is public and supported. The underscores are so it will not appear to be public code to various tools when imported into other code. .PP This subroutine takes as its argument a string representing an interpolation. It removes such things as braces around variable names to make it into more normal Perl \-\- which is to say Perl that produces a more normal PPI parse. Sample transformations are: .PP .Vb 3 \& \*(Aq${foo}\*(Aq => \*(Aq$foo\*(Aq \& \*(Aq@{[ foo() ]}\*(Aq => \*(Aqfoo()\*(Aq \& \*(Aq${\e( foo() )}\*(Aq => \*(Aqfoo()\*(Aq .Ve .PP \&\fBNOTE\fR that this is not intended for general code cleanup. Specifically, it assumes that its argument is an interpolation and \&\fBonly\fR an interpolation. Feeding it anything else is unsupported, and probably will not return anything useful. .SS statement .IX Subsection "statement" This subroutine/method returns the PPI::Statement that contains this element, or nothing if the statement can not be determined. .PP In general this method will return something only under the following conditions: .IP \(bu 4 The element is contained in a PPIx::Regexp object; .IP \(bu 4 That object was initialized from a PPI::Element; .IP \(bu 4 The PPI::Element is contained in a statement. .SS visual_column_number .IX Subsection "visual_column_number" This subroutine/method returns the visual column number (taking tabs into account) of the first character in the element, or \f(CW\*(C`undef\*(C'\fR if that can not be determined. .SS _\|_variables .IX Subsection "__variables" .Vb 1 \& say for _\|_variables( PPI::Document\->new( \e\*(Aq$foo\*(Aq ); .Ve .PP \&\fBNOTE\fR that this subroutine is discouraged, and may well be deprecated and removed. I have two problems with it. The first is that it returns variable names rather than PPI::Element objects, leaving you no idea how the variables are used. The second is that it does not properly handle things like \f(CW"${^CAPTURE[0]}"\fR, and it seems infeasible to make it do so. It was originally written for the benefit of Perl::Critic::Policy::Variables::ProhibitUnusedVarsStricter, but has proven inadequate to that policy's needs. .PP Despite the leading underscores, this exportable subroutine is public and supported. The underscores are so it will not appear to be public code to various tools when imported into other code. .PP This subroutine takes as its only argument a PPI::Element, and returns the names of all variables found in that element, in no particular order. Scope is not taken into account. .PP In addition to reporting variables parsed as such by PPI, and various corner cases such as \f(CW\*(C`${]}\*(C'\fR where PPI is blind to the use of the variable, this subroutine looks inside the following PPI classes: .PP .Vb 5 \& PPI::Token::Quote \& PPI::Token::QuoteLike::Backtick \& PPI::Token::QuoteLike::Command \& PPI::Token::QuoteLike::Readline \& PPI::Token::HereDoc .Ve .PP If PPIx::Regexp is installed, it will also look inside .PP .Vb 3 \& PPI::Token::QuoteLike::Regexp \& PPI::Token::Regexp::Match \& PPI::Token::Regexp::Substitute .Ve .PP Unfortunately I can not make \f(CW\*(C`PPIx::Regexp\*(C'\fR a requirement for this module, because of the possibility of a circular dependency. .SH SUPPORT .IX Header "SUPPORT" Support is by the author. Please file bug reports at , , or in electronic mail to the author. .SH AUTHOR .IX Header "AUTHOR" Thomas R. Wyant, III \fIwyant at cpan dot org\fR .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2016\-2022 by Thomas R. Wyant, III .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5.10.0. For more details, see the full text of the licenses in the directory LICENSES. .PP This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.