{
"mode": "perldoc",
"parameter": "HTML::TokeParser",
"section": "",
"url": "https://www.chedong.com/phpMan.php/perldoc/HTML%3A%3ATokeParser/json",
"generated": "2026-06-12T06:42:38Z",
"synopsis": "require HTML::TokeParser;\n$p = HTML::TokeParser->new(\"index.html\") ||\ndie \"Can't open: $!\";\n$p->emptyelementtags(1); # configure its behaviour\nwhile (my $token = $p->gettoken) {\n#...\n}",
"sections": {
"NAME": {
"content": "HTML::TokeParser - Alternative HTML::Parser interface\n",
"subsections": []
},
"SYNOPSIS": {
"content": "require HTML::TokeParser;\n$p = HTML::TokeParser->new(\"index.html\") ||\ndie \"Can't open: $!\";\n$p->emptyelementtags(1); # configure its behaviour\n\nwhile (my $token = $p->gettoken) {\n#...\n}\n",
"subsections": []
},
"DESCRIPTION": {
"content": "The \"HTML::TokeParser\" is an alternative interface to the \"HTML::Parser\" class. It is an\n\"HTML::PullParser\" subclass with a predeclared set of token types. If you wish the tokens to be\nreported differently you probably want to use the \"HTML::PullParser\" directly.\n\nThe following methods are available:\n\n$p = HTML::TokeParser->new( $filename, %opt );\n$p = HTML::TokeParser->new( $filehandle, %opt );\n$p = HTML::TokeParser->new( \\$document, %opt );\nThe object constructor argument is either a file name, a file handle object, or the complete\ndocument to be parsed. Extra options can be provided as key/value pairs and are processed as\ndocumented by the base classes.\n\nIf the argument is a plain scalar, then it is taken as the name of a file to be opened and\nparsed. If the file can't be opened for reading, then the constructor will return \"undef\"\nand $! will tell you why it failed.\n\nIf the argument is a reference to a plain scalar, then this scalar is taken to be the\nliteral document to parse. The value of this scalar should not be changed before all tokens\nhave been extracted.\n\nOtherwise the argument is taken to be some object that the \"HTML::TokeParser\" can read()\nfrom when it needs more data. Typically it will be a filehandle of some kind. The stream\nwill be read() until EOF, but not closed.\n\nA newly constructed \"HTML::TokeParser\" differ from its base classes by having the\n\"unbrokentext\" attribute enabled by default. See HTML::Parser for a description of this and\nother attributes that influence how the document is parsed. It is often a good idea to\nenable \"emptyelementtags\" behaviour.\n\nNote that the parsing result will likely not be valid if raw undecoded UTF-8 is used as a\nsource. When parsing UTF-8 encoded files turn on UTF-8 decoding:\n\nopen(my $fh, \"<:utf8\", \"index.html\") || die \"Can't open 'index.html': $!\";\nmy $p = HTML::TokeParser->new( $fh );\n# ...\n\nIf a $filename is passed to the constructor the file will be opened in raw mode and the\nparsing result will only be valid if its content is Latin-1 or pure ASCII.\n\nIf parsing from an UTF-8 encoded string buffer decode it first:\n\nutf8::decode($document);\nmy $p = HTML::TokeParser->new( \\$document );\n# ...\n\n$p->gettoken\nThis method will return the next *token* found in the HTML document, or \"undef\" at the end\nof the document. The token is returned as an array reference. The first element of the array\nwill be a string denoting the type of this token: \"S\" for start tag, \"E\" for end tag, \"T\"\nfor text, \"C\" for comment, \"D\" for declaration, and \"PI\" for process instructions. The rest\nof the token array depend on the type like this:\n\n[\"S\", $tag, $attr, $attrseq, $text]\n[\"E\", $tag, $text]\n[\"T\", $text, $isdata]\n[\"C\", $text]\n[\"D\", $text]\n[\"PI\", $token0, $text]\n\nwhere $attr is a hash reference, $attrseq is an array reference and the rest are plain\nscalars. The \"Argspec\" in HTML::Parser explains the details.\n\n$p->ungettoken( @tokens )\nIf you find you have read too many tokens you can push them back, so that they are returned\nthe next time $p->gettoken is called.\n\n$p->gettag\n$p->gettag( @tags )\nThis method returns the next start or end tag (skipping any other tokens), or \"undef\" if\nthere are no more tags in the document. If one or more arguments are given, then we skip\ntokens until one of the specified tag types is found. For example:\n\n$p->gettag(\"font\", \"/font\");\n\nwill find the next start or end tag for a font-element.\n\nThe tag information is returned as an array reference in the same form as for $p->gettoken\nabove, but the type code (first element) is missing. A start tag will be returned like this:\n\n[$tag, $attr, $attrseq, $text]\n\nThe tagname of end tags are prefixed with \"/\", i.e. end tag is returned like this:\n\n[\"/$tag\", $text]\n\n$p->gettext\n$p->gettext( @endtags )\nThis method returns all text found at the current position. It will return a zero length\nstring if the next token is not text. Any entities will be converted to their corresponding\ncharacter.\n\nIf one or more arguments are given, then we return all text occurring before the first of\nthe specified tags found. For example:\n\n$p->gettext(\"p\", \"br\");\n\nwill return the text up to either a paragraph of line break element.\n\nThe text might span tags that should be *textified*. This is controlled by the $p->{textify}\nattribute, which is a hash that defines how certain tags can be treated as text. If the name\nof a start tag matches a key in this hash then this tag is converted to text. The hash value\nis used to specify which tag attribute to obtain the text from. If this tag attribute is\nmissing, then the upper case name of the tag enclosed in brackets is returned, e.g. \"[IMG]\".\nThe hash value can also be a subroutine reference. In this case the routine is called with\nthe start tag token content as its argument and the return value is treated as the text.\n\nThe default $p->{textify} value is:\n\n{img => \"alt\", applet => \"alt\"}\n\nThis means that ![]()
and