XMLStorage::XMLNode Struct Reference

in memory representation of an XML node More...

#include <xmlstorage.h>

Inheritance diagram for XMLStorage::XMLNode:

Collaboration diagram for XMLStorage::XMLNode:

Classes
struct	AttributeMap
	map of XML node attributes More...
struct	Children
	internal children node list More...

Public Types
enum	COPY_FLAGS { COPY_NOCHILDREN }
Public Types inherited from XMLStorage::XS_String
typedef std::string	super

Public Member Functions
	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 More...
void	remove_children (const XS_String &name)
	remove all children named 'name' More...
void	put (const XS_String &attr_name, const XS_String &value)
	write access to an attribute More...
XS_String &	operator[] (const XS_String &attr_name)
	index operator write access to an attribute More...
template<typename T >
XS_String	get (const T &attr_name, LPCXSSTR def=XS_EMPTY_STR) const
	read only access to an attribute More...
void	erase (const XS_String &attr_name)
	remove the attribute 'attr_name' More...
XS_String	subvalue (const XS_String &child_name, const XS_String &attr_name, int n=0) const
	convenient value access in children node More...
XS_String &	subvalue (const XS_String &child_name, const XS_String &attr_name, int n=0)
	convenient storage of distinct values in children node More...
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 More...
XS_String	get_sub_content (const XPath &xpath) const
	read content of a subnode specified by an XPath expression More...
void	set_content (const XS_String &s, bool cdata=false)
	set element node content More...
bool	set_sub_content (const XPath &xpath, const XS_String &s, bool cdata=false)
	set content of a subnode specified by an XPath expression More...
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 More...
int	count (const XPath &xpath) const
	count the nodes matching the given relative XPath expression More...
int	count (XPath::const_iterator from, const XPath::const_iterator &to) const
	count the nodes matching the given relative XPath expression More...
bool	filter (const XPath &xpath, XMLNode &target) const
	copy matching tree nodes using the given XPath filter expression More...
const XMLNode *	find_relative (const XPath &xpath) const
	XPath find function (const) More...
XMLNode *	find_relative (const XPath &xpath)
	XPath find function. More...
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)

Protected Member Functions
XMLNode *	create_relative (const XPath &xpath)
	relative XPath create function More...
XMLNode *	filter (XPath::const_iterator from, const XPath::const_iterator &to) const
	create a new node tree using the given XPath filter expression More...
void	original_write_worker (std::ostream &out) const
	write node with children tree to output stream using original white space More...
void	plain_write_worker (std::ostream &out) const
	print node without any white space More...
void	pretty_write_worker (std::ostream &out, const XMLFormat &format, int indent) const
	pretty print node with children tree to output stream More...
void	smart_write_worker (std::ostream &out, const XMLFormat &format, int indent) const
	write node with children tree to output stream using smart formating More...

Protected Attributes
Children	_children
AttributeMap	_attributes
std::string	_leading
std::string	_content
std::string	_end_leading
std::string	_trailing
bool	_cdata_content

Friends
struct	XMLPos
struct	const_XMLPos
struct	XMLReaderBase
struct	XPathElement

Detailed Description

in memory representation of an XML node

Definition at line 854 of file xmlstorage.h.

Member Enumeration Documentation

COPY_FLAGS

enum XMLStorage::XMLNode::COPY_FLAGS

Enumerator
COPY_NOCHILDREN

Definition at line 1013 of file xmlstorage.h.

{COPY_NOCHILDREN};

Constructor & Destructor Documentation

XMLNode() [1/4]

XMLStorage::XMLNode::XMLNode ( const XS_String &  name )

inline

Definition at line 984 of file xmlstorage.h.

     :  XS_String(name),
        _cdata_content(false)
    {
    }

XMLNode() [2/4]

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

inline

Definition at line 990 of file xmlstorage.h.

     :  XS_String(name),
        _leading(leading),
        _cdata_content(false)
    {
    }

XMLNode() [3/4]

XMLStorage::XMLNode::XMLNode ( const XMLNode &  other )

inline

Definition at line 997 of file xmlstorage.h.

     :  XS_String(other),
        _attributes(other._attributes),
        _leading(other._leading),
        _content(other._content),
        _end_leading(other._end_leading),
        _trailing(other._trailing),
#ifdef XMLNODE_LOCATION
        _location(other._location),
#endif
        _cdata_content(false)
    {
        for(Children::const_iterator it=other._children.begin(); it!=other._children.end(); ++it)
            _children.push_back(new XMLNode(**it));
    }

