XMLStorage::XMLPos Struct Reference

iterator for XML trees More...

#include <xmlstorage.h>

Inheritance diagram for XMLStorage::XMLPos:

Collaboration diagram for XMLStorage::XMLPos:

Public Member Functions
	XMLPos (XMLNode *root)
	XMLPos (const XMLPos &other)
	XMLPos (XMLNode *node, const XS_String &name)
	XMLPos (XMLNode *node, const XS_String &name, const XS_String &attr_name, const XS_String &attr_value)
	XMLPos (const XMLPos &other, const XS_String &name)
	XMLPos (const XMLPos &other, const XS_String &name, const XS_String &attr_name, const XS_String &attr_value)
XMLNode &	cur ()
	access to current node
const XMLNode &	cur () const
	operator const XMLNode * () const
	automatic access to current node
	operator XMLNode * ()
const XMLNode *	operator-> () const
XMLNode *	operator-> ()
const XMLNode &	operator* () const
XMLNode &	operator* ()
XS_String	get (const XS_String &attr_name, LPCXSSTR def=XS_EMPTY_STR) const
	attribute access
void	put (const XS_String &attr_name, const XS_String &value)
	attribute setting
template<typename T >
XS_String	get (const T &attr_name) const
	index operator attribute access
XS_String &	operator[] (const XS_String &attr_name)
const XS_String &	operator[] (const XS_String &attr_name) const
void	add_down (XMLNode *child)
	insert children when building tree
bool	back ()
	go back to previous position
bool	go_down ()
	go down to first child
bool	go_down (const XS_String &child_name, int n=0)
	search for child and go down
bool	iterate (const XS_String &child_name, size_t &cnt)
	iterate to the next matching child
bool	go (const XPath &xpath)
	move to the position defined by xpath in XML tree
bool	create_relative (const XPath &xpath)
	create child nodes using XPath notation and move to the deepest child
void	create (const XS_String &name)
	create node and move to it
void	create_node_content (const XS_String &node_name, const XS_String &content)
	create node with string content
void	smart_create (const XS_String &child_name)
	create node if not already existing and move to it
void	smart_create (const XS_String &child_name, const XS_String &attr_name, const XS_String &attr_value)
	search matching child node identified by key name and an attribute value
int	count (const XPath &xpath) const
	count the nodes matching the given relative XPath expression
int	filter (const XPath &xpath, XMLNode &target) const
	create a new node tree using the given XPath filter expression
bool	delete_this ()
	delete current node and go back to previous position
void	remove_children (const XS_String &name)
	remove all children named 'name'
void	erase (const XS_String &attr_name)
	remove the attribute 'attr_name' from the current node
XS_String &	str ()
const XS_String &	str () const
void	set_property (const XS_String &key, int value, const XS_String &name=XS_PROPERTY)
void	set_property (const XS_String &key, double value, const XS_String &name=XS_PROPERTY)
void	set_property (const XS_String &key, const XS_String &value, const XS_String &name=XS_PROPERTY)
void	set_property (const XS_String &key, const struct XMLBool &value, const XS_String &name=XS_PROPERTY)
void	set_property (const XS_String &key, const char *value, const XS_String &name=XS_PROPERTY)

Protected Member Functions
void	go_to (XMLNode *child)
	go to specified node

Protected Attributes
XMLNode *	_root
XMLNode *	_cur
std::stack< XMLNode * >	_stack

Friends
struct	const_XMLPos

Detailed Description

iterator for XML trees

Definition at line 1493 of file xmlstorage.h.

Constructor & Destructor Documentation

XMLPos() [1/6]

XMLStorage::XMLPos::XMLPos ( XMLNode *  root )

inline

Definition at line 1495 of file xmlstorage.h.

     :  _root(root),
        _cur(root)
    {
    }

XMLPos() [2/6]

XMLStorage::XMLPos::XMLPos ( const XMLPos &  other )

inline

Definition at line 1501 of file xmlstorage.h.

     :  _root(other._root),
        _cur(other._cur)
    {   // don't copy _stack
    }

