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/classpugi_1_1xml__document.html | 476 +++++++++++++++++++++++++++--- 1 file changed, 432 insertions(+), 44 deletions(-) (limited to 'docs/html/classpugi_1_1xml__document.html') diff --git a/docs/html/classpugi_1_1xml__document.html b/docs/html/classpugi_1_1xml__document.html index 28d5991..96a34bc 100644 --- a/docs/html/classpugi_1_1xml__document.html +++ b/docs/html/classpugi_1_1xml__document.html @@ -44,34 +44,52 @@ This class has noncopyable semantics (private copy ctor/assignment operator).  ~xml_document ()  Dtor.
-xml_parse_result load (std::istream &stream, unsigned int options=parse_default) +xml_parse_result load (std::basic_istream< char, std::char_traits< char > > &stream, unsigned int options=parse_default, encoding_t encoding=encoding_auto) - Load document from stream.
-xml_parse_result load (const char *contents, unsigned int options=parse_default) + Load document from stream.
+xml_parse_result load (std::basic_istream< wchar_t, std::char_traits< wchar_t > > &stream, unsigned int options=parse_default) - Load document from string.
-xml_parse_result load_file (const char *name, unsigned int options=parse_default) + Load document from stream.
+xml_parse_result load (const char_t *contents, unsigned int options=parse_default) - Load document from file.
-xml_parse_result parse (char *xmlstr, unsigned int options=parse_default) + Load document from string.
+PUGIXML_DEPRECATED xml_parse_result parse (char *xmlstr, unsigned int options=parse_default) - Parse the given XML string in-situ.
-xml_parse_result parse (const transfer_ownership_tag &, char *xmlstr, unsigned int options=parse_default) + Parse the given XML string in-situ.
+PUGIXML_DEPRECATED xml_parse_result parse (const transfer_ownership_tag &, char *xmlstr, unsigned int options=parse_default) - Parse the given XML string in-situ (gains ownership).
-void save (xml_writer &writer, const char *indent="\t", unsigned int flags=format_default) const + Parse the given XML string in-situ (gains ownership).
+xml_parse_result load_file (const char *name, unsigned int options=parse_default, encoding_t encoding=encoding_auto) - Save XML to writer.
-bool save_file (const char *name, const char *indent="\t", unsigned int flags=format_default) const + Load document from file.
+xml_parse_result load_buffer (const void *contents, size_t size, unsigned int options=parse_default, encoding_t encoding=encoding_auto) - Save XML to file.
- -void precompute_document_order () + Load document from buffer.
+xml_parse_result load_buffer_inplace (void *contents, size_t size, unsigned int options=parse_default, encoding_t encoding=encoding_auto) + + Load document from buffer in-situ.
+xml_parse_result load_buffer_inplace_own (void *contents, size_t size, unsigned int options=parse_default, encoding_t encoding=encoding_auto) + + Load document from buffer in-situ (gains buffer ownership).
+void save (xml_writer &writer, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, encoding_t encoding=encoding_auto) const + + Save XML to writer.
+void save (std::basic_ostream< char, std::char_traits< char > > &stream, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, encoding_t encoding=encoding_auto) const + + Save XML to stream.
+void save (std::basic_ostream< wchar_t, std::char_traits< wchar_t > > &stream, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default) const + + Save XML to stream.
+bool save_file (const char *name, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, encoding_t encoding=encoding_auto) const + + Save XML to file.
+ +PUGIXML_DEPRECATED void precompute_document_order ()  Compute document order for the whole tree Sometimes this makes evaluation of XPath queries faster.

Member Function Documentation

-

+

