A TextReader-style XML parser. More...

#include <libxml++/parsers/textreader.h>

Inheritance diagram for xmlpp::TextReader:

Public Types
enum class	NodeType { InternalError = -1 , None = 0 , Element = 1 , Attribute = 2 , Text = 3 , CDATA = 4 , EntityReference = 5 , Entity = 6 , ProcessingInstruction = 7 , Comment = 8 , Document = 9 , DocumentType = 10 , DocumentFragment = 11 , Notation = 12 , Whitespace = 13 , SignificantWhitespace = 14 , EndElement = 15 , EndEntity = 16 , XmlDeclaration = 17 }
	Node type of the current node. More...

enum class	ParserProperties { LoadDtd = 1 , DefaultAttrs = 2 , Validate = 3 , SubstEntities = 4 }

enum class	ReadState { InternalError = -1 , Initial = 0 , Interactive = 1 , Error = 2 , EndOfFile = 3 , Closed = 4 , Reading = 5 }

using	size_type = unsigned int

Public Member Functions
	TextReader (const unsigned char *data, size_type size, const ustring & uri=ustring())
	Creates a new TextReader object which parses in memory data. More...

	TextReader (const ustring & URI)
	Creates a new TextReader object to parse a file or URI. More...

	TextReader (struct _xmlTextReader * cobj)
	Wraps a TextReader object from an underlying libxml object. More...

	~TextReader () override

void	close ()

Node *	expand ()
	Expand the current node. More...

ustring	get_attribute (const ustring & local_name, const ustring & ns_uri) const

ustring	get_attribute (const ustring & name) const

ustring	get_attribute (int number) const

int	get_attribute_count () const
	Gets the number of attributes on the current node. More...

ustring	get_base_uri () const
	Gets the base Uniform Resource Identifier (URI) of the current node. More...

Node *	get_current_node ()
	Get a pointer to the current node. More...

const Node *	get_current_node () const
	Get a pointer to the current node. More...

int	get_depth () const
	Gets the depth of the current node in the XML document. More...

ustring	get_local_name () const

ustring	get_name () const

ustring	get_namespace_uri () const

NodeType	get_node_type () const
	Get the node type of the current node. More...

bool	get_normalization () const

bool	get_parser_property (ParserProperties property) const

ustring	get_prefix () const
	Get the namespace prefix associated with the current node. More...

char	get_quote_char () const
	Get the quotation mark character used to enclose the value of an attribute. More...

ReadState	get_read_state () const

ustring	get_value () const

ustring	get_xml_lang () const

bool	has_attributes () const
	Gets a value indicating whether the current node has any attributes. More...

bool	has_value () const
	Whether the node can have a text value. More...

bool	is_default () const
	Whether an Attribute node was generated from the default value defined in the DTD or schema. More...

bool	is_empty_element () const
	Check if the current node is empty. More...

bool	is_valid () const

ustring	lookup_namespace (const ustring & prefix) const

bool	move_to_attribute (const ustring & local_name, const ustring & ns_uri)

bool	move_to_attribute (const ustring & name)

bool	move_to_attribute (int number)

bool	move_to_element ()

bool	move_to_first_attribute ()

bool	move_to_next_attribute ()

bool	next ()

bool	read ()
	Moves the position of the current instance to the next node in the stream, exposing its properties. More...

bool	read_attribute_value ()
	Parses an attribute value into one or more Text and EntityReference nodes. More...

ustring	read_inner_xml ()
	Reads the contents of the current node, including child nodes and markup. More...

ustring	read_outer_xml ()
	Reads the current node and its contents, including child nodes and markup. More...

ustring	read_string ()
	Reads the contents of an element or a text node as a string. More...

void	set_normalization (bool value)

void	set_parser_property (ParserProperties property, bool value)

Public Member Functions inherited from xmlpp::NonCopyable
	NonCopyable (const NonCopyable &)=delete

	NonCopyable (NonCopyable &&)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

NonCopyable &	operator= (NonCopyable &&)=delete

Additional Inherited Members
Protected Member Functions inherited from xmlpp::NonCopyable
	NonCopyable () noexcept

virtual	~NonCopyable ()

Detailed Description

A TextReader-style XML parser.

A reader that provides fast, non-cached, forward-only access to XML data, in the style of .Net's XmlTextReader class.

Member Typedef Documentation

◆ size_type

using xmlpp::TextReader::size_type = unsigned int

Member Enumeration Documentation

◆ NodeType

enum xmlpp::TextReader::NodeType

strong

Node type of the current node.

See DotGNU's XmlNodeType enum.

Enumerator
InternalError
None
Element
Attribute
Text
CDATA
EntityReference
Entity
ProcessingInstruction
Comment
Document
DocumentType
DocumentFragment
Notation
Whitespace
SignificantWhitespace
EndElement
EndEntity
XmlDeclaration

