D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
usr
/
local
/
lp
/
sonarperl
/
man
/
man3
/
Filename :
Pod::Simple::PullParserStartToken.3
back
Copy
.\" -*- 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::PullParserStartToken 3" .TH Pod::Simple::PullParserStartToken 3 2021-07-25 "perl v5.38.0" "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::PullParserStartToken \-\- start\-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 object, 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\->tagname 4 .el .IP \f(CW$token\fR\->tagname 4 .IX Item "$token->tagname" This returns the tagname for this start-token object. For example, parsing a "=head1 ..." line will give you a start-token with the tagname of "head1", token(s) for its content, and then an end-token with the tagname of "head1". .ie n .IP $token\->tagname(\fIsomestring\fR) 4 .el .IP \f(CW$token\fR\->tagname(\fIsomestring\fR) 4 .IX Item "$token->tagname(somestring)" This changes the tagname for this start-token object. You probably won't need to do this. .ie n .IP $token\->tag(...) 4 .el .IP \f(CW$token\fR\->tag(...) 4 .IX Item "$token->tag(...)" A shortcut for \f(CW$token\fR\->tagname(...) .ie n .IP "$token\->is_tag(\fIsomestring\fR) or $token\->is_tagname(\fIsomestring\fR)" 4 .el .IP "\f(CW$token\fR\->is_tag(\fIsomestring\fR) or \f(CW$token\fR\->is_tagname(\fIsomestring\fR)" 4 .IX Item "$token->is_tag(somestring) or $token->is_tagname(somestring)" These are shortcuts for \f(CW\*(C`$token\->tag() eq \fR\f(CIsomestring\fR\f(CW\*(C'\fR .ie n .IP $token\->attr(\fIattrname\fR) 4 .el .IP \f(CW$token\fR\->attr(\fIattrname\fR) 4 .IX Item "$token->attr(attrname)" This returns the value of the \fIattrname\fR attribute for this start-token object, or undef. .Sp For example, parsing a L<Foo/"Bar"> link will produce a start-token with a "to" attribute with the value "Foo", a "type" attribute with the value "pod", and a "section" attribute with the value "Bar". .ie n .IP "$token\->attr(\fIattrname\fR, \fInewvalue\fR)" 4 .el .IP "\f(CW$token\fR\->attr(\fIattrname\fR, \fInewvalue\fR)" 4 .IX Item "$token->attr(attrname, newvalue)" This sets the \fIattrname\fR attribute for this start-token object to \&\fInewvalue\fR. You probably won't need to do this. .ie n .IP $token\->attr_hash 4 .el .IP \f(CW$token\fR\->attr_hash 4 .IX Item "$token->attr_hash" This returns the hashref that is the attribute set for this start-token. This is useful if (for example) you want to ask what all the attributes are \-\- you can just do \f(CW\*(C`keys %{$token\->attr_hash}\*(C'\fR .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::PullParserStartToken\->new( \fR\f(CItagname\fR\f(CW, \fR\f(CIattrhash\fR\f(CW )\*(C'\fR .SH "SEE ALSO" .IX Header "SEE ALSO" Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing .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