xml_base< Ch > Class Template Reference
Inheritance diagram for xml_base< Ch >:
xml_attribute< Ch > xml_node< Ch > xml_document< Ch >

Public Member Functions

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_base< Ch >

Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent().

Parameters
ChCharacter type to use

Member Function Documentation

Ch* name ( ) const
inline

Gets name of the node. Interpretation of name depends on type of node. Note that name will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.

Use name_size() function to determine length of the name.

Returns
Name of node, or empty string if node has no name.

Referenced by memory_pool< Ch >::allocate_attribute(), memory_pool< Ch >::allocate_node(), xml_document< Ch >::clear(), and memory_pool< Ch >::clone_node().

std::size_t name_size ( ) const
inline

Gets size of node name, not including terminator character. This function works correctly irrespective of whether name is or is not zero terminated.

Returns
Size of node name, in characters.

Referenced by xml_document< Ch >::clear(), and memory_pool< Ch >::clone_node().

Ch* value ( ) const
inline

Gets value of node. Interpretation of value depends on type of node. Note that value will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.

Use value_size() function to determine length of the value.

Returns
Value of node, or empty string if node has no value.

Referenced by memory_pool< Ch >::allocate_attribute(), memory_pool< Ch >::allocate_node(), xml_document< Ch >::clear(), and memory_pool< Ch >::clone_node().

std::size_t value_size ( ) const
inline

Gets size of node value, not including terminator character. This function works correctly irrespective of whether value is or is not zero terminated.

Returns
Size of node value, in characters.

Referenced by xml_document< Ch >::clear(), and memory_pool< Ch >::clone_node().

void name ( const Ch *  name,
std::size_t  size 
)
inline

Sets name of node to a non zero-terminated string. See ownership_of_strings.

Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string will be automatically freed.

Size of name must be specified separately, because name does not have to be zero terminated. Use name(const Ch *) function to have the length automatically calculated (string must be zero terminated).

Parameters
nameName of node to set. Does not have to be zero terminated.
sizeSize of name, in characters. This does not include zero terminator, if one is present.
void name ( const Ch *  name)
inline

Sets name of node to a zero-terminated string. See also ownership_of_strings and xml_node::name(const Ch *, std::size_t).

Parameters
nameName of node to set. Must be zero terminated.
void value ( const Ch *  value,
std::size_t  size 
)
inline

Sets value of node to a non zero-terminated string. See ownership_of_strings.

Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string will be automatically freed.

Size of value must be specified separately, because it does not have to be zero terminated. Use value(const Ch *) function to have the length automatically calculated (string must be zero terminated).

If an element has a child node of type node_data, it will take precedence over element value when printing. If you want to manipulate data of elements using values, use parser flag rapidxml::parse_no_data_nodes to prevent creation of data nodes by the parser.

Parameters
valuevalue of node to set. Does not have to be zero terminated.
sizeSize of value, in characters. This does not include zero terminator, if one is present.
void value ( const Ch *  value)
inline

Sets value of node to a zero-terminated string. See also ownership_of_strings and xml_node::value(const Ch *, std::size_t).

Parameters
valueVame of node to set. Must be zero terminated.