pugi::xml_document Class Reference

Inheritance diagram for pugi::xml_document:

[legend]Collaboration diagram for pugi::xml_document:

[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.
xml_parse_result	load (std::istream &stream, unsigned int options=parse_default)
	Load document from stream.
xml_parse_result	load (const char *contents, 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 file.
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 (gains ownership).
void	save (xml_writer &writer, const char *indent="\t", unsigned int flags=format_default) const
	Save XML to writer.
bool	save_file (const char *name, const char *indent="\t", unsigned int flags=format_default) const
	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

xml_parse_result 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: parsing result

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

Load document from string. Parameters: contents  - input string options  - parsing options Returns: parsing result

xml_parse_result 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: parsing result

xml_parse_result 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: parsing result

xml_parse_result 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: parsing result

void pugi::xml_document::save (  xml_writer &  writer, const char *  indent = "\t", unsigned int  flags = format_default )  const

Save XML to writer. Parameters: writer  - writer object indent  - indentation string flags  - formatting flags

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

Save XML to file. Parameters: name  - file name indent  - indentation string flags  - formatting flags Returns: success flag

---