pugi::xml_document Class Reference

#include <pugixml.hpp>

Inheritance diagram for pugi::xml_document:

Public Member Functions
	xml_document ()
	~xml_document ()
void	reset ()
void	reset (const xml_document &proto)
xml_parse_result	load (std::basic_istream< char, std::char_traits< char > > &stream, unsigned int options=parse_default, xml_encoding encoding=encoding_auto)
xml_parse_result	load (std::basic_istream< wchar_t, std::char_traits< wchar_t > > &stream, unsigned int options=parse_default)
PUGIXML_DEPRECATED xml_parse_result	load (const char_t *contents, unsigned int options=parse_default)
xml_parse_result	load_string (const char_t *contents, unsigned int options=parse_default)
xml_parse_result	load_file (const char *path, unsigned int options=parse_default, xml_encoding encoding=encoding_auto)
xml_parse_result	load_file (const wchar_t *path, unsigned int options=parse_default, xml_encoding encoding=encoding_auto)
xml_parse_result	load_buffer (const void *contents, size_t size, unsigned int options=parse_default, xml_encoding encoding=encoding_auto)
xml_parse_result	load_buffer_inplace (void *contents, size_t size, unsigned int options=parse_default, xml_encoding encoding=encoding_auto)
xml_parse_result	load_buffer_inplace_own (void *contents, size_t size, unsigned int options=parse_default, xml_encoding encoding=encoding_auto)
void	save (xml_writer &writer, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, xml_encoding encoding=encoding_auto) const
void	save (std::basic_ostream< char, std::char_traits< char > > &stream, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, xml_encoding encoding=encoding_auto) const
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
bool	save_file (const char *path, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, xml_encoding encoding=encoding_auto) const
bool	save_file (const wchar_t *path, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, xml_encoding encoding=encoding_auto) const
xml_node	document_element () const
Public Member Functions inherited from pugi::xml_node
	xml_node ()
	xml_node (xml_node_struct *p)
	operator unspecified_bool_type () const
bool	operator! () 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
bool	operator>= (const xml_node &r) const
bool	empty () const
xml_node_type	type () const
const char_t *	name () const
const char_t *	value () const
xml_attribute	first_attribute () const
xml_attribute	last_attribute () const
xml_node	first_child () const
xml_node	last_child () const
xml_node	next_sibling () const
xml_node	previous_sibling () const
xml_node	parent () const
xml_node	root () const
xml_text	text () const
xml_node	child (const char_t *name) const
xml_attribute	attribute (const char_t *name) const
xml_node	next_sibling (const char_t *name) const
xml_node	previous_sibling (const char_t *name) const
xml_attribute	attribute (const char_t *name, xml_attribute &hint) const
const char_t *	child_value () const
const char_t *	child_value (const char_t *name) const
bool	set_name (const char_t *rhs)
bool	set_value (const char_t *rhs, size_t sz)
bool	set_value (const char_t *rhs)
xml_attribute	append_attribute (const char_t *name)
xml_attribute	prepend_attribute (const char_t *name)
xml_attribute	insert_attribute_after (const char_t *name, const xml_attribute &attr)
xml_attribute	insert_attribute_before (const char_t *name, const xml_attribute &attr)
xml_attribute	append_copy (const xml_attribute &proto)
xml_attribute	prepend_copy (const xml_attribute &proto)
xml_attribute	insert_copy_after (const xml_attribute &proto, const xml_attribute &attr)
xml_attribute	insert_copy_before (const xml_attribute &proto, const xml_attribute &attr)
xml_node	append_child (xml_node_type type=node_element)
xml_node	prepend_child (xml_node_type type=node_element)
xml_node	insert_child_after (xml_node_type type, const xml_node &node)
xml_node	insert_child_before (xml_node_type type, const xml_node &node)
xml_node	append_child (const char_t *name)
xml_node	prepend_child (const char_t *name)
xml_node	insert_child_after (const char_t *name, const xml_node &node)
xml_node	insert_child_before (const char_t *name, const xml_node &node)
xml_node	append_copy (const xml_node &proto)
xml_node	prepend_copy (const xml_node &proto)
xml_node	insert_copy_after (const xml_node &proto, const xml_node &node)
xml_node	insert_copy_before (const xml_node &proto, const xml_node &node)
xml_node	append_move (const xml_node &moved)
xml_node	prepend_move (const xml_node &moved)
xml_node	insert_move_after (const xml_node &moved, const xml_node &node)
xml_node	insert_move_before (const xml_node &moved, const xml_node &node)
bool	remove_attribute (const xml_attribute &a)
bool	remove_attribute (const char_t *name)
bool	remove_attributes ()
bool	remove_child (const xml_node &n)
bool	remove_child (const char_t *name)
bool	remove_children ()
xml_parse_result	append_buffer (const void *contents, size_t size, unsigned int options=parse_default, xml_encoding encoding=encoding_auto)
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_node (Predicate pred) const
xml_node	find_child_by_attribute (const char_t *name, const char_t *attr_name, const char_t *attr_value) const
xml_node	find_child_by_attribute (const char_t *attr_name, const char_t *attr_value) const
string_t	path (char_t delimiter='/') const
xml_node	first_element_by_path (const char_t *path, char_t delimiter='/') const
bool	traverse (xml_tree_walker &walker)
xpath_node	select_node (const char_t *query, xpath_variable_set *variables=PUGIXML_NULL) const
xpath_node	select_node (const xpath_query &query) const
xpath_node_set	select_nodes (const char_t *query, xpath_variable_set *variables=PUGIXML_NULL) const
xpath_node_set	select_nodes (const xpath_query &query) const
PUGIXML_DEPRECATED xpath_node	select_single_node (const char_t *query, xpath_variable_set *variables=PUGIXML_NULL) const
PUGIXML_DEPRECATED xpath_node	select_single_node (const xpath_query &query) const
void	print (xml_writer &writer, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, xml_encoding encoding=encoding_auto, unsigned int depth=0) const
void	print (std::basic_ostream< char, std::char_traits< char > > &os, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, xml_encoding encoding=encoding_auto, unsigned int depth=0) const
void	print (std::basic_ostream< wchar_t, std::char_traits< wchar_t > > &os, const char_t *indent=PUGIXML_TEXT("\t"), unsigned int flags=format_default, unsigned int depth=0) const
iterator	begin () const
iterator	end () const
attribute_iterator	attributes_begin () const
attribute_iterator	attributes_end () const
xml_object_range< xml_node_iterator >	children () const
xml_object_range< xml_named_node_iterator >	children (const char_t *name) const
xml_object_range< xml_attribute_iterator >	attributes () const
ptrdiff_t	offset_debug () const
size_t	hash_value () const
xml_node_struct *	internal_object () const