XMLNode() [4/4]

XMLStorage::XMLNode::XMLNode ( const XMLNode &  other, COPY_FLAGS  copy_no_children  )

inline

Definition at line 1015 of file xmlstorage.h.

     :  XS_String(other),
        _attributes(other._attributes),
        _leading(other._leading),
        _content(other._content),
        _end_leading(other._end_leading),
        _trailing(other._trailing),
#ifdef XMLNODE_LOCATION
        _location(other._location),
#endif
        _cdata_content(false)
    {
//      assert(copy_no_children==COPY_NOCHILDREN);
    }

~XMLNode()

virtual XMLStorage::XMLNode::~XMLNode ( )

inlinevirtual

Definition at line 1030 of file xmlstorage.h.

    {
        while(!_children.empty()) {
            delete _children.back();
            _children.pop_back();
        }
    }

Member Function Documentation

add_child()

void XMLStorage::XMLNode::add_child ( XMLNode *  child )

inline

add a new child node

Definition at line 1067 of file xmlstorage.h.

Referenced by create_relative(), and filter().

    {
        _children.push_back(child);
    }

clear()

void XMLStorage::XMLNode::clear ( void  )

inline

Definition at line 1038 of file xmlstorage.h.

Referenced by XMLStorage::XMLNode::Children::clear(), and operator=().

    {
        _leading.erase();
        _content.erase();
        _end_leading.erase();
        _trailing.erase();

        _attributes.clear();
        _children.clear();

        XS_String::erase();
    }

count() [1/2]

int XMLStorage::XMLNode::count ( const XPath &  xpath ) const

inline

count the nodes matching the given relative XPath expression

Definition at line 1244 of file xmlstorage.h.

    {
        return count(xpath.begin(), xpath.end());
    }

count() [2/2]

int XMLStorage::XMLNode::count	(	XPath::const_iterator	from,
		const XPath::const_iterator &	to
	)		const

count the nodes matching the given relative XPath expression

Definition at line 301 of file xmlstorage.cpp.

{
    const XPathElement& elem = *from++;
    int cnt = 0;
    int n = 0;

    for(XMLNode::Children::const_iterator it=_children.begin(); it!=_children.end(); ++it)
        if (elem.matches(**it, n)) {
            if (from != to)
                 // iterate deeper
                cnt += (*it)->count(from, to);
            else
                 // increment match counter
                ++cnt;
        }

    return cnt;
}

create_relative()

XMLNode * XMLStorage::XMLNode::create_relative ( const XPath &  xpath )

protected

relative XPath create function

Definition at line 279 of file xmlstorage.cpp.

{
    XMLNode* node = this;

    for(XPath::const_iterator it=xpath.begin(); it!=xpath.end(); ++it) {
        XMLNode* child = it->find(node);

        if (!child) {
            child = new XMLNode(it->_child_name);
            node->add_child(child);

            if (!it->_attr_name.empty())
                (*this)[it->_attr_name] = it->_attr_value;
        }

        node = child;
    }

    return node;
}

erase()

void XMLStorage::XMLNode::erase ( const XS_String &  attr_name )

inline

remove the attribute 'attr_name'

Definition at line 1106 of file xmlstorage.h.

    {
        _attributes.erase(attr_name);
    }

filter() [1/2]

bool XMLStorage::XMLNode::filter	(	const XPath &	xpath,
		XMLNode &	target
	)		const

copy matching tree nodes using the given XPath filter expression

Definition at line 321 of file xmlstorage.cpp.

{
    XMLNode* ret = filter(xpath.begin(), xpath.end());

    if (ret) {
         // move returned nodes to target node
        target._children.move(ret->_children);
        target._attributes = ret->_attributes;

        delete ret;

        return true;
    } else
        return false;
}

filter() [2/2]

XMLNode * XMLStorage::XMLNode::filter ( XPath::const_iterator  from, const XPath::const_iterator &  to  ) const

protected

create a new node tree using the given XPath filter expression

Definition at line 338 of file xmlstorage.cpp.

{
    XMLNode* copy = NULL;

    const XPathElement& elem = *from++;
    int cnt = 0;
    int n = 0;

    for(XMLNode::Children::const_iterator it=_children.begin(); it!=_children.end(); ++it)
        if (elem.matches(**it, n)) {
            if (!copy)
                copy = new XMLNode(*this, XMLNode::COPY_NOCHILDREN);

            if (from != to) {
                XMLNode* ret = (*it)->filter(from, to);

                if (ret) {
                    copy->add_child(ret);
                    ++cnt;
                }
            } else {
                copy->add_child(new XMLNode(**it, XMLNode::COPY_NOCHILDREN));
                ++cnt;
            }
        }

    if (cnt > 0) {
        return copy;
    } else {
        delete copy;
        return NULL;
    }
}

