.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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::Utils 3"
.TH PPIx::Utils 3 2023-07-26 "perl v5.38.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::Utils \- Utility functions for PPI
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use PPIx::Utils qw(:classification :language :traversal);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`PPIx::Utils\*(C'\fR is a collection of utility functions for working with PPI
documents. The functions are organized into submodules, and may be imported
from the appropriate submodule or via this module.
.PP
These functions were originally from Perl::Critic::Utils and related
modules, and have been split off to this distribution for use outside of
Perl::Critic.
.SH MODULES
.IX Header "MODULES"
The import tag \f(CW\*(C`:all\*(C'\fR will import the functions from all modules listed below.
.SS PPIx::Utils::Classification
.IX Subsection "PPIx::Utils::Classification"
Functions related to classification of PPI elements. All functions from this
module can be imported with the import tag \f(CW\*(C`:classification\*(C'\fR.
.SS PPIx::Utils::Language
.IX Subsection "PPIx::Utils::Language"
Functions related to the Perl language. All functions from this module can be
imported with the import tag \f(CW\*(C`:language\*(C'\fR.
.SS PPIx::Utils::Traversal
.IX Subsection "PPIx::Utils::Traversal"
Functions related to traversal of PPI documents. All functions from this
module can be imported with the import tag \f(CW\*(C`:traversal\*(C'\fR.
.SH BUGS
.IX Header "BUGS"
Report any issues on the public bugtracker.
.SH AUTHOR
.IX Header "AUTHOR"
Dan Book <dbook@cpan.org>
.PP
Code originally from Perl::Critic::Utils by Jeffrey Ryan Thalhammer
<jeff@imaginative\-software.com>, Perl::Critic::Utils::PPI +
Perl::Critic::Utils::Perl + PPIx::Utilities::Node by Elliot Shank
<perl@galumph.com>, and PPIx::Utilities::Statement by
Thomas R. Wyant, III <wyant@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2005\-2011 Imaginative Software Systems,
2007\-2011 Elliot Shank, 2009\-2010 Thomas R. Wyant, III, 2017 Dan Book.
.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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
PPI, Perl::Critic::Utils, PPIx::Utilities