.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "PPIx::Regexp::Token::Literal 3"
.TH PPIx::Regexp::Token::Literal 3 2026-06-15 "perl v5.42.2" "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::Regexp::Token::Literal \- Represent a literal character
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use PPIx::Regexp::Dumper;
\& PPIx::Regexp::Dumper\->new( \*(Aqqr{foo}smx\*(Aq )
\&     \->print();
.Ve
.SH INHERITANCE
.IX Header "INHERITANCE"
\&\f(CW\*(C`PPIx::Regexp::Token::Literal\*(C'\fR is a
PPIx::Regexp::Token.
.PP
\&\f(CW\*(C`PPIx::Regexp::Token::Literal\*(C'\fR has no descendants.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class represents a literal character, no matter how specified.
.SH METHODS
.IX Header "METHODS"
This class provides the following public methods. Methods not documented
here are private, and unsupported in the sense that the author reserves
the right to change or remove them without notice.
.SS is_matcher
.IX Subsection "is_matcher"
This method returns a true value because a literal matches itself.
.SS ordinal
.IX Subsection "ordinal"
.Vb 2
\& print \*(AqThe ordinal of \*(Aq, $token\->content(),
\&     \*(Aq is \*(Aq, $token\->ordinal(), "\en";
.Ve
.PP
This method returns the ordinal of the literal if it can figure it out.
It is analogous to the \f(CW\*(C`ord\*(C'\fR built\-in.
.PP
It will not attempt to determine the ordinal of a unicode name
(\f(CW\*(C`\eN{...}\*(C'\fR) unless charnames has been loaded, and supports
the \fBvianame()\fR function.
Instead, it will return \f(CW\*(C`undef\*(C'\fR. Users of Perl 5.6.2 and older may be
out of luck here.
.PP
Unicode code points (e.g. \f(CW\*(C`\eN{U+abcd}\*(C'\fR) should work independently of
charnames, and just return the value of \f(CW\*(C`abcd\*(C'\fR.
.PP
It will never attempt to return the ordinal of an octet (\f(CW\*(C`\eC{...}\*(C'\fR)
because I don\*(Aqt understand the syntax.
.SH SUPPORT
.IX Header "SUPPORT"
Support is by the author. Please file bug reports at
<https://github.com/trwyant/perl\-PPIx\-Regexp/issues> or in
electronic mail to the author.
.SH AUTHOR
.IX Header "AUTHOR"
Thomas R. Wyant, III \fIharryfmudd at comcast dot net\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2009\-2023, 2025\-2026 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.