find_relative() [1/2]

const XMLNode * XMLStorage::XMLNode::find_relative

(

const XPath &

xpath

)

const

XPath find function (const)

Definition at line 251 of file xmlstorage.cpp.

Referenced by XMLStorage::XMLPos::go(), and XMLStorage::const_XMLPos::go().

{
    const XMLNode* node = this;

    for(XPath::const_iterator it=xpath.begin(); it!=xpath.end(); ++it) {
        node = it->const_find(node);

        if (!node)
            return NULL;
    }

    return node;
}

find_relative() [2/2]

XMLNode * XMLStorage::XMLNode::find_relative

(

const XPath &

xpath

)

XPath find function.

Definition at line 265 of file xmlstorage.cpp.

{
    XMLNode* node = this;

    for(XPath::const_iterator it=xpath.begin(); it!=xpath.end(); ++it) {
        node = it->find(node);

        if (!node)
            return NULL;
    }

    return node;
}

get()

template<typename T >

XS_String XMLStorage::XMLNode::get ( const T &  attr_name, LPCXSSTR  def = XS_EMPTY_STR  ) const

inline

read only access to an attribute

Definition at line 1095 of file xmlstorage.h.

Referenced by XMLStorage::XPathElement::matches(), subvalue(), XMLStorage::XMLBool::XMLBool(), XMLStorage::XMLDouble::XMLDouble(), XMLStorage::XMLInt::XMLInt(), and XMLStorage::XMLString::XMLString().

    {
        AttributeMap::const_iterator found = _attributes.find(attr_name);

        if (found != _attributes.end())
            return found->second;
        else
            return def;
    }

get_attributes() [1/2]

const AttributeMap& XMLStorage::XMLNode::get_attributes ( ) const

inline

Definition at line 1171 of file xmlstorage.h.

    {
        return _attributes;
    }

get_attributes() [2/2]

AttributeMap& XMLStorage::XMLNode::get_attributes ( )

inline

Definition at line 1176 of file xmlstorage.h.

    {
        return _attributes;
    }

get_children() [1/2]

const Children& XMLStorage::XMLNode::get_children ( ) const

inline

Definition at line 1161 of file xmlstorage.h.

    {
        return _children;
    }

get_children() [2/2]

Children& XMLStorage::XMLNode::get_children ( )

inline

Definition at line 1166 of file xmlstorage.h.

    {
        return _children;
    }

get_content()

XS_String XMLStorage::XMLNode::get_content ( ) const

inline

read element node content

Definition at line 1182 of file xmlstorage.h.

Referenced by get_sub_content().

    {
        return DecodeXMLString(_content);
    }

get_first_child()

XMLNode* XMLStorage::XMLNode::get_first_child ( ) const

inline

Definition at line 1261 of file xmlstorage.h.

    {
        if (!_children.empty())
            return _children.front();
        else
            return NULL;
    }

get_sub_content()

XS_String XMLStorage::XMLNode::get_sub_content ( const XPath &  xpath ) const

inline

read content of a subnode specified by an XPath expression

Definition at line 1188 of file xmlstorage.h.

    {
        const XMLNode* node = find_relative(xpath);

        if (node)
            return node->get_content();
        else
            return XS_EMPTY_STR;
    }

operator=()

XMLNode& XMLStorage::XMLNode::operator= ( const XMLNode &  other )

inline

Definition at line 1051 of file xmlstorage.h.

    {
        _children.clear();
        _children.copy(other._children);

        _attributes = other._attributes;

        _leading = other._leading;
        _content = other._content;
        _end_leading = other._end_leading;
        _trailing = other._trailing;

        return *this;
    }

operator[]()

XS_String& XMLStorage::XMLNode::operator[] ( const XS_String &  attr_name )

inline

index operator write access to an attribute

Definition at line 1089 of file xmlstorage.h.

    {
        return _attributes[attr_name];
    }

original_write_worker()

void XMLStorage::XMLNode::original_write_worker ( std::ostream &  out ) const

protected

write node with children tree to output stream using original white space

Definition at line 528 of file xmlstorage.cpp.