XMLPos() [3/6]

XMLStorage::XMLPos::XMLPos ( XMLNode *  node, const XS_String &  name  )

inline

Definition at line 1507 of file xmlstorage.h.

     :  _root(node),
        _cur(node)
    {
        smart_create(name);
    }

XMLPos() [4/6]

XMLStorage::XMLPos::XMLPos ( XMLNode *  node, const XS_String &  name, const XS_String &  attr_name, const XS_String &  attr_value  )

inline

Definition at line 1514 of file xmlstorage.h.

     :  _root(node),
        _cur(node)
    {
        smart_create(name, attr_name, attr_value);
    }

XMLPos() [5/6]

XMLStorage::XMLPos::XMLPos ( const XMLPos &  other, const XS_String &  name  )

inline

Definition at line 1521 of file xmlstorage.h.

     :  _root(other._root),
        _cur(other._cur)
    {
        smart_create(name);
    }

XMLPos() [6/6]

XMLStorage::XMLPos::XMLPos ( const XMLPos &  other, const XS_String &  name, const XS_String &  attr_name, const XS_String &  attr_value  )

inline

Definition at line 1528 of file xmlstorage.h.

     :  _root(other._root),
        _cur(other._cur)
    {
        smart_create(name, attr_name, attr_value);
    }

Member Function Documentation

add_down()

void XMLStorage::XMLPos::add_down ( XMLNode *  child )

inline

insert children when building tree

Definition at line 1574 of file xmlstorage.h.

    {
        _cur->add_child(child);
        go_to(child);
    }

Referenced by create(), smart_create(), and XMLStorage::XMLReaderBase::StartElementHandler().

back()

bool XMLStorage::XMLPos::back ( )

inline

go back to previous position

Definition at line 1581 of file xmlstorage.h.

    {
        if (!_stack.empty()) {
            _cur = _stack.top();
            _stack.pop();
            return true;
        } else
            return false;
    }

Referenced by XMLStorage::XMLReaderBase::EndElementHandler(), and set_property().

count()

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

inline

count the nodes matching the given relative XPath expression

Definition at line 1682 of file xmlstorage.h.

    {
        return _cur->count(xpath);
    }

create()

void XMLStorage::XMLPos::create ( const XS_String &  name )

inline

create node and move to it

Definition at line 1643 of file xmlstorage.h.

    {
        add_down(new XMLNode(name));
    }

Referenced by XMLStorage::XMLMessage::XMLMessage().

create_node_content()

void XMLStorage::XMLPos::create_node_content ( const XS_String &  node_name, const XS_String &  content  )

inline

create node with string content

Definition at line 1649 of file xmlstorage.h.

    {
        XMLNode* pNode = new XMLNode(node_name);
            pNode->set_content(content);
        _cur->add_child(pNode);
    }

create_relative()

bool XMLStorage::XMLPos::create_relative ( const XPath &  xpath )

inline

create child nodes using XPath notation and move to the deepest child

Definition at line 1632 of file xmlstorage.h.

    {
        XMLNode* node = _cur->create_relative(xpath);
        if (!node)
            return false;   // invalid path specified
 
        go_to(node);
        return true;
    }

Referenced by ExplorerGlobals::get_cfg().

cur() [1/2]

XMLNode & XMLStorage::XMLPos::cur ( )

inline

access to current node

Definition at line 1536 of file xmlstorage.h.

    {
        return *_cur;
    }

cur() [2/2]

const XMLNode & XMLStorage::XMLPos::cur ( ) const

inline

Definition at line 1541 of file xmlstorage.h.

    {
        return *_cur;
    }

delete_this()

bool XMLStorage::XMLPos::delete_this ( )

inline

delete current node and go back to previous position

Definition at line 1740 of file xmlstorage.h.

    {
        if (!_stack.empty()) {
            XMLNode* pLast = _stack.top();
 
            if (pLast->_children.remove(_cur)) {
                _cur = _stack.top();
                return true;
            }
        }
 
        return false;
    }

