- Inheritance
A template for stream parser listeners. Note that the declarations (attlistdecl, elementdecl, etc) are trivially processed; REXML doesn‘t yet handle doctype entity declarations, so you have to parse them out yourself.
Methods
Instance
| Visibility | Signature |
|---|---|
| public | attlistdecl (element_name, attributes, raw_content) |
| public | cdata (content) |
| public | comment (comment) |
| public | doctype (name, pub_sys, long_name, uri) |
| public | doctype_end () |
| public | elementdecl (content) |
| public | entity (content) |
| public | entitydecl (content) |
| public | instruction (name, instruction) |
| public | notationdecl (content) |
| public | tag_end (name) |
| public | tag_start (name, attrs) |
| public | text (text) |
| public | xmldecl (version, encoding, standalone) |
Instance Method Detail
attlistdecl(element_name, attributes, raw_content)
If a doctype includes an ATTLIST declaration, it will cause this method to be called. The content is the declaration itself, unparsed. EG, <!ATTLIST el attr CDATA REQUIRED> will come to this method as "el attr CDATA REQUIRED". This is the same for all of the .*decl methods.
cdata(content)
Called when <![CDATA[ … ]]> is encountered in a document. @p content "…"
comment(comment)
doctype(name, pub_sys, long_name, uri)
Handles a doctype declaration. Any attributes of the doctype which are not supplied will be nil. # EG, <!DOCTYPE me PUBLIC "foo" "bar"> @p name the name of the doctype; EG, "me" @p pub_sys "PUBLIC", "SYSTEM", or nil. EG, "PUBLIC" @p long_name the supplied long name, or nil. EG, "foo" @p uri the uri of the doctype, or nil. EG, "bar"
doctype_end()
Called when the doctype is done
elementdecl(content)
<!ELEMENT …>
entity(content)
Called when %foo; is encountered in a doctype declaration. @p content "foo"
entitydecl(content)
<!ENTITY …> The argument passed to this method is an array of the entity declaration. It can be in a number of formats, but in general it returns (example, result):
<!ENTITY % YN '"Yes"'> ["%", "YN", "'\"Yes\"'", "\""] <!ENTITY % YN 'Yes'> ["%", "YN", "'Yes'", "s"] <!ENTITY WhatHeSaid "He said %YN;"> ["WhatHeSaid", "\"He said %YN;\"", "YN"] <!ENTITY open-hatch SYSTEM "http://www.textuality.com/boilerplate/OpenHatch.xml"> ["open-hatch", "SYSTEM", "\"http://www.textuality.com/boilerplate/OpenHatch.xml\""] <!ENTITY open-hatch PUBLIC "-//Textuality//TEXT Standard open-hatch boilerplate//EN" "http://www.textuality.com/boilerplate/OpenHatch.xml"> ["open-hatch", "PUBLIC", "\"-//Textuality//TEXT Standard open-hatch boilerplate//EN\"", "\"http://www.textuality.com/boilerplate/OpenHatch.xml\""] <!ENTITY hatch-pic SYSTEM "../grafix/OpenHatch.gif" NDATA gif> ["hatch-pic", "SYSTEM", "\"../grafix/OpenHatch.gif\"", "\n\t\t\t\t\t\t\tNDATA gif", "gif"]
instruction(name, instruction)
Called when an instruction is encountered. EG: <?xsl sheet=‘foo’?> @p name the instruction name; in the example, "xsl" @p instruction the rest of the instruction. In the example, "sheet=‘foo’"
notationdecl(content)
<!NOTATION …>
tag_end(name)
Called when the end tag is reached. In the case of <tag/>, tag_end will be called immidiately after tag_start @p the name of the tag
tag_start(name, attrs)
Called when a tag is encountered. @p name the tag name @p attrs an array of arrays of attribute/value pairs, suitable for use with assoc or rassoc. IE, <tag attr1="value1" attr2="value2"> will result in tag_start( "tag", # [["attr1","value1"],["attr2","value2"]])
text(text)
xmldecl(version, encoding, standalone)
Called when an XML PI is encountered in the document. EG: <?xml version="1.0" encoding="utf"?> @p version the version attribute value. EG, "1.0" @p encoding the encoding attribute value, or nil. EG, "utf" @p standalone the standalone attribute value, or nil. EG, nil