1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
.\" -*- 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 "Pod::Simple::PullParserTextToken 3perl"
.TH Pod::Simple::PullParserTextToken 3perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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
Pod::Simple::PullParserTextToken \-\- text\-tokens from Pod::Simple::PullParser
.SH SYNOPSIS
.IX Header "SYNOPSIS"
(See Pod::Simple::PullParser)
.SH DESCRIPTION
.IX Header "DESCRIPTION"
When you do \f(CW$parser\fR\->get_token on a Pod::Simple::PullParser, you might
get an object of this class.
.PP
This is a subclass of Pod::Simple::PullParserToken and inherits all its methods,
and adds these methods:
.ie n .IP $token\->text 4
.el .IP \f(CW$token\fR\->text 4
.IX Item "$token->text"
This returns the text that this token holds. For example, parsing
C<foo> will return a C start-token, a text-token, and a C end-token. And
if you want to get the "foo" out of the text-token, call \f(CW\*(C`$token\->text\*(C'\fR
.ie n .IP $token\->text(\fIsomestring\fR) 4
.el .IP \f(CW$token\fR\->text(\fIsomestring\fR) 4
.IX Item "$token->text(somestring)"
This changes the string that this token holds. You probably won't need
to do this.
.ie n .IP $token\->\fBtext_r()\fR 4
.el .IP \f(CW$token\fR\->\fBtext_r()\fR 4
.IX Item "$token->text_r()"
This returns a scalar reference to the string that this token holds.
This can be useful if you don't want to memory-copy the potentially
large text value (well, as large as a paragraph or a verbatim block)
as calling \f(CW$token\fR\->text would do.
.Sp
Or, if you want to alter the value, you can even do things like this:
.Sp
.Vb 1
\& for ( ${ $token\->text_r } ) { # Aliases it with $_ !!
\&
\& s/ The / the /g; # just for example
\&
\& if( \*(AqA\*(Aq eq chr(65) ) { # (if in an ASCII world)
\& tr/\exA0/ /;
\& tr/\exAD//d;
\& }
\&
\& ...or however you want to alter the value...
\& (Note that starting with Perl v5.8, you can use, e.g.,
\&
\& my $nbsp = chr utf8::unicode_to_native(0xA0);
\& s/$nbsp/ /g;
\&
\& to handle the above regardless if it\*(Aqs an ASCII world or not)
\& }
.Ve
.PP
You're unlikely to ever need to construct an object of this class for
yourself, but if you want to, call
\&\f(CW\*(C`Pod::Simple::PullParserTextToken\->new( \fR\f(CItext\fR\f(CW )\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
.SH SUPPORT
.IX Header "SUPPORT"
Questions or discussion about POD and Pod::Simple should be sent to the
pod\-people@perl.org mail list. Send an empty email to
pod\-people\-subscribe@perl.org to subscribe.
.PP
This module is managed in an open GitHub repository,
<https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
to clone <git://github.com/perl\-pod/pod\-simple.git> and send patches!
.PP
Patches against Pod::Simple are welcome. Please send bug reports to
<bug\-pod\-simple@rt.cpan.org>.
.SH "COPYRIGHT AND DISCLAIMERS"
.IX Header "COPYRIGHT AND DISCLAIMERS"
Copyright (c) 2002 Sean M. Burke.
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.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.
.SH AUTHOR
.IX Header "AUTHOR"
Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.
But don't bother him, he's retired.
.PP
Pod::Simple is maintained by:
.IP \(bu 4
Allison Randal \f(CW\*(C`allison@perl.org\*(C'\fR
.IP \(bu 4
Hans Dieter Pearcey \f(CW\*(C`hdp@cpan.org\*(C'\fR
.IP \(bu 4
David E. Wheeler \f(CW\*(C`dwheeler@cpan.org\*(C'\fR
|