Additional Inherited Members
Public Types inherited from pugi::xml_node
typedef xml_node_iterator	iterator
typedef xml_attribute_iterator	attribute_iterator
Protected Types inherited from pugi::xml_node
typedef void(*	unspecified_bool_type) (xml_node ***)
Protected Attributes inherited from pugi::xml_node
xml_node_struct *	_root

Detailed Description

Definition at line 1029 of file pugixml.hpp.

Constructor & Destructor Documentation

xml_document()

PUGI__FN pugi::xml_document::xml_document

(

)

Definition at line 7068 of file pugixml.cc.

                                       : _buffer(0)
    {
        _create();
    }

~xml_document()

PUGI__FN pugi::xml_document::~xml_document

(

)

Definition at line 7073 of file pugixml.cc.

    {
        _destroy();
    }

Member Function Documentation

document_element()

PUGI__FN xml_node pugi::xml_document::document_element

(

)

const

Definition at line 7437 of file pugixml.cc.

    {
        assert(_root);
 
        for (xml_node_struct* i = _root->first_child; i; i = i->next_sibling)
            if (PUGI__NODETYPE(i) == node_element)
                return xml_node(i);
 
        return xml_node();
    }

load() [1/3]

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

Definition at line 7331 of file pugixml.cc.

    {
        return load_string(contents, options);
    }

load() [2/3]

PUGI__FN xml_parse_result pugi::xml_document::load	(	std::basic_istream< char, std::char_traits< char > > &	stream,
		unsigned int	options = parse_default,
		xml_encoding	encoding = encoding_auto )

Definition at line 7304 of file pugixml.cc.

    {
        reset();
 
        return impl::load_stream_impl(static_cast<impl::xml_document_struct*>(_root), stream, options, encoding, &_buffer);
    }

load() [3/3]

PUGI__FN xml_parse_result pugi::xml_document::load	(	std::basic_istream< wchar_t, std::char_traits< wchar_t > > &	stream,
		unsigned int	options = parse_default )

Definition at line 7311 of file pugixml.cc.

    {
        reset();
 
        return impl::load_stream_impl(static_cast<impl::xml_document_struct*>(_root), stream, options, encoding_wchar, &_buffer);
    }

load_buffer()

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

Definition at line 7356 of file pugixml.cc.

    {
        reset();
 
        return impl::load_buffer_impl(static_cast<impl::xml_document_struct*>(_root), _root, const_cast<void*>(contents), size, options, encoding, false, false, &_buffer);
    }

Referenced by load_string().

load_buffer_inplace()

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

Definition at line 7363 of file pugixml.cc.

    {
        reset();
 
        return impl::load_buffer_impl(static_cast<impl::xml_document_struct*>(_root), _root, contents, size, options, encoding, true, false, &_buffer);
    }

load_buffer_inplace_own()

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

Definition at line 7370 of file pugixml.cc.

    {
        reset();
 
        return impl::load_buffer_impl(static_cast<impl::xml_document_struct*>(_root), _root, contents, size, options, encoding, true, true, &_buffer);
    }

load_file() [1/2]

PUGI__FN xml_parse_result pugi::xml_document::load_file	(	const char *	path,
		unsigned int	options = parse_default,
		xml_encoding	encoding = encoding_auto )

Definition at line 7336 of file pugixml.cc.

    {
        reset();
 
        using impl::auto_deleter; // MSVC7 workaround
        auto_deleter<FILE> file(impl::open_file(path_, "rb"), impl::close_file);
 
        return impl::load_file_impl(static_cast<impl::xml_document_struct*>(_root), file.data, options, encoding, &_buffer);
    }

load_file() [2/2]

PUGI__FN xml_parse_result pugi::xml_document::load_file	(	const wchar_t *	path,
		unsigned int	options = parse_default,
		xml_encoding	encoding = encoding_auto )

Definition at line 7346 of file pugixml.cc.

    {
        reset();
 
        using impl::auto_deleter; // MSVC7 workaround
        auto_deleter<FILE> file(impl::open_file_wide(path_, L"rb"), impl::close_file);
 
        return impl::load_file_impl(static_cast<impl::xml_document_struct*>(_root), file.data, options, encoding, &_buffer);
    }

load_string()

PUGI__FN xml_parse_result pugi::xml_document::load_string	(	const char_t *	contents,
		unsigned int	options = parse_default )

Definition at line 7319 of file pugixml.cc.

    {
        // Force native encoding (skip autodetection)
    #ifdef PUGIXML_WCHAR_MODE
        xml_encoding encoding = encoding_wchar;
    #else
        xml_encoding encoding = encoding_utf8;
    #endif
 
        return load_buffer(contents, impl::strlength(contents) * sizeof(char_t), options, encoding);
    }

Referenced by PoPI::Database::addDatabase(), and load().

reset() [1/2]

PUGI__FN void pugi::xml_document::reset

(

)

Definition at line 7097 of file pugixml.cc.

    {
        _destroy();
        _create();
    }

Referenced by load(), load(), load_buffer(), load_buffer_inplace(), load_buffer_inplace_own(), load_file(), load_file(), and reset().

reset() [2/2]

PUGI__FN void pugi::xml_document::reset

(

const xml_document &

proto

)

Definition at line 7103 of file pugixml.cc.

    {
        reset();
 
        impl::node_copy_tree(_root, proto._root);
    }

save() [1/3]

PUGI__FN 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,
		xml_encoding	encoding = encoding_auto ) const

Definition at line 7406 of file pugixml.cc.

    {
        xml_writer_stream writer(stream);
 
        save(writer, indent, flags, encoding);
    }

save() [2/3]

PUGI__FN 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

Definition at line 7413 of file pugixml.cc.

    {
        xml_writer_stream writer(stream);
 
        save(writer, indent, flags, encoding_wchar);
    }

save() [3/3]

PUGI__FN void pugi::xml_document::save	(	xml_writer &	writer,
		const char_t *	indent = PUGIXML_TEXT("\t"),
		unsigned int	flags = format_default,
		xml_encoding	encoding = encoding_auto ) const

Definition at line 7377 of file pugixml.cc.

    {
        impl::xml_buffered_writer buffered_writer(writer, encoding);
 
        if ((flags & format_write_bom) && encoding != encoding_latin1)
        {
            // BOM always represents the codepoint U+FEFF, so just write it in native encoding
        #ifdef PUGIXML_WCHAR_MODE
            unsigned int bom = 0xfeff;
            buffered_writer.write(static_cast<wchar_t>(bom));
        #else
            buffered_writer.write('\xef', '\xbb', '\xbf');
        #endif
        }
 
        if (!(flags & format_no_declaration) && !impl::has_declaration(_root))
        {
            buffered_writer.write_string(PUGIXML_TEXT("<?xml version=\"1.0\""));
            if (encoding == encoding_latin1) buffered_writer.write_string(PUGIXML_TEXT(" encoding=\"ISO-8859-1\""));
            buffered_writer.write('?', '>');
            if (!(flags & format_raw)) buffered_writer.write('\n');
        }
 
        impl::node_output(buffered_writer, _root, indent, flags, 0);
 
        buffered_writer.flush();
    }

Referenced by save(), and save().

save_file() [1/2]

PUGI__FN bool pugi::xml_document::save_file	(	const char *	path,
		const char_t *	indent = PUGIXML_TEXT("\t"),
		unsigned int	flags = format_default,
		xml_encoding	encoding = encoding_auto ) const

Definition at line 7421 of file pugixml.cc.

    {
        using impl::auto_deleter; // MSVC7 workaround
        auto_deleter<FILE> file(impl::open_file(path_, (flags & format_save_file_text) ? "w" : "wb"), impl::close_file);
 
        return impl::save_file_impl(*this, file.data, indent, flags, encoding) && fclose(file.release()) == 0;
    }

save_file() [2/2]

PUGI__FN bool pugi::xml_document::save_file	(	const wchar_t *	path,
		const char_t *	indent = PUGIXML_TEXT("\t"),
		unsigned int	flags = format_default,
		xml_encoding	encoding = encoding_auto ) const

Definition at line 7429 of file pugixml.cc.

    {
        using impl::auto_deleter; // MSVC7 workaround
        auto_deleter<FILE> file(impl::open_file_wide(path_, (flags & format_save_file_text) ? L"w" : L"wb"), impl::close_file);
 
        return impl::save_file_impl(*this, file.data, indent, flags, encoding) && fclose(file.release()) == 0;
    }

---

The documentation for this class was generated from the following files:

• pugixml.hpp
• pugixml.cc