From 75a0d2379aee05e59f0829b04240b9307469e727 Mon Sep 17 00:00:00 2001 From: "arseny.kapoulkine" Date: Tue, 25 May 2010 19:24:32 +0000 Subject: Updated version, updated changelog, minor Doxygen fixes git-svn-id: http://pugixml.googlecode.com/svn/trunk@449 99668b35-9821-0410-8761-19e4c4f06640 --- docs/html/namespacepugi.html | 233 ++++++++++++++++++++++++++++++++----------- 1 file changed, 177 insertions(+), 56 deletions(-) (limited to 'docs/html/namespacepugi.html') diff --git a/docs/html/namespacepugi.html b/docs/html/namespacepugi.html index 00050a3..b28bb1b 100644 --- a/docs/html/namespacepugi.html +++ b/docs/html/namespacepugi.html @@ -52,8 +52,6 @@ The PugiXML Parser namespace. 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...
@@ -73,6 +71,16 @@ The PugiXML Parser namespace.  Not necessarily ordered constant collection of XPath nodes. More...

Typedefs

+ +typedef char char_t + + Character type used for all internal storage and operations; depends on PUGIXML_WCHAR_MODE.
+ +typedef std::basic_string<
+ char, std::char_traits< char >,
+ std::allocator< char > > string_t + + String type used for operations that work with STL string; depends on PUGIXML_WCHAR_MODE.
typedef void *(* allocation_function )(size_t size)  Memory allocation function.
@@ -94,6 +102,22 @@ The PugiXML Parser namespace. }  Tree node classification. More...
+enum  encoding_t {
+  encoding_auto, +encoding_utf8, +encoding_utf16_le, +encoding_utf16_be, +
+  encoding_utf16, +encoding_utf32_le, +encoding_utf32_be, +encoding_utf32, +
+  encoding_wchar +
+ } + + These flags determine the encoding of input data for XML document. More...
enum  xpath_type_t {
  xpath_type_none, xpath_type_node_set, @@ -129,12 +153,23 @@ The PugiXML Parser namespace.  Parsing status enumeration, returned as part of xml_parse_result struct. More...

Functions

-std::string PUGIXML_FUNCTION as_utf8 (const wchar_t *str) - - Convert utf16 to utf8.
-std::wstring PUGIXML_FUNCTION as_utf16 (const char *str) - - Convert utf8 to utf16.
+std::basic_string< char, std::char_traits<
+ char >, std::allocator< char
+> > PUGIXML_FUNCTION as_utf8 (const wchar_t *str) + + Convert wide string to utf8.
+PUGIXML_DEPRECATED std::basic_string<
+ wchar_t, std::char_traits<
+ wchar_t >, std::allocator<
+ wchar_t > > PUGIXML_FUNCTION as_utf16 (const char *str) + + Convert utf8 to wide string.
+std::basic_string< wchar_t,
+ std::char_traits< wchar_t >,
+ std::allocator< wchar_t
+> > PUGIXML_FUNCTION as_wide (const char *str) + + Convert utf8 to wide string.
void PUGIXML_FUNCTION set_memory_management_functions (allocation_function allocate, deallocation_function deallocate)  Override default memory management functions.
@@ -145,9 +180,6 @@ The PugiXML Parser namespace.  Get current memory deallocation function.

Variables

-const size_t memory_block_size = 32768 - - Memory block size, used for fast allocator.
const unsigned int parse_minimal = 0x0000  Minimal parsing mode.
@@ -169,9 +201,10 @@ The PugiXML Parser namespace. 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 +PUGIXML_DEPRECATED const unsigned
+int parse_wnorm_attribute = 0x0040 - This flag determines if attribute value normalization should be performed for all attributes.
+ This flag determines if attribute value normalization should be performed for all attributes.
const unsigned int parse_wconv_attribute = 0x0080  This flag determines if attribute value normalization should be performed for all attributes.
@@ -184,9 +217,12 @@ The PugiXML Parser namespace. 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_write_bom_utf8 = 0x02 +const unsigned int format_write_bom = 0x02 + + This flag determines if encoding-specific BOM is to be written to output stream.
+PUGIXML_DEPRECATED const unsigned
+int format_write_bom_utf8 = format_write_bom - This flag determines if UTF-8 BOM is to be written to output stream.
const unsigned int format_raw = 0x04  If this flag is on, no indentation is performed and no line breaks are written to output file.
@@ -305,6 +341,53 @@ E.g. '<?xml ...?>'. +

+ + + + +
+ + + + +
enum pugi::encoding_t
+
+ + + + + +
+   + + +

+These flags determine the encoding of input data for XML document. +

+Default mode is encoding_auto, which means that document encoding is autodetected from BOM and necessary encoding conversions are applied. You can override this mode by using any of the specific encodings.

Enumerator:
+ + + + + + + + + + +
encoding_auto  +Auto-detect input encoding using BOM or </<? detection; use UTF8 if BOM is not found.
encoding_utf8  +UTF8 encoding.
encoding_utf16_le  +Little-endian UTF16.
encoding_utf16_be  +Big-endian UTF16.
encoding_utf16  +UTF16 with native endianness.
encoding_utf32_le  +Little-endian UTF32.
encoding_utf32_be  +Big-endian UTF32.
encoding_utf32  +UTF32 with native endianness.
encoding_wchar  +The same encoding wchar_t has (either UTF16 or UTF32).
+
+

@@ -404,13 +487,13 @@ There was a mismatch of start-end tags (closing tag had incorrect name, some tag

Function Documentation

-

+

@@ -587,31 +707,6 @@ Get current memory deallocation function.
- + @@ -429,24 +512,24 @@ There was a mismatch of start-end tags (closing tag had incorrect name, some tag
std::string PUGIXML_FUNCTION pugi::as_utf8 std::basic_string<char, std::char_traits<char>, std::allocator<char> > PUGIXML_FUNCTION pugi::as_utf8 (  const wchar_t *  str

-Convert utf16 to utf8. +Convert wide string to utf8.

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

+

- + @@ -465,14 +548,51 @@ Convert utf16 to utf8. + +
std::wstring PUGIXML_FUNCTION pugi::as_utf16 PUGIXML_DEPRECATED std::basic_string<wchar_t, std::char_traits<wchar_t>, std::allocator<wchar_t> > PUGIXML_FUNCTION pugi::as_utf16 (  const char *  str

-Convert utf8 to utf16. +Convert utf8 to wide string.

Parameters:
str - input UTF8 string
-
Returns:
output UTF16 string
+
Returns:
output wide string string
+
Deprecated:
This function is deprecated and will be removed in future versions; use as_wide instead
+
+

+ + + + +
+ + + + + + + + + +
std::basic_string<wchar_t, std::char_traits<wchar_t>, std::allocator<wchar_t> > PUGIXML_FUNCTION pugi::as_wide ( const char *  str  ) 
+
+ + + +
+   + + +

+Convert utf8 to wide string. +

+

Parameters:
+ + +
str - input UTF8 string
+
+
Returns:
output wide string string
@@ -519,7 +639,7 @@ All subsequent allocations/deallocations will be performed via supplied function

deallocate - deallocation function
-

Note:
XPath-related allocations, as well as allocations in functions that return std::string (xml_node::path, as_utf8, as_utf16) are not performed via these functions.

+

Note:
XPath-related allocations, as well as allocations in functions that return std::string (xml_node::path, as_utf8, as_wide) are not performed via these functions.

If you're using parse() with ownership transfer, you have to allocate the buffer you pass to parse() with allocation function you set via this function.

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.

@@ -796,13 +891,13 @@ This flag determines if EOL handling (that is, replacing sequences 0x0d 0x0a by This flag is on by default.
-

+

@@ -819,7 +914,9 @@ This flag is on by default. This flag determines if attribute value normalization should be performed for all attributes.

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. +This flag is off by default.

+

Deprecated:
This flag is deprecated
+
- +
const unsigned int pugi::parse_wnorm_attribute = 0x0040 PUGIXML_DEPRECATED const unsigned int pugi::parse_wnorm_attribute = 0x0040

@@ -925,13 +1022,13 @@ Indent the nodes that are written to output stream with as many indentation stri This flag is on by default. -

+

@@ -945,11 +1042,35 @@ This flag is on by default.
- +
const unsigned int pugi::format_write_bom_utf8 = 0x02 const unsigned int pugi::format_write_bom = 0x02

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

This flag is off by default.

+

+ + + + +
+ + + + +
PUGIXML_DEPRECATED const unsigned int pugi::format_write_bom_utf8 = format_write_bom
+
+ + + + + +
+   + + +

+

Deprecated:
This constant is deprecated and will be removed in future versions; use format_write_bom instead
+

@@ -1027,7 +1148,7 @@ This is the default set of formatting flags. It includes indenting nodes depending on their depth in DOM tree.
-

Generated on Tue Jan 5 20:02:10 2010 for pugixml by  +
Generated on Tue May 25 23:22:40 2010 for pugixml by  doxygen 1.4.6-NO
-- cgit v1.2.3