123456789_123456789_123456789_123456789_123456789_

Module: REXML::StreamListener

Relationships & Source Files
Defined in: lib/rexml/streamlistener.rb

Overview

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.

Instance Method Summary

Instance Method Details

#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.

[ GitHub ] 

  


# File 'lib/rexml/streamlistener.rb', line 50



def attlistdecl element_name, attributes, raw_content
end


  








  

    #cdata(content)  
  



  

    

Called when <![CDATA[ … ]]> is encountered in a document.


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 82



def cdata content
end


  








  

    #comment(comment)  
  



  

    

Called when a comment is encountered.


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 32



def comment comment
end


  








  

    #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”>


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 40



def doctype name, pub_sys, long_name, uri
end


  








  

    #doctype_end  
  



  

    

Called when the doctype is done


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 43



def doctype_end
end


  








  

    #elementdecl(content)  
  



  

    

<!ELEMENT …>


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 53



def elementdecl content
end


  








  

    #entity(content)  
  



  

    

Called when %foo; is encountered in a doctype declaration.


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 78



def entity content
end


  








  

    #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", "%"]
<!ENTITY WhatHeSaid "He said %YN;">
["WhatHeSaid", "He said %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", "gif"]


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 71



def entitydecl content
end


  








  

    #instruction(name, instruction)  
  



  

    

Called when an instruction is encountered.  EG: <?xsl sheet='foo'?> “sheet='foo'”


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 28



def instruction name, instruction
end


  








  

    #notationdecl(content)  
  



  

    

<!NOTATION …>


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 74



def notationdecl content
end


  








  

    #tag_end(name)  
  



  

    

Called when the end tag is reached.  In the case of <tag/>, tag_end will be called immediately after tag_start


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 18



def tag_end name
end


  








  

    #tag_start(name, attrs)  
  



  

    

Called when a tag is encountered. use with assoc or rassoc.  IE, <tag attr1=“value1” attr2=“value2”> will result in tag_start( “tag”, # [[“attr1”,“value1”],])


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 13



def tag_start name, attrs
end


  








  

    #text(text)  
  



  

    

Called when text is encountered in the document


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 22



def text text
end


  








  

    #xmldecl(version, encoding, standalone)  
  



  

    

Called when an XML PI is encountered in the document. EG: <?xml version=“1.0” encoding=“utf”?>


  



  [ GitHub ]


  

  


# File 'lib/rexml/streamlistener.rb', line 89



def xmldecl version, encoding, standalone
end