Debian Codegraph @

upstream/mageia-cauldron/man3pm/Pod::Simple::PullParserStartToken.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Simple::PullParserStartToken 3pm"
61 .TH Pod::Simple::PullParserStartToken 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Simple::PullParserStartToken \-\- start\-tokens from Pod::Simple::PullParser
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 (See Pod::Simple::PullParser)
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 When you do \f(CW$parser\fR\->get_token on a Pod::Simple::PullParser object, you might
74 get an object of this class.
75 .PP
76 This is a subclass of Pod::Simple::PullParserToken and inherits all its methods,
77 and adds these methods:
78 .ie n .IP $token\->tagname 4
79 .el .IP \f(CW$token\fR\->tagname 4
80 .IX Item "$token->tagname"
81 This returns the tagname for this start\-token object.
82 For example, parsing a "=head1 ..." line will give you
83 a start\-token with the tagname of "head1", token(s) for its
84 content, and then an end\-token with the tagname of "head1".
85 .ie n .IP $token\->tagname(\fIsomestring\fR) 4
86 .el .IP \f(CW$token\fR\->tagname(\fIsomestring\fR) 4
87 .IX Item "$token->tagname(somestring)"
88 This changes the tagname for this start\-token object.
89 You probably won\*(Aqt need
90 to do this.
91 .ie n .IP $token\->tag(...) 4
92 .el .IP \f(CW$token\fR\->tag(...) 4
93 .IX Item "$token->tag(...)"
94 A shortcut for \f(CW$token\fR\->tagname(...)
95 .ie n .IP "$token\->is_tag(\fIsomestring\fR) or $token\->is_tagname(\fIsomestring\fR)" 4
96 .el .IP "\f(CW$token\fR\->is_tag(\fIsomestring\fR) or \f(CW$token\fR\->is_tagname(\fIsomestring\fR)" 4
97 .IX Item "$token->is_tag(somestring) or $token->is_tagname(somestring)"
98 These are shortcuts for \f(CW\*(C`$token\->tag() eq \fR\f(CIsomestring\fR\f(CW\*(C'\fR
99 .ie n .IP $token\->attr(\fIattrname\fR) 4
100 .el .IP \f(CW$token\fR\->attr(\fIattrname\fR) 4
101 .IX Item "$token->attr(attrname)"
102 This returns the value of the \fIattrname\fR attribute for this start\-token
103 object, or undef.
104 .Sp
105 For example, parsing a L<Foo/"Bar"> link will produce a start\-token
106 with a "to" attribute with the value "Foo", a "type" attribute with the
107 value "pod", and a "section" attribute with the value "Bar".
108 .ie n .IP "$token\->attr(\fIattrname\fR, \fInewvalue\fR)" 4
109 .el .IP "\f(CW$token\fR\->attr(\fIattrname\fR, \fInewvalue\fR)" 4
110 .IX Item "$token->attr(attrname, newvalue)"
111 This sets the \fIattrname\fR attribute for this start\-token object to
112 \&\fInewvalue\fR. You probably won\*(Aqt need to do this.
113 .ie n .IP $token\->attr_hash 4
114 .el .IP \f(CW$token\fR\->attr_hash 4
115 .IX Item "$token->attr_hash"
116 This returns the hashref that is the attribute set for this start\-token.
117 This is useful if (for example) you want to ask what all the attributes
118 are \-\- you can just do \f(CW\*(C`keys %{$token\->attr_hash}\*(C'\fR
119 .PP
120 You\*(Aqre unlikely to ever need to construct an object of this class for
121 yourself, but if you want to, call
122 \&\f(CW\*(C`Pod::Simple::PullParserStartToken\->new( \fR\f(CItagname\fR\f(CW, \fR\f(CIattrhash\fR\f(CW )\*(C'\fR
123 .SH "SEE ALSO"
124 .IX Header "SEE ALSO"
125 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
126 .SH "SEE ALSO"
127 .IX Header "SEE ALSO"
128 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
129 .SH SUPPORT
130 .IX Header "SUPPORT"
131 Questions or discussion about POD and Pod::Simple should be sent to the
132 pod\[email protected] mail list. Send an empty email to
133 pod\-people\[email protected] to subscribe.
134 .PP
135 This module is managed in an open GitHub repository,
136 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
137 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
138 .PP
139 Patches against Pod::Simple are welcome. Please send bug reports to
140 <bug\-pod\[email protected]>.
141 .SH "COPYRIGHT AND DISCLAIMERS"
142 .IX Header "COPYRIGHT AND DISCLAIMERS"
143 Copyright (c) 2002 Sean M. Burke.
144 .PP
145 This library is free software; you can redistribute it and/or modify it
146 under the same terms as Perl itself.
147 .PP
148 This program is distributed in the hope that it will be useful, but
149 without any warranty; without even the implied warranty of
150 merchantability or fitness for a particular purpose.
151 .SH AUTHOR
152 .IX Header "AUTHOR"
153 Pod::Simple was created by Sean M. Burke <[email protected]>.
154 But don\*(Aqt bother him, he\*(Aqs retired.
155 .PP
156 Pod::Simple is maintained by:
157 .IP \(bu 4
158 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
159 .IP \(bu 4
160 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
161 .IP \(bu 4
162 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR