D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
lampp
/
share
/
man
/
man3
/
Filename :
Pod::Simple::PullParserStartToken.3
back
Copy
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Pod::Simple::PullParserStartToken 3" .TH Pod::Simple::PullParserStartToken 3 "2013-03-04" "perl v5.16.3" "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 \*(L"=head1 ...\*(R" line will give you a start-token with the tagname of \*(L"head1\*(R", token(s) for its content, and then an end-token with the tagname of \*(L"head1\*(R". .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 \f(CIsomestring\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/\*(L"Bar\*(R"> link will produce a start-token with a \*(L"to\*(R" attribute with the value \*(L"Foo\*(R", a \*(L"type\*(R" attribute with the value \*(L"pod\*(R", and a \*(L"section\*(R" attribute with the value \*(L"Bar\*(R". .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( \f(CItagname\f(CW, \f(CIattrhash\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 \s-1POD\s0 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, http://github.com/theory/pod\-simple/ <http://github.com/theory/pod-simple/>. Feel free to fork and contribute, or to clone git://github.com/theory/pod\-simple.git <git://github.com/theory/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