Accessing document data

int xml_attribute::as_int() const; -unsigned int xml_attribute::as_uint() const; -double xml_attribute::as_double() const; -float xml_attribute::as_float() const; -bool xml_attribute::as_bool() const; +

int xml_attribute::as_int(int def = 0) const;
+unsigned int xml_attribute::as_uint(unsigned int def = 0) const;
+double xml_attribute::as_double(double def = 0) const;
+float xml_attribute::as_float(float def = 0) const;
+bool xml_attribute::as_bool(bool def = false) const;

as_int, as_uint, as_double and as_float convert attribute values to numbers. - If attribute handle is null or attribute value is empty, 0 - is returned. Otherwise, all leading whitespace characters are truncated, - and the remaining string is parsed as a decimal number (as_int - or as_uint) or as a floating - point number in either decimal or scientific form (as_double + If attribute handle is null or attribute value is empty, def + argument is returned (which is 0 by default). Otherwise, all leading whitespace + characters are truncated, and the remaining string is parsed as a decimal + number (as_int or as_uint) or as a floating point number + in either decimal or scientific form (as_double or as_float). Any extra characters are silently discarded, i.e. as_int will return 1 for string "1abc". @@ -241,10 +264,11 @@

for (pugi::xml_node tool: tools.children("Tool")) +{ + std::cout << "Tool:"; + + for (pugi::xml_attribute attr: tool.attributes()) + { + std::cout << " " << attr.name() << "=" << attr.value(); + } + + for (pugi::xml_node child: tool.children()) + { + std::cout << ", child " << child.name(); + } + + std::cout << std::endl; +} +

+ Working with text contents +

+ It is common to store data as text contents of some node - i.e. <node><description>This is a node</description></node>. + In this case, <description> node does not have a value, but instead + has a child of type node_pcdata with value + "This is a node". pugixml + provides a special class, xml_text, + to work with such data. Working with text objects to modify data is described + in the documentation for modifying document + data; this section describes the access interface of xml_text. +

+ You can get the text object from a node by using text() method: +

xml_text xml_node::text() const;
+

+ If the node has a type node_pcdata + or node_cdata, then the node + itself is used to return data; otherwise, a first child node of type node_pcdata or node_cdata + is used. +

+ You can check if the text object is bound to a valid PCDATA/CDATA node by + using it as a boolean value, i.e. if + (text) { ... + } or if + (!text) { ... + }. Alternatively you can check it + by using the empty() + method: +

bool xml_text::empty() const;
+

+ Given a text object, you can get the contents (i.e. the value of PCDATA/CDATA + node) by using the following function: +

const char_t* xml_text::get() const;
+

+ In case text object is empty, the function returns an empty string - it never + returns a null pointer. +

+ If you need a non-empty string if the text object is empty, or if the text + contents is actually a number or a boolean that is stored as a string, you + can use the following accessors: +

const char_t* xml_text::as_string(const char_t* def = "") const;
+int xml_text::as_int(int def = 0) const;
+unsigned int xml_text::as_uint(unsigned int def = 0) const;
+double xml_text::as_double(double def = 0) const;
+float xml_text::as_float(float def = 0) const;
+bool xml_text::as_bool(bool def = false) const;
+

+ All of the above functions have the same semantics as similar xml_attribute members: they return the + default argument if the text object is empty, they convert the text contents + to a target type using the same rules and restrictions. You can refer + to documentation for the attribute functions for details. +

+ xml_text is essentially a + helper class that operates on xml_node + values. It is bound to a node of type node_pcdata + or [node_cdata]. You can use the following function to retrieve this node: +

xml_node xml_text::data() const;
+

+ Essentially, assuming text + is an xml_text object, callling + text.get() is + equivalent to calling text.data().value(). +

+ This is an example of using xml_text + object (samples/text.cpp): +

+ +

std::cout << "Project name: " << project.child("name").text().get() << std::endl;
+std::cout << "Project version: " << project.child("version").text().as_double() << std::endl;
+std::cout << "Project visibility: " << (project.child("public").text().as_bool(/* def= */ true) ? "public" : "private") << std::endl;
+std::cout << "Project description: " << project.child("description").text().get() << std::endl;
+

+ Range-based for-loop support +

Traversing node/attribute lists via iterators

+ Working with text contents +

Miscellaneous functions