Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members

xmlpp::SaxParser Class Reference

SAX XML parser. More...

Inheritance diagram for xmlpp::SaxParser:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::map< std::string,
std::string > 
AttributeMap

Public Member Functions

 SaxParser (bool use_get_entity=false)
virtual ~SaxParser ()
virtual void parse_file (const std::string &filename)
virtual void parse_memory (const std::string &contents)
virtual void parse_stream (std::istream &in)
virtual void parse_chunk (const std::string &chunk)
 Parse a chunk of data.

virtual void finish_chunk_parsing ()
 Finish a chunk-wise parse.


Protected Member Functions

virtual _xmlEntity * on_get_entity (const std::string &name)
 If you override this function see constructor parameter use_get_entity.

virtual void on_start_document ()
virtual void on_end_document ()
virtual void on_start_element (const std::string &name, const AttributeMap &attributes)
virtual void on_end_element (const std::string &name)
virtual void on_characters (const std::string &characters)
virtual void on_comment (const std::string &text)
virtual void on_warning (const std::string &text)
virtual void on_error (const std::string &text)
virtual void on_fatal_error (const std::string &text)
virtual void on_cdata_block (const std::string &text)
virtual void release_underlying ()

Friends

struct SaxParserCallback

Detailed Description

SAX XML parser.

Derive your own class and override the on_*() methods.


Member Typedef Documentation

typedef std::map<std::string, std::string> xmlpp::SaxParser::AttributeMap
 


Constructor & Destructor Documentation

xmlpp::SaxParser::SaxParser bool  use_get_entity = false  ) 
 

Parameters:
use_get_entity set to true when getEntity callback is going to be used. In such a case on_get_entity MUST be overridden.

virtual xmlpp::SaxParser::~SaxParser  )  [virtual]
 


Member Function Documentation

virtual void xmlpp::SaxParser::finish_chunk_parsing  )  [virtual]
 

Finish a chunk-wise parse.

Call this after the last call to parse_chunk(). Don't use this function with the other parsing methods.

virtual void xmlpp::SaxParser::on_cdata_block const std::string &  text  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::on_characters const std::string &  characters  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::on_comment const std::string &  text  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::on_end_document  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::on_end_element const std::string &  name  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::on_error const std::string &  text  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::on_fatal_error const std::string &  text  )  [protected, virtual]
 

virtual _xmlEntity* xmlpp::SaxParser::on_get_entity const std::string &  name  )  [protected, virtual]
 

If you override this function see constructor parameter use_get_entity.

virtual void xmlpp::SaxParser::on_start_document  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::on_start_element const std::string &  name,
const AttributeMap attributes
[protected, virtual]
 

virtual void xmlpp::SaxParser::on_warning const std::string &  text  )  [protected, virtual]
 

virtual void xmlpp::SaxParser::parse_chunk const std::string &  chunk  )  [virtual]
 

Parse a chunk of data.

This lets you pass a document in small chunks, e.g. from a network connection. The on_* virtual functions are called each time the chunks provide enough information to advance the parser.

The first call to parse_chunk will setup the parser. When the last chunk has been parsed, call finish_chunk_parsing() to finish the parse.

virtual void xmlpp::SaxParser::parse_file const std::string &  filename  )  [virtual]
 

Implements xmlpp::Parser.

virtual void xmlpp::SaxParser::parse_memory const std::string &  contents  )  [virtual]
 

Implements xmlpp::Parser.

virtual void xmlpp::SaxParser::parse_stream std::istream &  in  )  [virtual]
 

Implements xmlpp::Parser.

virtual void xmlpp::SaxParser::release_underlying  )  [protected, virtual]
 

Reimplemented from xmlpp::Parser.


Friends And Related Function Documentation

friend struct SaxParserCallback [friend]
 


The documentation for this class was generated from the following file:
Generated on Wed Nov 12 18:25:48 2003 for libxml++ by doxygen 1.3.4