The xml::event_parser is used to parse an XML document by calling member functions when certain things in the XML document are parsed. More...

#include <event_parser.h>

Public Types
typedef std::map< std::string, std::string >	attrs_type
	a type for holding XML node attributes More...

typedef std::size_t	size_type
	size type More...

Public Member Functions
	event_parser ()
	Default constructor. More...

bool	parse_file (const char *filename)
	Call this member function to parse the given file. More...

bool	parse_stream (std::istream &stream)
	Parse what ever data that can be read from the given stream. More...

bool	parse_chunk (const char *chunk, size_type length)
	Call this function to parse a chunk of xml data. More...

bool	parse_finish ()
	Finish parsing chunked data. More...

const std::string &	get_error_message () const
	If there was an error parsing the XML data, (indicated by one of the parsing functions returning false), you can call this function to get a message describing the error. More...

Protected Member Functions
virtual bool	start_element (const std::string &name, const attrs_type &attrs)=0
	Override this member function to receive the start_element message. More...

virtual bool	end_element (const std::string &name)=0
	Override this member function to receive the end_element message. More...

virtual bool	text (const std::string &contents)=0
	Override this member function to receive the text message. More...

virtual bool	cdata (const std::string &contents)
	Override this member function to receive the cdata message. More...

virtual bool	processing_instruction (const std::string &target, const std::string &data)
	Override this member function to receive the processing_instruction message. More...

virtual bool	comment (const std::string &contents)
	Override this member function to receive the comment message. More...

virtual bool	warning (const std::string &message)
	Override this member function to receive parser warnings. More...

void	set_error_message (const char *message)
	Set the error message that will be returned from the get_error_message() member function. More...

Detailed Description

The xml::event_parser is used to parse an XML document by calling member functions when certain things in the XML document are parsed.

In order to use this class you derive a sub-class from it and override the protected virtual functions.

Member Typedef Documentation

◆ attrs_type

typedef std::map<std::string, std::string> xml::event_parser::attrs_type

a type for holding XML node attributes

◆ size_type

typedef std::size_t xml::event_parser::size_type

size type

Constructor & Destructor Documentation

◆ event_parser()

xml::event_parser::event_parser ( )

Default constructor.

Member Function Documentation

◆ cdata()

virtual bool xml::event_parser::cdata ( const std::string & contents )

protectedvirtual

Override this member function to receive the cdata message.

This member function is called when the parser encounters a <![CDATA[]]> section in the XML data.

The default implementation just calls the text() member function to handle the text inside the CDATA section.

Parameters

contents The contents of the CDATA section.

Returns: You should return true to continue parsing.; Return false if you want to stop.

◆ comment()

virtual bool xml::event_parser::comment ( const std::string & contents )

protectedvirtual

Override this member function to receive the comment message.

This member function will be called when the XML parser encounters a comment .

The default implementation will ignore XML comments and return true.

Parameters

contents The contents of the XML comment.

Returns: You should return true to continue parsing.; Return false if you want to stop.

◆ end_element()

virtual bool xml::event_parser::end_element ( const std::string & name )

protectedpure virtual

Override this member function to receive the end_element message.

This member function is called when the parser encounters the closing of an element.

Parameters

name	The name of the element that was closed.

Returns: You should return true to continue parsing; false to stop.

◆ get_error_message()

const std::string& xml::event_parser::get_error_message ( ) const

If there was an error parsing the XML data, (indicated by one of the parsing functions returning false), you can call this function to get a message describing the error.

Returns: A description of the XML parsing error.

◆ parse_chunk()

bool xml::event_parser::parse_chunk	(	const char *	chunk,
		size_type	length
	)

Call this function to parse a chunk of xml data.

When you are done feeding the parser chucks of data you need to call the parse_finish member function.

Parameters

chunk	The xml data chuck to parse.
length	The size of the given data chunk

Returns: True if the chunk was parsed successfully; false otherwise.

◆ parse_file()

bool xml::event_parser::parse_file ( const char * filename )

Call this member function to parse the given file.

Parameters

filename The name of the file to parse.

Returns: True if the file was successfully parsed; false otherwise.

◆ parse_finish()

bool xml::event_parser::parse_finish ( )

Finish parsing chunked data.

You only need to call this member function is you were parsing chunked xml data via the parse_chunk member function.

Returns: True if all parsing was successful; false otherwise.

◆ parse_stream()

bool xml::event_parser::parse_stream ( std::istream & stream )

Parse what ever data that can be read from the given stream.

Parameters

stream The stream to read data from.

Returns: True if the stream was successfully parsed; false otherwise.

◆ processing_instruction()

virtual bool xml::event_parser::processing_instruction	(	const std::string &	target,
		const std::string &	data
	)

protectedvirtual

Override this member function to receive the processing_instruction message.

This member function will be called when the XML parser encounters a processing instruction <?target data?>.

The default implementation will ignore processing instructions and return true.

Parameters

target	The target of the processing instruction
data	The data of the processing instruction.

Returns: You should return true to continue parsing.; Return false if you want to stop.

◆ set_error_message()

void xml::event_parser::set_error_message ( const char * message )

protected

Set the error message that will be returned from the get_error_message() member function.

If one of your callback functions returns false and does not first call this member function, "Unknown Error" will be returned from get_error_message().

Parameters

message The message to return from get_error_message().

◆ start_element()

virtual bool xml::event_parser::start_element	(	const std::string &	name,
		const attrs_type &	attrs
	)

protectedpure virtual

Override this member function to receive the start_element message.

This member function is called when the parser encounters an xml element.

Parameters

name	The name of the element
attrs	The element's attributes

Returns: You should return true to continue parsing; false to stop.

◆ text()

virtual bool xml::event_parser::text ( const std::string & contents )

protectedpure virtual

Override this member function to receive the text message.

This member function is called when the parser encounters text nodes.

Parameters

contents The contents of the text node.

Returns: You should return true to continue parsing; false to stop.

◆ warning()

virtual bool xml::event_parser::warning ( const std::string & message )

protectedvirtual

Override this member function to receive parser warnings.

The default behaviour is to ignore warnings.

Parameters

message The warning message from the compiler.

Returns: You should return true to continue parsing.; Return false if you want to stop.

The documentation for this class was generated from the following file:

xmlwrapp/event_parser.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ attrs_type

◆ size_type

Constructor & Destructor Documentation

◆ event_parser()

Member Function Documentation

◆ cdata()

◆ comment()

◆ end_element()

◆ get_error_message()

◆ parse_chunk()

◆ parse_file()

◆ parse_finish()

◆ parse_stream()

◆ processing_instruction()

◆ set_error_message()

◆ start_element()

◆ text()

◆ warning()