- + - + + + + + + + @@ -111,13 +135,14 @@ Load document from stream.
@@ -79,14 +97,20 @@ void xml_parse_result pugi::xml_document::load ( std::istream & std::basic_istream< char, std::char_traits< char > > &  stream,
unsigned int  options = parse_default options = parse_default,
encoding_t  encoding = encoding_auto
+
stream - stream with xml data
options - parsing options
encoding - source data encoding

Returns:
parsing result
-

+

- - + + @@ -151,11 +176,11 @@ Load document from stream.
@@ -125,8 +150,8 @@ Load document from stream.
xml_parse_result pugi::xml_document::load ( const char *  contents, std::basic_istream< wchar_t, std::char_traits< wchar_t > > &  stream,

-Load document from string. +Load document from stream.

Parameters:
- +
contents - input string
stream - stream with xml data
options - parsing options
@@ -163,16 +188,16 @@ Load document from string.
-

+

+ +
- + - - + + @@ -197,11 +222,12 @@ Load document from string.
xml_parse_result pugi::xml_document::load_file xml_parse_result pugi::xml_document::load ( const char *  name, const char_t *  contents,

-Load document from file. +Load document from string.

+String has to be zero-terminated. No encoding conversions are applied.

Parameters:
- +
name - file name
contents - input string
options - parsing options
@@ -209,13 +235,13 @@ Load document from file.
-

+

- + @@ -252,17 +278,18 @@ The string is modified; you should ensure that string data will persist througho
xml_parse_result pugi::xml_document::parse PUGIXML_DEPRECATED xml_parse_result pugi::xml_document::parse (  char *  xmlstr,
options - parsing options
-
Returns:
parsing result
+
Returns:
parsing result
+
Deprecated:
This function is deprecated and will be removed in future versions; use xml_document::load_buffer_inplace instead
-

+

+ +
- + @@ -305,11 +332,247 @@ The string is modified; document gains ownership over the string, so you don't h
xml_parse_result pugi::xml_document::parse PUGIXML_DEPRECATED xml_parse_result pugi::xml_document::parse (  const transfer_ownership_tag &  ,
options - parsing options
+
Returns:
parsing result
+
Deprecated:
This function is deprecated and will be removed in future versions; use xml_document::load_buffer_inplace_own instead
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
xml_parse_result pugi::xml_document::load_file ( const char *  name,
unsigned int  options = parse_default,
encoding_t  encoding = encoding_auto
) 
+
+ + + + + +
+   + + +

+Load document from file. +

+

Parameters:
+ + + + +
name - file name
options - parsing options
encoding - source data encoding
+
+
Returns:
parsing result
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
xml_parse_result pugi::xml_document::load_buffer ( const void *  contents,
size_t  size,
unsigned int  options = parse_default,
encoding_t  encoding = encoding_auto
) 
+
+ + + + + +
+   + + +

+Load document from buffer. +

+

Parameters:
+ + + + + +
contents - buffer contents
size - buffer size in bytes
options - parsing options
encoding - source data encoding
+
+
Returns:
parsing result
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
xml_parse_result pugi::xml_document::load_buffer_inplace ( void *  contents,
size_t  size,
unsigned int  options = parse_default,
encoding_t  encoding = encoding_auto
) 
+
+ + + +
+   + + +

+Load document from buffer in-situ. +

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

+

Parameters:
+ + + + + +
contents - buffer contents
size - buffer size in bytes
options - parsing options
encoding - source data encoding
+
Returns:
parsing result
-

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
xml_parse_result pugi::xml_document::load_buffer_inplace_own ( void *  contents,
size_t  size,
unsigned int  options = parse_default,
encoding_t  encoding = encoding_auto
) 
+
+ + + + + +
+   + + +

+Load document from buffer in-situ (gains buffer ownership). +

+The buffer is modified; you should ensure that buffer data will persist throughout the document's lifetime. Document gains ownership over the buffer, so you should allocate the buffer with pugixml allocation function.

+

Parameters:
+ + + + + +
contents - buffer contents
size - buffer size in bytes
options - parsing options
encoding - source data encoding
+
+
Returns:
parsing result
+
+

- - + + - + + + + + + + @@ -356,12 +625,124 @@ Save XML to writer. + +
@@ -323,14 +586,20 @@ The string is modified; document gains ownership over the string, so you don't h
const char *  indent = "\t", const char_t *  indent = PUGIXML_TEXT("\t"),
unsigned int  flags = format_default flags = format_default,
encoding_t  encoding = encoding_auto
writer - writer object
indent - indentation string
flags - formatting flags
encoding - encoding used for writing
+ +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void pugi::xml_document::save ( std::basic_ostream< char, std::char_traits< char > > &  stream,
const char_t *  indent = PUGIXML_TEXT("\t"),
unsigned int  flags = format_default,
encoding_t  encoding = encoding_auto
)  const
+
+ + + +
+   + + +

+Save XML to stream. +

+

Parameters:
+ + + + +
stream - output stream
indent - indentation string
flags - formatting flags
encoding - encoding used for writing
-

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void pugi::xml_document::save ( std::basic_ostream< wchar_t, std::char_traits< wchar_t > > &  stream,
const char_t *  indent = PUGIXML_TEXT("\t"),
unsigned int  flags = format_default
)  const
+
+ + + + + +
+   + + +

+Save XML to stream. +

+

Parameters:
+ + + + +
stream - output stream
indent - indentation string
flags - formatting flags
+
+
+

- - + + - + + + + + + + @@ -408,13 +795,14 @@ Save XML to file. +
@@ -375,14 +756,20 @@ Save XML to writer.
const char *  indent = "\t", const char_t *  indent = PUGIXML_TEXT("\t"),
unsigned int  flags = format_default flags = format_default,
encoding_t  encoding = encoding_auto
name - file name
indent - indentation string
flags - formatting flags
encoding - encoding used for writing

Returns:
success flag
-
Generated on Tue Jan 5 20:02:14 2010 for pugixml by  +
Generated on Tue May 25 23:22:41 2010 for pugixml by  doxygen 1.4.6-NO
-- cgit v1.2.3