◆ ParserProperties

enum xmlpp::TextReader::ParserProperties

strong

Enumerator
LoadDtd
DefaultAttrs
Validate
SubstEntities

◆ ReadState

enum xmlpp::TextReader::ReadState

strong

Enumerator
InternalError
Initial
Interactive
Error
EndOfFile
Closed
Reading

Constructor & Destructor Documentation

◆ TextReader() [1/3]

xmlpp::TextReader::TextReader ( struct _xmlTextReader * cobj )

Wraps a TextReader object from an underlying libxml object.

The TextReader takes ownership of cobj.

Parameters

cobj	The underlying libxml xmlTextReader object.

◆ TextReader() [2/3]

xmlpp::TextReader::TextReader ( const ustring & URI )

Creates a new TextReader object to parse a file or URI.

Parameters

URI	The URI to read.

Exceptions

xmlpp::internal_error If an xmlTextReader object cannot be created.

◆ TextReader() [3/3]

xmlpp::TextReader::TextReader	(	const unsigned char *	data,
		size_type	size,
		const ustring &	uri = `ustring()`
	)

Creates a new TextReader object which parses in memory data.

Parameters

data	The data to parse.
size	The number of bytes in data.
uri	The base URI to use for the document.

Exceptions

xmlpp::internal_error If an xmlTextReader object cannot be created.

◆ ~TextReader()

xmlpp::TextReader::~TextReader ( )

override

Member Function Documentation

◆ close()

void xmlpp::TextReader::close ( )

◆ expand()

Node* xmlpp::TextReader::expand ( )

Expand the current node.

Reads the contents of the current node and the full subtree. It then makes the subtree available until the next call to read() or next().

Warning: The C++ wrappers are not deleted. Using this method causes memory leaks, unless you call xmlpp::Node::free_wrappers(), which is not intended to be called by the application.

Returns: A pointer to the current node, or nullptr in case of error.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ get_attribute() [1/3]

ustring xmlpp::TextReader::get_attribute	(	const ustring &	local_name,
		const ustring &	ns_uri
	)		const

◆ get_attribute() [2/3]

ustring xmlpp::TextReader::get_attribute ( const ustring & name ) const

◆ get_attribute() [3/3]

ustring xmlpp::TextReader::get_attribute ( int number ) const

◆ get_attribute_count()

int xmlpp::TextReader::get_attribute_count ( ) const

Gets the number of attributes on the current node.

Returns: The number of attributes on the current node, or zero if the current node does not support attributes, or -1 in case of error.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ get_base_uri()

ustring xmlpp::TextReader::get_base_uri ( ) const

Gets the base Uniform Resource Identifier (URI) of the current node.

Returns: The base URI of the current node or an empty ustring if not available.

◆ get_current_node() [1/2]

Node* xmlpp::TextReader::get_current_node ( )

Get a pointer to the current node.

Warning: This is dangerous because the underlying node may be destroyed on the next read. The C++ wrapper is not deleted. Using this method causes memory leaks, unless you call xmlpp::Node::free_wrappers(), which is not intended to be called by the application.

Returns: A pointer to the current node, or nullptr in case of error.

◆ get_current_node() [2/2]

const Node* xmlpp::TextReader::get_current_node ( ) const

Get a pointer to the current node.

Warning: See the non-const get_current_node().

Returns: A pointer to the current node, or nullptr in case of error.

◆ get_depth()

int xmlpp::TextReader::get_depth ( ) const

Gets the depth of the current node in the XML document.

Returns: The depth of the current node in the XML document, or -1 in case of error.

◆ get_local_name()

ustring xmlpp::TextReader::get_local_name ( ) const

◆ get_name()

ustring xmlpp::TextReader::get_name ( ) const

◆ get_namespace_uri()

ustring xmlpp::TextReader::get_namespace_uri ( ) const

◆ get_node_type()

NodeType xmlpp::TextReader::get_node_type ( ) const

Get the node type of the current node.

Returns: The xmlpp::TextReader::NodeType of the current node. In case of error, either returns xmlpp::TextReader::NodeType::InternalError or throws an exception.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ get_normalization()

bool xmlpp::TextReader::get_normalization ( ) const

◆ get_parser_property()

bool xmlpp::TextReader::get_parser_property ( ParserProperties property ) const

◆ get_prefix()

ustring xmlpp::TextReader::get_prefix ( ) const

Get the namespace prefix associated with the current node.

Returns: The namespace prefix, or an empty string if not available.

◆ get_quote_char()

char xmlpp::TextReader::get_quote_char ( ) const

Get the quotation mark character used to enclose the value of an attribute.

Returns: Returns " or ' and -1 in case of error.

◆ get_read_state()