{
    out << _leading << '<' << EncodeXMLString(*this);

    for(AttributeMap::const_iterator it=_attributes.begin(); it!=_attributes.end(); ++it)
        out << ' ' << EncodeXMLString(it->first) << "=\"" << EncodeXMLString(it->second) << "\"";

    if (!_children.empty() || !_content.empty()) {
        out << '>';

        if (_cdata_content)
            out << CDATA_START << _content << CDATA_END;
        else
            out << _content;

        for(Children::const_iterator it=_children.begin(); it!=_children.end(); ++it)
            (*it)->original_write_worker(out);

        out << _end_leading << "</" << EncodeXMLString(*this) << '>';
    } else
        out << "/>";

    out << _trailing;
}

plain_write_worker()

void XMLStorage::XMLNode::plain_write_worker ( std::ostream &  out ) const

protected

print node without any white space

Definition at line 555 of file xmlstorage.cpp.

{
    out << '<' << EncodeXMLString(*this);

    for(AttributeMap::const_iterator it=_attributes.begin(); it!=_attributes.end(); ++it)
        out << ' ' << EncodeXMLString(it->first) << "=\"" << EncodeXMLString(it->second) << "\"";

     // strip leading white space from content
    const char* content = _content.c_str();
    while(isspace((unsigned char)*content)) ++content;

    if (!_children.empty() || *content) {
        out << ">" << content;

        for(Children::const_iterator it=_children.begin(); it!=_children.end(); ++it)
            (*it)->plain_write_worker(out);

        out << "</" << EncodeXMLString(*this) << ">";
    } else
        out << "/>";
}

pretty_write_worker()

void XMLStorage::XMLNode::pretty_write_worker ( std::ostream &  out, const XMLFormat &  format, int  indent  ) const

protected

pretty print node with children tree to output stream

Definition at line 579 of file xmlstorage.cpp.

{
    for(int i=indent; i--; )
        out << XML_INDENT_SPACE;

    out << '<' << EncodeXMLString(*this);

    for(AttributeMap::const_iterator it=_attributes.begin(); it!=_attributes.end(); ++it)
        out << ' ' << EncodeXMLString(it->first) << "=\"" << EncodeXMLString(it->second) << "\"";

     // strip leading white space from content
    const char* content = _content.c_str();
    while(isspace((unsigned char)*content)) ++content;

    if (!_children.empty() || *content) {
        out << '>' << content;

        if (!_children.empty())
            out << format._endl;

        for(Children::const_iterator it=_children.begin(); it!=_children.end(); ++it)
            (*it)->pretty_write_worker(out, format, indent+1);

        for(int i=indent; i--; )
            out << XML_INDENT_SPACE;

        out << "</" << EncodeXMLString(*this) << '>' << format._endl;
    } else
        out << "/>" << format._endl;
}

put()

void XMLStorage::XMLNode::put ( const XS_String &  attr_name, const XS_String &  value  )

inline

write access to an attribute

Definition at line 1083 of file xmlstorage.h.

    {
        _attributes[attr_name] = value;
    }

remove_children()

void XMLStorage::XMLNode::remove_children ( const XS_String &  name )

inline

remove all children named 'name'

Definition at line 1073 of file xmlstorage.h.

    {
        Children::iterator it, next=_children.begin();

        while((it=next++) != _children.end())
            if (**it == name)
                _children.erase(it);
    }

set_content()

void XMLStorage::XMLNode::set_content ( const XS_String &  s, bool  cdata = false  )

inline

set element node content

Definition at line 1199 of file xmlstorage.h.

Referenced by XMLStorage::XMLPos::create_node_content(), and set_sub_content().

    {
        _content.assign(EncodeXMLString(s.c_str(), cdata));
    }

set_sub_content()

bool XMLStorage::XMLNode::set_sub_content ( const XPath &  xpath, const XS_String &  s, bool  cdata = false  )

inline

set content of a subnode specified by an XPath expression

Definition at line 1205 of file xmlstorage.h.

    {
        XMLNode* node = create_relative(xpath);

        if (node) {
            node->set_content(s, cdata);
            return true;
        } else
            return false;
    }

smart_write_worker()

void XMLStorage::XMLNode::smart_write_worker ( std::ostream &  out, const XMLFormat &  format, int  indent  ) const

protected

write node with children tree to output stream using smart formating

Definition at line 612 of file xmlstorage.cpp.

