Debian Codegraph @

upstream/debian-unstable/man3/Pod::Simple::PullParserStartToken.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Pod::Simple::PullParserStartToken 3perl"
58 .TH Pod::Simple::PullParserStartToken 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Pod::Simple::PullParserStartToken \-\- start\-tokens from Pod::Simple::PullParser
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 (See Pod::Simple::PullParser)
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 When you do \f(CW$parser\fR\->get_token on a Pod::Simple::PullParser object, you might
71 get an object of this class.
72 .PP
73 This is a subclass of Pod::Simple::PullParserToken and inherits all its methods,
74 and adds these methods:
75 .ie n .IP $token\->tagname 4
76 .el .IP \f(CW$token\fR\->tagname 4
77 .IX Item "$token->tagname"
78 This returns the tagname for this start-token object.
79 For example, parsing a "=head1 ..." line will give you
80 a start-token with the tagname of "head1", token(s) for its
81 content, and then an end-token with the tagname of "head1".
82 .ie n .IP $token\->tagname(\fIsomestring\fR) 4
83 .el .IP \f(CW$token\fR\->tagname(\fIsomestring\fR) 4
84 .IX Item "$token->tagname(somestring)"
85 This changes the tagname for this start-token object.
86 You probably won't need
87 to do this.
88 .ie n .IP $token\->tag(...) 4
89 .el .IP \f(CW$token\fR\->tag(...) 4
90 .IX Item "$token->tag(...)"
91 A shortcut for \f(CW$token\fR\->tagname(...)
92 .ie n .IP "$token\->is_tag(\fIsomestring\fR) or $token\->is_tagname(\fIsomestring\fR)" 4
93 .el .IP "\f(CW$token\fR\->is_tag(\fIsomestring\fR) or \f(CW$token\fR\->is_tagname(\fIsomestring\fR)" 4
94 .IX Item "$token->is_tag(somestring) or $token->is_tagname(somestring)"
95 These are shortcuts for \f(CW\*(C`$token\->tag() eq \fR\f(CIsomestring\fR\f(CW\*(C'\fR
96 .ie n .IP $token\->attr(\fIattrname\fR) 4
97 .el .IP \f(CW$token\fR\->attr(\fIattrname\fR) 4
98 .IX Item "$token->attr(attrname)"
99 This returns the value of the \fIattrname\fR attribute for this start-token
100 object, or undef.
101 .Sp
102 For example, parsing a L<Foo/"Bar"> link will produce a start-token
103 with a "to" attribute with the value "Foo", a "type" attribute with the
104 value "pod", and a "section" attribute with the value "Bar".
105 .ie n .IP "$token\->attr(\fIattrname\fR, \fInewvalue\fR)" 4
106 .el .IP "\f(CW$token\fR\->attr(\fIattrname\fR, \fInewvalue\fR)" 4
107 .IX Item "$token->attr(attrname, newvalue)"
108 This sets the \fIattrname\fR attribute for this start-token object to
109 \&\fInewvalue\fR. You probably won't need to do this.
110 .ie n .IP $token\->attr_hash 4
111 .el .IP \f(CW$token\fR\->attr_hash 4
112 .IX Item "$token->attr_hash"
113 This returns the hashref that is the attribute set for this start-token.
114 This is useful if (for example) you want to ask what all the attributes
115 are \-\- you can just do \f(CW\*(C`keys %{$token\->attr_hash}\*(C'\fR
116 .PP
117 You're unlikely to ever need to construct an object of this class for
118 yourself, but if you want to, call
119 \&\f(CW\*(C`Pod::Simple::PullParserStartToken\->new( \fR\f(CItagname\fR\f(CW, \fR\f(CIattrhash\fR\f(CW )\*(C'\fR
120 .SH "SEE ALSO"
121 .IX Header "SEE ALSO"
122 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
123 .SH "SEE ALSO"
124 .IX Header "SEE ALSO"
125 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
126 .SH SUPPORT
127 .IX Header "SUPPORT"
128 Questions or discussion about POD and Pod::Simple should be sent to the
129 pod\[email protected] mail list. Send an empty email to
130 pod\-people\[email protected] to subscribe.
131 .PP
132 This module is managed in an open GitHub repository,
133 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
134 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
135 .PP
136 Patches against Pod::Simple are welcome. Please send bug reports to
137 <bug\-pod\[email protected]>.
138 .SH "COPYRIGHT AND DISCLAIMERS"
139 .IX Header "COPYRIGHT AND DISCLAIMERS"
140 Copyright (c) 2002 Sean M. Burke.
141 .PP
142 This library is free software; you can redistribute it and/or modify it
143 under the same terms as Perl itself.
144 .PP
145 This program is distributed in the hope that it will be useful, but
146 without any warranty; without even the implied warranty of
147 merchantability or fitness for a particular purpose.
148 .SH AUTHOR
149 .IX Header "AUTHOR"
150 Pod::Simple was created by Sean M. Burke <[email protected]>.
151 But don't bother him, he's retired.
152 .PP
153 Pod::Simple is maintained by:
154 .IP \(bu 4
155 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
156 .IP \(bu 4
157 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
158 .IP \(bu 4
159 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR