XML document holder. More...

#include <xmlstorage.h>

Inheritance diagram for XMLStorage::XMLDoc:

[legend]

Collaboration diagram for XMLStorage::XMLDoc:

[legend]

Public Member Functions
	XMLDoc ()

	XMLDoc (LPCTSTR path)

bool	read_file (LPCTSTR path)

bool	read_buffer (const char *buffer, size_t len, const std::string &system_id=std::string())

bool	read_buffer (const std::string &buffer, const std::string &system_id=std::string())

bool	read_stream (std::istream &in, const std::string &system_id=std::string())

bool	read (XMLReaderBase &reader, const std::string &display_path)

bool	write (std::ostream &out, WRITE_MODE mode=FORMAT_SMART) const
	write XML stream

bool	write_formating (std::ostream &out) const
	write XML stream with formating

bool	write_file (LPCTSTR path, WRITE_MODE mode=FORMAT_SMART) const

bool	write_formating (LPCTSTR path) const

Public Member Functions inherited from XMLStorage::XMLNode
	XMLNode (const XS_String &name)

	XMLNode (const XS_String &name, const std::string &leading)

	XMLNode (const XMLNode &other)

	XMLNode (const XMLNode &other, COPY_FLAGS copy_no_children)

virtual	~XMLNode ()

void	clear ()

XMLNode &	operator= (const XMLNode &other)

void	add_child (XMLNode *child)
	add a new child node

void	remove_children (const XS_String &name)
	remove all children named 'name'

void	put (const XS_String &attr_name, const XS_String &value)
	write access to an attribute

XS_String &	operator[] (const XS_String &attr_name)
	index operator write access to an attribute

template<typename T >
XS_String	get (const T &attr_name, LPCXSSTR def=XS_EMPTY_STR) const
	read only access to an attribute

void	erase (const XS_String &attr_name)
	remove the attribute 'attr_name'

XS_String	subvalue (const XS_String &child_name, const XS_String &attr_name, int n=0) const
	convenient value access in children node

XS_String &	subvalue (const XS_String &child_name, const XS_String &attr_name, int n=0)
	convenient storage of distinct values in children node

const Children &	get_children () const

Children &	get_children ()

const AttributeMap &	get_attributes () const

AttributeMap &	get_attributes ()

XS_String	get_content () const
	read element node content

XS_String	get_sub_content (const XPath &xpath) const
	read content of a subnode specified by an XPath expression

void	set_content (const XS_String &s, bool cdata=false)
	set element node content

bool	set_sub_content (const XPath &xpath, const XS_String &s, bool cdata=false)
	set content of a subnode specified by an XPath expression

bool	write (std::ostream &out, const XMLFormat &format, WRITE_MODE mode=FORMAT_SMART, int indent=0) const
	write node with children tree to output stream

int	count (const XPath &xpath) const
	count the nodes matching the given relative XPath expression

int	count (XPath::const_iterator from, const XPath::const_iterator &to) const
	count the nodes matching the given relative XPath expression

bool	filter (const XPath &xpath, XMLNode &target) const
	copy matching tree nodes using the given XPath filter expression

const XMLNode *	find_relative (const XPath &xpath) const
	XPath find function (const)

XMLNode *	find_relative (const XPath &xpath)
	XPath find function.

XMLNode *	get_first_child () const

Public Member Functions inherited from XMLStorage::XS_String
	XS_String ()

	XS_String (LPCXSSTR s)

	XS_String (LPCXSSTR s, size_t l)

	XS_String (const super &other)

	XS_String (const XS_String &other)

void	assign (const XS_String &s)

XS_String &	operator= (LPCXSSTR s)

XS_String &	operator= (const super &s)

void	assign (LPCXSSTR s)

void	assign (LPCXSSTR s, size_t l)

	operator LPCXSSTR () const

XS_String &	printf (LPCXSSTR fmt,...)

XS_String &	vprintf (LPCXSSTR fmt, va_list l)

XS_String &	appendf (LPCXSSTR fmt,...)

XS_String &	vappendf (LPCXSSTR fmt, va_list l)

Public Attributes
XMLFormat	_format

XMLErrorList	_errors

Additional Inherited Members
Public Types inherited from XMLStorage::XMLNode
enum	COPY_FLAGS { COPY_NOCHILDREN }

Public Types inherited from XMLStorage::XS_String
typedef std::string	super

Protected Member Functions inherited from XMLStorage::XMLNode
XMLNode *	create_relative (const XPath &xpath)
	relative XPath create function

XMLNode *	filter (XPath::const_iterator from, const XPath::const_iterator &to) const
	create a new node tree using the given XPath filter expression

void	original_write_worker (std::ostream &out) const
	write node with children tree to output stream using original white space

void	plain_write_worker (std::ostream &out) const
	print node without any white space

void	pretty_write_worker (std::ostream &out, const XMLFormat &format, int indent) const
	pretty print node with children tree to output stream

void	smart_write_worker (std::ostream &out, const XMLFormat &format, int indent) const
	write node with children tree to output stream using smart formating

Protected Attributes inherited from XMLStorage::XMLNode
Children	_children

AttributeMap	_attributes

std::string	_leading

std::string	_content

std::string	_end_leading

std::string	_trailing

bool	_cdata_content

Detailed Description

XML document holder.

Definition at line 2702 of file xmlstorage.h.

Constructor & Destructor Documentation

◆ XMLDoc() [1/2]

XMLStorage::XMLDoc::XMLDoc ( )

inline

Definition at line 2704 of file xmlstorage.h.

     :  XMLNode("")
    {
    }

◆ XMLDoc() [2/2]

XMLStorage::XMLDoc::XMLDoc ( LPCTSTR path )

inline

Definition at line 2709 of file xmlstorage.h.

     :  XMLNode("")
    {
        read_file(path);
    }

Member Function Documentation

◆ read()

bool XMLStorage::XMLDoc::read	(	XMLReaderBase &	reader,
		const std::string &	display_path
	)

inline

Definition at line 2776 of file xmlstorage.h.

    {
#ifdef XMLNODE_LOCATION
         // make a string copy to handle temporary string objects
        _display_path = display_path;
        reader._display_path = _display_path.c_str();
#endif
 
        reader.clear_errors();
        reader.read();
 
        _format = reader.get_format();
        _format._endl = reader.get_endl();
 
        if (!reader.get_errors().empty()) {
            _errors = reader.get_errors();
            return false;
        }
 
        return true;
    }

◆ read_buffer() [1/2]

bool XMLStorage::XMLDoc::read_buffer	(	const char *	buffer,
		size_t	len,
		const std::string &	system_id = `std::string()`
	)

inline

Definition at line 2756 of file xmlstorage.h.

    {
        return read_buffer(std::string(buffer, len), system_id);
    }

Referenced by read_buffer(), XMLStorage::XMLMessageFromString::XMLMessageFromString(), and XMLStorage::XMLMessageReader::XMLMessageReader().

◆ read_buffer() [2/2]

bool XMLStorage::XMLDoc::read_buffer	(	const std::string &	buffer,
		const std::string &	system_id = `std::string()`
	)

inline

Definition at line 2761 of file xmlstorage.h.

    {
        std::istringstream istr(buffer);
 
        return read_stream(istr, system_id);
    }

◆ read_file()

bool XMLStorage::XMLDoc::read_file ( LPCTSTR path )

inline

Definition at line 2741 of file xmlstorage.h.

    {
        tifstream in(path);
        if (!in.good())
            return false;
 
        XMLReader reader(this, in);
 
#if defined(_STRING_DEFINED) && !defined(XS_STRING_UTF8)
        return read(reader, std::string(ANS(path)));
#else
        return read(reader, XS_String(path));
#endif
    }

Referenced by ExplorerGlobals::read_persistent(), and XMLDoc().

◆ read_stream()

bool XMLStorage::XMLDoc::read_stream	(	std::istream &	in,
		const std::string &	system_id = `std::string()`
	)

inline

Definition at line 2768 of file xmlstorage.h.

    {
        XMLReader reader(this, in);
 
        return read(reader, system_id);
    }

Referenced by read_buffer().

◆ write()

bool XMLStorage::XMLDoc::write	(	std::ostream &	out,
		WRITE_MODE	mode = `FORMAT_SMART`
	)		const

inline

write XML stream

Definition at line 2800 of file xmlstorage.h.

    {
        _format.print_header(out, mode!=FORMAT_PLAIN);
 
        if (_children.size() == 1)
            _children.front()->write(out, _format, mode);
        else if (!_children.empty()) {
            //throw Exception("more than one XML root!");
            return false;
        }
 
        return out.good();
    }

◆ write_file()

bool XMLStorage::XMLDoc::write_file	(	LPCTSTR	path,
		WRITE_MODE	mode = `FORMAT_SMART`
	)		const

inline

Definition at line 2820 of file xmlstorage.h.

    {
        tofstream out(path);
 
        return write(out, mode);
    }

Referenced by ExplorerGlobals::write_persistent().

◆ write_formating() [1/2]

bool XMLStorage::XMLDoc::write_formating ( LPCTSTR path ) const

inline

Definition at line 2827 of file xmlstorage.h.

    {
        tofstream out(path);
 
        return write_formating(out);
    }

◆ write_formating() [2/2]

bool XMLStorage::XMLDoc::write_formating ( std::ostream & out ) const

inline

write XML stream with formating

Definition at line 2815 of file xmlstorage.h.

    {
        return write(out, FORMAT_PRETTY);
    }

Referenced by write_formating().

Member Data Documentation

◆ _errors

XMLErrorList XMLStorage::XMLDoc::_errors

Definition at line 2835 of file xmlstorage.h.

Referenced by read(), and ExplorerGlobals::read_persistent().

◆ _format

XMLFormat XMLStorage::XMLDoc::_format

Definition at line 2834 of file xmlstorage.h.

Referenced by read(), and write().

The documentation for this struct was generated from the following file:

modules/rosapps/applications/explorer-old/utility/xmlstorage.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XMLDoc() [1/2]

◆ XMLDoc() [2/2]

Member Function Documentation

◆ read()

◆ read_buffer() [1/2]

◆ read_buffer() [2/2]

◆ read_file()

◆ read_stream()

◆ write()

◆ write_file()

◆ write_formating() [1/2]

◆ write_formating() [2/2]

Member Data Documentation

◆ _errors

◆ _format