From 0a97bad6608a2b1ea01ae6ce18bab63abf0c9210 Mon Sep 17 00:00:00 2001 From: "arseny.kapoulkine" Date: Wed, 21 Feb 2007 19:41:31 +0000 Subject: Merged 0.3 in trunk git-svn-id: http://pugixml.googlecode.com/svn/trunk@68 99668b35-9821-0410-8761-19e4c4f06640 --- docs/html/annotated.html | 37 + docs/html/classpugi_1_1xml__attribute-members.html | 52 + docs/html/classpugi_1_1xml__attribute.html | 881 +++++++ .../classpugi_1_1xml__attribute__coll__graph.map | 1 + .../classpugi_1_1xml__attribute__coll__graph.md5 | 1 + .../classpugi_1_1xml__attribute__coll__graph.png | Bin 0 -> 876 bytes ...sspugi_1_1xml__attribute__iterator-members.html | 37 + .../classpugi_1_1xml__attribute__iterator.html | 414 ++++ ...gi_1_1xml__attribute__iterator__coll__graph.map | 2 + ...gi_1_1xml__attribute__iterator__coll__graph.md5 | 1 + ...gi_1_1xml__attribute__iterator__coll__graph.png | Bin 0 -> 3027 bytes ...1_1xml__attribute__iterator__inherit__graph.map | 1 + ...1_1xml__attribute__iterator__inherit__graph.md5 | 1 + ...1_1xml__attribute__iterator__inherit__graph.png | Bin 0 -> 1386 bytes docs/html/classpugi_1_1xml__document-members.html | 103 + docs/html/classpugi_1_1xml__document.html | 365 +++ .../classpugi_1_1xml__document__coll__graph.map | 2 + .../classpugi_1_1xml__document__coll__graph.md5 | 1 + .../classpugi_1_1xml__document__coll__graph.png | Bin 0 -> 2396 bytes .../classpugi_1_1xml__document__inherit__graph.map | 2 + .../classpugi_1_1xml__document__inherit__graph.md5 | 1 + .../classpugi_1_1xml__document__inherit__graph.png | Bin 0 -> 697 bytes docs/html/classpugi_1_1xml__node-members.html | 95 + docs/html/classpugi_1_1xml__node.html | 2473 ++++++++++++++++++++ docs/html/classpugi_1_1xml__node__coll__graph.map | 1 + docs/html/classpugi_1_1xml__node__coll__graph.md5 | 1 + docs/html/classpugi_1_1xml__node__coll__graph.png | Bin 0 -> 756 bytes .../classpugi_1_1xml__node__inherit__graph.map | 2 + .../classpugi_1_1xml__node__inherit__graph.md5 | 1 + .../classpugi_1_1xml__node__inherit__graph.png | Bin 0 -> 704 bytes .../classpugi_1_1xml__node__iterator-members.html | 37 + docs/html/classpugi_1_1xml__node__iterator.html | 414 ++++ ...asspugi_1_1xml__node__iterator__coll__graph.map | 2 + ...asspugi_1_1xml__node__iterator__coll__graph.md5 | 1 + ...asspugi_1_1xml__node__iterator__coll__graph.png | Bin 0 -> 2813 bytes ...pugi_1_1xml__node__iterator__inherit__graph.map | 1 + ...pugi_1_1xml__node__iterator__inherit__graph.md5 | 1 + ...pugi_1_1xml__node__iterator__inherit__graph.png | Bin 0 -> 1300 bytes .../classpugi_1_1xml__tree__walker-members.html | 32 + docs/html/classpugi_1_1xml__tree__walker.html | 186 ++ ...classpugi_1_1xml__tree__walker__coll__graph.map | 1 + ...classpugi_1_1xml__tree__walker__coll__graph.md5 | 1 + ...classpugi_1_1xml__tree__walker__coll__graph.png | Bin 0 -> 738 bytes .../classpugi_1_1xpath__exception-members.html | 27 + docs/html/classpugi_1_1xpath__exception.html | 108 + .../classpugi_1_1xpath__exception__coll__graph.map | 1 + .../classpugi_1_1xpath__exception__coll__graph.md5 | 1 + .../classpugi_1_1xpath__exception__coll__graph.png | Bin 0 -> 1442 bytes ...asspugi_1_1xpath__exception__inherit__graph.map | 1 + ...asspugi_1_1xpath__exception__inherit__graph.md5 | 1 + ...asspugi_1_1xpath__exception__inherit__graph.png | Bin 0 -> 764 bytes docs/html/classpugi_1_1xpath__node-members.html | 34 + docs/html/classpugi_1_1xpath__node.html | 341 +++ .../html/classpugi_1_1xpath__node__coll__graph.map | 3 + .../html/classpugi_1_1xpath__node__coll__graph.md5 | 1 + .../html/classpugi_1_1xpath__node__coll__graph.png | Bin 0 -> 2333 bytes .../classpugi_1_1xpath__node__set-members.html | 42 + docs/html/classpugi_1_1xpath__node__set.html | 413 ++++ .../classpugi_1_1xpath__node__set__coll__graph.map | 4 + .../classpugi_1_1xpath__node__set__coll__graph.md5 | 1 + .../classpugi_1_1xpath__node__set__coll__graph.png | Bin 0 -> 4399 bytes docs/html/classpugi_1_1xpath__query-members.html | 31 + docs/html/classpugi_1_1xpath__query.html | 239 ++ .../classpugi_1_1xpath__query__coll__graph.map | 1 + .../classpugi_1_1xpath__query__coll__graph.md5 | 1 + .../classpugi_1_1xpath__query__coll__graph.png | Bin 0 -> 1519 bytes docs/html/doxygen.css | 310 +++ docs/html/doxygen.png | Bin 0 -> 1281 bytes docs/html/functions.html | 195 ++ docs/html/functions_enum.html | 38 + docs/html/functions_eval.html | 40 + docs/html/functions_func.html | 188 ++ docs/html/functions_type.html | 40 + docs/html/graph_legend.dot | 22 + docs/html/graph_legend.html | 80 + docs/html/graph_legend.png | Bin 0 -> 3938 bytes docs/html/hierarchy.html | 45 + docs/html/index.html | 20 + docs/html/inherit__graph__0.map | 2 + docs/html/inherit__graph__0.md5 | 1 + docs/html/inherit__graph__0.png | Bin 0 -> 582 bytes docs/html/inherit__graph__1.map | 2 + docs/html/inherit__graph__1.md5 | 1 + docs/html/inherit__graph__1.png | Bin 0 -> 428 bytes docs/html/inherit__graph__2.map | 3 + docs/html/inherit__graph__2.md5 | 1 + docs/html/inherit__graph__2.png | Bin 0 -> 1068 bytes docs/html/inherit__graph__3.map | 3 + docs/html/inherit__graph__3.md5 | 1 + docs/html/inherit__graph__3.png | Bin 0 -> 596 bytes docs/html/inherit__graph__4.map | 2 + docs/html/inherit__graph__4.md5 | 1 + docs/html/inherit__graph__4.png | Bin 0 -> 485 bytes docs/html/inherit__graph__5.map | 2 + docs/html/inherit__graph__5.md5 | 1 + docs/html/inherit__graph__5.png | Bin 0 -> 644 bytes docs/html/inherit__graph__6.map | 2 + docs/html/inherit__graph__6.md5 | 1 + docs/html/inherit__graph__6.png | Bin 0 -> 404 bytes docs/html/inherit__graph__7.map | 2 + docs/html/inherit__graph__7.md5 | 1 + docs/html/inherit__graph__7.png | Bin 0 -> 470 bytes docs/html/inherit__graph__8.map | 2 + docs/html/inherit__graph__8.md5 | 1 + docs/html/inherit__graph__8.png | Bin 0 -> 437 bytes docs/html/inherits.html | 66 + docs/html/namespacemembers.html | 62 + docs/html/namespacemembers_enum.html | 37 + docs/html/namespacemembers_eval.html | 43 + docs/html/namespacemembers_func.html | 38 + docs/html/namespacemembers_vars.html | 52 + docs/html/namespacepugi.html | 668 ++++++ docs/html/namespaces.html | 26 + .../structpugi_1_1transfer__ownership__tag.html | 35 + docs/html/tab_b.gif | Bin 0 -> 35 bytes docs/html/tab_l.gif | Bin 0 -> 706 bytes docs/html/tab_r.gif | Bin 0 -> 2585 bytes docs/html/tabs.css | 102 + docs/index.html | 1059 +++------ 119 files changed, 8839 insertions(+), 757 deletions(-) create mode 100644 docs/html/annotated.html create mode 100644 docs/html/classpugi_1_1xml__attribute-members.html create mode 100644 docs/html/classpugi_1_1xml__attribute.html create mode 100644 docs/html/classpugi_1_1xml__attribute__coll__graph.map create mode 100644 docs/html/classpugi_1_1xml__attribute__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__attribute__coll__graph.png create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator-members.html create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator.html create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.map create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.png create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.map create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.png create mode 100644 docs/html/classpugi_1_1xml__document-members.html create mode 100644 docs/html/classpugi_1_1xml__document.html create mode 100644 docs/html/classpugi_1_1xml__document__coll__graph.map create mode 100644 docs/html/classpugi_1_1xml__document__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__document__coll__graph.png create mode 100644 docs/html/classpugi_1_1xml__document__inherit__graph.map create mode 100644 docs/html/classpugi_1_1xml__document__inherit__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__document__inherit__graph.png create mode 100644 docs/html/classpugi_1_1xml__node-members.html create mode 100644 docs/html/classpugi_1_1xml__node.html create mode 100644 docs/html/classpugi_1_1xml__node__coll__graph.map create mode 100644 docs/html/classpugi_1_1xml__node__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__node__coll__graph.png create mode 100644 docs/html/classpugi_1_1xml__node__inherit__graph.map create mode 100644 docs/html/classpugi_1_1xml__node__inherit__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__node__inherit__graph.png create mode 100644 docs/html/classpugi_1_1xml__node__iterator-members.html create mode 100644 docs/html/classpugi_1_1xml__node__iterator.html create mode 100644 docs/html/classpugi_1_1xml__node__iterator__coll__graph.map create mode 100644 docs/html/classpugi_1_1xml__node__iterator__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__node__iterator__coll__graph.png create mode 100644 docs/html/classpugi_1_1xml__node__iterator__inherit__graph.map create mode 100644 docs/html/classpugi_1_1xml__node__iterator__inherit__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__node__iterator__inherit__graph.png create mode 100644 docs/html/classpugi_1_1xml__tree__walker-members.html create mode 100644 docs/html/classpugi_1_1xml__tree__walker.html create mode 100644 docs/html/classpugi_1_1xml__tree__walker__coll__graph.map create mode 100644 docs/html/classpugi_1_1xml__tree__walker__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xml__tree__walker__coll__graph.png create mode 100644 docs/html/classpugi_1_1xpath__exception-members.html create mode 100644 docs/html/classpugi_1_1xpath__exception.html create mode 100644 docs/html/classpugi_1_1xpath__exception__coll__graph.map create mode 100644 docs/html/classpugi_1_1xpath__exception__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xpath__exception__coll__graph.png create mode 100644 docs/html/classpugi_1_1xpath__exception__inherit__graph.map create mode 100644 docs/html/classpugi_1_1xpath__exception__inherit__graph.md5 create mode 100644 docs/html/classpugi_1_1xpath__exception__inherit__graph.png create mode 100644 docs/html/classpugi_1_1xpath__node-members.html create mode 100644 docs/html/classpugi_1_1xpath__node.html create mode 100644 docs/html/classpugi_1_1xpath__node__coll__graph.map create mode 100644 docs/html/classpugi_1_1xpath__node__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xpath__node__coll__graph.png create mode 100644 docs/html/classpugi_1_1xpath__node__set-members.html create mode 100644 docs/html/classpugi_1_1xpath__node__set.html create mode 100644 docs/html/classpugi_1_1xpath__node__set__coll__graph.map create mode 100644 docs/html/classpugi_1_1xpath__node__set__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xpath__node__set__coll__graph.png create mode 100644 docs/html/classpugi_1_1xpath__query-members.html create mode 100644 docs/html/classpugi_1_1xpath__query.html create mode 100644 docs/html/classpugi_1_1xpath__query__coll__graph.map create mode 100644 docs/html/classpugi_1_1xpath__query__coll__graph.md5 create mode 100644 docs/html/classpugi_1_1xpath__query__coll__graph.png create mode 100644 docs/html/doxygen.css create mode 100644 docs/html/doxygen.png create mode 100644 docs/html/functions.html create mode 100644 docs/html/functions_enum.html create mode 100644 docs/html/functions_eval.html create mode 100644 docs/html/functions_func.html create mode 100644 docs/html/functions_type.html create mode 100644 docs/html/graph_legend.dot create mode 100644 docs/html/graph_legend.html create mode 100644 docs/html/graph_legend.png create mode 100644 docs/html/hierarchy.html create mode 100644 docs/html/index.html create mode 100644 docs/html/inherit__graph__0.map create mode 100644 docs/html/inherit__graph__0.md5 create mode 100644 docs/html/inherit__graph__0.png create mode 100644 docs/html/inherit__graph__1.map create mode 100644 docs/html/inherit__graph__1.md5 create mode 100644 docs/html/inherit__graph__1.png create mode 100644 docs/html/inherit__graph__2.map create mode 100644 docs/html/inherit__graph__2.md5 create mode 100644 docs/html/inherit__graph__2.png create mode 100644 docs/html/inherit__graph__3.map create mode 100644 docs/html/inherit__graph__3.md5 create mode 100644 docs/html/inherit__graph__3.png create mode 100644 docs/html/inherit__graph__4.map create mode 100644 docs/html/inherit__graph__4.md5 create mode 100644 docs/html/inherit__graph__4.png create mode 100644 docs/html/inherit__graph__5.map create mode 100644 docs/html/inherit__graph__5.md5 create mode 100644 docs/html/inherit__graph__5.png create mode 100644 docs/html/inherit__graph__6.map create mode 100644 docs/html/inherit__graph__6.md5 create mode 100644 docs/html/inherit__graph__6.png create mode 100644 docs/html/inherit__graph__7.map create mode 100644 docs/html/inherit__graph__7.md5 create mode 100644 docs/html/inherit__graph__7.png create mode 100644 docs/html/inherit__graph__8.map create mode 100644 docs/html/inherit__graph__8.md5 create mode 100644 docs/html/inherit__graph__8.png create mode 100644 docs/html/inherits.html create mode 100644 docs/html/namespacemembers.html create mode 100644 docs/html/namespacemembers_enum.html create mode 100644 docs/html/namespacemembers_eval.html create mode 100644 docs/html/namespacemembers_func.html create mode 100644 docs/html/namespacemembers_vars.html create mode 100644 docs/html/namespacepugi.html create mode 100644 docs/html/namespaces.html create mode 100644 docs/html/structpugi_1_1transfer__ownership__tag.html create mode 100644 docs/html/tab_b.gif create mode 100644 docs/html/tab_l.gif create mode 100644 docs/html/tab_r.gif create mode 100644 docs/html/tabs.css (limited to 'docs') diff --git a/docs/html/annotated.html b/docs/html/annotated.html new file mode 100644 index 0000000..92baeb6 --- /dev/null +++ b/docs/html/annotated.html @@ -0,0 +1,37 @@ + + +pugixml: Class List + + + + +
+
+
+
+

pugixml Class List

Here are the classes, structs, unions and interfaces with brief descriptions: + + + + + + + + + + + +
pugi::transfer_ownership_tagStruct used to distinguish parsing with ownership transfer from parsing without it
pugi::xml_attributeA light-weight wrapper for manipulating attributes in DOM tree
pugi::xml_attribute_iteratorAttribute iterator
pugi::xml_documentDocument class (DOM tree root)
pugi::xml_nodeA light-weight wrapper for manipulating nodes in DOM tree
pugi::xml_node_iteratorChild node iterator
pugi::xml_tree_walkerAbstract tree walker class
pugi::xpath_exceptionXPath exception class
pugi::xpath_nodeXPath node class
pugi::xpath_node_setNot necessarily ordered constant collection of XPath nodes
pugi::xpath_queryA class that holds compiled XPath query and allows to evaluate query result
+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__attribute-members.html b/docs/html/classpugi_1_1xml__attribute-members.html new file mode 100644 index 0000000..83c136c --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute-members.html @@ -0,0 +1,52 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xml_attribute Member List

This is the complete list of members for pugi::xml_attribute, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
as_bool() const pugi::xml_attribute
as_double() const pugi::xml_attribute
as_float() const pugi::xml_attribute
as_int() const pugi::xml_attribute
document_order() const (defined in pugi::xml_attribute)pugi::xml_attribute
empty() const pugi::xml_attribute
name() const pugi::xml_attribute
next_attribute() const pugi::xml_attribute
operator unspecified_bool_type() const pugi::xml_attribute
operator!() const (defined in pugi::xml_attribute)pugi::xml_attribute
operator!=(const xml_attribute &r) const pugi::xml_attribute
operator<(const xml_attribute &r) const pugi::xml_attribute
operator<=(const xml_attribute &r) const pugi::xml_attribute
operator=(const char *rhs)pugi::xml_attribute
operator=(int rhs)pugi::xml_attribute
operator=(double rhs)pugi::xml_attribute
operator=(bool rhs)pugi::xml_attribute
operator==(const xml_attribute &r) const pugi::xml_attribute
operator>(const xml_attribute &r) const pugi::xml_attribute
operator>=(const xml_attribute &r) const pugi::xml_attribute
previous_attribute() const pugi::xml_attribute
set_name(const char *rhs)pugi::xml_attribute
set_value(const char *rhs)pugi::xml_attribute
value() const pugi::xml_attribute
xml_attribute()pugi::xml_attribute
xml_attribute_iterator (defined in pugi::xml_attribute)pugi::xml_attribute [friend]
xml_node (defined in pugi::xml_attribute)pugi::xml_attribute [friend]

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__attribute.html b/docs/html/classpugi_1_1xml__attribute.html new file mode 100644 index 0000000..840a4a7 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute.html @@ -0,0 +1,881 @@ + + +pugixml: pugi::xml_attribute Class Reference + + + + +
+
+
+
+
+pugi::xml_attribute
+

pugi::xml_attribute Class Reference

Collaboration diagram for pugi::xml_attribute:

Collaboration graph
+
[legend]
List of all members.

Detailed Description

+A light-weight wrapper for manipulating attributes in DOM tree. +

+Note: xml_attribute does not allocate any memory for the attribute it wraps; it only wraps a pointer to existing attribute. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 xml_attribute ()
 Default ctor.
 operator unspecified_bool_type () const
 Safe bool conversion.