ReadState xmlpp::TextReader::get_read_state ( ) const

◆ get_value()

ustring xmlpp::TextReader::get_value ( ) const

◆ get_xml_lang()

ustring xmlpp::TextReader::get_xml_lang ( ) const

◆ has_attributes()

bool xmlpp::TextReader::has_attributes ( ) const

Gets a value indicating whether the current node has any attributes.

Returns: true if the current has attributes, false otherwise.

◆ has_value()

bool xmlpp::TextReader::has_value ( ) const

Whether the node can have a text value.

Returns: true if the current node can have an associated text value, false otherwise.

◆ is_default()

bool xmlpp::TextReader::is_default ( ) const

Whether an Attribute node was generated from the default value defined in the DTD or schema.

Returns: true if defaulted, false otherwise.

◆ is_empty_element()

bool xmlpp::TextReader::is_empty_element ( ) const

Check if the current node is empty.

Returns: true if empty, false otherwise.

◆ is_valid()

bool xmlpp::TextReader::is_valid ( ) const

◆ lookup_namespace()

ustring xmlpp::TextReader::lookup_namespace ( const ustring & prefix ) const

◆ move_to_attribute() [1/3]

bool xmlpp::TextReader::move_to_attribute	(	const ustring &	local_name,
		const ustring &	ns_uri
	)

◆ move_to_attribute() [2/3]

bool xmlpp::TextReader::move_to_attribute ( const ustring & name )

◆ move_to_attribute() [3/3]

bool xmlpp::TextReader::move_to_attribute ( int number )

◆ move_to_element()

bool xmlpp::TextReader::move_to_element ( )

◆ move_to_first_attribute()

bool xmlpp::TextReader::move_to_first_attribute ( )

◆ move_to_next_attribute()

bool xmlpp::TextReader::move_to_next_attribute ( )

◆ next()

bool xmlpp::TextReader::next ( )

◆ read()

bool xmlpp::TextReader::read ( )

Moves the position of the current instance to the next node in the stream, exposing its properties.

Returns: true if the node was read successfully, false if there are no more nodes to read.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ read_attribute_value()

bool xmlpp::TextReader::read_attribute_value ( )

Parses an attribute value into one or more Text and EntityReference nodes.

Returns: A bool where true indicates the attribute value was parsed, and false indicates the reader was not positioned on an attribute node or all the attribute values have been read.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ read_inner_xml()

ustring xmlpp::TextReader::read_inner_xml ( )

Reads the contents of the current node, including child nodes and markup.

Returns: A ustring containing the XML content, or an empty ustring if the current node is neither an element nor attribute, or has no child nodes.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ read_outer_xml()

ustring xmlpp::TextReader::read_outer_xml ( )

Reads the current node and its contents, including child nodes and markup.

Returns: A ustring containing the XML content, or an empty ustring if the current node is neither an element nor attribute.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ read_string()

ustring xmlpp::TextReader::read_string ( )

Reads the contents of an element or a text node as a string.

Returns: A ustring containing the contents of the Element or Text node, or an empty ustring if the reader is positioned on any other type of node.

Exceptions

xmlpp::parse_error
xmlpp::validity_error

◆ set_normalization()

void xmlpp::TextReader::set_normalization ( bool value )

◆ set_parser_property()

void xmlpp::TextReader::set_parser_property	(	ParserProperties	property,
		bool	value
	)

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ size_type

Member Enumeration Documentation

◆ NodeType

◆ ParserProperties

◆ ReadState

Constructor & Destructor Documentation

◆ TextReader() [1/3]

◆ TextReader() [2/3]

◆ TextReader() [3/3]

◆ ~TextReader()

Member Function Documentation

◆ close()

◆ expand()

◆ get_attribute() [1/3]

◆ get_attribute() [2/3]

◆ get_attribute() [3/3]

◆ get_attribute_count()

◆ get_base_uri()

◆ get_current_node() [1/2]

◆ get_current_node() [2/2]

◆ get_depth()

◆ get_local_name()

◆ get_name()

◆ get_namespace_uri()

◆ get_node_type()

◆ get_normalization()

◆ get_parser_property()

◆ get_prefix()

◆ get_quote_char()

◆ get_read_state()

◆ get_value()

◆ get_xml_lang()

◆ has_attributes()

◆ has_value()

◆ is_default()

◆ is_empty_element()

◆ is_valid()

◆ lookup_namespace()

◆ move_to_attribute() [1/3]

◆ move_to_attribute() [2/3]

◆ move_to_attribute() [3/3]

◆ move_to_element()

◆ move_to_first_attribute()

◆ move_to_next_attribute()

◆ next()

◆ read()

◆ read_attribute_value()

◆ read_inner_xml()

◆ read_outer_xml()

◆ read_string()

◆ set_normalization()

◆ set_parser_property()