.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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 "HTML::TokeParser 3"
.TH HTML::TokeParser 3 2024-09-02 "perl v5.40.0" "User Contributed Perl Documentation"
.\" 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
HTML::TokeParser \- Alternative HTML::Parser interface
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\& require HTML::TokeParser;
\& $p = HTML::TokeParser\->new("index.html") ||
\&      die "Can\*(Aqt open: $!";
\& $p\->empty_element_tags(1);  # configure its behaviour
\&
\& while (my $token = $p\->get_token) {
\&     #...
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`HTML::TokeParser\*(C'\fR is an alternative interface to the
\&\f(CW\*(C`HTML::Parser\*(C'\fR class.  It is an \f(CW\*(C`HTML::PullParser\*(C'\fR subclass with a
predeclared set of token types.  If you wish the tokens to be reported
differently you probably want to use the \f(CW\*(C`HTML::PullParser\*(C'\fR directly.
.PP
The following methods are available:
.ie n .IP "$p = HTML::TokeParser\->new( $filename, %opt );" 4
.el .IP "\f(CW$p\fR = HTML::TokeParser\->new( \f(CW$filename\fR, \f(CW%opt\fR );" 4
.IX Item "$p = HTML::TokeParser->new( $filename, %opt );"
.PD 0
.ie n .IP "$p = HTML::TokeParser\->new( $filehandle, %opt );" 4
.el .IP "\f(CW$p\fR = HTML::TokeParser\->new( \f(CW$filehandle\fR, \f(CW%opt\fR );" 4
.IX Item "$p = HTML::TokeParser->new( $filehandle, %opt );"
.ie n .IP "$p = HTML::TokeParser\->new( \e$document, %opt );" 4
.el .IP "\f(CW$p\fR = HTML::TokeParser\->new( \e$document, \f(CW%opt\fR );" 4
.IX Item "$p = HTML::TokeParser->new( $document, %opt );"
.PD
The object constructor argument is either a file name, a file handle
object, or the complete document to be parsed.  Extra options can be
provided as key/value pairs and are processed as documented by the base
classes.
.Sp
If the argument is a plain scalar, then it is taken as the name of a
file to be opened and parsed.  If the file can't be opened for
reading, then the constructor will return \f(CW\*(C`undef\*(C'\fR and $! will tell
you why it failed.
.Sp
If the argument is a reference to a plain scalar, then this scalar is
taken to be the literal document to parse.  The value of this
scalar should not be changed before all tokens have been extracted.
.Sp
Otherwise the argument is taken to be some object that the
\&\f(CW\*(C`HTML::TokeParser\*(C'\fR can \fBread()\fR from when it needs more data.  Typically
it will be a filehandle of some kind.  The stream will be \fBread()\fR until
EOF, but not closed.
.Sp
A newly constructed \f(CW\*(C`HTML::TokeParser\*(C'\fR differ from its base classes
by having the \f(CW\*(C`unbroken_text\*(C'\fR attribute enabled by default. See
HTML::Parser for a description of this and other attributes that
influence how the document is parsed. It is often a good idea to enable
\&\f(CW\*(C`empty_element_tags\*(C'\fR behaviour.
.Sp
Note that the parsing result will likely not be valid if raw undecoded
UTF\-8 is used as a source.  When parsing UTF\-8 encoded files turn
on UTF\-8 decoding:
.Sp
.Vb 3
\&   open(my $fh, "<:utf8", "index.html") || die "Can\*(Aqt open \*(Aqindex.html\*(Aq: $!";
\&   my $p = HTML::TokeParser\->new( $fh );
\&   # ...
.Ve
.Sp
If a \f(CW$filename\fR is passed to the constructor the file will be opened in
raw mode and the parsing result will only be valid if its content is
Latin\-1 or pure ASCII.
.Sp
If parsing from an UTF\-8 encoded string buffer decode it first:
.Sp
.Vb 3
\&   utf8::decode($document);
\&   my $p = HTML::TokeParser\->new( \e$document );
\&   # ...
.Ve
.ie n .IP $p\->get_token 4
.el .IP \f(CW$p\fR\->get_token 4
.IX Item "$p->get_token"
This method will return the next \fItoken\fR found in the HTML document,
or \f(CW\*(C`undef\*(C'\fR at the end of the document.  The token is returned as an
array reference.  The first element of the array will be a string
denoting the type of this token: "S" for start tag, "E" for end tag,
"T" for text, "C" for comment, "D" for declaration, and "PI" for
process instructions.  The rest of the token array depend on the type
like this:
.Sp
.Vb 6
\&  ["S",  $tag, $attr, $attrseq, $text]
\&  ["E",  $tag, $text]
\&  ["T",  $text, $is_data]
\&  ["C",  $text]
\&  ["D",  $text]
\&  ["PI", $token0, $text]
.Ve
.Sp
where \f(CW$attr\fR is a hash reference, \f(CW$attrseq\fR is an array reference and
the rest are plain scalars.  The "Argspec" in HTML::Parser explains the
details.
.ie n .IP "$p\->unget_token( @tokens )" 4
.el .IP "\f(CW$p\fR\->unget_token( \f(CW@tokens\fR )" 4
.IX Item "$p->unget_token( @tokens )"
If you find you have read too many tokens you can push them back,
so that they are returned the next time \f(CW$p\fR\->get_token is called.
.ie n .IP $p\->get_tag 4
.el .IP \f(CW$p\fR\->get_tag 4
.IX Item "$p->get_tag"
.PD 0
.ie n .IP "$p\->get_tag( @tags )" 4
.el .IP "\f(CW$p\fR\->get_tag( \f(CW@tags\fR )" 4
.IX Item "$p->get_tag( @tags )"
.PD
This method returns the next start or end tag (skipping any other
tokens), or \f(CW\*(C`undef\*(C'\fR if there are no more tags in the document.  If
one or more arguments are given, then we skip tokens until one of the
specified tag types is found.  For example:
.Sp
.Vb 1
\&   $p\->get_tag("font", "/font");
.Ve
.Sp
will find the next start or end tag for a font-element.
.Sp
The tag information is returned as an array reference in the same form
as for \f(CW$p\fR\->get_token above, but the type code (first element) is
missing. A start tag will be returned like this:
.Sp
.Vb 1
\&  [$tag, $attr, $attrseq, $text]
.Ve
.Sp
The tagname of end tags are prefixed with "/", i.e. end tag is
returned like this:
.Sp
.Vb 1
\&  ["/$tag", $text]
.Ve
.ie n .IP $p\->get_text 4
.el .IP \f(CW$p\fR\->get_text 4
.IX Item "$p->get_text"
.PD 0
.ie n .IP "$p\->get_text( @endtags )" 4
.el .IP "\f(CW$p\fR\->get_text( \f(CW@endtags\fR )" 4
.IX Item "$p->get_text( @endtags )"
.PD
This method returns all text found at the current position. It will
return a zero length string if the next token is not text. Any
entities will be converted to their corresponding character.
.Sp
If one or more arguments are given, then we return all text occurring
before the first of the specified tags found. For example:
.Sp
.Vb 1
\&   $p\->get_text("p", "br");
.Ve
.Sp
will return the text up to either a paragraph of line break element.
.Sp
The text might span tags that should be \fItextified\fR.  This is
controlled by the \f(CW$p\fR\->{textify} attribute, which is a hash that
defines how certain tags can be treated as text.  If the name of a
start tag matches a key in this hash then this tag is converted to
text.  The hash value is used to specify which tag attribute to obtain
the text from.  If this tag attribute is missing, then the upper case
name of the tag enclosed in brackets is returned, e.g. "[IMG]".  The
hash value can also be a subroutine reference.  In this case the
routine is called with the start tag token content as its argument and
the return value is treated as the text.
.Sp
The default \f(CW$p\fR\->{textify} value is:
.Sp
.Vb 1
\&  {img => "alt", applet => "alt"}
.Ve
.Sp
This means that <IMG> and <APPLET> tags are treated as text, and that
the text to substitute can be found in the ALT attribute.
.ie n .IP $p\->get_trimmed_text 4
.el .IP \f(CW$p\fR\->get_trimmed_text 4
.IX Item "$p->get_trimmed_text"
.PD 0
.ie n .IP "$p\->get_trimmed_text( @endtags )" 4
.el .IP "\f(CW$p\fR\->get_trimmed_text( \f(CW@endtags\fR )" 4
.IX Item "$p->get_trimmed_text( @endtags )"
.PD
Same as \f(CW$p\fR\->get_text above, but will collapse any sequences of white
space to a single space character.  Leading and trailing white space is
removed.
.ie n .IP $p\->get_phrase 4
.el .IP \f(CW$p\fR\->get_phrase 4
.IX Item "$p->get_phrase"
This will return all text found at the current position ignoring any
phrasal-level tags.  Text is extracted until the first non
phrasal-level tag.  Textification of tags is the same as for
\&\fBget_text()\fR.  This method will collapse white space in the same way as
\&\fBget_trimmed_text()\fR does.
.Sp
The definition of <i>phrasal\-level tags</i> is obtained from the
HTML::Tagset module.
.SH EXAMPLES
.IX Header "EXAMPLES"
This example extracts all links from a document.  It will print one
line for each link, containing the URL and the textual description
between the <A>...</A> tags:
.PP
.Vb 2
\&  use HTML::TokeParser;
\&  $p = HTML::TokeParser\->new(shift||"index.html");
\&
\&  while (my $token = $p\->get_tag("a")) {
\&      my $url = $token\->[1]{href} || "\-";
\&      my $text = $p\->get_trimmed_text("/a");
\&      print "$url\et$text\en";
\&  }
.Ve
.PP
This example extract the <TITLE> from the document:
.PP
.Vb 6
\&  use HTML::TokeParser;
\&  $p = HTML::TokeParser\->new(shift||"index.html");
\&  if ($p\->get_tag("title")) {
\&      my $title = $p\->get_trimmed_text;
\&      print "Title: $title\en";
\&  }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::PullParser, HTML::Parser
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 1998\-2005 Gisle Aas.
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.