{
     // strip the first line feed from _leading
    const char* leading = _leading.c_str();
    if (*leading == '\n') ++leading;

    if (!*leading)
        for(int i=indent; i--; )
            out << XML_INDENT_SPACE;
    else
        out << leading;

    out << '<' << EncodeXMLString(*this);

    for(AttributeMap::const_iterator it=_attributes.begin(); it!=_attributes.end(); ++it)
        out << ' ' << EncodeXMLString(it->first) << "=\"" << EncodeXMLString(it->second) << "\"";

     // strip leading white space from content
    const char* content = _content.c_str();
    while(isspace((unsigned char)*content)) ++content;

    if (_children.empty() && !*content)
        out << "/>";
    else {
        out << '>';

        if (_cdata_content)
            out << CDATA_START << _content << CDATA_END;
        else if (!*content)
            out << format._endl;
        else
            out << content;

        Children::const_iterator it = _children.begin();

        if (it != _children.end()) {
            for(; it!=_children.end(); ++it)
                (*it)->smart_write_worker(out, format, indent+1);

             // strip the first line feed from _end_leading
            const char* end_leading = _end_leading.c_str();
            if (*end_leading == '\n') ++end_leading;

            if (!*end_leading)
                for(int i=indent; i--; )
                    out << XML_INDENT_SPACE;
            else
                out << end_leading;
        } else
            out << _end_leading;

        out << "</" << EncodeXMLString(*this) << '>';
    }

    if (_trailing.empty())
        out << format._endl;
    else
        out << _trailing;
}

subvalue() [1/2]

XS_String XMLStorage::XMLNode::subvalue ( const XS_String &  child_name, const XS_String &  attr_name, int  n = 0  ) const

inline

convenient value access in children node

Definition at line 1112 of file xmlstorage.h.

    {
        const XMLNode* node = XPathElement(child_name, n).const_find(this);

        if (node)
            return node->get(attr_name);
        else
            return XS_String();
    }

subvalue() [2/2]

XS_String& XMLStorage::XMLNode::subvalue ( const XS_String &  child_name, const XS_String &  attr_name, int  n = 0  )

inline

convenient storage of distinct values in children node

Definition at line 1123 of file xmlstorage.h.

    {
        XMLNode* node = XPathElement(child_name, n).find(this);

        if (!node) {
            node = new XMLNode(child_name);
            add_child(node);
        }

        return (*node)[attr_name];
    }

write()

bool XMLStorage::XMLNode::write ( std::ostream &  out, const XMLFormat &  format, WRITE_MODE  mode = FORMAT_SMART, int  indent = 0  ) const

inline

write node with children tree to output stream

Definition at line 1221 of file xmlstorage.h.

    {
        switch(mode) {
          case FORMAT_PLAIN:
            plain_write_worker(out);
            break;

          case FORMAT_PRETTY:
            pretty_write_worker(out, format, indent);
            break;

          case FORMAT_ORIGINAL:
            original_write_worker(out);
            break;

          default:  // FORMAT_SMART
            smart_write_worker(out, format, indent);
        }

        return out.good();
    }

Friends And Related Function Documentation

const_XMLPos

friend struct const_XMLPos

friend

Definition at line 980 of file xmlstorage.h.

XMLPos

friend struct XMLPos

friend

Definition at line 979 of file xmlstorage.h.

XMLReaderBase

friend struct XMLReaderBase

friend

Definition at line 981 of file xmlstorage.h.

XPathElement

friend struct XPathElement

friend

Definition at line 982 of file xmlstorage.h.

Member Data Documentation

_attributes

AttributeMap XMLStorage::XMLNode::_attributes

protected

Definition at line 1271 of file xmlstorage.h.

Referenced by filter(), operator=(), and XMLStorage::XMLReaderBase::StartElementHandler().

_cdata_content

bool XMLStorage::XMLNode::_cdata_content

protected

Definition at line 1282 of file xmlstorage.h.

_children

Children XMLStorage::XMLNode::_children

protected

Definition at line 1270 of file xmlstorage.h.

Referenced by XMLStorage::XPathElement::const_find(), XMLStorage::XMLPos::delete_this(), filter(), XMLStorage::XPathElement::find(), operator=(), and XMLNode().

_content

std::string XMLStorage::XMLNode::_content

protected

Definition at line 1274 of file xmlstorage.h.

Referenced by operator=().

_end_leading

std::string XMLStorage::XMLNode::_end_leading

protected

Definition at line 1275 of file xmlstorage.h.

Referenced by operator=().

_leading

std::string XMLStorage::XMLNode::_leading

protected

Definition at line 1273 of file xmlstorage.h.

Referenced by operator=().

_trailing

std::string XMLStorage::XMLNode::_trailing

protected

Definition at line 1276 of file xmlstorage.h.

Referenced by operator=().

---

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

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