xml_node< Ch > Class Template Reference

Inheritance diagram for xml_node< Ch >:

Public Member Functions
	xml_node (node_type type)
node_type	type () const
xml_document< Ch > *	document () const
xml_node< Ch > *	first_node (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
xml_node< Ch > *	last_node (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
xml_node< Ch > *	previous_sibling (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
xml_node< Ch > *	next_sibling (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
xml_attribute< Ch > *	first_attribute (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
xml_attribute< Ch > *	last_attribute (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
void	type (node_type type)
void	prepend_node (xml_node< Ch > *child)
void	append_node (xml_node< Ch > *child)
void	insert_node (xml_node< Ch > *where, xml_node< Ch > *child)
void	remove_first_node ()
void	remove_last_node ()
void	remove_node (xml_node< Ch > *where)
	Removes specified child from the node.
void	remove_all_nodes ()
	Removes all child nodes (but not attributes).
void	prepend_attribute (xml_attribute< Ch > *attribute)
void	append_attribute (xml_attribute< Ch > *attribute)
void	insert_attribute (xml_attribute< Ch > *where, xml_attribute< Ch > *attribute)
void	remove_first_attribute ()
void	remove_last_attribute ()
void	remove_attribute (xml_attribute< Ch > *where)
void	remove_all_attributes ()
	Removes all attributes of node.
Public Member Functions inherited from xml_base< Ch >
Ch *	name () const
std::size_t	name_size () const
Ch *	value () const
std::size_t	value_size () const
void	name (const Ch *name, std::size_t size)
void	name (const Ch *name)
void	value (const Ch *value, std::size_t size)
void	value (const Ch *value)
xml_node< Ch > *	parent () const

Detailed Description

template<class Ch = char>
class rapidxml::xml_node< Ch >

Class representing a node of XML document. Each node may have associated name and value strings, which are available through name() and value() functions. Interpretation of name and value depends on type of the node. Type of node can be determined by using type() function.

Note that after parse, both name and value of node, if any, will point interior of source text used for parsing. Thus, this text must persist in the memory for the lifetime of node.

Parameters

Ch	Character type to use.

Constructor & Destructor Documentation

xml_node ( node_type  type )

inline

Constructs an empty node with the specified type. Consider using memory_pool of appropriate document to allocate nodes manually.

Parameters

type	Type of node to construct.

Member Function Documentation

node_type type ( ) const

inline

Gets type of node.

Returns

Type of node.

Referenced by xml_node< Ch >::append_node(), memory_pool< Ch >::clone_node(), xml_node< Ch >::document(), xml_node< Ch >::insert_node(), and xml_node< Ch >::prepend_node().

xml_document<Ch>* document ( ) const

inline

Gets document of which node is a child.

Returns

Pointer to document that contains this node, or 0 if there is no parent document.

References rapidxml::node_document, xml_base< Ch >::parent(), and xml_node< Ch >::type().

xml_node<Ch>* first_node ( const Ch *  name = 0, std::size_t  name_size = 0, bool  case_sensitive = true  ) const

inline

Gets first child node, optionally matching node name.

Parameters

name	Name of child to find, or 0 to return first child regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found child, or 0 if not found.

References xml_node< Ch >::next_sibling().

Referenced by memory_pool< Ch >::clone_node().

xml_node<Ch>* last_node ( const Ch *  name = 0, std::size_t  name_size = 0, bool  case_sensitive = true  ) const

inline

Gets last child node, optionally matching node name. Behaviour is undefined if node has no children. Use first_node() to test if node has children.

Parameters

name	Name of child to find, or 0 to return last child regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found child, or 0 if not found.

References xml_node< Ch >::previous_sibling().

xml_node<Ch>* previous_sibling ( const Ch *  name = 0, std::size_t  name_size = 0, bool  case_sensitive = true  ) const

inline

Gets previous sibling node, optionally matching node name. Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.

Parameters

name	Name of sibling to find, or 0 to return previous sibling regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found sibling, or 0 if not found.

Referenced by xml_node< Ch >::last_node().

xml_node<Ch>* next_sibling ( const Ch *  name = 0, std::size_t  name_size = 0, bool  case_sensitive = true  ) const

inline

Gets next sibling node, optionally matching node name. Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.

Parameters

name	Name of sibling to find, or 0 to return next sibling regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found sibling, or 0 if not found.

Referenced by xml_node< Ch >::first_node().

xml_attribute<Ch>* first_attribute ( const Ch *  name = 0, std::size_t  name_size = 0, bool  case_sensitive = true  ) const

inline

Gets first attribute of node, optionally matching attribute name.

Parameters

name	Name of attribute to find, or 0 to return first attribute regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found attribute, or 0 if not found.

Referenced by memory_pool< Ch >::clone_node().

xml_attribute<Ch>* last_attribute ( const Ch *  name = 0, std::size_t  name_size = 0, bool  case_sensitive = true  ) const

inline

Gets last attribute of node, optionally matching attribute name.

Parameters

name	Name of attribute to find, or 0 to return last attribute regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found attribute, or 0 if not found.

void type ( node_type  type )

inline

Sets type of node.

Parameters

type	Type of node to set.

void prepend_node ( xml_node< Ch > *  child )

inline

Prepends a new child node. The prepended child becomes the first child, and all existing children are moved one position back.

Parameters

child

Node to prepend.

References rapidxml::node_document, xml_base< Ch >::parent(), and xml_node< Ch >::type().

void append_node ( xml_node< Ch > *  child )

inline

Appends a new child node. The appended child becomes the last child.

Parameters

child

Node to append.

References rapidxml::node_document, xml_base< Ch >::parent(), and xml_node< Ch >::type().

Referenced by xml_document< Ch >::clear().

void insert_node ( xml_node< Ch > *  where, xml_node< Ch > *  child  )

inline

Inserts a new child node at specified place inside the node. All children after and including the specified node are moved one position back.

Parameters

where	Place where to insert the child, or 0 to insert at the back.
child	Node to insert.

References rapidxml::node_document, xml_base< Ch >::parent(), xml_node< Ch >::type(), and parse_error::where().

void remove_first_node ( )

inline

Removes first child node. If node has no children, behaviour is undefined. Use first_node() to test if node has children.

void remove_last_node ( )

inline

Removes last child of the node. If node has no children, behaviour is undefined. Use first_node() to test if node has children.

void prepend_attribute ( xml_attribute< Ch > *  attribute )

inline

Prepends a new attribute to the node.

Parameters

attribute

Attribute to prepend.

References xml_base< Ch >::parent().

void append_attribute ( xml_attribute< Ch > *  attribute )

inline

Appends a new attribute to the node.

Parameters

attribute

Attribute to append.

References xml_base< Ch >::parent().

Referenced by xml_document< Ch >::clear().

void insert_attribute ( xml_attribute< Ch > *  where, xml_attribute< Ch > *  attribute  )

inline

Inserts a new attribute at specified place inside the node. All attributes after and including the specified attribute are moved one position back.

Parameters

where	Place where to insert the attribute, or 0 to insert at the back.
attribute	Attribute to insert.

References xml_base< Ch >::parent(), and parse_error::where().

void remove_first_attribute ( )

inline

Removes first attribute of the node. If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

void remove_last_attribute ( )

inline

Removes last attribute of the node. If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

void remove_attribute ( xml_attribute< Ch > *  where )

inline

Removes specified attribute from node.

Parameters

where

Pointer to attribute to be removed.

References xml_base< Ch >::parent().