erase()

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

inline

remove the attribute 'attr_name' from the current node

Definition at line 1761 of file xmlstorage.h.

    {
        _cur->erase(attr_name);
    }

filter()

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

inline

create a new node tree using the given XPath filter expression

Definition at line 1688 of file xmlstorage.h.

    {
        return _cur->filter(xpath, target);
    }

get() [1/2]

template<typename T >

XS_String XMLStorage::XMLPos::get ( const T &  attr_name ) const

inline

index operator attribute access

Definition at line 1569 of file xmlstorage.h.

{return (*_cur)[attr_name];}

get() [2/2]

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

inline

attribute access

Definition at line 1557 of file xmlstorage.h.

    {
        return _cur->get(attr_name, def);
    }

go()

bool XMLStorage::XMLPos::go

(

const XPath &

xpath

)

move to the position defined by xpath in XML tree

Definition at line 114 of file xmlstorage.cpp.

{
    XMLNode* node = xpath._absolute? _root: _cur;
 
    node = node->find_relative(xpath);
 
    if (node) {
        go_to(node);
        return true;
    } else
        return false;
}

go_down() [1/2]

bool XMLStorage::XMLPos::go_down ( )

inline

go down to first child

Definition at line 1592 of file xmlstorage.h.

    {
        XMLNode* node = _cur->get_first_child();
 
        if (node) {
            go_to(node);
            return true;
        } else
            return false;
    }

go_down() [2/2]

bool XMLStorage::XMLPos::go_down ( const XS_String &  child_name, int  n = 0  )

inline

search for child and go down

Definition at line 1604 of file xmlstorage.h.

    {
        XMLNode* node = XPathElement(child_name, n).find(_cur);
 
        if (node) {
            go_to(node);
            return true;
        } else
            return false;
    }

go_to()

void XMLStorage::XMLPos::go_to ( XMLNode *  child )

inlineprotected

go to specified node

Definition at line 1786 of file xmlstorage.h.

    {
        _stack.push(_cur);
        _cur = child;
    }

Referenced by add_down(), create_relative(), go(), go_down(), iterate(), and smart_create().

iterate()

bool XMLStorage::XMLPos::iterate ( const XS_String &  child_name, size_t &  cnt  )

inline

iterate to the next matching child

Definition at line 1616 of file xmlstorage.h.

    {
        XMLNode* node = XPathElement(child_name, cnt).find(_cur);
 
        if (node) {
            go_to(node);
            ++cnt;
            return true;
        } else
            return false;
    }

operator const XMLNode *()

XMLStorage::XMLPos::operator const XMLNode * ( ) const

inline

automatic access to current node

Definition at line 1547 of file xmlstorage.h.

{return _cur;}

operator XMLNode *()

XMLStorage::XMLPos::operator XMLNode * ( )

inline

Definition at line 1548 of file xmlstorage.h.

{return _cur;}

operator*() [1/2]

XMLNode & XMLStorage::XMLPos::operator* ( )

inline

Definition at line 1554 of file xmlstorage.h.

{return *_cur;}

operator*() [2/2]

const XMLNode & XMLStorage::XMLPos::operator* ( ) const

inline

Definition at line 1553 of file xmlstorage.h.

{return *_cur;}

operator->() [1/2]

XMLNode * XMLStorage::XMLPos::operator-> ( )

inline

Definition at line 1551 of file xmlstorage.h.

{return _cur;}

operator->() [2/2]

const XMLNode * XMLStorage::XMLPos::operator-> ( ) const

inline

Definition at line 1550 of file xmlstorage.h.

{return _cur;}

operator[]() [1/2]

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

inline

Definition at line 1570 of file xmlstorage.h.

{return (*_cur)[attr_name];}

operator[]() [2/2]

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

inline

Definition at line 1571 of file xmlstorage.h.

{return (*_cur)[attr_name];}

put()

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

inline

attribute setting

Definition at line 1563 of file xmlstorage.h.

    {
        _cur->put(attr_name, value);
    }