+bool operator! () const
bool operator== (const xml_attribute &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator!= (const xml_attribute &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator< (const xml_attribute &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator> (const xml_attribute &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator<= (const xml_attribute &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator>= (const xml_attribute &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
xml_attribute next_attribute () const
 Get next attribute in attribute list of node that contains the attribute.
xml_attribute previous_attribute () const
 Get previous attribute in attribute list of node that contains the attribute.
int as_int () const
 Cast attribute value as int.
double as_double () const
 Cast attribute value as double.
float as_float () const
 Cast attribute value as float.
bool as_bool () const
 Cast attribute value as bool.
+unsigned int document_order () const
xml_attribute & operator= (const char *rhs)
 Set attribute value to rhs.
xml_attribute & operator= (int rhs)
 Set attribute value to rhs.
xml_attribute & operator= (double rhs)
 Set attribute value to rhs.
xml_attribute & operator= (bool rhs)
 Set attribute value to either 'true' or 'false' (depends on whether rhs is true or false).
bool set_name (const char *rhs)
 Set attribute name to rhs.
bool set_value (const char *rhs)
 Set attribute value to rhs.
bool empty () const
 Check if attribute is empty.
const char * name () const
 Get attribute name.
const char * value () const
 Get attribute value.

Friends

+class xml_attribute_iterator
+class xml_node
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + +
pugi::xml_attribute::xml_attribute (   ) 
+
+ + + + + +
+   + + +

+Default ctor. +

+Constructs an empty attribute.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + +
pugi::xml_attribute::operator unspecified_bool_type (   )  const
+
+ + + + + +
+   + + +

+Safe bool conversion. +

+Allows xml_node to be used in a context where boolean variable is expected, such as 'if (node)'.

+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::operator== ( const xml_attribute &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::operator!= ( const xml_attribute &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::operator< ( const xml_attribute &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::operator> ( const xml_attribute &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::operator<= ( const xml_attribute &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::operator>= ( const xml_attribute &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + +
xml_attribute pugi::xml_attribute::next_attribute (   )  const
+
+ + + + + +
+   + + +

+Get next attribute in attribute list of node that contains the attribute. +

+

Returns:
next attribute, if any; empty attribute otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_attribute pugi::xml_attribute::previous_attribute (   )  const
+
+ + + + + +
+   + + +

+Get previous attribute in attribute list of node that contains the attribute. +

+

Returns:
previous attribute, if any; empty attribute otherwise
+
+

+ + + + +
+ + + + + + + + +
int pugi::xml_attribute::as_int (   )  const
+
+ + + + + +
+   + + +

+Cast attribute value as int. +

+

Returns:
attribute value as int, or 0 if conversion did not succeed or attribute is empty
+
+

+ + + + +
+ + + + + + + + +
double pugi::xml_attribute::as_double (   )  const
+
+ + + + + +
+   + + +

+Cast attribute value as double. +

+

Returns:
attribute value as double, or 0.0 if conversion did not succeed or attribute is empty
+
+

+ + + + +
+ + + + + + + + +
float pugi::xml_attribute::as_float (   )  const
+
+ + + + + +
+   + + +

+Cast attribute value as float. +

+

Returns:
attribute value as float, or 0.0f if conversion did not succeed or attribute is empty
+
+

+ + + + +
+ + + + + + + + +
bool pugi::xml_attribute::as_bool (   )  const
+
+ + + + + +
+   + + +

+Cast attribute value as bool. +

+Returns true for attributes with values that start with '1', 't', 'T', 'y', 'Y', returns false for other attributes.

+

Returns:
attribute value as bool, or false if conversion did not succeed or attribute is empty
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute& pugi::xml_attribute::operator= ( const char *  rhs  ) 
+
+ + + + + +
+   + + +

+Set attribute value to rhs. +

+

Parameters:
+ + +
rhs - new attribute value
+
+
Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute& pugi::xml_attribute::operator= ( int  rhs  ) 
+
+ + + + + +
+   + + +

+Set attribute value to rhs. +

+

Parameters:
+ + +
rhs - new attribute value
+
+
Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute& pugi::xml_attribute::operator= ( double  rhs  ) 
+
+ + + + + +
+   + + +

+Set attribute value to rhs. +

+

Parameters:
+ + +
rhs - new attribute value
+
+
Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute& pugi::xml_attribute::operator= ( bool  rhs  ) 
+
+ + + + + +
+   + + +

+Set attribute value to either 'true' or 'false' (depends on whether rhs is true or false). +

+

Parameters:
+ + +
rhs - new attribute value
+
+
Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::set_name ( const char *  rhs  ) 
+
+ + + + + +
+   + + +

+Set attribute name to rhs. +

+

Parameters:
+ + +
rhs - new attribute name
+
+
Returns:
success flag (call fails if attribute is empty or there is not enough memory)
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute::set_value ( const char *  rhs  ) 
+
+ + + + + +
+   + + +

+Set attribute value to rhs. +

+

Parameters:
+ + +
rhs - new attribute value
+
+
Returns:
success flag (call fails if attribute is empty or there is not enough memory)
+
+

+ + + + +
+ + + + + + + + +
bool pugi::xml_attribute::empty (   )  const
+
+ + + + + +
+   + + +

+Check if attribute is empty. +

+

Returns:
true if attribute is empty, false otherwise
+
+

+ + + + +
+ + + + + + + + +
const char* pugi::xml_attribute::name (   )  const
+
+ + + + + +
+   + + +

+Get attribute name. +

+

Returns:
attribute name, or "" if attribute is empty
+
+

+ + + + +
+ + + + + + + + +
const char* pugi::xml_attribute::value (   )  const
+
+ + + + + +
+   + + +

+Get attribute value. +

+

Returns:
attribute value, or "" if attribute is empty
+
+

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__attribute__coll__graph.map b/docs/html/classpugi_1_1xml__attribute__coll__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__coll__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xml__attribute__coll__graph.md5 b/docs/html/classpugi_1_1xml__attribute__coll__graph.md5 new file mode 100644 index 0000000..5c6e354 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__coll__graph.md5 @@ -0,0 +1 @@ +bbcc1bb9d46dc6d7963d87bb57d9c972 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__attribute__coll__graph.png b/docs/html/classpugi_1_1xml__attribute__coll__graph.png new file mode 100644 index 0000000..92a5dc0 Binary files /dev/null and b/docs/html/classpugi_1_1xml__attribute__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xml__attribute__iterator-members.html b/docs/html/classpugi_1_1xml__attribute__iterator-members.html new file mode 100644 index 0000000..48c5720 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__iterator-members.html @@ -0,0 +1,37 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xml_attribute_iterator Member List

This is the complete list of members for pugi::xml_attribute_iterator, including all inherited members.

+ + + + + + + + + + + + +
operator *()pugi::xml_attribute_iterator
operator!=(const xml_attribute_iterator &rhs) const pugi::xml_attribute_iterator
operator++()pugi::xml_attribute_iterator
operator++(int)pugi::xml_attribute_iterator
operator--()pugi::xml_attribute_iterator
operator--(int)pugi::xml_attribute_iterator
operator->()pugi::xml_attribute_iterator
operator==(const xml_attribute_iterator &rhs) const pugi::xml_attribute_iterator
xml_attribute_iterator()pugi::xml_attribute_iterator
xml_attribute_iterator(const xml_attribute &node)pugi::xml_attribute_iterator
xml_attribute_iterator(xml_attribute_struct *ref, xml_attribute_struct *prev)pugi::xml_attribute_iterator
xml_node (defined in pugi::xml_attribute_iterator)pugi::xml_attribute_iterator [friend]

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__attribute__iterator.html b/docs/html/classpugi_1_1xml__attribute__iterator.html new file mode 100644 index 0000000..81b80cb --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__iterator.html @@ -0,0 +1,414 @@ + + +pugixml: pugi::xml_attribute_iterator Class Reference + + + + +
+
+
+
+
+pugi::xml_attribute_iterator
+

pugi::xml_attribute_iterator Class Reference

Inheritance diagram for pugi::xml_attribute_iterator:

Inheritance graph
+
[legend]
Collaboration diagram for pugi::xml_attribute_iterator:

Collaboration graph
+ + + +
[legend]
List of all members.

Detailed Description

+Attribute iterator. +

+It's a bidirectional iterator with value type 'xml_attribute'. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ xml_attribute_iterator ()
 Default ctor.
 xml_attribute_iterator (const xml_attribute &node)
 Initializing ctor.
 xml_attribute_iterator (xml_attribute_struct *ref, xml_attribute_struct *prev)
 Initializing ctor (for past-the-end).
bool operator== (const xml_attribute_iterator &rhs) const
 Check if this iterator is equal to rhs.
bool operator!= (const xml_attribute_iterator &rhs) const
 Check if this iterator is not equal to rhs.
xml_attribute & operator * ()
 Dereferencing operator.
xml_attribute * operator-> ()
 Member access operator.
const xml_attribute_iterator & operator++ ()
 Pre-increment operator.
xml_attribute_iterator operator++ (int)
 Post-increment operator.
const xml_attribute_iterator & operator-- ()
 Pre-decrement operator.
xml_attribute_iterator operator-- (int)
 Post-decrement operator.

Friends

+class xml_node
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
pugi::xml_attribute_iterator::xml_attribute_iterator ( const xml_attribute &  node  ) 
+
+ + + + + +
+   + + +

+Initializing ctor. +

+

Parameters:
+ + +
node - node that iterator will point at
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
pugi::xml_attribute_iterator::xml_attribute_iterator ( xml_attribute_struct *  ref,
xml_attribute_struct *  prev
) 
+
+ + + + + +
+   + + +

+Initializing ctor (for past-the-end). +

+

Parameters:
+ + + +
ref - should be 0
prev - previous node
+
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute_iterator::operator== ( const xml_attribute_iterator &  rhs  )  const
+
+ + + + + +
+   + + +

+Check if this iterator is equal to rhs. +

+

Parameters:
+ + +
rhs - other iterator
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_attribute_iterator::operator!= ( const xml_attribute_iterator &  rhs  )  const
+
+ + + + + +
+   + + +

+Check if this iterator is not equal to rhs. +

+

Parameters:
+ + +
rhs - other iterator
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + +
xml_attribute& pugi::xml_attribute_iterator::operator * (   ) 
+
+ + + + + +
+   + + +

+Dereferencing operator. +

+

Returns:
reference to the node iterator points at
+
+

+ + + + +
+ + + + + + + + +
xml_attribute* pugi::xml_attribute_iterator::operator-> (   ) 
+
+ + + + + +
+   + + +

+Member access operator. +

+

Returns:
poitner to the node iterator points at
+
+

+ + + + +
+ + + + + + + + +
const xml_attribute_iterator& pugi::xml_attribute_iterator::operator++ (   ) 
+
+ + + + + +
+   + + +

+Pre-increment operator. +

+

Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute_iterator pugi::xml_attribute_iterator::operator++ ( int   ) 
+
+ + + + + +
+   + + +

+Post-increment operator. +

+

Returns:
old value
+
+

+ + + + +
+ + + + + + + + +
const xml_attribute_iterator& pugi::xml_attribute_iterator::operator-- (   ) 
+
+ + + + + +
+   + + +

+Pre-decrement operator. +

+

Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute_iterator pugi::xml_attribute_iterator::operator-- ( int   ) 
+
+ + + + + +
+   + + +

+Post-decrement operator. +

+

Returns:
old value
+
+

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.map b/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.map new file mode 100644 index 0000000..8ab0214 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xml__attribute.html 394,98 528,125 diff --git a/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.md5 b/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.md5 new file mode 100644 index 0000000..374ea03 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.md5 @@ -0,0 +1 @@ +fca591ae465868d5d6efde7fe15693de \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.png b/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.png new file mode 100644 index 0000000..d188df2 Binary files /dev/null and b/docs/html/classpugi_1_1xml__attribute__iterator__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.map b/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.md5 b/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.md5 new file mode 100644 index 0000000..c6bbcb8 --- /dev/null +++ b/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.md5 @@ -0,0 +1 @@ +4426af196a7b9222c3d5e7c1a18fcd84 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.png b/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.png new file mode 100644 index 0000000..8b08b13 Binary files /dev/null and b/docs/html/classpugi_1_1xml__attribute__iterator__inherit__graph.png differ diff --git a/docs/html/classpugi_1_1xml__document-members.html b/docs/html/classpugi_1_1xml__document-members.html new file mode 100644 index 0000000..e25d78d --- /dev/null +++ b/docs/html/classpugi_1_1xml__document-members.html @@ -0,0 +1,103 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xml_document Member List

This is the complete list of members for pugi::xml_document, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
_root (defined in pugi::xml_node)pugi::xml_node [protected]
all_elements_by_name(const char *name, OutputIterator it) const pugi::xml_node
all_elements_by_name_w(const char *name, OutputIterator it) const pugi::xml_node
append_attribute(const char *name)pugi::xml_node
append_child(xml_node_type type=node_element)pugi::xml_node
attribute(const char *name) const pugi::xml_node
attribute_iterator typedefpugi::xml_node
attribute_w(const char *name) const pugi::xml_node
attributes_begin() const pugi::xml_node
attributes_end() const pugi::xml_node
begin() const pugi::xml_node
child(const char *name) const pugi::xml_node
child_value() const pugi::xml_node
child_value(const char *name) const pugi::xml_node
child_value_w(const char *name) const pugi::xml_node
child_w(const char *name) const pugi::xml_node
document_order() const (defined in pugi::xml_node)pugi::xml_node
empty() const pugi::xml_node
end() const pugi::xml_node
find_attribute(Predicate pred) const pugi::xml_node [inline]
find_child(Predicate pred) const pugi::xml_node [inline]
find_node(Predicate pred) const pugi::xml_node [inline]
first_attribute() const pugi::xml_node
first_child() const pugi::xml_node
first_element_by_path(const char *path, char delimiter= '/') const pugi::xml_node
get_allocator() const (defined in pugi::xml_node)pugi::xml_node [protected]
insert_attribute_after(const char *name, const xml_attribute &attr)pugi::xml_node
insert_attribute_before(const char *name, const xml_attribute &attr)pugi::xml_node
insert_child_after(xml_node_type type, const xml_node &node)pugi::xml_node
insert_child_before(xml_node_type type, const xml_node &node)pugi::xml_node
iterator typedefpugi::xml_node
last_attribute() const pugi::xml_node
last_child() const pugi::xml_node
load(std::istream &stream, unsigned int options=parse_default)pugi::xml_document
load(const char *contents, unsigned int options=parse_default)pugi::xml_document
load_file(const char *name, unsigned int options=parse_default)pugi::xml_document
name() const pugi::xml_node
next_sibling(const char *name) const pugi::xml_node
next_sibling() const pugi::xml_node
next_sibling_w(const char *name) const pugi::xml_node
operator unspecified_bool_type() const pugi::xml_node
operator!() const (defined in pugi::xml_node)pugi::xml_node
operator!=(const xml_node &r) const pugi::xml_node
operator<(const xml_node &r) const pugi::xml_node
operator<=(const xml_node &r) const pugi::xml_node
operator==(const xml_node &r) const pugi::xml_node
operator>(const xml_node &r) const pugi::xml_node
operator>=(const xml_node &r) const pugi::xml_node
parent() const pugi::xml_node
parse(char *xmlstr, unsigned int options=parse_default)pugi::xml_document
parse(const transfer_ownership_tag &, char *xmlstr, unsigned int options=parse_default)pugi::xml_document
path(char delimiter= '/') const pugi::xml_node
precompute_document_order()pugi::xml_document
precompute_document_order_impl() (defined in pugi::xml_node)pugi::xml_node [protected]
previous_sibling(const char *name) const pugi::xml_node
previous_sibling() const pugi::xml_node
previous_sibling_w(const char *name) const pugi::xml_node
print(std::ostream &os, const char *indent="\t", unsigned int flags=format_default, unsigned int depth=0)pugi::xml_node
remove_attribute(const xml_attribute &a)pugi::xml_node
remove_attribute(const char *name)pugi::xml_node
remove_child(const xml_node &n)pugi::xml_node
remove_child(const char *name)pugi::xml_node
root() const pugi::xml_node
save_file(const char *name, const char *indent="\t", unsigned int flags=format_default)pugi::xml_document
select_nodes(const char *query) const pugi::xml_node
select_nodes(xpath_query &query) const pugi::xml_node
select_single_node(const char *query) const pugi::xml_node
select_single_node(xpath_query &query) const pugi::xml_node
set_name(const char *rhs)pugi::xml_node
set_value(const char *rhs)pugi::xml_node
traverse(xml_tree_walker &walker)pugi::xml_node
type() const pugi::xml_node
unspecified_bool_type typedef (defined in pugi::xml_node)pugi::xml_node [protected]
value() const pugi::xml_node
xml_document()pugi::xml_document
xml_node(xml_node_struct *p) (defined in pugi::xml_node)pugi::xml_node [explicit, protected]
xml_node()pugi::xml_node
~xml_document()pugi::xml_document

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__document.html b/docs/html/classpugi_1_1xml__document.html new file mode 100644 index 0000000..c3a4bd4 --- /dev/null +++ b/docs/html/classpugi_1_1xml__document.html @@ -0,0 +1,365 @@ + + +pugixml: pugi::xml_document Class Reference + + + + +
+
+
+
+
+pugi::xml_document
+

pugi::xml_document Class Reference

Inheritance diagram for pugi::xml_document:

Inheritance graph
+ + + +
[legend]
Collaboration diagram for pugi::xml_document:

Collaboration graph
+ + + +
[legend]
List of all members.

Detailed Description

+Document class (DOM tree root). +

+This class has noncopyable semantics (private copy ctor/assignment operator). +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ xml_document ()
 Default ctor, makes empty document.
+ ~xml_document ()
 Dtor.
bool load (std::istream &stream, unsigned int options=parse_default)
 Load document from stream.
bool load (const char *contents, unsigned int options=parse_default)
 Load document from string.
bool load_file (const char *name, unsigned int options=parse_default)
 Load document from file.
bool parse (char *xmlstr, unsigned int options=parse_default)
 Parse the given XML string in-situ.
bool parse (const transfer_ownership_tag &, char *xmlstr, unsigned int options=parse_default)
 Parse the given XML string in-situ (gains ownership).
bool save_file (const char *name, const char *indent="\t", unsigned int flags=format_default)
 Save XML to file.
+void precompute_document_order ()
 Compute document order for the whole tree Sometimes this makes evaluation of XPath queries faster.
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool pugi::xml_document::load ( std::istream &  stream,
unsigned int  options = parse_default
) 
+
+ + + + + +
+   + + +

+Load document from stream. +

+

Parameters:
+ + + +
stream - stream with xml data
options - parsing options
+
+
Returns:
success flag
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool pugi::xml_document::load ( const char *  contents,
unsigned int  options = parse_default
) 
+
+ + + + + +
+   + + +

+Load document from string. +

+

Parameters:
+ + + +
contents - input string
options - parsing options
+
+
Returns:
success flag
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool pugi::xml_document::load_file ( const char *  name,
unsigned int  options = parse_default
) 
+
+ + + + + +
+   + + +

+Load document from file. +

+

Parameters:
+ + + +
name - file name
options - parsing options
+
+
Returns:
success flag
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool pugi::xml_document::parse ( char *  xmlstr,
unsigned int  options = parse_default
) 
+
+ + + + + +
+   + + +

+Parse the given XML string in-situ. +

+The string is modified; you should ensure that string data will persist throughout the document's lifetime. Although, document does not gain ownership over the string, so you should free the memory occupied by it manually.

+

Parameters:
+ + + +
xmlstr - readwrite string with xml data
options - parsing options
+
+
Returns:
success flag
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool pugi::xml_document::parse ( const transfer_ownership_tag & ,
char *  xmlstr,
unsigned int  options = parse_default
) 
+
+ + + + + +
+   + + +

+Parse the given XML string in-situ (gains ownership). +

+The string is modified; document gains ownership over the string, so you don't have to worry about it's lifetime. Call example: doc.parse(transfer_ownership_tag(), string, options);

+

Parameters:
+ + + +
xmlstr - readwrite string with xml data
options - parsing options
+
+
Returns:
success flag
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool pugi::xml_document::save_file ( const char *  name,
const char *  indent = "\t",
unsigned int  flags = format_default
) 
+
+ + + + + +
+   + + +

+Save XML to file. +

+

Parameters:
+ + + + +
name - file name
indent - indentation string
flags - formatting flags
+
+
Returns:
success flag
+
+

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__document__coll__graph.map b/docs/html/classpugi_1_1xml__document__coll__graph.map new file mode 100644 index 0000000..78dbed9 --- /dev/null +++ b/docs/html/classpugi_1_1xml__document__coll__graph.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xml__node.html 17,98 129,125 diff --git a/docs/html/classpugi_1_1xml__document__coll__graph.md5 b/docs/html/classpugi_1_1xml__document__coll__graph.md5 new file mode 100644 index 0000000..6da3440 --- /dev/null +++ b/docs/html/classpugi_1_1xml__document__coll__graph.md5 @@ -0,0 +1 @@ +3e4052a1037be38a0cdf2df3c750dd84 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__document__coll__graph.png b/docs/html/classpugi_1_1xml__document__coll__graph.png new file mode 100644 index 0000000..ac5f77f Binary files /dev/null and b/docs/html/classpugi_1_1xml__document__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xml__document__inherit__graph.map b/docs/html/classpugi_1_1xml__document__inherit__graph.map new file mode 100644 index 0000000..a324f1d --- /dev/null +++ b/docs/html/classpugi_1_1xml__document__inherit__graph.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xml__node.html 24,7 136,34 diff --git a/docs/html/classpugi_1_1xml__document__inherit__graph.md5 b/docs/html/classpugi_1_1xml__document__inherit__graph.md5 new file mode 100644 index 0000000..71d9ecc --- /dev/null +++ b/docs/html/classpugi_1_1xml__document__inherit__graph.md5 @@ -0,0 +1 @@ +68a77824c939d2564bd1548379a7c1e1 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__document__inherit__graph.png b/docs/html/classpugi_1_1xml__document__inherit__graph.png new file mode 100644 index 0000000..8f89193 Binary files /dev/null and b/docs/html/classpugi_1_1xml__document__inherit__graph.png differ diff --git a/docs/html/classpugi_1_1xml__node-members.html b/docs/html/classpugi_1_1xml__node-members.html new file mode 100644 index 0000000..0a4dcee --- /dev/null +++ b/docs/html/classpugi_1_1xml__node-members.html @@ -0,0 +1,95 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xml_node Member List

This is the complete list of members for pugi::xml_node, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
_root (defined in pugi::xml_node)pugi::xml_node [protected]
all_elements_by_name(const char *name, OutputIterator it) const pugi::xml_node
all_elements_by_name_w(const char *name, OutputIterator it) const pugi::xml_node
append_attribute(const char *name)pugi::xml_node
append_child(xml_node_type type=node_element)pugi::xml_node
attribute(const char *name) const pugi::xml_node
attribute_iterator typedefpugi::xml_node
attribute_w(const char *name) const pugi::xml_node
attributes_begin() const pugi::xml_node
attributes_end() const pugi::xml_node
begin() const pugi::xml_node
child(const char *name) const pugi::xml_node
child_value() const pugi::xml_node
child_value(const char *name) const pugi::xml_node
child_value_w(const char *name) const pugi::xml_node
child_w(const char *name) const pugi::xml_node
document_order() const (defined in pugi::xml_node)pugi::xml_node
empty() const pugi::xml_node
end() const pugi::xml_node
find_attribute(Predicate pred) const pugi::xml_node [inline]
find_child(Predicate pred) const pugi::xml_node [inline]
find_node(Predicate pred) const pugi::xml_node [inline]
first_attribute() const pugi::xml_node
first_child() const pugi::xml_node
first_element_by_path(const char *path, char delimiter= '/') const pugi::xml_node
get_allocator() const (defined in pugi::xml_node)pugi::xml_node [protected]
insert_attribute_after(const char *name, const xml_attribute &attr)pugi::xml_node
insert_attribute_before(const char *name, const xml_attribute &attr)pugi::xml_node
insert_child_after(xml_node_type type, const xml_node &node)pugi::xml_node
insert_child_before(xml_node_type type, const xml_node &node)pugi::xml_node
iterator typedefpugi::xml_node
last_attribute() const pugi::xml_node
last_child() const pugi::xml_node
name() const pugi::xml_node
next_sibling(const char *name) const pugi::xml_node
next_sibling() const pugi::xml_node
next_sibling_w(const char *name) const pugi::xml_node
operator unspecified_bool_type() const pugi::xml_node
operator!() const (defined in pugi::xml_node)pugi::xml_node
operator!=(const xml_node &r) const pugi::xml_node
operator<(const xml_node &r) const pugi::xml_node
operator<=(const xml_node &r) const pugi::xml_node
operator==(const xml_node &r) const pugi::xml_node
operator>(const xml_node &r) const pugi::xml_node
operator>=(const xml_node &r) const pugi::xml_node
parent() const pugi::xml_node
path(char delimiter= '/') const pugi::xml_node
precompute_document_order_impl() (defined in pugi::xml_node)pugi::xml_node [protected]
previous_sibling(const char *name) const pugi::xml_node
previous_sibling() const pugi::xml_node
previous_sibling_w(const char *name) const pugi::xml_node
print(std::ostream &os, const char *indent="\t", unsigned int flags=format_default, unsigned int depth=0)pugi::xml_node
remove_attribute(const xml_attribute &a)pugi::xml_node
remove_attribute(const char *name)pugi::xml_node
remove_child(const xml_node &n)pugi::xml_node
remove_child(const char *name)pugi::xml_node
root() const pugi::xml_node
select_nodes(const char *query) const pugi::xml_node
select_nodes(xpath_query &query) const pugi::xml_node
select_single_node(const char *query) const pugi::xml_node
select_single_node(xpath_query &query) const pugi::xml_node
set_name(const char *rhs)pugi::xml_node
set_value(const char *rhs)pugi::xml_node
traverse(xml_tree_walker &walker)pugi::xml_node
type() const pugi::xml_node
unspecified_bool_type typedef (defined in pugi::xml_node)pugi::xml_node [protected]
value() const pugi::xml_node
xml_node(xml_node_struct *p) (defined in pugi::xml_node)pugi::xml_node [explicit, protected]
xml_node()pugi::xml_node
xml_node_iterator (defined in pugi::xml_node)pugi::xml_node [friend]

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__node.html b/docs/html/classpugi_1_1xml__node.html new file mode 100644 index 0000000..2be96f3 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node.html @@ -0,0 +1,2473 @@ + + +pugixml: pugi::xml_node Class Reference + + + + +
+
+
+
+
+pugi::xml_node
+

pugi::xml_node Class Reference

Inheritance diagram for pugi::xml_node:

Inheritance graph
+ + + +
[legend]
Collaboration diagram for pugi::xml_node:

Collaboration graph
+
[legend]
List of all members.

Detailed Description

+A light-weight wrapper for manipulating nodes in DOM tree. +

+Note: xml_node does not allocate any memory for the node it wraps; it only wraps a pointer to existing node. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types

typedef xml_node_iterator iterator
 Node iterator type (for child nodes).
typedef xml_attribute_iterator attribute_iterator
 Node iterator type (for child nodes).

Public Member Functions

 xml_node ()
 Default ctor.
 operator unspecified_bool_type () const
 Safe bool conversion.
+bool operator! () const
bool operator== (const xml_node &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator!= (const xml_node &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator< (const xml_node &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator> (const xml_node &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator<= (const xml_node &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
bool operator>= (const xml_node &r) const
 Compare wrapped pointer to the attribute to the pointer that is wrapped by r.
iterator begin () const
 Access the begin iterator for this node's collection of child nodes.
iterator end () const
 Access the end iterator for this node's collection of child nodes.
attribute_iterator attributes_begin () const
 Access the begin iterator for this node's collection of attributes.
attribute_iterator attributes_end () const
 Access the end iterator for this node's collection of attributes.
bool empty () const
 Check if node is empty.
xml_node_type type () const
 Get node type.
const char * name () const
 Get node name (element name for element nodes, PI target for PI).
const char * value () const
 Get node value (comment/PI/PCDATA/CDATA contents, depending on node type).
xml_node child (const char *name) const
 Get child with the specified name.
xml_node child_w (const char *name) const
 Get child with the name that matches specified pattern.
xml_attribute attribute (const char *name) const
 Get attribute with the specified name.
xml_attribute attribute_w (const char *name) const
 Get attribute with the name that matches specified pattern.
xml_node next_sibling (const char *name) const
 Get first of following sibling nodes with the specified name.
xml_node next_sibling_w (const char *name) const
 Get first of the following sibling nodes with the name that matches specified pattern.
xml_node next_sibling () const
 Get following sibling.
xml_node previous_sibling (const char *name) const
 Get first of preceding sibling nodes with the specified name.
xml_node previous_sibling_w (const char *name) const
 Get first of the preceding sibling nodes with the name that matches specified pattern.
xml_node previous_sibling () const
 Get preceding sibling.
xml_node parent () const
 Get parent node.
xml_node root () const
 Get root of DOM tree this node belongs to.
const char * child_value () const
 Get child value of current node; that is, value of the first child node of type PCDATA/CDATA.
const char * child_value (const char *name) const
 Get child value of child with specified name.
const char * child_value_w (const char *name) const
 Get child value of child with name that matches the specified pattern.
bool set_name (const char *rhs)
 Set node name to rhs (for PI/element nodes).
bool set_value (const char *rhs)
 Set node value to rhs (for PI/PCDATA/CDATA/comment nodes).
xml_attribute append_attribute (const char *name)
 Add attribute with specified name (for element nodes).
xml_attribute insert_attribute_after (const char *name, const xml_attribute &attr)
 Insert attribute with specified name after attr (for element nodes).
xml_attribute insert_attribute_before (const char *name, const xml_attribute &attr)
 Insert attribute with specified name before attr (for element nodes).
xml_node append_child (xml_node_type type=node_element)
 Add child node with specified type (for element nodes).
xml_node insert_child_after (xml_node_type type, const xml_node &node)
 Insert child node with specified type after node (for element nodes).
xml_node insert_child_before (xml_node_type type, const xml_node &node)
 Insert child node with specified type before node (for element nodes).
void remove_attribute (const xml_attribute &a)
 Remove specified attribute.
void remove_attribute (const char *name)
 Remove attribute with the specified name, if any.
void remove_child (const xml_node &n)
 Remove specified child.
void remove_child (const char *name)
 Remove child with the specified name, if any.
xml_attribute first_attribute () const
 Get first attribute.
xml_attribute last_attribute () const
 Get last attribute.
template<typename OutputIterator>
void all_elements_by_name (const char *name, OutputIterator it) const
 Get all elements from subtree with given name.
template<typename OutputIterator>
void all_elements_by_name_w (const char *name, OutputIterator it) const
 Get all elements from subtree with name that matches given pattern.
xml_node first_child () const
 Get first child.
xml_node last_child () const
 Get last child.
template<typename Predicate>
xml_attribute find_attribute (Predicate pred) const
 Find attribute using predicate.
template<typename Predicate>
xml_node find_child (Predicate pred) const
 Find child node using predicate.
template<typename Predicate>
xml_node find_node (Predicate pred) const
 Find node from subtree using predicate.
std::string path (char delimiter= '/') const
 Get the absolute node path from root as a text string.
xml_node first_element_by_path (const char *path, char delimiter= '/') const
 Search for a node by path.
bool traverse (xml_tree_walker &walker)
 Recursively traverse subtree with xml_tree_walker.
xpath_node select_single_node (const char *query) const
 Select single node by evaluating XPath query.
xpath_node select_single_node (xpath_query &query) const
 Select single node by evaluating XPath query.
xpath_node_set select_nodes (const char *query) const
 Select node set by evaluating XPath query.
xpath_node_set select_nodes (xpath_query &query) const
 Select node set by evaluating XPath query.
+unsigned int document_order () const
void print (std::ostream &os, const char *indent="\t", unsigned int flags=format_default, unsigned int depth=0)
 Print subtree to stream.

Protected Types

+typedef xml_node_struct *xml_node::* unspecified_bool_type

Protected Member Functions

+ xml_node (xml_node_struct *p)
+void precompute_document_order_impl ()
+xml_allocator & get_allocator () const

Protected Attributes

+xml_node_struct * _root

Friends

+class xml_node_iterator
+

Member Typedef Documentation

+

+ + + + +
+ + + + +
typedef xml_node_iterator pugi::xml_node::iterator
+
+ + + + + +
+   + + +

+Node iterator type (for child nodes). +

+

See also:
xml_node_iterator
+
+

+ + + + +
+ + + + +
typedef xml_attribute_iterator pugi::xml_node::attribute_iterator
+
+ + + + + +
+   + + +

+Node iterator type (for child nodes). +

+

See also:
xml_attribute_iterator
+
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + +
pugi::xml_node::xml_node (   ) 
+
+ + + + + +
+   + + +

+Default ctor. +

+Constructs an empty node.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + +
pugi::xml_node::operator unspecified_bool_type (   )  const
+
+ + + + + +
+   + + +

+Safe bool conversion. +

+Allows xml_node to be used in a context where boolean variable is expected, such as 'if (node)'.

+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::operator== ( const xml_node &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::operator!= ( const xml_node &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::operator< ( const xml_node &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::operator> ( const xml_node &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::operator<= ( const xml_node &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::operator>= ( const xml_node &  r  )  const
+
+ + + + + +
+   + + +

+Compare wrapped pointer to the attribute to the pointer that is wrapped by r. +

+

Parameters:
+ + +
r - value to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + +
iterator pugi::xml_node::begin (   )  const
+
+ + + + + +
+   + + +

+Access the begin iterator for this node's collection of child nodes. +

+

Returns:
iterator that points to the first child node, or past-the-end iterator if node is empty or has no children
+
+

+ + + + +
+ + + + + + + + +
iterator pugi::xml_node::end (   )  const
+
+ + + + + +
+   + + +

+Access the end iterator for this node's collection of child nodes. +

+

Returns:
past-the-end iterator for child list
+
+

+ + + + +
+ + + + + + + + +
attribute_iterator pugi::xml_node::attributes_begin (   )  const
+
+ + + + + +
+   + + +

+Access the begin iterator for this node's collection of attributes. +

+

Returns:
iterator that points to the first attribute, or past-the-end iterator if node is empty or has no attributes
+
+

+ + + + +
+ + + + + + + + +
attribute_iterator pugi::xml_node::attributes_end (   )  const
+
+ + + + + +
+   + + +

+Access the end iterator for this node's collection of attributes. +

+

Returns:
past-the-end iterator for attribute list
+
+

+ + + + +
+ + + + + + + + +
bool pugi::xml_node::empty (   )  const
+
+ + + + + +
+   + + +

+Check if node is empty. +

+

Returns:
true if node is empty, false otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_node_type pugi::xml_node::type (   )  const
+
+ + + + + +
+   + + +

+Get node type. +

+

Returns:
node type; node_null for empty nodes
+
+

+ + + + +
+ + + + + + + + +
const char* pugi::xml_node::name (   )  const
+
+ + + + + +
+   + + +

+Get node name (element name for element nodes, PI target for PI). +

+

Returns:
node name, if any; "" otherwise
+
+

+ + + + +
+ + + + + + + + +
const char* pugi::xml_node::value (   )  const
+
+ + + + + +
+   + + +

+Get node value (comment/PI/PCDATA/CDATA contents, depending on node type). +

+

Returns:
node value, if any; "" otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_node pugi::xml_node::child ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get child with the specified name. +

+

Parameters:
+ + +
name - child name
+
+
Returns:
child with the specified name, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_node pugi::xml_node::child_w ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get child with the name that matches specified pattern. +

+

Parameters:
+ + +
name - child name pattern
+
+
Returns:
child with the name that matches pattern, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute pugi::xml_node::attribute ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get attribute with the specified name. +

+

Parameters:
+ + +
name - attribute name
+
+
Returns:
attribute with the specified name, if any; empty attribute otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute pugi::xml_node::attribute_w ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get attribute with the name that matches specified pattern. +

+

Parameters:
+ + +
name - attribute name pattern
+
+
Returns:
attribute with the name that matches pattern, if any; empty attribute otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_node pugi::xml_node::next_sibling ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get first of following sibling nodes with the specified name. +

+

Parameters:
+ + +
name - sibling name
+
+
Returns:
node with the specified name, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_node pugi::xml_node::next_sibling_w ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get first of the following sibling nodes with the name that matches specified pattern. +

+

Parameters:
+ + +
name - sibling name pattern
+
+
Returns:
node with the name that matches pattern, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_node pugi::xml_node::next_sibling (   )  const
+
+ + + + + +
+   + + +

+Get following sibling. +

+

Returns:
following sibling node, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_node pugi::xml_node::previous_sibling ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get first of preceding sibling nodes with the specified name. +

+

Parameters:
+ + +
name - sibling name
+
+
Returns:
node with the specified name, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + + +
xml_node pugi::xml_node::previous_sibling_w ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get first of the preceding sibling nodes with the name that matches specified pattern. +

+

Parameters:
+ + +
name - sibling name pattern
+
+
Returns:
node with the name that matches pattern, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_node pugi::xml_node::previous_sibling (   )  const
+
+ + + + + +
+   + + +

+Get preceding sibling. +

+

Returns:
preceding sibling node, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_node pugi::xml_node::parent (   )  const
+
+ + + + + +
+   + + +

+Get parent node. +

+

Returns:
parent node if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_node pugi::xml_node::root (   )  const
+
+ + + + + +
+   + + +

+Get root of DOM tree this node belongs to. +

+

Returns:
tree root
+
+

+ + + + +
+ + + + + + + + +
const char* pugi::xml_node::child_value (   )  const
+
+ + + + + +
+   + + +

+Get child value of current node; that is, value of the first child node of type PCDATA/CDATA. +

+

Returns:
child value of current node, if any; "" otherwise
+
+

+ + + + +
+ + + + + + + + + +
const char* pugi::xml_node::child_value ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get child value of child with specified name. +

+

See also:
child_value node.child_value(name) is equivalent to node.child(name).child_value()
+
Parameters:
+ + +
name - child name
+
+
Returns:
child value of specified child node, if any; "" otherwise
+
+

+ + + + +
+ + + + + + + + + +
const char* pugi::xml_node::child_value_w ( const char *  name  )  const
+
+ + + + + +
+   + + +

+Get child value of child with name that matches the specified pattern. +

+

See also:
child_value node.child_value_w(name) is equivalent to node.child_w(name).child_value()
+
Parameters:
+ + +
name - child name pattern
+
+
Returns:
child value of specified child node, if any; "" otherwise
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::set_name ( const char *  rhs  ) 
+
+ + + + + +
+   + + +

+Set node name to rhs (for PI/element nodes). +

+

See also:
name
+
Parameters:
+ + +
rhs - new node name
+
+
Returns:
success flag (call fails if node is of the wrong type or there is not enough memory)
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::set_value ( const char *  rhs  ) 
+
+ + + + + +
+   + + +

+Set node value to rhs (for PI/PCDATA/CDATA/comment nodes). +

+

See also:
value
+
Parameters:
+ + +
rhs - new node value
+
+
Returns:
success flag (call fails if node is of the wrong type or there is not enough memory)
+
+

+ + + + +
+ + + + + + + + + +
xml_attribute pugi::xml_node::append_attribute ( const char *  name  ) 
+
+ + + + + +
+   + + +

+Add attribute with specified name (for element nodes). +

+

Parameters:
+ + +
name - attribute name
+
+
Returns:
added attribute, or empty attribute if there was an error (wrong node type)
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
xml_attribute pugi::xml_node::insert_attribute_after ( const char *  name,
const xml_attribute &  attr
) 
+
+ + + + + +
+   + + +

+Insert attribute with specified name after attr (for element nodes). +

+

Parameters:
+ + + +
name - attribute name
attr - attribute to insert a new one after
+
+
Returns:
inserted attribute, or empty attribute if there was an error (wrong node type, or attr does not belong to node)
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
xml_attribute pugi::xml_node::insert_attribute_before ( const char *  name,
const xml_attribute &  attr
) 
+
+ + + + + +
+   + + +

+Insert attribute with specified name before attr (for element nodes). +

+

Parameters:
+ + + +
name - attribute name
attr - attribute to insert a new one before
+
+
Returns:
inserted attribute, or empty attribute if there was an error (wrong node type, or attr does not belong to node)
+
+

+ + + + +
+ + + + + + + + + +
xml_node pugi::xml_node::append_child ( xml_node_type  type = node_element  ) 
+
+ + + + + +
+   + + +

+Add child node with specified type (for element nodes). +

+

Parameters:
+ + +
type - node type
+
+
Returns:
added node, or empty node if there was an error (wrong node type)
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
xml_node pugi::xml_node::insert_child_after ( xml_node_type  type,
const xml_node &  node
) 
+
+ + + + + +
+   + + +

+Insert child node with specified type after node (for element nodes). +

+

Parameters:
+ + + +
type - node type
node - node to insert a new one after
+
+
Returns:
inserted node, or empty node if there was an error (wrong node type, or node is not a child of this node)
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
xml_node pugi::xml_node::insert_child_before ( xml_node_type  type,
const xml_node &  node
) 
+
+ + + + + +
+   + + +

+Insert child node with specified type before node (for element nodes). +

+

Parameters:
+ + + +
type - node type
node - node to insert a new one before
+
+
Returns:
inserted node, or empty node if there was an error (wrong node type, or node is not a child of this node)
+
+

+ + + + +
+ + + + + + + + + +
void pugi::xml_node::remove_attribute ( const xml_attribute &  a  ) 
+
+ + + + + +
+   + + +

+Remove specified attribute. +

+

Parameters:
+ + +
a - attribute to be removed
+
+
+

+ + + + +
+ + + + + + + + + +
void pugi::xml_node::remove_attribute ( const char *  name  ) 
+
+ + + + + +
+   + + +

+Remove attribute with the specified name, if any. +

+

Parameters:
+ + +
name - attribute name
+
+
+

+ + + + +
+ + + + + + + + + +
void pugi::xml_node::remove_child ( const xml_node &  n  ) 
+
+ + + + + +
+   + + +

+Remove specified child. +

+

Parameters:
+ + +
n - child node to be removed
+
+
+

+ + + + +
+ + + + + + + + + +
void pugi::xml_node::remove_child ( const char *  name  ) 
+
+ + + + + +
+   + + +

+Remove child with the specified name, if any. +

+

Parameters:
+ + +
name - child name
+
+
+

+ + + + +
+ + + + + + + + +
xml_attribute pugi::xml_node::first_attribute (   )  const
+
+ + + + + +
+   + + +

+Get first attribute. +

+

Returns:
first attribute, if any; empty attribute otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_attribute pugi::xml_node::last_attribute (   )  const
+
+ + + + + +
+   + + +

+Get last attribute. +

+

Returns:
last attribute, if any; empty attribute otherwise
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+template<typename OutputIterator>
void pugi::xml_node::all_elements_by_name ( const char *  name,
OutputIterator  it
)  const
+
+ + + + + +
+   + + +

+Get all elements from subtree with given name. +

+

Parameters:
+ + + +
name - node name
it - output iterator (for example, std::back_insert_iterator (result of std::back_inserter))
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+template<typename OutputIterator>
void pugi::xml_node::all_elements_by_name_w ( const char *  name,
OutputIterator  it
)  const
+
+ + + + + +
+   + + +

+Get all elements from subtree with name that matches given pattern. +

+

Parameters:
+ + + +
name - node name pattern
it - output iterator (for example, std::back_insert_iterator (result of std::back_inserter))
+
+
+

+ + + + +
+ + + + + + + + +
xml_node pugi::xml_node::first_child (   )  const
+
+ + + + + +
+   + + +

+Get first child. +

+

Returns:
first child, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_node pugi::xml_node::last_child (   )  const
+
+ + + + + +
+   + + +

+Get last child. +

+

Returns:
last child, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + + + + + +
+template<typename Predicate>
xml_attribute pugi::xml_node::find_attribute ( Predicate  pred  )  const [inline]
+
+ + + + + +
+   + + +

+Find attribute using predicate. +

+

Parameters:
+ + +
pred - predicate, that takes xml_attribute and returns bool
+
+
Returns:
first attribute for which predicate returned true, or empty attribute
+
+

+ + + + +
+ + + + + + + + + + + + +
+template<typename Predicate>
xml_node pugi::xml_node::find_child ( Predicate  pred  )  const [inline]
+
+ + + + + +
+   + + +

+Find child node using predicate. +

+

Parameters:
+ + +
pred - predicate, that takes xml_node and returns bool
+
+
Returns:
first child node for which predicate returned true, or empty node
+
+

+ + + + +
+ + + + + + + + + + + + +
+template<typename Predicate>
xml_node pugi::xml_node::find_node ( Predicate  pred  )  const [inline]
+
+ + + + + +
+   + + +

+Find node from subtree using predicate. +

+

Parameters:
+ + +
pred - predicate, that takes xml_node and returns bool
+
+
Returns:
first node from subtree for which predicate returned true, or empty node
+
+

+ + + + +
+ + + + + + + + + +
std::string pugi::xml_node::path ( char  delimiter = '/'  )  const
+
+ + + + + +
+   + + +

+Get the absolute node path from root as a text string. +

+

Parameters:
+ + +
delimiter - delimiter character to insert between element names
+
+
Returns:
path string (e.g. '/bookstore/book/author').
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
xml_node pugi::xml_node::first_element_by_path ( const char *  path,
char  delimiter = '/'
)  const
+
+ + + + + +
+   + + +

+Search for a node by path. +

+

Parameters:
+ + + +
path - path string; e.g. './foo/bar' (relative to node), '/foo/bar' (relative to root), '../foo/bar'.
delimiter - delimiter character to use while tokenizing path
+
+
Returns:
matching node, if any; empty node otherwise
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node::traverse ( xml_tree_walker &  walker  ) 
+
+ + + + + +
+   + + +

+Recursively traverse subtree with xml_tree_walker. +

+

See also:
xml_tree_walker::begin

+xml_tree_walker::for_each

+xml_tree_walker::end

+
Parameters:
+ + +
walker - tree walker to traverse subtree with
+
+
Returns:
traversal result
+
+

+ + + + +
+ + + + + + + + + +
xpath_node pugi::xml_node::select_single_node ( const char *  query  )  const
+
+ + + + + +
+   + + +

+Select single node by evaluating XPath query. +

+

Parameters:
+ + +
query - query string
+
+
Returns:
first node from the resulting node set by document order, or empty node if none found
+
+

+ + + + +
+ + + + + + + + + +
xpath_node pugi::xml_node::select_single_node ( xpath_query &  query  )  const
+
+ + + + + +
+   + + +

+Select single node by evaluating XPath query. +

+

Parameters:
+ + +
query - compiled query
+
+
Returns:
first node from the resulting node set by document order, or empty node if none found
+
+

+ + + + +
+ + + + + + + + + +
xpath_node_set pugi::xml_node::select_nodes ( const char *  query  )  const
+
+ + + + + +
+   + + +

+Select node set by evaluating XPath query. +

+

Parameters:
+ + +
query - query string
+
+
Returns:
resulting node set
+
+

+ + + + +
+ + + + + + + + + +
xpath_node_set pugi::xml_node::select_nodes ( xpath_query &  query  )  const
+
+ + + + + +
+   + + +

+Select node set by evaluating XPath query. +

+

Parameters:
+ + +
query - compiled query
+
+
Returns:
resulting node set
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void pugi::xml_node::print ( std::ostream &  os,
const char *  indent = "\t",
unsigned int  flags = format_default,
unsigned int  depth = 0
) 
+
+ + + + + +
+   + + +

+Print subtree to stream. +

+

Parameters:
+ + + + + +
os - output stream
indent - indentation string
flags - formatting flags
depth - starting depth (used for indentation)
+
+
+

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__node__coll__graph.map b/docs/html/classpugi_1_1xml__node__coll__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__coll__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xml__node__coll__graph.md5 b/docs/html/classpugi_1_1xml__node__coll__graph.md5 new file mode 100644 index 0000000..2572420 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__coll__graph.md5 @@ -0,0 +1 @@ +8b5be5e31df5c5adb3a803e79757f0d2 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__node__coll__graph.png b/docs/html/classpugi_1_1xml__node__coll__graph.png new file mode 100644 index 0000000..db6620e Binary files /dev/null and b/docs/html/classpugi_1_1xml__node__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xml__node__inherit__graph.map b/docs/html/classpugi_1_1xml__node__inherit__graph.map new file mode 100644 index 0000000..e1b3a3b --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__inherit__graph.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xml__document.html 8,82 152,109 diff --git a/docs/html/classpugi_1_1xml__node__inherit__graph.md5 b/docs/html/classpugi_1_1xml__node__inherit__graph.md5 new file mode 100644 index 0000000..a6ac927 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__inherit__graph.md5 @@ -0,0 +1 @@ +feb1f5b174d36f4f52a15fdc9a9e8309 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__node__inherit__graph.png b/docs/html/classpugi_1_1xml__node__inherit__graph.png new file mode 100644 index 0000000..d889c51 Binary files /dev/null and b/docs/html/classpugi_1_1xml__node__inherit__graph.png differ diff --git a/docs/html/classpugi_1_1xml__node__iterator-members.html b/docs/html/classpugi_1_1xml__node__iterator-members.html new file mode 100644 index 0000000..0910691 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__iterator-members.html @@ -0,0 +1,37 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xml_node_iterator Member List

This is the complete list of members for pugi::xml_node_iterator, including all inherited members.

+ + + + + + + + + + + + +
operator *()pugi::xml_node_iterator
operator!=(const xml_node_iterator &rhs) const pugi::xml_node_iterator
operator++()pugi::xml_node_iterator
operator++(int)pugi::xml_node_iterator
operator--()pugi::xml_node_iterator
operator--(int)pugi::xml_node_iterator
operator->()pugi::xml_node_iterator
operator==(const xml_node_iterator &rhs) const pugi::xml_node_iterator
xml_node (defined in pugi::xml_node_iterator)pugi::xml_node_iterator [friend]
xml_node_iterator()pugi::xml_node_iterator
xml_node_iterator(const xml_node &node)pugi::xml_node_iterator
xml_node_iterator(xml_node_struct *ref, xml_node_struct *prev)pugi::xml_node_iterator

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__node__iterator.html b/docs/html/classpugi_1_1xml__node__iterator.html new file mode 100644 index 0000000..225c11a --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__iterator.html @@ -0,0 +1,414 @@ + + +pugixml: pugi::xml_node_iterator Class Reference + + + + +
+
+
+
+
+pugi::xml_node_iterator
+

pugi::xml_node_iterator Class Reference

Inheritance diagram for pugi::xml_node_iterator:

Inheritance graph
+
[legend]
Collaboration diagram for pugi::xml_node_iterator:

Collaboration graph
+ + + +
[legend]
List of all members.

Detailed Description

+Child node iterator. +

+It's a bidirectional iterator with value type 'xml_node'. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ xml_node_iterator ()
 Default ctor.
 xml_node_iterator (const xml_node &node)
 Initializing ctor.
 xml_node_iterator (xml_node_struct *ref, xml_node_struct *prev)
 Initializing ctor (for past-the-end).
bool operator== (const xml_node_iterator &rhs) const
 Check if this iterator is equal to rhs.
bool operator!= (const xml_node_iterator &rhs) const
 Check if this iterator is not equal to rhs.
xml_node & operator * ()
 Dereferencing operator.
xml_node * operator-> ()
 Member access operator.
const xml_node_iterator & operator++ ()
 Pre-increment operator.
xml_node_iterator operator++ (int)
 Post-increment operator.
const xml_node_iterator & operator-- ()
 Pre-decrement operator.
xml_node_iterator operator-- (int)
 Post-decrement operator.

Friends

+class xml_node
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
pugi::xml_node_iterator::xml_node_iterator ( const xml_node &  node  ) 
+
+ + + + + +
+   + + +

+Initializing ctor. +

+

Parameters:
+ + +
node - node that iterator will point at
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
pugi::xml_node_iterator::xml_node_iterator ( xml_node_struct *  ref,
xml_node_struct *  prev
) 
+
+ + + + + +
+   + + +

+Initializing ctor (for past-the-end). +

+

Parameters:
+ + + +
ref - should be 0
prev - previous node
+
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node_iterator::operator== ( const xml_node_iterator &  rhs  )  const
+
+ + + + + +
+   + + +

+Check if this iterator is equal to rhs. +

+

Parameters:
+ + +
rhs - other iterator
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xml_node_iterator::operator!= ( const xml_node_iterator &  rhs  )  const
+
+ + + + + +
+   + + +

+Check if this iterator is not equal to rhs. +

+

Parameters:
+ + +
rhs - other iterator
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + +
xml_node& pugi::xml_node_iterator::operator * (   ) 
+
+ + + + + +
+   + + +

+Dereferencing operator. +

+

Returns:
reference to the node iterator points at
+
+

+ + + + +
+ + + + + + + + +
xml_node* pugi::xml_node_iterator::operator-> (   ) 
+
+ + + + + +
+   + + +

+Member access operator. +

+

Returns:
poitner to the node iterator points at
+
+

+ + + + +
+ + + + + + + + +
const xml_node_iterator& pugi::xml_node_iterator::operator++ (   ) 
+
+ + + + + +
+   + + +

+Pre-increment operator. +

+

Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
xml_node_iterator pugi::xml_node_iterator::operator++ ( int   ) 
+
+ + + + + +
+   + + +

+Post-increment operator. +

+

Returns:
old value
+
+

+ + + + +
+ + + + + + + + +
const xml_node_iterator& pugi::xml_node_iterator::operator-- (   ) 
+
+ + + + + +
+   + + +

+Pre-decrement operator. +

+

Returns:
self
+
+

+ + + + +
+ + + + + + + + + +
xml_node_iterator pugi::xml_node_iterator::operator-- ( int   ) 
+
+ + + + + +
+   + + +

+Post-decrement operator. +

+

Returns:
old value
+
+

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__node__iterator__coll__graph.map b/docs/html/classpugi_1_1xml__node__iterator__coll__graph.map new file mode 100644 index 0000000..a1778b4 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__iterator__coll__graph.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xml__node.html 375,98 487,125 diff --git a/docs/html/classpugi_1_1xml__node__iterator__coll__graph.md5 b/docs/html/classpugi_1_1xml__node__iterator__coll__graph.md5 new file mode 100644 index 0000000..90c4c46 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__iterator__coll__graph.md5 @@ -0,0 +1 @@ +22bd4d00266db939271000f74fa43d5f \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__node__iterator__coll__graph.png b/docs/html/classpugi_1_1xml__node__iterator__coll__graph.png new file mode 100644 index 0000000..820aee7 Binary files /dev/null and b/docs/html/classpugi_1_1xml__node__iterator__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.map b/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.md5 b/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.md5 new file mode 100644 index 0000000..c91b5e0 --- /dev/null +++ b/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.md5 @@ -0,0 +1 @@ +0215459dad00cd6fcdc98555bd24087b \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.png b/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.png new file mode 100644 index 0000000..e3f04ba Binary files /dev/null and b/docs/html/classpugi_1_1xml__node__iterator__inherit__graph.png differ diff --git a/docs/html/classpugi_1_1xml__tree__walker-members.html b/docs/html/classpugi_1_1xml__tree__walker-members.html new file mode 100644 index 0000000..956ef8a --- /dev/null +++ b/docs/html/classpugi_1_1xml__tree__walker-members.html @@ -0,0 +1,32 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xml_tree_walker Member List

This is the complete list of members for pugi::xml_tree_walker, including all inherited members.

+ + + + + + + +
begin(xml_node &)pugi::xml_tree_walker [virtual]
depth() const pugi::xml_tree_walker [protected]
end(xml_node &)pugi::xml_tree_walker [virtual]
for_each(xml_node &)=0pugi::xml_tree_walker [pure virtual]
xml_node (defined in pugi::xml_tree_walker)pugi::xml_tree_walker [friend]
xml_tree_walker()pugi::xml_tree_walker
~xml_tree_walker()pugi::xml_tree_walker [virtual]

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__tree__walker.html b/docs/html/classpugi_1_1xml__tree__walker.html new file mode 100644 index 0000000..2e73c1a --- /dev/null +++ b/docs/html/classpugi_1_1xml__tree__walker.html @@ -0,0 +1,186 @@ + + +pugixml: pugi::xml_tree_walker Class Reference + + + + +
+
+
+
+
+pugi::xml_tree_walker
+

pugi::xml_tree_walker Class Reference

Collaboration diagram for pugi::xml_tree_walker:

Collaboration graph
+
[legend]
List of all members.

Detailed Description

+Abstract tree walker class. +

+

See also:
xml_node::traverse
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ xml_tree_walker ()
 Default ctor.
+virtual ~xml_tree_walker ()
 Virtual dtor.
virtual bool begin (xml_node &)
 Callback that is called when traversal of node begins.
virtual bool for_each (xml_node &)=0
 Callback that is called for each node traversed.
virtual bool end (xml_node &)
 Callback that is called when traversal of node ends.

Protected Member Functions

int depth () const
 Get node depth.

Friends

+class xml_node
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + +
int pugi::xml_tree_walker::depth (   )  const [protected]
+
+ + + + + +
+   + + +

+Get node depth. +

+

Returns:
node depth
+
+

+ + + + +
+ + + + + + + + + +
virtual bool pugi::xml_tree_walker::begin ( xml_node &   )  [virtual]
+
+ + + + + +
+   + + +

+Callback that is called when traversal of node begins. +

+

Returns:
returning false will abort the traversal
+
+

+ + + + +
+ + + + + + + + + +
virtual bool pugi::xml_tree_walker::for_each ( xml_node &   )  [pure virtual]
+
+ + + + + +
+   + + +

+Callback that is called for each node traversed. +

+

Returns:
returning false will abort the traversal
+
+

+ + + + +
+ + + + + + + + + +
virtual bool pugi::xml_tree_walker::end ( xml_node &   )  [virtual]
+
+ + + + + +
+   + + +

+Callback that is called when traversal of node ends. +

+

Returns:
returning false will abort the traversal
+
+

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xml__tree__walker__coll__graph.map b/docs/html/classpugi_1_1xml__tree__walker__coll__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xml__tree__walker__coll__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xml__tree__walker__coll__graph.md5 b/docs/html/classpugi_1_1xml__tree__walker__coll__graph.md5 new file mode 100644 index 0000000..a7106de --- /dev/null +++ b/docs/html/classpugi_1_1xml__tree__walker__coll__graph.md5 @@ -0,0 +1 @@ +d990bdcfb4fd4dd9f8f3a6fe4ee6759b \ No newline at end of file diff --git a/docs/html/classpugi_1_1xml__tree__walker__coll__graph.png b/docs/html/classpugi_1_1xml__tree__walker__coll__graph.png new file mode 100644 index 0000000..39c90dd Binary files /dev/null and b/docs/html/classpugi_1_1xml__tree__walker__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xpath__exception-members.html b/docs/html/classpugi_1_1xpath__exception-members.html new file mode 100644 index 0000000..3fa5c6f --- /dev/null +++ b/docs/html/classpugi_1_1xpath__exception-members.html @@ -0,0 +1,27 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xpath_exception Member List

This is the complete list of members for pugi::xpath_exception, including all inherited members.

+ + +
what() const pugi::xpath_exception [virtual]
xpath_exception(const char *message)pugi::xpath_exception [explicit]

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__exception.html b/docs/html/classpugi_1_1xpath__exception.html new file mode 100644 index 0000000..4278767 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__exception.html @@ -0,0 +1,108 @@ + + +pugixml: pugi::xpath_exception Class Reference + + + + +
+
+
+
+
+pugi::xpath_exception
+

pugi::xpath_exception Class Reference

Inheritance diagram for pugi::xpath_exception:

Inheritance graph
+
[legend]
Collaboration diagram for pugi::xpath_exception:

Collaboration graph
+
[legend]
List of all members.

Detailed Description

+XPath exception class. +

+ + + + + + + + + +

Public Member Functions

 xpath_exception (const char *message)
 Construct exception from static error string.
virtual const char * what () const throw ()
 Return error message.
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
pugi::xpath_exception::xpath_exception ( const char *  message  )  [explicit]
+
+ + + + + +
+   + + +

+Construct exception from static error string. +

+

Parameters:
+ + +
message - error string
+
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + +
virtual const char* pugi::xpath_exception::what (   )  const throw () [virtual]
+
+ + + + + +
+   + + +

+Return error message. +

+

Returns:
error message
+
+

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__exception__coll__graph.map b/docs/html/classpugi_1_1xpath__exception__coll__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__exception__coll__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xpath__exception__coll__graph.md5 b/docs/html/classpugi_1_1xpath__exception__coll__graph.md5 new file mode 100644 index 0000000..c917263 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__exception__coll__graph.md5 @@ -0,0 +1 @@ +e513ec4c3dceb21149d86032837e55f8 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xpath__exception__coll__graph.png b/docs/html/classpugi_1_1xpath__exception__coll__graph.png new file mode 100644 index 0000000..f713014 Binary files /dev/null and b/docs/html/classpugi_1_1xpath__exception__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xpath__exception__inherit__graph.map b/docs/html/classpugi_1_1xpath__exception__inherit__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__exception__inherit__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xpath__exception__inherit__graph.md5 b/docs/html/classpugi_1_1xpath__exception__inherit__graph.md5 new file mode 100644 index 0000000..900b385 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__exception__inherit__graph.md5 @@ -0,0 +1 @@ +531210d868031d4dfad14e6148fd793e \ No newline at end of file diff --git a/docs/html/classpugi_1_1xpath__exception__inherit__graph.png b/docs/html/classpugi_1_1xpath__exception__inherit__graph.png new file mode 100644 index 0000000..a88837e Binary files /dev/null and b/docs/html/classpugi_1_1xpath__exception__inherit__graph.png differ diff --git a/docs/html/classpugi_1_1xpath__node-members.html b/docs/html/classpugi_1_1xpath__node-members.html new file mode 100644 index 0000000..f1efe50 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node-members.html @@ -0,0 +1,34 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xpath_node Member List

This is the complete list of members for pugi::xpath_node, including all inherited members.

+ + + + + + + + + +
attribute() const pugi::xpath_node
node() const pugi::xpath_node
operator unspecified_bool_type() const pugi::xpath_node
operator!=(const xpath_node &n) const pugi::xpath_node
operator==(const xpath_node &n) const pugi::xpath_node
parent() const pugi::xpath_node
xpath_node()pugi::xpath_node
xpath_node(const xml_node &node)pugi::xpath_node
xpath_node(const xml_attribute &attribute, const xml_node &parent)pugi::xpath_node

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__node.html b/docs/html/classpugi_1_1xpath__node.html new file mode 100644 index 0000000..87b5b59 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node.html @@ -0,0 +1,341 @@ + + +pugixml: pugi::xpath_node Class Reference + + + + +
+
+
+
+
+pugi::xpath_node
+

pugi::xpath_node Class Reference

Collaboration diagram for pugi::xpath_node:

Collaboration graph
+ + + + +
[legend]
List of all members.

Detailed Description

+XPath node class. +

+XPath defines node to be either xml_node or xml_attribute in pugixml terminology, so xpath_node is either xml_node or xml_attribute. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

+ xpath_node ()
 Construct empty XPath node.
 xpath_node (const xml_node &node)
 Construct XPath node from XML node.
 xpath_node (const xml_attribute &attribute, const xml_node &parent)
 Construct XPath node from XML attribute.
xml_node node () const
 Get XML node, if any.
xml_attribute attribute () const
 Get XML attribute, if any.
xml_node parent () const
 Get parent of contained XML attribute, if any.
 operator unspecified_bool_type () const
 Safe bool conversion.
bool operator== (const xpath_node &n) const
 Compares two XPath nodes.
bool operator!= (const xpath_node &n) const
 Compares two XPath nodes.
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
pugi::xpath_node::xpath_node ( const xml_node &  node  ) 
+
+ + + + + +
+   + + +

+Construct XPath node from XML node. +

+

Parameters:
+ + +
node - XML node
+
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
pugi::xpath_node::xpath_node ( const xml_attribute &  attribute,
const xml_node &  parent
) 
+
+ + + + + +
+   + + +

+Construct XPath node from XML attribute. +

+

Parameters:
+ + + +
attribute - XML attribute
parent - attribute's parent node
+
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + +
xml_node pugi::xpath_node::node (   )  const
+
+ + + + + +
+   + + +

+Get XML node, if any. +

+

Returns:
contained XML node, empty node otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_attribute pugi::xpath_node::attribute (   )  const
+
+ + + + + +
+   + + +

+Get XML attribute, if any. +

+

Returns:
contained XML attribute, if any, empty attribute otherwise
+
+

+ + + + +
+ + + + + + + + +
xml_node pugi::xpath_node::parent (   )  const
+
+ + + + + +
+   + + +

+Get parent of contained XML attribute, if any. +

+

Returns:
parent of contained XML attribute, if any, empty node otherwise
+
+

+ + + + +
+ + + + + + + + +
pugi::xpath_node::operator unspecified_bool_type (   )  const
+
+ + + + + +
+   + + +

+Safe bool conversion. +

+Allows xpath_node to be used in a context where boolean variable is expected, such as 'if (node)'.

+

+ + + + +
+ + + + + + + + + +
bool pugi::xpath_node::operator== ( const xpath_node &  n  )  const
+
+ + + + + +
+   + + +

+Compares two XPath nodes. +

+

Parameters:
+ + +
n - XPath node to compare to
+
+
Returns:
comparison result
+
+

+ + + + +
+ + + + + + + + + +
bool pugi::xpath_node::operator!= ( const xpath_node &  n  )  const
+
+ + + + + +
+   + + +

+Compares two XPath nodes. +

+

Parameters:
+ + +
n - XPath node to compare to
+
+
Returns:
comparison result
+
+

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__node__coll__graph.map b/docs/html/classpugi_1_1xpath__node__coll__graph.map new file mode 100644 index 0000000..dd6359e --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node__coll__graph.map @@ -0,0 +1,3 @@ +base referer +rect $classpugi_1_1xml__node.html 22,98 134,125 +rect $classpugi_1_1xml__attribute.html 166,98 300,125 diff --git a/docs/html/classpugi_1_1xpath__node__coll__graph.md5 b/docs/html/classpugi_1_1xpath__node__coll__graph.md5 new file mode 100644 index 0000000..5b4d30d --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node__coll__graph.md5 @@ -0,0 +1 @@ +6221c8e84c73ffa18f2147cf42452f28 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xpath__node__coll__graph.png b/docs/html/classpugi_1_1xpath__node__coll__graph.png new file mode 100644 index 0000000..ba8c62b Binary files /dev/null and b/docs/html/classpugi_1_1xpath__node__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xpath__node__set-members.html b/docs/html/classpugi_1_1xpath__node__set-members.html new file mode 100644 index 0000000..4f9a678 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node__set-members.html @@ -0,0 +1,42 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xpath_node_set Member List

This is the complete list of members for pugi::xpath_node_set, including all inherited members.

+ + + + + + + + + + + + + + + + + +
begin() const pugi::xpath_node_set
const_iterator typedefpugi::xpath_node_set
empty() const pugi::xpath_node_set
end() const pugi::xpath_node_set
first() const pugi::xpath_node_set
operator=(const xpath_node_set &ns)pugi::xpath_node_set
size() const pugi::xpath_node_set
sort(bool reverse=false)pugi::xpath_node_set
type() const pugi::xpath_node_set
type_sorted enum valuepugi::xpath_node_set
type_sorted_reverse enum valuepugi::xpath_node_set
type_t enum namepugi::xpath_node_set
type_unsorted enum valuepugi::xpath_node_set
xpath_ast_node (defined in pugi::xpath_node_set)pugi::xpath_node_set [friend]
xpath_node_set()pugi::xpath_node_set
xpath_node_set(const xpath_node_set &ns)pugi::xpath_node_set
~xpath_node_set()pugi::xpath_node_set

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__node__set.html b/docs/html/classpugi_1_1xpath__node__set.html new file mode 100644 index 0000000..2773fb6 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node__set.html @@ -0,0 +1,413 @@ + + +pugixml: pugi::xpath_node_set Class Reference + + + + +
+
+
+
+
+pugi::xpath_node_set
+

pugi::xpath_node_set Class Reference

Collaboration diagram for pugi::xpath_node_set:

Collaboration graph
+ + + + + +
[legend]
List of all members.

Detailed Description

+Not necessarily ordered constant collection of XPath nodes. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types

+typedef const xpath_node * const_iterator
 Constant iterator type.
enum  type_t { type_unsorted, +type_sorted, +type_sorted_reverse + }
 Collection type. More...

Public Member Functions

+ xpath_node_set ()
 Default ctor Constructs empty set.
+ ~xpath_node_set ()
 Dtor.
 xpath_node_set (const xpath_node_set &ns)
 Copy ctor.
xpath_node_set & operator= (const xpath_node_set &ns)
 Assignment operator.
type_t type () const
 Get collection type.
size_t size () const
 Get collection size.
const_iterator begin () const
 Get begin constant iterator for collection.
const_iterator end () const
 Get end iterator for collection.
void sort (bool reverse=false)
 Sort the collection in ascending/descending order by document order.
xpath_node first () const
 Get first node in the collection by document order.
bool empty () const
 Return true if collection is empty.

Friends

+class xpath_ast_node
+

Member Enumeration Documentation

+

+ + + + +
+ + + + +
enum pugi::xpath_node_set::type_t
+
+ + + + + +
+   + + +

+Collection type. +

+

Enumerator:
+ + + + +
type_unsorted  +Not ordered.
type_sorted  +Sorted by document order (ascending).
type_sorted_reverse  +Sorted by document order (descending).
+
+
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
pugi::xpath_node_set::xpath_node_set ( const xpath_node_set &  ns  ) 
+
+ + + + + +
+   + + +

+Copy ctor. +

+

Parameters:
+ + +
ns - set to copy
+
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
xpath_node_set& pugi::xpath_node_set::operator= ( const xpath_node_set &  ns  ) 
+
+ + + + + +
+   + + +

+Assignment operator. +

+

Parameters:
+ + +
ns - set to assign
+
+
Returns:
self
+
+

+ + + + +
+ + + + + + + + +
type_t pugi::xpath_node_set::type (   )  const
+
+ + + + + +
+   + + +

+Get collection type. +

+

Returns:
collection type
+
+

+ + + + +
+ + + + + + + + +
size_t pugi::xpath_node_set::size (   )  const
+
+ + + + + +
+   + + +

+Get collection size. +

+

Returns:
collection size
+
+

+ + + + +
+ + + + + + + + +
const_iterator pugi::xpath_node_set::begin (   )  const
+
+ + + + + +
+   + + +

+Get begin constant iterator for collection. +

+

Returns:
begin constant iterator
+
+

+ + + + +
+ + + + + + + + +
const_iterator pugi::xpath_node_set::end (   )  const
+
+ + + + + +
+   + + +

+Get end iterator for collection. +

+

Returns:
end iterator
+
+

+ + + + +
+ + + + + + + + + +
void pugi::xpath_node_set::sort ( bool  reverse = false  ) 
+
+ + + + + +
+   + + +

+Sort the collection in ascending/descending order by document order. +

+

Parameters:
+ + +
reverse - whether to sort in ascending (false) or descending (true) order
+
+
+

+ + + + +
+ + + + + + + + +
xpath_node pugi::xpath_node_set::first (   )  const
+
+ + + + + +
+   + + +

+Get first node in the collection by document order. +

+

Returns:
first node by document order
+
+

+ + + + +
+ + + + + + + + +
bool pugi::xpath_node_set::empty (   )  const
+
+ + + + + +
+   + + +

+Return true if collection is empty. +

+

Returns:
true if collection is empty, false otherwise
+
+

Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__node__set__coll__graph.map b/docs/html/classpugi_1_1xpath__node__set__coll__graph.map new file mode 100644 index 0000000..6f67906 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node__set__coll__graph.map @@ -0,0 +1,4 @@ +base referer +rect $classpugi_1_1xpath__node.html 82,189 207,216 +rect $classpugi_1_1xml__node.html 25,98 137,125 +rect $classpugi_1_1xml__attribute.html 166,98 299,125 diff --git a/docs/html/classpugi_1_1xpath__node__set__coll__graph.md5 b/docs/html/classpugi_1_1xpath__node__set__coll__graph.md5 new file mode 100644 index 0000000..f36e93e --- /dev/null +++ b/docs/html/classpugi_1_1xpath__node__set__coll__graph.md5 @@ -0,0 +1 @@ +dae803c90d7e38f8b78eec2188afc6b8 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xpath__node__set__coll__graph.png b/docs/html/classpugi_1_1xpath__node__set__coll__graph.png new file mode 100644 index 0000000..81c6982 Binary files /dev/null and b/docs/html/classpugi_1_1xpath__node__set__coll__graph.png differ diff --git a/docs/html/classpugi_1_1xpath__query-members.html b/docs/html/classpugi_1_1xpath__query-members.html new file mode 100644 index 0000000..5edc682 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__query-members.html @@ -0,0 +1,31 @@ + + +pugixml: Member List + + + + +
+
+
+
+

pugi::xpath_query Member List

This is the complete list of members for pugi::xpath_query, including all inherited members.

+ + + + + + +
evaluate_boolean(const xml_node &n)pugi::xpath_query
evaluate_node_set(const xml_node &n)pugi::xpath_query
evaluate_number(const xml_node &n)pugi::xpath_query
evaluate_string(const xml_node &n)pugi::xpath_query
xpath_query(const char *query)pugi::xpath_query [explicit]
~xpath_query()pugi::xpath_query

Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__query.html b/docs/html/classpugi_1_1xpath__query.html new file mode 100644 index 0000000..a55cb0d --- /dev/null +++ b/docs/html/classpugi_1_1xpath__query.html @@ -0,0 +1,239 @@ + + +pugixml: pugi::xpath_query Class Reference + + + + +
+
+
+
+
+pugi::xpath_query
+

pugi::xpath_query Class Reference

Collaboration diagram for pugi::xpath_query:

Collaboration graph
+
[legend]
List of all members.

Detailed Description

+A class that holds compiled XPath query and allows to evaluate query result. +

+ + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 xpath_query (const char *query)
 Ctor from string with XPath expression.
+ ~xpath_query ()
 Dtor.
bool evaluate_boolean (const xml_node &n)
 Evaluate expression as boolean value for the context node n.
double evaluate_number (const xml_node &n)
 Evaluate expression as double value for the context node n.
std::string evaluate_string (const xml_node &n)
 Evaluate expression as string value for the context node n.
xpath_node_set evaluate_node_set (const xml_node &n)
 Evaluate expression as node set for the context node n.
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
pugi::xpath_query::xpath_query ( const char *  query  )  [explicit]
+
+ + + + + +
+   + + +

+Ctor from string with XPath expression. +

+Throws xpath_exception on compilation error, std::bad_alloc on out of memory error.

+

Parameters:
+ + +
query - string with XPath expression
+
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
bool pugi::xpath_query::evaluate_boolean ( const xml_node &  n  ) 
+
+ + + + + +
+   + + +

+Evaluate expression as boolean value for the context node n. +

+If expression does not directly evaluate to boolean, the expression result is converted as through boolean() XPath function call. Throws std::bad_alloc on out of memory error.

+

Parameters:
+ + +
n - context node
+
+
Returns:
evaluation result
+
+

+ + + + +
+ + + + + + + + + +
double pugi::xpath_query::evaluate_number ( const xml_node &  n  ) 
+
+ + + + + +
+   + + +

+Evaluate expression as double value for the context node n. +

+If expression does not directly evaluate to double, the expression result is converted as through number() XPath function call. Throws std::bad_alloc on out of memory error.

+

Parameters:
+ + +
n - context node
+
+
Returns:
evaluation result
+
+

+ + + + +
+ + + + + + + + + +
std::string pugi::xpath_query::evaluate_string ( const xml_node &  n  ) 
+
+ + + + + +
+   + + +

+Evaluate expression as string value for the context node n. +

+If expression does not directly evaluate to string, the expression result is converted as through string() XPath function call. Throws std::bad_alloc on out of memory error.

+

Parameters:
+ + +
n - context node
+
+
Returns:
evaluation result
+
+

+ + + + +
+ + + + + + + + + +
xpath_node_set pugi::xpath_query::evaluate_node_set ( const xml_node &  n  ) 
+
+ + + + + +
+   + + +

+Evaluate expression as node set for the context node n. +

+If expression does not directly evaluate to node set, function returns empty node set. Throws std::bad_alloc on out of memory error.

+

Parameters:
+ + +
n - context node
+
+
Returns:
evaluation result
+
+

Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/classpugi_1_1xpath__query__coll__graph.map b/docs/html/classpugi_1_1xpath__query__coll__graph.map new file mode 100644 index 0000000..5a14779 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__query__coll__graph.map @@ -0,0 +1 @@ +base referer diff --git a/docs/html/classpugi_1_1xpath__query__coll__graph.md5 b/docs/html/classpugi_1_1xpath__query__coll__graph.md5 new file mode 100644 index 0000000..f1a2247 --- /dev/null +++ b/docs/html/classpugi_1_1xpath__query__coll__graph.md5 @@ -0,0 +1 @@ +8954c6e562b8b9c0f96734834320e6c2 \ No newline at end of file diff --git a/docs/html/classpugi_1_1xpath__query__coll__graph.png b/docs/html/classpugi_1_1xpath__query__coll__graph.png new file mode 100644 index 0000000..f7b3e06 Binary files /dev/null and b/docs/html/classpugi_1_1xpath__query__coll__graph.png differ diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css new file mode 100644 index 0000000..05615b2 --- /dev/null +++ b/docs/html/doxygen.css @@ -0,0 +1,310 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { font-weight: bold } +DIV.qindex { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.nav { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff } +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code:link { text-decoration: none; font-weight: normal; color: #0000FF} +A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF} +A.codeRef:link { font-weight: normal; color: #0000FF} +A.codeRef:visited { font-weight: normal; color: #0000FF} +A:hover { text-decoration: none; background-color: #f2f2ff } +DL.el { margin-left: -1cm } +.fragment { + font-family: Fixed, monospace; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #F4F4FB; font-weight: bold; } +TD.mdPrefix { + background-color: #F4F4FB; + color: #606060; + font-size: 80%; +} +TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; } +TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% } +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #e8eef2; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #e8eef2; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { text-align: center; } +IMG.formulaDsp { } +IMG.formulaInl { vertical-align: middle; } +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +.mdTable { + border: 1px solid #868686; + background-color: #F4F4FB; +} +.mdRow { + padding: 8px 10px; +} +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +TD.tiny { font-size: 75%; +} +a { + color: #1A41A8; +} +a:visited { + color: #2A3798; +} +.dirtab { padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} +TH.dirtab { background: #e8eef2; + font-weight: bold; +} +HR { height: 1px; + border: none; + border-top: 1px solid black; +} + diff --git a/docs/html/doxygen.png b/docs/html/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/docs/html/doxygen.png differ diff --git a/docs/html/functions.html b/docs/html/functions.html new file mode 100644 index 0000000..7870ea7 --- /dev/null +++ b/docs/html/functions.html @@ -0,0 +1,195 @@ + + +pugixml: Class Members + + + + +
+
+
+
+
+ +
+
+ +
+ +

+Here is a list of all documented class members with links to the class documentation for each member: +

+

- a -

+

- b -

+

- c -

+

- d -

+

- e -

+

- f -

+

- i -

+

- l -

+

- n -

+

- o -

+

- p -

+

- r -

+

- s -

+

- t -

+

- v -

+

- w -

+

- x -

+

- ~ -

+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/functions_enum.html b/docs/html/functions_enum.html new file mode 100644 index 0000000..5f676d1 --- /dev/null +++ b/docs/html/functions_enum.html @@ -0,0 +1,38 @@ + + +pugixml: Class Members - Enumerations + + + + +
+
+
+
+
+ +
+  +

+

+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/functions_eval.html b/docs/html/functions_eval.html new file mode 100644 index 0000000..ae211d9 --- /dev/null +++ b/docs/html/functions_eval.html @@ -0,0 +1,40 @@ + + +pugixml: Class Members - Enumerator + + + + +
+
+
+
+
+ +
+  +

+

+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html new file mode 100644 index 0000000..a68a6c0 --- /dev/null +++ b/docs/html/functions_func.html @@ -0,0 +1,188 @@ + + +pugixml: Class Members - Functions + + + + +
+
+
+
+
+ +
+
+ +
+ +

+  +

+

- a -

+

- b -

+

- c -

+

- d -

+

- e -

+

- f -

+

- i -

+

- l -

+

- n -

+

- o -

+

- p -

+

- r -

+

- s -

+

- t -

+

- v -

+

- w -

+

- x -

+

- ~ -

+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/functions_type.html b/docs/html/functions_type.html new file mode 100644 index 0000000..e732be9 --- /dev/null +++ b/docs/html/functions_type.html @@ -0,0 +1,40 @@ + + +pugixml: Class Members - Typedefs + + + + +
+
+
+
+
+ +
+  +

+

+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/graph_legend.dot b/docs/html/graph_legend.dot new file mode 100644 index 0000000..5420927 --- /dev/null +++ b/docs/html/graph_legend.dot @@ -0,0 +1,22 @@ +digraph G +{ + edge [fontname="Helvetica",fontsize=10,labelfontname="Helvetica",labelfontsize=10]; + node [fontname="Helvetica",fontsize=10,shape=record]; + Node9 [shape="box",label="Inherited",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="black",style="filled" fontcolor="white"]; + Node10 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="Helvetica"]; + Node10 [shape="box",label="PublicBase",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="black",URL="$classPublicBase.html"]; + Node11 -> Node10 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="Helvetica"]; + Node11 [shape="box",label="Truncated",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="red",URL="$classTruncated.html"]; + Node13 -> Node9 [dir=back,color="darkgreen",fontsize=10,style="solid",fontname="Helvetica"]; + Node13 [shape="box",label="ProtectedBase",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="black",URL="$classProtectedBase.html"]; + Node14 -> Node9 [dir=back,color="firebrick4",fontsize=10,style="solid",fontname="Helvetica"]; + Node14 [shape="box",label="PrivateBase",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="black",URL="$classPrivateBase.html"]; + Node15 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="Helvetica"]; + Node15 [shape="box",label="Undocumented",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="grey75"]; + Node16 -> Node9 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="Helvetica"]; + Node16 [shape="box",label="Templ< int >",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="black",URL="$classTempl.html"]; + Node17 -> Node16 [dir=back,color="orange",fontsize=10,style="dashed",label="< int >",fontname="Helvetica"]; + Node17 [shape="box",label="Templ< T >",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="black",URL="$classTempl.html"]; + Node18 -> Node9 [dir=back,color="darkorchid3",fontsize=10,style="dashed",label="m_usedClass",fontname="Helvetica"]; + Node18 [shape="box",label="Used",fontsize=10,height=0.2,width=0.4,fontname="Helvetica",color="black",URL="$classUsed.html"]; +} diff --git a/docs/html/graph_legend.html b/docs/html/graph_legend.html new file mode 100644 index 0000000..a07c58e --- /dev/null +++ b/docs/html/graph_legend.html @@ -0,0 +1,80 @@ + + +pugixml: Graph Legend + + + + +
+
+

Graph Legend

This page explains how to interpret the graphs that are generated by doxygen.

+Consider the following example: 

/*! Invisible class because of truncation */
+class Invisible { };
+
+/*! Truncated class, inheritance relation is hidden */
+class Truncated : public Invisible { };
+
+/* Class not documented with doxygen comments */
+class Undocumented { };
+
+/*! Class that is inherited using public inheritance */
+class PublicBase : public Truncated { };
+
+/*! A template class */
+template<class T> class Templ { };
+
+/*! Class that is inherited using protected inheritance */
+class ProtectedBase { };
+
+/*! Class that is inherited using private inheritance */
+class PrivateBase { };
+
+/*! Class that is used by the Inherited class */
+class Used { };
+
+/*! Super class that inherits a number of other classes */
+class Inherited : public PublicBase,
+                  protected ProtectedBase,
+                  private PrivateBase,
+                  public Undocumented
+                  public Templ<int>
+{
+  private:
+    Used *m_usedClass;
+};
+
If the MAX_DOT_GRAPH_HEIGHT tag in the configuration file is set to 240 this will result in the following graph:

+

+graph_legend.png +
+

+The boxes in the above graph have the following meaning:

+The arrows have the following meaning: +
Generated on Wed Feb 21 22:19:53 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/graph_legend.png b/docs/html/graph_legend.png new file mode 100644 index 0000000..b8cfe42 Binary files /dev/null and b/docs/html/graph_legend.png differ diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html new file mode 100644 index 0000000..bcd7f02 --- /dev/null +++ b/docs/html/hierarchy.html @@ -0,0 +1,45 @@ + + +pugixml: Hierarchical Index + + + + +
+
+
+
+

pugixml Class Hierarchy

Go to the graphical class hierarchy +

+This inheritance list is sorted roughly, but not completely, alphabetically:

+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/index.html b/docs/html/index.html new file mode 100644 index 0000000..39fb2e8 --- /dev/null +++ b/docs/html/index.html @@ -0,0 +1,20 @@ + + +pugixml: Main Page + + + + +
+
+

pugixml Documentation

+

+

0.3

Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/inherit__graph__0.map b/docs/html/inherit__graph__0.map new file mode 100644 index 0000000..795e91c --- /dev/null +++ b/docs/html/inherit__graph__0.map @@ -0,0 +1,2 @@ +base referer +rect $structpugi_1_1transfer__ownership__tag.html 8,8 202,34 diff --git a/docs/html/inherit__graph__0.md5 b/docs/html/inherit__graph__0.md5 new file mode 100644 index 0000000..dcd3819 --- /dev/null +++ b/docs/html/inherit__graph__0.md5 @@ -0,0 +1 @@ +fa65747bb299b27710c65a261c62df42 \ No newline at end of file diff --git a/docs/html/inherit__graph__0.png b/docs/html/inherit__graph__0.png new file mode 100644 index 0000000..1f839bd Binary files /dev/null and b/docs/html/inherit__graph__0.png differ diff --git a/docs/html/inherit__graph__1.map b/docs/html/inherit__graph__1.map new file mode 100644 index 0000000..8f51b91 --- /dev/null +++ b/docs/html/inherit__graph__1.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xml__attribute.html 7,8 141,34 diff --git a/docs/html/inherit__graph__1.md5 b/docs/html/inherit__graph__1.md5 new file mode 100644 index 0000000..584e00e --- /dev/null +++ b/docs/html/inherit__graph__1.md5 @@ -0,0 +1 @@ +8a34c90a8a44150412d4efe4e02856c6 \ No newline at end of file diff --git a/docs/html/inherit__graph__1.png b/docs/html/inherit__graph__1.png new file mode 100644 index 0000000..1984539 Binary files /dev/null and b/docs/html/inherit__graph__1.png differ diff --git a/docs/html/inherit__graph__2.map b/docs/html/inherit__graph__2.map new file mode 100644 index 0000000..c81fa55 --- /dev/null +++ b/docs/html/inherit__graph__2.map @@ -0,0 +1,3 @@ +base referer +rect $classpugi_1_1xml__attribute__iterator.html 121,7 302,34 +rect $classpugi_1_1xml__node__iterator.html 130,58 293,85 diff --git a/docs/html/inherit__graph__2.md5 b/docs/html/inherit__graph__2.md5 new file mode 100644 index 0000000..0ced39c --- /dev/null +++ b/docs/html/inherit__graph__2.md5 @@ -0,0 +1 @@ +0a31bb256f9ea1e428ad381426e2138a \ No newline at end of file diff --git a/docs/html/inherit__graph__2.png b/docs/html/inherit__graph__2.png new file mode 100644 index 0000000..c0f9a3f Binary files /dev/null and b/docs/html/inherit__graph__2.png differ diff --git a/docs/html/inherit__graph__3.map b/docs/html/inherit__graph__3.map new file mode 100644 index 0000000..ac3e60d --- /dev/null +++ b/docs/html/inherit__graph__3.map @@ -0,0 +1,3 @@ +base referer +rect $classpugi_1_1xml__node.html 9,8 121,34 +rect $classpugi_1_1xml__document.html 170,8 314,34 diff --git a/docs/html/inherit__graph__3.md5 b/docs/html/inherit__graph__3.md5 new file mode 100644 index 0000000..0b2554a --- /dev/null +++ b/docs/html/inherit__graph__3.md5 @@ -0,0 +1 @@ +3ac52082f65d390a3aa62f772b82deb2 \ No newline at end of file diff --git a/docs/html/inherit__graph__3.png b/docs/html/inherit__graph__3.png new file mode 100644 index 0000000..4d9a231 Binary files /dev/null and b/docs/html/inherit__graph__3.png differ diff --git a/docs/html/inherit__graph__4.map b/docs/html/inherit__graph__4.map new file mode 100644 index 0000000..a42cb31 --- /dev/null +++ b/docs/html/inherit__graph__4.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xml__tree__walker.html 9,8 161,34 diff --git a/docs/html/inherit__graph__4.md5 b/docs/html/inherit__graph__4.md5 new file mode 100644 index 0000000..0ef35dc --- /dev/null +++ b/docs/html/inherit__graph__4.md5 @@ -0,0 +1 @@ +660d4318c9e8103b2831b4787c62da46 \ No newline at end of file diff --git a/docs/html/inherit__graph__4.png b/docs/html/inherit__graph__4.png new file mode 100644 index 0000000..96d08a5 Binary files /dev/null and b/docs/html/inherit__graph__4.png differ diff --git a/docs/html/inherit__graph__5.map b/docs/html/inherit__graph__5.map new file mode 100644 index 0000000..4cda6cd --- /dev/null +++ b/docs/html/inherit__graph__5.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xpath__exception.html 137,8 289,34 diff --git a/docs/html/inherit__graph__5.md5 b/docs/html/inherit__graph__5.md5 new file mode 100644 index 0000000..68b862c --- /dev/null +++ b/docs/html/inherit__graph__5.md5 @@ -0,0 +1 @@ +fffb0beaca2cbe6da35b67b995ae9ff1 \ No newline at end of file diff --git a/docs/html/inherit__graph__5.png b/docs/html/inherit__graph__5.png new file mode 100644 index 0000000..f833cf9 Binary files /dev/null and b/docs/html/inherit__graph__5.png differ diff --git a/docs/html/inherit__graph__6.map b/docs/html/inherit__graph__6.map new file mode 100644 index 0000000..a984b26 --- /dev/null +++ b/docs/html/inherit__graph__6.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xpath__node.html 7,8 133,34 diff --git a/docs/html/inherit__graph__6.md5 b/docs/html/inherit__graph__6.md5 new file mode 100644 index 0000000..2019dc5 --- /dev/null +++ b/docs/html/inherit__graph__6.md5 @@ -0,0 +1 @@ +0a388cc004e983eab729bc6d5c666cce \ No newline at end of file diff --git a/docs/html/inherit__graph__6.png b/docs/html/inherit__graph__6.png new file mode 100644 index 0000000..1468a8b Binary files /dev/null and b/docs/html/inherit__graph__6.png differ diff --git a/docs/html/inherit__graph__7.map b/docs/html/inherit__graph__7.map new file mode 100644 index 0000000..95b7466 --- /dev/null +++ b/docs/html/inherit__graph__7.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xpath__node__set.html 9,8 158,34 diff --git a/docs/html/inherit__graph__7.md5 b/docs/html/inherit__graph__7.md5 new file mode 100644 index 0000000..e3b0507 --- /dev/null +++ b/docs/html/inherit__graph__7.md5 @@ -0,0 +1 @@ +7052cf580394885a252e97fd06476596 \ No newline at end of file diff --git a/docs/html/inherit__graph__7.png b/docs/html/inherit__graph__7.png new file mode 100644 index 0000000..adc2e3a Binary files /dev/null and b/docs/html/inherit__graph__7.png differ diff --git a/docs/html/inherit__graph__8.map b/docs/html/inherit__graph__8.map new file mode 100644 index 0000000..442f8f7 --- /dev/null +++ b/docs/html/inherit__graph__8.map @@ -0,0 +1,2 @@ +base referer +rect $classpugi_1_1xpath__query.html 9,8 137,34 diff --git a/docs/html/inherit__graph__8.md5 b/docs/html/inherit__graph__8.md5 new file mode 100644 index 0000000..563962a --- /dev/null +++ b/docs/html/inherit__graph__8.md5 @@ -0,0 +1 @@ +965d93716ac65e345066d158b1bec3f1 \ No newline at end of file diff --git a/docs/html/inherit__graph__8.png b/docs/html/inherit__graph__8.png new file mode 100644 index 0000000..6bfb42e Binary files /dev/null and b/docs/html/inherit__graph__8.png differ diff --git a/docs/html/inherits.html b/docs/html/inherits.html new file mode 100644 index 0000000..310e5fa --- /dev/null +++ b/docs/html/inherits.html @@ -0,0 +1,66 @@ + + +pugixml: Graphical Class Hierarchy + + + + +
+
+
+
+

pugixml Graphical Class Hierarchy

Go to the textual class hierarchy +

+ + + + + + + + + + +
+ + +
+ + +
+ + + +
+ + + +
+ + +
+ + +
+ + +
+ + +
+ + +
+

Generated on Wed Feb 21 22:19:53 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html new file mode 100644 index 0000000..3a874c4 --- /dev/null +++ b/docs/html/namespacemembers.html @@ -0,0 +1,62 @@ + + +pugixml: Class Members + + + + +
+
+
+
+
+ +
+Here is a list of all documented namespace members with links to the namespaces they belong to: +

+

+
Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html new file mode 100644 index 0000000..e682fba --- /dev/null +++ b/docs/html/namespacemembers_enum.html @@ -0,0 +1,37 @@ + + +pugixml: Class Members + + + + +
+
+
+
+
+ +
+  +

+

+
Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/namespacemembers_eval.html b/docs/html/namespacemembers_eval.html new file mode 100644 index 0000000..4c55750 --- /dev/null +++ b/docs/html/namespacemembers_eval.html @@ -0,0 +1,43 @@ + + +pugixml: Class Members + + + + +
+
+
+
+
+ +
+  +

+

+
Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html new file mode 100644 index 0000000..1c6e897 --- /dev/null +++ b/docs/html/namespacemembers_func.html @@ -0,0 +1,38 @@ + + +pugixml: Class Members + + + + +
+
+
+
+
+ +
+  +

+

+
Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/namespacemembers_vars.html b/docs/html/namespacemembers_vars.html new file mode 100644 index 0000000..9c6d3e2 --- /dev/null +++ b/docs/html/namespacemembers_vars.html @@ -0,0 +1,52 @@ + + +pugixml: Class Members + + + + +
+
+
+
+
+ +
+  +

+

+
Generated on Wed Feb 21 22:19:52 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/namespacepugi.html b/docs/html/namespacepugi.html new file mode 100644 index 0000000..30b9247 --- /dev/null +++ b/docs/html/namespacepugi.html @@ -0,0 +1,668 @@ + + +pugixml: pugi Namespace Reference + + + + +
+
+
+
+

pugi Namespace Reference

Detailed Description

+The PugiXML Parser namespace. +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

class  xpath_query
 A class that holds compiled XPath query and allows to evaluate query result. More...
class  xml_attribute
 A light-weight wrapper for manipulating attributes in DOM tree. More...
class  xml_node
 A light-weight wrapper for manipulating nodes in DOM tree. More...
class  xml_node_iterator
 Child node iterator. More...
class  xml_attribute_iterator
 Attribute iterator. More...
class  xml_tree_walker
 Abstract tree walker class. More...
struct  xml_memory_block
struct  transfer_ownership_tag
 Struct used to distinguish parsing with ownership transfer from parsing without it. More...
class  xml_document
 Document class (DOM tree root). More...
class  xpath_exception
 XPath exception class. More...
class  xpath_node
 XPath node class. More...
class  xpath_node_set
 Not necessarily ordered constant collection of XPath nodes. More...

Enumerations

enum  xml_node_type {
+  node_null, +node_document, +node_element, +node_pcdata, +
+  node_cdata, +node_comment, +node_pi +
+ }
 Tree node classification. More...

Functions

std::string as_utf8 (const wchar_t *str)
 Convert utf16 to utf8.
std::wstring as_utf16 (const char *str)
 Convert utf8 to utf16.

Variables

const size_t memory_block_size = 32768
 Memory block size, used for fast allocator.
const unsigned int parse_minimal = 0x0000
 Minimal parsing mode.
const unsigned int parse_pi = 0x0001
 This flag determines if processing instructions (nodes with type node_pi; such nodes have the form of <? target content ?> or <? target ?> in XML) are to be put in DOM tree.
const unsigned int parse_comments = 0x0002
 This flag determines if comments (nodes with type node_comment; such nodes have the form of in XML) are to be put in DOM tree.
const unsigned int parse_cdata = 0x0004
 This flag determines if CDATA sections (nodes with type node_cdata; such nodes have the form of <![CDATA[[content]]> in XML) are to be put in DOM tree.
const unsigned int parse_ws_pcdata = 0x0008
 This flag determines if nodes with PCDATA (regular text) that consist only of whitespace characters are to be put in DOM tree.
const unsigned int parse_escapes = 0x0010
 This flag determines if character and entity references are to be expanded during the parsing process.
const unsigned int parse_eol = 0x0020
 This flag determines if EOL handling (that is, replacing sequences 0x0d 0x0a by a single 0x0a character, and replacing all standalone 0x0d characters by 0x0a) is to be performed on input data (that is, comments contents, PCDATA/CDATA contents and attribute values).
const unsigned int parse_wnorm_attribute = 0x0040
 This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is not CDATA.
const unsigned int parse_wconv_attribute = 0x0080
 This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is CDATA.
const unsigned int parse_default = parse_cdata | parse_escapes | parse_wconv_attribute | parse_eol
 This is the default set of flags.
const unsigned int format_indent = 0x01
 Indent the nodes that are written to output stream with as many indentation strings as deep the node is in DOM tree.
const unsigned int format_utf8 = 0x02
 This flag determines how the non-printable symbols are written to output stream - they are either considered UTF-8 and are written as UTF-8 character, escaped with &#.
const unsigned int format_write_bom = 0x04
 This flag determines if UTF-8 BOM is to be written to output stream.
const unsigned int format_raw = 0x08
 If this flag is on, no indentation is performed and no line breaks are written to output file.
const unsigned int format_default = format_indent | format_utf8
 This is the default set of formatting flags.
+

Enumeration Type Documentation

+

+ + + + +
+ + + + +
enum pugi::xml_node_type
+
+ + + + + +
+   + + +

+Tree node classification. +

+

Enumerator:
+ + + + + + + + +
node_null  +Undifferentiated entity.
node_document  +A document tree's absolute root.
node_element  +E.g. '<...>'.
node_pcdata  +E.g. '>...<'.
node_cdata  +E.g. '<![CDATA[...]]>'.
node_comment  +E.g. ''.
node_pi  +E.g. '<?...?>'.
+
+
+

Function Documentation

+

+ + + + +
+ + + + + + + + + +
std::string pugi::as_utf8 ( const wchar_t *  str  ) 
+
+ + + + + +
+   + + +

+Convert utf16 to utf8. +

+

Parameters:
+ + +
str - input UTF16 string
+
+
Returns:
output UTF8 string
+
+

+ + + + +
+ + + + + + + + + +
std::wstring pugi::as_utf16 ( const char *  str  ) 
+
+ + + + + +
+   + + +

+Convert utf8 to utf16. +

+

Parameters:
+ + +
str - input UTF8 string
+
+
Returns:
output UTF16 string
+
+

Variable Documentation

+

+ + + + +
+ + + + +
const size_t pugi::memory_block_size = 32768
+
+ + + + + +
+   + + +

+Memory block size, used for fast allocator. +

+Memory for DOM tree is allocated in blocks of memory_block_size + 4. This value affects size of xml_memory class.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_minimal = 0x0000
+
+ + + + + +
+   + + +

+Minimal parsing mode. +

+Equivalent to turning all other flags off. This set of flags means that pugixml does not add pi/cdata sections or comments to DOM tree and does not perform any conversions for input data, meaning fastest parsing.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_pi = 0x0001
+
+ + + + + +
+   + + +

+This flag determines if processing instructions (nodes with type node_pi; such nodes have the form of <? target content ?> or <? target ?> in XML) are to be put in DOM tree. +

+If this flag is off, they are not put in the tree, but are still parsed and checked for correctness.

+The corresponding node in DOM tree will have type node_pi, name "target" and value "content", if any.

+Note that <?xml ...?> (document declaration) is not considered to be a PI.

+This flag is off by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_comments = 0x0002
+
+ + + + + +
+   + + +

+This flag determines if comments (nodes with type node_comment; such nodes have the form of in XML) are to be put in DOM tree. +

+If this flag is off, they are not put in the tree, but are still parsed and checked for correctness.

+The corresponding node in DOM tree will have type node_comment, empty name and value "content".

+This flag is off by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_cdata = 0x0004
+
+ + + + + +
+   + + +

+This flag determines if CDATA sections (nodes with type node_cdata; such nodes have the form of <![CDATA[[content]]> in XML) are to be put in DOM tree. +

+If this flag is off, they are not put in the tree, but are still parsed and checked for correctness.

+The corresponding node in DOM tree will have type node_cdata, empty name and value "content".

+This flag is on by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_ws_pcdata = 0x0008
+
+ + + + + +
+   + + +

+This flag determines if nodes with PCDATA (regular text) that consist only of whitespace characters are to be put in DOM tree. +

+Often whitespace-only data is not significant for the application, and the cost of allocating and storing such nodes (both memory and speed-wise) can be significant. For example, after parsing XML string "<node> <a/> </node>", <node> element will have 3 children when parse_ws_pcdata is set (child with type node_pcdata and value=" ", child with type node_element and name "a", and another child with type node_pcdata and value=" "), and only 1 child when parse_ws_pcdata is not set.

+This flag is off by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_escapes = 0x0010
+
+ + + + + +
+   + + +

+This flag determines if character and entity references are to be expanded during the parsing process. +

+Character references are &#...; or &x...; (... is Unicode numeric representation of character in either decimal (&#...;) or hexadecimal (&x...;) form), entity references are &...; Note that as pugixml does not handle DTD, the only allowed entities are predefined ones - &lt;, &gt;, &amp;, &apos; and &quot;. If character/entity reference can not be expanded, it is leaved as is, so you can do additional processing later. Reference expansion is performed in attribute values and PCDATA content.

+This flag is on by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_eol = 0x0020
+
+ + + + + +
+   + + +

+This flag determines if EOL handling (that is, replacing sequences 0x0d 0x0a by a single 0x0a character, and replacing all standalone 0x0d characters by 0x0a) is to be performed on input data (that is, comments contents, PCDATA/CDATA contents and attribute values). +

+This flag is on by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_wnorm_attribute = 0x0040
+
+ + + + + +
+   + + +

+This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is not CDATA. +

+This means, that: 1. Whitespace characters (new line, tab and space) are replaced with space (' ') 2. Afterwards sequences of spaces are replaced with a single space 3. Leading/trailing whitespace characters are trimmed

+This flag is off by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_wconv_attribute = 0x0080
+
+ + + + + +
+   + + +

+This flag determines if attribute value normalization should be performed for all attributes, assuming that their type is CDATA. +

+This means, that whitespace characters (new line, tab and space) are replaced with space (' '). Note, that the actions performed while this flag is on are also performed if parse_wnorm_attribute is on, so this flag has no effect if parse_wnorm_attribute flag is set.

+This flag is on by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::parse_default = parse_cdata | parse_escapes | parse_wconv_attribute | parse_eol
+
+ + + + + +
+   + + +

+This is the default set of flags. +

+It includes parsing CDATA sections (comments/PIs are not parsed), performing character and entity reference expansion, replacing whitespace characters with spaces in attribute values and performing EOL handling. Note, that PCDATA sections consisting only of whitespace characters are not parsed (by default) for performance reasons.

+

+ + + + +
+ + + + +
const unsigned int pugi::format_indent = 0x01
+
+ + + + + +
+   + + +

+Indent the nodes that are written to output stream with as many indentation strings as deep the node is in DOM tree. +

+This flag is on by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::format_utf8 = 0x02
+
+ + + + + +
+   + + +

+This flag determines how the non-printable symbols are written to output stream - they are either considered UTF-8 and are written as UTF-8 character, escaped with &#. +

+..;, or they are considered to be ASCII and each ASCII character is escaped separately.

+This flag is on by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::format_write_bom = 0x04
+
+ + + + + +
+   + + +

+This flag determines if UTF-8 BOM is to be written to output stream. +

+This flag is off by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::format_raw = 0x08
+
+ + + + + +
+   + + +

+If this flag is on, no indentation is performed and no line breaks are written to output file. +

+This means that the data is written to output stream as is.

+This flag is off by default.

+

+ + + + +
+ + + + +
const unsigned int pugi::format_default = format_indent | format_utf8
+
+ + + + + +
+   + + +

+This is the default set of formatting flags. +

+It includes indenting nodes depending on their depth in DOM tree and considering input data to be UTF-8.

+

Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html new file mode 100644 index 0000000..b52fc10 --- /dev/null +++ b/docs/html/namespaces.html @@ -0,0 +1,26 @@ + + +pugixml: Namespace Index + + + + +
+
+
+
+

pugixml Namespace List

Here is a list of all documented namespaces with brief descriptions: + +
pugiThe PugiXML Parser namespace
+
Generated on Wed Feb 21 22:19:50 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/structpugi_1_1transfer__ownership__tag.html b/docs/html/structpugi_1_1transfer__ownership__tag.html new file mode 100644 index 0000000..aea2270 --- /dev/null +++ b/docs/html/structpugi_1_1transfer__ownership__tag.html @@ -0,0 +1,35 @@ + + +pugixml: pugi::transfer_ownership_tag Struct Reference + + + + +
+
+
+
+
+pugi::transfer_ownership_tag
+

pugi::transfer_ownership_tag Struct Reference

Detailed Description

+Struct used to distinguish parsing with ownership transfer from parsing without it. +

+

See also:
xml_document::parse
+ +

+ + +
+

Generated on Wed Feb 21 22:19:51 2007 for pugixml by  + +doxygen 1.4.6-NO
+ + diff --git a/docs/html/tab_b.gif b/docs/html/tab_b.gif new file mode 100644 index 0000000..0d62348 Binary files /dev/null and b/docs/html/tab_b.gif differ diff --git a/docs/html/tab_l.gif b/docs/html/tab_l.gif new file mode 100644 index 0000000..9b1e633 Binary files /dev/null and b/docs/html/tab_l.gif differ diff --git a/docs/html/tab_r.gif b/docs/html/tab_r.gif new file mode 100644 index 0000000..ce9dd9f Binary files /dev/null and b/docs/html/tab_r.gif differ diff --git a/docs/html/tabs.css b/docs/html/tabs.css new file mode 100644 index 0000000..a61552a --- /dev/null +++ b/docs/html/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI#current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI#current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.nav +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/docs/index.html b/docs/index.html index c843bdb..7c8392f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -15,17 +15,8 @@

Contents

Introduction
-
Document Object Model
-
Documentation -
Introduction
-
xml_parser class
-
xml_node class
-
xml_attribute class
-
Iterators
-
Miscellaneous
-
Lifetime issues and memory management
- -
Parsing process
+
Quick start
+
Reference
W3C compliance
Comparison with existing parsers
FAQ
@@ -43,7 +34,7 @@

pugixml is just another XML parser. This is a successor to pugxml (well, to be honest, the only part that is left as is is wildcard matching code; the rest was either heavily refactored or rewritten -from scratch). The main features (call it USP) are:

+from scratch). The main features are:

@@ -84,10 +75,8 @@ ok with DOM - it should not be a problem, because the overall memory consumption you'll need a contiguous chunk of memory, which can be a problem).
  • lack of validation, DTD processing, XML namespaces, proper handling of encoding. If you need those - go take MSXML or XercesC or anything like that.
    • -
  • lack of XPath & UTF-16/32 parsing. These are not implemented for now, but they are the features -for the next release.
    • -
  • immutability of DOM tree. It's constant. You can't change it. There are good reasons for prohibiting -that, though it is a thing that will likely be in the next release.
    • +
  • lack of UTF-16/32 parsing. This is not implemented for now, but this is the features for the next +release.
    • @@ -101,803 +90,345 @@ an XML file were measured.
    - -

    Document Object Model

    +     +

    Quick start

    -

    pugixml is a DOM-based parser. This means, that the XML document is converted to a tree. -Each XML tag is converted to a node in DOM tree. If a tag is contained in some other tag, its node -is a child to the outer tag's one. Comments, CDATA sections and PIs (Processing Instructions) also are -transformed into tree nodes, as is the standalone text. Each node has its type.

    +

    Here there is a small collection of code snippets to help the reader begin using pugixml.

    -

    Here is an example of an XML document: +

    For everything you can do with pugixml, you need a document. There are several ways to obtain it:

    -
    -<?xml version="1.0"?>
-<mesh name="mesh_root">
-    <!-- here is a mesh node -->
-    some text
-    <![CDATA[[someothertext]]>
-    some more text
-    <node attr1="value1" />
-    <node attr1="value2">
-        <?TARGET somedata?>
-        <innernode/>
-    </node>
-</mesh>
-
    - -It gets converted to the following tree (note, that with some parsing options comments, PIs and CDATA -sections are not stored in the tree, and with some options there are also nodes with whitespaces -and the contents of PCDATA sections is a bit different (with trailing/leading whitespaces). So generally -the resulting DOM tree depends on the parsing options):

    - -

    - -

    The parent-children relations are shown with lines. Some nodes have previous and next siblings -(for example, the next sibling for node_comment node is node_pcdata with value "some text", and the -previous sibling for node_element with name "mesh" is node_pi with target "xml" (target for PI nodes -is stored in the node name)).

    -
    - -     -

    Documentation

    - -     -

    Introduction

    - -

    pugixml is a library for parsing XML files, which means that you give it XML data some way, -and it gives you the DOM tree and the ways to traverse it and to get some useful information from it. -The library source consist of two files, the header pugixml.hpp, and the source code pugixml.cpp. -You can either compile cpp file in your project, or build a static library (or perhaps even a DLL), -or make the whole code use inline linkage and make one big file (as it was done in pugxml). -All library classes reside in namespace pugi, so you can either use fully qualified -names (pugi::xml_node) or write a using declaration (using namespace pugi;, using -pugi::xml_node) and use plain names. All classes have the xml_ prefix.

    - -

    By default it's supposed that you compile the source file with your project (add it into your -project, or add relevant entry in your Makefile, or do whatever you need to do with your compilation -environment). The library is written in standard-conformant C++ and was tested on win32 platform -(MSVC 7.1 (2003), MSVC 8.0 (2005)).

    - -     -

    xml_parser class

    - -

    xml_parser class is the core of parsing process; you initiate parsing with it, you get DOM -tree from it, the nodes and attributes are stored in it. You have two ways to load a file: either -provide a string with XML-data (it has to be null-terminated, and it will be modified during parsing -process, so it can not be a piece of read-only memory), or with an std::istream object (any input -stream, like std::ifstream, std::istringstream, etc.) - in this case the parser will allocate -the necessary amount of memory (equivalent to stream's size) and read everything from the stream.

    - -

    The functions for parsing are: -

    -
    -
    
-        void parse(std::istream& stream, unsigned int optmsk = parse_noset);
    -
    This function will create a buffer with the size equal to that of provided stream, -read the chunk of data from the stream and parse it with provided options (optmsk). -The stream does not have to persist after the call to the function, the lifetime of internal buffer -with stream's data is managed by pugixml. -
    - -
     
    -
    -
    
-        char* parse(char* xmlstr, unsigned int optmsk = parse_noset);
-
    -
    This function parses the provided string with provided options, and returns the position where the -parsing stopped (do not expect, that parsing will stop on every error, or on most of them - as I've -said, pugixml is error ignorant). The input string is modified. The string must persist for the -lifetime of the parser. - -
     
    -
    -
    
-        char* parse(const ownership_transfer_tag&, char* xmlstr, unsigned int optmsk = parse_noset);
-
    -
    This function parses the provided string with provided options, and returns the position where the -parsing stopped (do not expect, that parsing will stop on every error, or on most of them - as I've -said, pugixml is error ignorant). The input string is modified. The string's ownership is -managed by parser (string's memory is freed automatically when parser's destructor is called). -
     
    -
    -
    
-        xml_parser(std::istream& stream, unsigned int optmsk = parse_default);
    -
    Just a convenience ctor, that calls the corresponding parse() function.
    - -
     
    -
    -
    
-        xml_parser(char* xmlstr, unsigned int optmsk = parse_default);
    -
    Just a convenience ctor, that calls the corresponding parse() function.
    - -
     
    -
    
-        xml_parser(const ownership_transfer_tag&, char* xmlstr, unsigned int optmsk = parse_default);
    -
    Just a convenience ctor, that calls the corresponding parse() function.
    - -
    - -

    If you want to provide XML data after the creation of the parser, use the default ctor. Otherwise -you are free to use either parsing ctors or default ctor and later - parsing function.

    - -

    After parsing an XML file, you'll get a DOM tree. To get access to it (or, more precisely, to its -root), call either document() function or cast xml_parser object to xml_node by -using the following functions:

    - -
    
-        operator xml_node() const;
-        xml_node document() const;
-
    - -

    Ok, easy part is behind - now let's dive into parsing options. There is a variety of them, and you -must choose them wisely to get the needed results and the best speed/least memory overhead. At first, -there are flags that determine which parts of the document will be put into DOM tree, and which will -be just skipped:

    - -
      -
    • If parse_pi is on, then processing instructions (<? ... ?>) are put into DOM -tree (with node type node_pi) otherwise they are discarded. Note that for now the prolog -(<?xml ... ?>) is parsed as a processing instruction. -
      Default value: off -
      In W3C mode: on
      • -
    • If parse_comments is on, then comments (<!-- ... -->) are put into DOM -tree (with node type node_comment) otherwise they are discarded. -
      Default value: off -
      In W3C mode: on
      • -
    • If parse_cdata is on, then the content of CDATA section (<![CDATA[[ ... ]]>) -is put into DOM tree (with node type node_cdata) otherwise it is discarded. -
      Default value: on -
      In W3C mode: on
      • -
    • If parse_ws_pcdata is off, then the content of PCDATA section (it's the plain text -in the node, like in <some_tag>Hello!</some_tag>) is discarded if it consists only -of space-like characters (spaces, tabs and newlines). -
      Default value: off -
      In W3C mode: on
      • -
    • If parse_ext_pcdata is off, then the content of PCDATA section is discarded if it belongs -to root (document) node, that is it does not have a parent tag. -
      Default value: on -
      In W3C mode: off
      • -
    - -

    Then there are flags that determine how the processing of the retrieved data is done. There are -several reasons for these flags, mainly: -

      -
    • parsing speed. The less processing - the more speed.
      • -
    • data fetching comfort. Sometimes you're ok with messed linefeeds, sometimes you're not. Sometimes -you want your PCDATA trimmed, sometimes you do not. Sometimes you want your attribute values normalized, -sometimes you do not. Some of these are normally specified in DOCTYPE, though... -
    • ...parser is not DOCTYPE aware (and will never be), so you need a way to set those properties - -if not on per-node basis, then on per-document
      • -
    -So, these are the processing flags: -

    - -
      -
    • If parse_escapes is on, then the character reference expansion is done for PCDATA content -and for attribute values (replacing <lt; with <, &#4c; with L, etc.). -
      Default value: on -
      In W3C mode: on
      • -
    • If parse_wnorm_attribute is on, then the whitespace normalisation is done for attribute -values (this includes replacing any space-like character by a space character, converting sequences of -spaces into a single space and trimming of leading/trailing spaces) -
      Default value: off -
      In W3C mode: off
      • -
    • If parse_wconv_attribute is on, then the whitespace conversion is done for attribute -values (this is a subset of whitespace normalization, and includes only replacing space-like characters -with spaces). If parse_wnorm_attribute is on, this flag has no effect. -
      Default value: on -
      In W3C mode: on
      • -
    • If parse_eol is on, then the end-of-line handling is done for PCDATA/CDATA content and for -attribute values (this includes converting any pair of 0x0d 0x0a characters to a single 0x0a and -converting any standalone 0x0d to 0x0a). -
      Default value: on -
      In W3C mode: on
      • -
    - -

    Finally, there are two more flags, that indicate closing tag parsing. When pugixml meets a -close tags, there are three ways: -

      -
    • check that the tag name matches the opening tag, return an error if it does not. This is a -standard-compliant way, is controlled by parse_check_end_tags flag, which is on in W3C mode
      • -
    • try to find the corresponding tag name (so that <foo> <bar> </foo> will be parsed -correctly). This is controlled by parse_match_end_tags, which is on by default
      • -
    • just treat the tag as a closing tag for the node (so that <foo> ... </bar> will -be parsed as <foo> ... </foo>). This is the fastest way, and this is what pugxml -is doing, but it can corrupt your DOM tree. This way is chosen if both parse_check_end_tags and -parse_match_end_tags are off. -
    -Note, that these 2 flags are mutually exclusive. -

    - -

    Did I say finally? Ok, so finally there are some helper flags, or better groups of flags. -These are: -

      -
    • parse_minimal - no flag is set (this also means the fastest parsing)
      • -
    • parse_default - default set of flags
      • -
    • parse_noset - use the current parser options (see below)
      • -
    • parse_w3c - use the W3C compliance mode
      • -
    -

    - -

    A couple of words on flag usage. The parsing options are just a set of bits, with each bit corresponding -to one flag. You can turn the flag on by OR-ing the options value with this flag's constant: -

    -	parse_w3c | parse_wnorm_attribute
-
    -or turn the flag off by AND-ing the options value with the NEGation of this flag's constant: -
    -	parse_w3c & ~parse_comments
-
    -You can access the current options of parser by options() method: -
    
-        unsigned int options() const;
-        unsigned int options(unsigned int optmsk);
-
    -(the latter one returns previous options). These options are used when parse_noset flag set is -passed to parse() functions (which is the default value of corresponding parameter). -

    - -     -

    xml_node class

    - -

    If xml_parser is a heart of constructing a DOM tree from file, xml_node is a heart -of processing the tree. This is a simple wrapper, so it's small (4/8 bytes, depending on the size of -pointer), you're free to copy it and it does not own anything. I'll continue with a list of methods -with their description, with one note in advance. Some functions, that do something according to a -string-like parameter, have a pair with a suffix _w. The _w suffix tells, that this -function is doing a wildcard matching, instead of simple string comparison. You're free to use wildcards -* (that is equal to any sequence of characters (possibly empty)), ? (that is equal to -any character) and character sets ([Abc] means 'any symbol of A, b and c', [A-Z4] means -'any symbol from A to Z, or 4', [!0-9] means 'any symbol, that is not a digit'). So the wildcard -?ell_[0-9][0-9]_* will match strings like 'cell_23_xref', 'hell_00_', but will not match the -strings like 'ell_23_xref', 'cell_0_x' or 'cell_0a_x'.

    - -
    
-        /// Access iterators for this node's collection of child nodes.
-        iterator begin() const;
-        iterator end() const;
-        
-        /// Access iterators for this node's collection of child nodes (same as begin/end).
-        iterator children_begin() const;
-        iterator children_end() const;
-    
-        /// Access iterators for this node's collection of attributes.
-        attribute_iterator attributes_begin() const;
-        attribute_iterator attributes_end() const;
-
-        /// Access iterators for this node's collection of siblings.
-        iterator siblings_begin() const;
-        iterator siblings_end() const;
-
    - -

    Functions, returning the iterators to walk through children/siblings/attributes. More on that in -Iterators section.

    - -
    
-        operator unspecified_bool_type() const;
-
    - -

    This is a safe bool-like conversion operator. You can check node's validity (if (xml_node), - if (!xml_node), if (node1 && node2 && !node3 && cond1 && ...) - you get the idea) with -it. -

    - -
    
-        bool operator==(const xml_node& r) const;
-        bool operator!=(const xml_node& r) const;
-        bool operator<(const xml_node& r) const;
-        bool operator>(const xml_node& r) const;
-        bool operator<=(const xml_node& r) const;
-        bool operator>=(const xml_node& r) const;
-
    - -

    Comparison operators

    - -
    
-        bool empty() const;
-
    - -

    if (node.empty()) is equivalent to if (!node)

    - -
    
-        xml_node_type type() const;
-        const char* name() const;
-        const char* value() const;
-
    - -

    Access node's properties (type, name and value). If there is no name/value, the corresponding functions -return "" - they never return NULL.

    - -
    
-        xml_node child(const char* name) const;
-        xml_node child_w(const char* name) const;
-
    - -

    Get a child node with specified name, or xml_node() (this is an invalid node) if nothing is -found

    - -
    
-        xml_attribute attribute(const char* name) const;
-        xml_attribute attribute_w(const char* name) const;
-
    - -

    Get an attribute with specified name, or xml_attribute() (this is an invalid attribute) if -nothing is found

    - -
    
-        xml_node sibling(const char* name) const;
-        xml_node sibling_w(const char* name) const;
-
    - -

    Get a node's sibling with specified name, or xml_node() if nothing is found.
    -node.sibling(name) is equivalent to node.parent().child(name).

    - -
    
-        xml_node next_sibling(const char* name) const;
-        xml_node next_sibling_w(const char* name) const;
-        xml_node next_sibling() const;
-
    - -

    These functions get the next sibling, that is, one of the siblings of that node, that is to the -right. next_sibling() just returns the right brother of the node (or xml_node()), -the two other functions are searching for the sibling with the given name

    - -
    
-        xml_node previous_sibling(const char* name) const;
-        xml_node previous_sibling_w(const char* name) const;
-        xml_node previous_sibling() const;
-
    - -

    These functions do exactly the same as next_sibling ones, with the exception that they -search for the left siblings.

    - -
    
-        xml_node parent() const;
-
    - -

    Get a parent node. The parent node for the root one (the document) is considered to be the document -itself.

    - -
    
-        const char* child_value() const;
-
    - -

    Look for the first node of type node_pcdata or node_cdata among the -children of the current node and return its contents (or "" if nothing is found)

    - -
    
-    const char* child_value(const char* name) const;
-
    +#include <fstream> +#include <iostream> -

    This is the convenient way of looking into child's child value - that is, node.child_value(name) is equivalent to node.child(name).child_value().

    +#include "pugixml.hpp" -
    
-    const char* child_value_w(const char* name) const;
-
    +using namespace std; +using namespace pugi; -

    This is the convenient way of looking into child's child value - that is, node.child_value_w(name) is equivalent to node.child_w(name).child_value().

    +int main() +{ + // Several ways to get XML document -
    
-        xml_attribute first_attribute() const;
-        xml_attribute last_attribute() const;
-
    + { + // Load from string + xml_document doc; -

    These functions get the first and last attributes of the node (or xml_attribute() if the node -has no attributes).

    + cout << doc.load("<sample-xml>some text <b>in bold</b> here</sample-xml>") << endl; + } -
    
-        xml_node first_child() const;
-        xml_node last_child() const;
-
    + { + // Load from file + xml_document doc; -

    These functions get the first and last children of the node (or xml_node() if the node has -no children).

    + cout << doc.load_file("sample.xml") << endl; + } -
    
-        template <typename OutputIterator> void all_elements_by_name(const char* name, OutputIterator it) const;
-        template <typename OutputIterator> void all_elements_by_name_w(const char* name, OutputIterator it) const;
-
    + { + // Load from any input stream (STL) + xml_document doc; -

    Get all elements with the specified name in the subtree (depth-first search) and return them with -the help of output iterator (i.e. std::back_inserter)

    + std::ifstream in("sample.xml"); + cout << doc.load(in) << endl; + } -
    
-        template <typename Predicate> xml_attribute find_attribute(Predicate pred) const;
-        template <typename Predicate> xml_node find_child(Predicate pred) const;
-        template <typename Predicate> xml_node find_element(Predicate pred) const;
-
    + { + // More advanced: parse the specified string without duplicating it + xml_document doc; -

    Find attribute, child or a node in the subtree (find_element - depth-first search) with the help -of the given predicate. Predicate should behave like a function which accepts a xml_node or -xml_attribute (for find_attribute) parameter and returns bool. The first entity for which -the predicate returned true is returned. If predicate returned false for all entities, xml_node() -or xml_attribute() is returned.

    + char* s = new char[100]; + strcpy(s, "<sample-xml>some text <b>in bold</b> here</sample-xml>"); + cout << doc.parse(transfer_ownership_tag(), s) << endl; + } -
    
-        xml_node first_element(const char* name) const;
-        xml_node first_element_w(const char* name) const;
+    {
+        // Even more advanced: assume manual lifetime control
+        xml_document doc;
 
-        xml_node first_element_by_value(const char* name, const char* value) const;
-        xml_node first_element_by_value_w(const char* name, const char* value) const;
+        char* s = new char[100];
+        strcpy(s, "<sample-xml>some text <b>in bold</b> here</sample-xml>");
+        cout << doc.parse(transfer_ownership_tag(), s) << endl;
 
-        xml_node first_element_by_attribute(const char* name, const char* attr_name, const char* attr_value) const;
-        xml_node first_element_by_attribute_w(const char* name, const char* attr_name, const char* attr_value) const;
+        delete[] s; // <-- after this point, all string contents of document is invalid!
+    }
 
-        xml_node first_element_by_attribute(const char* attr_name, const char* attr_value) const;
-        xml_node first_element_by_attribute_w(const char* attr_name, const char* attr_value) const;
-
    + { + // Or just create document from code? + xml_document doc; -

    Find the first node (depth-first search), which corresponds to the given criteria (i.e. either has -a matching name, or a matching value, or has an attribute with given name/value, or has an attribute -and has a matching name). Note that _w versions treat all parameters as wildcards.

    + // add nodes to document (see next samples) + } +} +_Winnie C++ Colorizer -
    
-        xml_node first_node(xml_node_type type) const;
-
    +

    This sample should print a row of 1, meaning that all load/parse functions returned true (of course, if sample.xml does not exist or is malformed, there will be 0's)

    -

    Return a first node (depth-first search) with a given type, or xml_node().

    +

    Once you have your document, there are several ways to extract data from it.

    
-        std::string path(char delimiter = '/') const;
-
    +#include <iostream> -

    Get a path of the node (i.e. the string of names of the nodes on the path from the DOM tree root -to the node, separated with delimiter (/ by default).

    +#include "pugixml.hpp" -
    
-        xml_node first_element_by_path(const char* path, char delimiter = '/') const;
-
    +using namespace std; +using namespace pugi; -

    Get the first element that has the following path. The path can be absolute (beginning with delimiter) or -relative, '..' means 'up-level' (so if we are at the path mesh/fragment/geometry/stream, ../.. -will lead us to mesh/fragment, and /mesh will lead us to mesh).

    +struct bookstore_traverser: public xml_tree_walker +{ + virtual bool for_each(xml_node& n) + { + for (int i = 0; i < depth(); ++i) cout << " "; // indentation -
    
-        bool traverse(xml_tree_walker& walker) const;
-
    + if (n.type() == node_element) cout << n.name() << endl; + else cout << n.value() << endl; -

    Traverse the subtree (beginning with current node) with the walker, return the result. See -Miscellaneous section for details.

    + return true; // continue traversal + } +}; - -

    xml_attribute class

    +int main() +{ + xml_document doc; + doc.load("<bookstore><book title='ShaderX'><price>3</price></book><book title='GPU Gems'><price>4</price></book></bookstore>"); -

    Like xml_node, xml_attribute is a simple wrapper of the node's attribute.

    + // If you want to iterate through nodes... -
    
-        bool operator==(const xml_attribute& r) const;
-        bool operator!=(const xml_attribute& r) const;
-        bool operator<(const xml_attribute& r) const;
-        bool operator>(const xml_attribute& r) const;
-        bool operator<=(const xml_attribute& r) const;
-        bool operator>=(const xml_attribute& r) const;
-
    + { + // Get a bookstore node + xml_node bookstore = doc.child("bookstore"); -

    Comparison operators.

    + // Iterate through books + for (xml_node book = bookstore.child("book"); book; book = book.next_sibling("book")) + { + cout << "Book " << book.attribute("title").value() << ", price " << book.child("price").first_child().value() << endl; + } -
    
-        operator unspecified_bool_type() const;
-
    + // Output: + // Book ShaderX, price 3 + // Book GPU Gems, price 4 + } -

    Safe bool conversion - like in xml_node, use this to check for validity.

    + { + // Alternative way to get a bookstore node (wildcards) + xml_node bookstore = doc.child_w("*[sS]tore"); // this will select bookstore, anyStore, Store, etc. -
    
-        bool empty() const;
-
    + // Iterate through books with STL compatible iterators + for (xml_node::iterator it = bookstore.begin(); it != bookstore.end(); ++it) + { + // Note the use of helper function child_value() + cout << "Book " << it->attribute("title").value() << ", price " << it->child_value("price") << endl; + } + + // Output: + // Book ShaderX, price 3 + // Book GPU Gems, price 4 + } -

    Like with xml_node, if (attr.empty()) is equivalent to if (!attr). -

    + { + // You can also traverse the whole tree (or a subtree) + bookstore_traverser t; -
    
-        xml_attribute next_attribute() const;
-        xml_attribute previous_attribute() const;
-
    + doc.traverse(t); + + // Output: + // bookstore + // book + // price + // 3 + // book + // price + // 4 + + doc.first_child().traverse(t); + + // Output: + // book + // price + // 3 + // book + // price + // 4 + } -

    Get the next/previous attribute of the node, that owns the current attribute. Return xml_attribute() -if no such attribute is found.

    + // If you want a distinct node... -
    
-        const char* name() const;
-        const char* value() const;
-
    + { + // You can specify the way to it through child() functions + cout << doc.child("bookstore").child("book").next_sibling().attribute("title").value() << endl; -

    Get the name and value of the attribute. These methods never return NULL - they return "" instead.

    + // Output: + // GPU Gems + + // You can use a sometimes convenient path function + cout << doc.first_element_by_path("bookstore/book/price").child_value() << endl; + + // Output: + // 3 -
    
-        int as_int() const;
-        double as_double() const;
-        float as_float() const;
-
    + // And you can use powerful XPath expressions + cout << doc.select_single_node("/bookstore/book[@title = 'ShaderX']/price").node().child_value() << endl; + + // Output: + // 3 -

    Convert the value of an attribute to the desired type. If the conversion is not successfull, return -default value (0 for int, 0.0 for double, 0.0f for float). These functions rely on CRT functions ato*.

    + // Of course, XPath is much more powerful -
    
-        bool as_bool() const;
-
    + // Compile query that prints total price of all Gems book in store + xpath_query query("sum(/bookstore/book[contains(@title, 'Gems')]/price)"); -

    Convert the value of an attribute to bool. This method returns true if the first character of the -value is '1', 't', 'T', 'y' or 'Y'. Otherwise it returns false.

    + cout << query.evaluate_number(doc) << endl; -     -

    Iterators

    + // Output: + // 4 -

    Sometimes you have to cycle through the children or the attributes of the node. You can do it either -by using next_sibling, previous_sibling, next_attribute and previous_attribute -(along with first_child, last_child, first_attribute and last_attribute), -or you can use an iterator-like interface. There are two iterator types, xml_node_iterator and -xml_attribute_iterator. They are bidirectional constant iterators, which means that you can -either increment or decrement them, and use dereferencing and member access operators to get constant -access to node/attribute (the constness of iterators may change with the introducing of mutable trees).

    + // You can apply the same XPath query to any document. For example, let's add another Gems + // book (more detail about modifying tree in next sample): + xml_node book = doc.child("bookstore").append_child(); + book.set_name("book"); + book.append_attribute("title") = "Game Programming Gems 2"; + + xml_node price = book.append_child(); + price.set_name("price"); -

    In order to get the iterators, use corresponding functions of xml_node. Note that _end() -functions return past-the-end iterator, that is, in order to get the last attribute, you'll have to -do something like: + xml_node price_text = price.append_child(node_pcdata); + price_text.set_value("5.3"); + + // Now let's reevaluate query + cout << query.evaluate_number(doc) << endl; -
    
-    if (node.attributes_begin() != node.attributes_end()) // we have at least one attribute
-    {
-        xml_attribute last_attrib = *(--node.attributes_end());
-        ...
+        // Output:
+        // 9.3
     }
-
    -

    - -     -

    Miscellaneous

    - -

    If you want to traverse a subtree, you can use traverse function. There is a class -xml_tree_walker, which has some functions that you can override in order to get custom traversing -(the default one just does nothing). - -
    
-        virtual bool begin(const xml_node&);
-        virtual bool end(const xml_node&);
-
    - -

    These functions are called when the processing of the node starts/ends. First begin() -is called, then all children of the node are processed recursively, then end() is called. If -any of these functions returns false, the traversing is stopped and the traverse() function -returns false.

    - -
    
-        virtual void push();
-        virtual void pop();
-
    +} +    _Winnie C++ Colorizer -

    These functions are called before and after the processing of node's children. If node has no children, -none of these is called. The default behavior is to increment/decrement current node depth.

    +

    Finally, let's get into more details about tree modification and saving.

    
-        virtual int depth() const;
-
    - -

    Get the current depth. You can use this function to do your own indentation, for example.

    - -

    Lets get to some minor notes. You can safely write something like: +#include <iostream> -
    
-        bool value = node.child("stream").attribute("compress").as_bool();
-
    - -If node has a child with the name 'geometry', and this child has an attribute 'compress', than everything -is ok. If node has a child with the name 'geometry' with no attribute 'compress', then attribute("compress") -will return xml_attribute(), and the corresponding call to as_bool() will return default value (false). -If there is no child node 'geometry', the child(...) call will return xml_node(), the subsequent call -to attribute(...) will return xml_attribute() (because there are no attributes belonging to invalid -node), and as_bool() will again return false, so this call sequence is perfectly safe.

    - - -

    Lifetime issues and memory management

    - -

    As parsing is done in-situ, the XML data is to persist during the lifetime of xml_parser. If -the parsing is called via a function of xml_parser, that accepts char*, you have to ensure -yourself, that the string will outlive the xml_parser object.

    - -

    The memory for nodes and attributes is allocated in blocks of data (the blocks form a linked list; -the default size of the block is 32 kb, though you can change it via changing a memory_block_size -constant in pugixml.hpp file. Remember that the first block is allocated on stack (it resides -inside xml_parser object), and all subsequent blocks are allocated on heap, so expect a stack overflow -when setting too large memory block size), so the xml_parser object (which contains the blocks) -should outlive all xml_node and xml_attribute objects (as well as iterators), which belong -to the parser's tree. Again, you should ensure it yourself.

    +#include "pugixml.hpp" -
    +using namespace std; +using namespace pugi; -     -

    Example

    +int main() +{ + // For this example, we'll start with an empty document and create nodes in it from code + xml_document doc; -

    Ok, so you are not much of documentation reader, are you? So am I. Let's assume that you're going -to parse an xml file... something like this: + // Append several children and set values/names at once + doc.append_child(node_comment).set_value("This is a test comment"); + doc.append_child().set_name("application"); -

    -<?xml version="1.0" encoding="UTF-8"?>
-<mesh name="Cathedral">
-    <fragment name="Cathedral">    
-        <geometry>
-            <stream usage="main" source="StAnna.dmesh" compress="true" />
-            <stream usage="ao" source="StAnna.ao" />
-        </geometry>
-    </fragment>
-    <fragment name="Cathedral">    
-    	...
-    </fragment>
-	...
-</mesh>
-
    + // Let's add a few modules + xml_node application = doc.child("application"); -

    <mesh> is a root node, it has 0 or more <fragment>s, each of them has a <geometry> -node, and there are <stream> nodes with the shown attributes. We'd like to parse the file and... -well, and do something with it's contents. There are several methods of doing that; I'll show 2 of them -(the remaining one is using iterators).

    + // Save node wrapper for convenience + xml_node module_a = application.append_child(); + module_a.set_name("module"); + + // Add an attribute, immediately setting it's value + module_a.append_attribute("name").set_value("A"); -

    Here we exploit the knowledge of the strict hierarchy of our XML document and read the nodes from -DOM tree accordingly. When we have an xml_node object, we can get the desired information from -it (name, value, attributes list, nearby nodes in a tree - siblings, parent and children).

    + // You can use operator= + module_a.append_attribute("folder") = "/work/app/module_a"; -
    
-#include <fstream>
-#include <vector>
-#include <algorithm>
-#include <iterator>
+    // Or even assign numbers
+    module_a.append_attribute("status") = 85.4;
 
-#include "pugixml.hpp"
+    // Let's add another module
+    xml_node module_c = application.append_child();
+    module_c.set_name("module");
+    module_c.append_attribute("name") = "C";
+    module_c.append_attribute("folder") = "/work/app/module_c";
 
-using namespace pugi;
+    // Oh, we missed module B. Not a problem, let's insert it before module C
+    xml_node module_b = application.insert_child_before(node_element, module_c);
+    module_b.set_name("module");
+    module_b.append_attribute("folder") = "/work/app/module_b";
 
-int main()
-{
-    std::ifstream in("mesh.xml");
-    in.unsetf(std::ios::skipws);
-                
-    std::vector<char> buf;
-    std::copy(std::istream_iterator<char>(in), std::istream_iterator<char>(), std::back_inserter(buf));
-    buf.push_back(0); // zero-terminate
+    // We can do the same thing for attributes
+    module_b.insert_attribute_before("name", module_b.attribute("folder")) = "B";
     
-    xml_parser parser(&buf[0], pugi::parse_w3c);
+    // Let's add some text in module A
+    module_a.append_child(node_pcdata).set_value("Module A description");
 
-    xml_node doc = parser.document();
-        
-    if (xml_node mesh = doc.first_element("mesh"))
-    {
-        // store mesh.attribute("name").value()
+    // Well, there's not much left to do here. Let's output our document to file using several formatting options
 
-        for (xml_node fragment = mesh.first_element("fragment"); fragment; fragment = fragment.next_sibling())
-        {
-            // store fragment.attribute("name").value()
+    doc.save_file("sample_saved_1.xml");
     
-            if (xml_node geometry = fragment.first_element("geometry"))
-                for (xml_node stream = geometry.first_element("stream"); stream; stream = stream.next_sibling())
-                {
-                    // store stream.attribute("usage").value()
-                    // store stream.attribute("source").value()
-                    
-                    if (stream.attribute("compress"))
-                        // store stream.attribute("compress").as_bool()
+    // Contents of file sample_saved_1.xml (tab size = 4):
+    // <?xml version="1.0"?>
+    // <!--This is a test comment-->
+    // <application>
+    //     <module name="A" folder="/work/app/module_a" status="85.4">Module A description</module>
+    //     <module name="B" folder="/work/app/module_b" />
+    //     <module name="C" folder="/work/app/module_c" />
+    // </application>
+
+    // Let's use two spaces for indentation instead of tab character
+    doc.save_file("sample_saved_2.xml", "  ");
+
+    // Contents of file sample_saved_2.xml:
+    // <?xml version="1.0"?>
+    // <!--This is a test comment-->
+    // <application>
+    //   <module name="A" folder="/work/app/module_a" status="85.4">Module A description</module>
+    //   <module name="B" folder="/work/app/module_b" />
+    //   <module name="C" folder="/work/app/module_c" />
+    // </application>
     
-                }
-        }
-    }
-}
-
    + // Let's save a raw XML file + doc.save_file("sample_saved_3.xml", "", format_raw); + + // Contents of file sample_saved_3.xml: + // <?xml version="1.0"?><!--This is a test comment--><application><module name="A" folder="/work/app/module_a" status="85.4">Module A description</module><module name="B" folder="/work/app/module_b" /><module name="C" folder="/work/app/module_c" /></application> -

    We can also write a class that will traverse the DOM tree and store the information from nodes based -on their names, depths, attributes, etc. This way is well known by the users of SAX parsers. To do that, -we have to write an implementation of xml_tree_walker interface

    + // Finally, you can print a subtree to any output stream (including cout) + doc.child("application").child("module").print(cout); -
                       
-#include <fstream>
-#include <vector>
-#include <algorithm>
-#include <iterator>
+    // Output:
+    // <module name="A" folder="/work/app/module_a" status="85.4">Module A description</module>
+}
+
    _Winnie C++ Colorizer
    -#include "pugixml.hpp" +

    Note, that these examples do not cover the whole pugixml API. For further information, look into reference section.

    -using namespace pugi; +
    -struct mesh_parser: public xml_tree_walker -{ - virtual bool begin(const xml_node& node) - { - if (strcmp(node.name(), "mesh") == 0) - { - // store node.attribute("name").value() - } - else if (strcmp(node.name(), "fragment") == 0) - { - // store node.attribute("name").value() - } - else if (strcmp(node.name(), "geometry") == 0) - { - // ... - } - else if (strcmp(node.name(), "stream") == 0) - { - // store node.attribute("usage").value() - // store node.attribute("source").value() - - if (node.attribute("compress")) - // store stream.attribute("compress").as_bool() - } - else return false; +     +

    Reference

    - return true; - } -}; +

    pugixml is a library for parsing XML files, which means that you give it XML data some way, +and it gives you the DOM tree and the ways to traverse it and to get some useful information from it. +The library source consist of two headers, pugixml.hpp and pugiconfig.hpp, and two source +files, pugixml.cpp and pugixpath.cpp. +You can either compile cpp files in your project, or build a static library. +All library classes reside in namespace pugi, so you can either use fully qualified +names (pugi::xml_node) or write a using declaration (using namespace pugi;, using +pugi::xml_node) and use plain names. All classes have eitther xml_ or xpath_ prefix.

    -int main() -{ - std::ifstream in("mesh.xml"); - in.unsetf(std::ios::skipws); - - std::vector<char> buf; - std::copy(std::istream_iterator<char>(in), std::istream_iterator<char>(), std::back_inserter(buf)); - buf.push_back(0); // zero-terminate - - xml_parser parser(&buf[0], pugi::parse_w3c); +

    By default it's supposed that you compile the source file with your project (add it into your +project, or add relevant entry in your Makefile, or do whatever you need to do with your compilation +environment). The library is written in standard-conformant C++ and was tested on following platforms:

    - mesh_parser mp; +

    +

     +

    - if (!parser.document().traverse(mp)) - // generate an error -} - +

    The documentation for pugixml classes, functions and constants is available here.

    - -

    Parsing process

    - -

    So, let's talk a bit about parsing process, and about the reason for providing XML data as a contiguous -writeable block of memory. Parsing is done in-situ. This means, that the strings, representing the -parts of DOM tree (node names, attribute names and values, CDATA content, etc.) are not separately -allocated on heap, but instead are parts of the original data. This is the keypoint to parsing speed, -because it helps achieve the minimal amount of memory allocations (more on that below) and minimal -amount of copying data.

    - -

    In-situ parsing can be done in two ways, with zero-segmenting the string (that is, set the past-the-end -character for the part of XML string to 0, see -this image for further details), and storing pointer + size of the string instead of pointer to -the beginning of ASCIIZ string.

    - -

    Originally, pugxml had only the first way, but then authors added the second method, 'non-segmenting' -or non-destructive parsing. The advantages of this method are: you no longer need non-constant storage; -you can even read data from memory-mapped files directly. Well, there are disadvantages. -For one thing, you can not do any of the transformations in-situ. The transformations that are required -by XML standard are: -

    - -None of these can be done in-situ. pugxml did neither character nor entity reference expansion, -and allocated new memory when normalizing white spaces when in non-destructive mode. I chose complete -in-situ parsing (the good thing about it is that any transformation, except entity reference, can be -done in-situ because it does not increase the amount of characters - even converting a character -reference to UTF-8). There is no entity reference expansion because of this and because I do not want -to parse DOCTYPE and, moreover, use DOCTYPE in following parsing (performing selective whitespace -normalization in attributes and CDATA sections and so on).

    - -

    In order to be able to modify the tree (change attribute/node names & values) with in-situ parsing, -one needs to implement two ways of storing data (both in-situ and not). The DOM tree is now mutable, -but it will change in the future releases (without introducing speed/memory overhead, except on clean- -up stage).

    - -

    The parsing process itself is more or less straightforward, when you see it - but the impression -is fake, because the explicit jumps are made (i.e. we know, that if we come to a closing brace (>), -we should expect CDATA after it (or a new tag), so let's just jump to the corresponding code), and, -well, there can be bugs (see Bugs section).

    - -

    And, to make things worse, memory allocation (which is done only for node and attribute structures) -is done in pools. The pools are single-linked lists with predefined block size (32 kb by default), and -well, it increases speed a lot (allocations are slow, and the memory gets fragmented when allocating -a bunch of 16-byte (attribute) or 40-byte (node) structures)

    +3 MSVC is Microsoft Visual C++ Compiler
    +    4 ICC is Intel C++ Compiler
    +    5 BCC is Borland C++ Compiler
    @@ -913,20 +444,17 @@ of ones when using parse_w3c mode): correctly, let alone use them for parsing
  • It accepts multiple attributes with the same name in one node
  • It is charset-ignorant -
  • It accepts invalid names of tags
  • It accepts invalid attribute values (those with < in them) and does not reject invalid entity references or character references (in fact, it does not do DOCTYPE parsing, so it does not perform entity reference expansion)
  • It does not reject comments with -- inside -
  • It does not reject PI with the names of 'xml' and alike; in fact, it parses prolog as a PI, which -is not conformant -
  • All characters from #x1 to #x20 are considered to be whitespaces +
  • It does not reject PI with the names of 'xml' and alike
  • And some other things that I forgot to mention -In short, it accepts most malformed XML files and does not do anything that is related to DOCTYPE. -This is because the main goal was developing fast, easy-to-use and error ignorant (so you can always -get something even from a malformed document) parser, there are some good validating and conformant +In short, it accepts some malformed XML files and does not do anything that is related to DOCTYPE. +This is because the main goal was developing fast, easy-to-use and error ignorant (so you can get +something even from a malformed document) parser, there are some good validating and conformant parsers already.

    @@ -1015,9 +543,10 @@ off. The test system is AMD Sempron 2500+, 512 Mb RAM.

    Q: I do not have/want STL support. How can I compile pugixml without STL?

    A: There is an undocumented define PUGIXML_NO_STL. If you uncomment the relevant line in pugixml header file, it will compile without any STL classes. The reason it is undocumented -are that it will make some documented functions not available (specifically, xml_parser() ctor and -parse() function that operate on std::istream, xml_node::path function, utf16 and utf8 conversion -functions). Otherwise, it will work fine.

    +are that it will make some documented functions not available (specifically, xml_document::load, that +operates on std::istream, xml_node::path function, saving functions (xml_node::print, xml_document::save), +XPath-related functions and classes and as_utf16 and as_utf8 conversion functions). Otherwise, it will +work fine.

    Q: Do paths that are accepted by first_element_by_path have to end with delimiter?

    A: Either way will work, both /path/to/node/ and /path/to/node is fine.

    @@ -1048,16 +577,10 @@ do not send executable files.

    upper ones will get there sooner).

      -
    • Support for altering the tree (both changing nodes'/attributes' names and values and adding/deleting -attributes/nodes) and writing the tree to stream
    • Support for UTF-16 files (parsing BOM to get file's type and converting UTF-16 file to UTF-8 buffer if necessary) -
    • Improved API (I'm going to look at SelectNode from MS XML and perhaps there will be some other -changes) -
    • Externally provided entity reference table (or perhaps even taken from DOCTYPE?)
    • More intelligent parsing of DOCTYPE (it does not always skip DOCTYPE for now)
    • XML 1.1 changes (changed EOL handling, normalization issues, etc.) -
    • XPath support
    • Name your own?
    @@ -1079,6 +602,28 @@ changes)
  • Optimizations of strconv_t +
    21.02.2007 - v0.3 +
    Refactored, reworked and improved version. Changes:
      +
    • Interface:
        +
      • Added XPath +
      • Added tree modification functions +
      • Added no STL compilation mode +
      • Added saving document to file +
      • Refactored parsing flags +
      • Removed xml_parser class in favor of xml_document +
      • Added transfer ownership parsing mode +
      • Modified the way xml_tree_walker works +
      • Iterators are now non-constant +
      +
    • Implementation:
        +
      • Support of several compilers and platforms +
      • Refactored and sped up parsing core +
      • Improved standard compliancy +
      • Added XPath implementation +
      • Fixed several bugs +
      +
    +
    • @@ -1099,7 +644,7 @@ changes)

    The pugixml parser is distributed under the MIT license:

    -Copyright (c) 2006 Arseny Kapoulkine
+Copyright (c) 2006-2007 Arseny Kapoulkine
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -1125,7 +670,7 @@ OTHER DEALINGS IN THE SOFTWARE.
 
 
    
 
-
    Revised 8 December, 2006
    
-
    © Copyright Arseny Kapoulkine 2006. All Rights Reserved.
    
+
    Revised 21 February, 2007
    
+
    © Copyright Arseny Kapoulkine 2006-2007. All Rights Reserved.
    
 
 
-- 
cgit v1.2.3