Loading document

xml_parse_result xml_document::load_file(const char* path, unsigned int options = parse_default, xml_encoding encoding = encoding_auto); +xml_parse_result xml_document::load_file(const wchar_t* path, unsigned int options = parse_default, xml_encoding encoding = encoding_auto);

Note

- As of version 0.9, there is no function for loading XML document from wide - character path. Unfortunately, there is no portable way to do this; the - version 1.0 will provide such function only for platforms with the corresponding - functionality. You can use stream-loading functions as a workaround if - your STL implementation can open file streams via wchar_t - paths. -

@@ -490,9 +484,15 @@

parse_declaration determines if XML document declaration (node with type node_declaration) - are to be put in DOM tree. If this flag is off, it is not put in the - tree, but is still parsed and checked for correctness. This flag is - off by default.

+ is to be put in DOM tree. If this flag is off, it is not put in the tree, + but is still parsed and checked for correctness. This flag is off by default.

+ +

+ parse_doctype determines if XML document + type declaration (node with type node_doctype) + is to be put in DOM tree. If this flag is off, it is not put in the tree, + but is still parsed and checked for correctness. This flag is off by default.

@@ -525,13 +525,13 @@ 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 three children when parse_ws_pcdata - is set (child with type node_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 one child when parse_ws_pcdata + child with type node_element and + name "a", and another + child with type node_pcdata and value + " "), and only + one child when parse_ws_pcdata is not set. This flag is off by default.

@@ -551,7 +551,7 @@ that as pugixml does not handle DTD, the only allowed entities are predefined ones). If character/entity reference can not be expanded, it is left 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.

+ is performed on attribute values and PCDATA content. This flag is on by default.

@@ -569,9 +569,9 @@ if attribute value normalization should be performed for all attributes. This means, that whitespace characters (new line, tab and space) are replaced with space (' '). - New line characters are always treated as if parse_eol + New line characters are always treated as if parse_eol is set, i.e. \r\n - is converted to single space. This flag is on + is converted to a single space. This flag is on by default.

@@ -579,10 +579,10 @@ parse_wnorm_attribute determines if extended attribute value normalization should be performed for all attributes. This means, that after attribute values are normalized as - if parse_wconv_attribute + if parse_wconv_attribute was set, leading and trailing space characters are removed, and all sequences of space characters are replaced by a single space character. The value - of parse_wconv_attribute + of parse_wconv_attribute has no effect if this flag is on. This flag is off by default. @@ -595,24 +595,25 @@

parse_wconv_attribute option performs transformations that are required by W3C specification for attributes - that are declared as CDATA; parse_wnorm_attribute + that are declared as CDATA; parse_wnorm_attribute performs transformations required for NMTOKENS attributes. - In the absence of document type declaration all attributes behave as if - they are declared as CDATA, thus parse_wconv_attribute + In the absence of document type declaration all attributes should behave + as if they are declared as CDATA, thus parse_wconv_attribute is the default option.

- Additionally there are two predefined option masks: + Additionally there are three predefined option masks:

parse_minimal has all options turned off. This option mask means that pugixml does not add declaration nodes, - PI nodes, CDATA sections and comments to the resulting tree and does - not perform any conversion for input data, so theoretically it is the - fastest mode. However, as discussed above, in practice parse_default is usually equally fast. -

+ document type declaration nodes, PI nodes, CDATA sections and comments + to the resulting tree and does not perform any conversion for input data, + so theoretically it is the fastest mode. However, as mentioned above, + in practice parse_default is usually + equally fast.
@@ -622,7 +623,18 @@ 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. + for performance reasons.

+ +
+ parse_full is the set of flags which adds + nodes of all types to the resulting tree and performs default conversions + for input data. It includes parsing CDATA sections, comments, PI nodes, + document declaration node and document type declaration node, 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 + in this mode.

Loading document from file