remove_children()

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

inline

remove all children named 'name'

Definition at line 1755 of file xmlstorage.h.

    {
        _cur->remove_children(name);
    }

set_property() [1/5]

void XMLStorage::XMLPos::set_property ( const XS_String &  key, const char *  value, const XS_String &  name = XS_PROPERTY  )

inline

Definition at line 1775 of file xmlstorage.h.

        {set_property(key, XS_String(value), name);}

set_property() [2/5]

void XMLStorage::XMLPos::set_property	(	const XS_String &	key,
		const struct XMLBool &	value,
		const XS_String &	name = XS_PROPERTY
	)

set_property() [3/5]

void XMLStorage::XMLPos::set_property ( const XS_String &  key, const XS_String &  value, const XS_String &  name = XS_PROPERTY  )

inline

Definition at line 2288 of file xmlstorage.h.

{
    smart_create(name, XS_KEY, key);
        put(XS_VALUE, value);
    back();
}

set_property() [4/5]

void XMLStorage::XMLPos::set_property ( const XS_String &  key, double  value, const XS_String &  name = XS_PROPERTY  )

inline

Definition at line 2281 of file xmlstorage.h.

{
    smart_create(name, XS_KEY, key);
        XMLDoubleRef(_cur, XS_VALUE) = value;
    back();
}

set_property() [5/5]

void XMLStorage::XMLPos::set_property ( const XS_String &  key, int  value, const XS_String &  name = XS_PROPERTY  )

inline

Definition at line 2274 of file xmlstorage.h.

{
    smart_create(name, XS_KEY, key);
        XMLIntRef(_cur, XS_VALUE) = value;
    back();
}

Referenced by set_property().

smart_create() [1/2]

void XMLStorage::XMLPos::smart_create ( const XS_String &  child_name )

inline

create node if not already existing and move to it

Definition at line 1657 of file xmlstorage.h.

    {
        XMLNode* node = XPathElement(child_name).find(_cur);
 
        if (node)
            go_to(node);
        else
            add_down(new XMLNode(child_name));
    }

Referenced by ExplorerGlobals::get_cfg(), set_property(), and XMLPos().

smart_create() [2/2]

void XMLStorage::XMLPos::smart_create ( const XS_String &  child_name, const XS_String &  attr_name, const XS_String &  attr_value  )

inline

search matching child node identified by key name and an attribute value

Definition at line 1668 of file xmlstorage.h.

    {
        XMLNode* node = XPathElement(child_name, 0, attr_name, attr_value).find(_cur);
 
        if (node)
            go_to(node);
        else {
            node = new XMLNode(child_name);
            add_down(node);
            (*node)[attr_name] = attr_value;
        }
    }

str() [1/2]

XS_String & XMLStorage::XMLPos::str ( )

inline

Definition at line 1766 of file xmlstorage.h.

{return *_cur;}

str() [2/2]

const XS_String & XMLStorage::XMLPos::str ( ) const

inline

Definition at line 1767 of file xmlstorage.h.

{return *_cur;}

Friends And Related Function Documentation

const_XMLPos

friend struct const_XMLPos

friend

Definition at line 1779 of file xmlstorage.h.

Member Data Documentation

_cur

XMLNode* XMLStorage::XMLPos::_cur

protected

Definition at line 1782 of file xmlstorage.h.

Referenced by add_down(), back(), count(), create_node_content(), create_relative(), cur(), delete_this(), erase(), filter(), get(), go(), go_down(), go_to(), iterate(), operator const XMLNode *(), operator XMLNode *(), operator*(), operator->(), operator[](), put(), remove_children(), set_property(), smart_create(), and str().

_root

XMLNode* XMLStorage::XMLPos::_root

protected

Definition at line 1781 of file xmlstorage.h.

Referenced by go().

_stack

std::stack<XMLNode*> XMLStorage::XMLPos::_stack

protected

Definition at line 1783 of file xmlstorage.h.

Referenced by back(), delete_this(), and go_to().

---

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