XMLStorage::XMLWriter Struct Reference

on the fly XML writer More...

#include <xmlstorage.h>

Collaboration diagram for XMLStorage::XMLWriter:

Classes
struct	StackEntry
	container for XMLWriter state information More...

Public Types
enum	WRITESTATE { NOTHING , ATTRIBUTES , PRE_CLOSED , POST }

Public Member Functions
	XMLWriter (std::ostream &out, const XMLFormat &format=XMLFormat())
	XMLWriter (LPCTSTR path, const XMLFormat &format=XMLFormat())
	~XMLWriter ()
void	create (const XS_String &name)
	create node and move to it
bool	back ()
	go back to previous position
void	put (const XS_String &attr_name, const XS_String &value)
	attribute setting
XS_String &	operator[] (const XS_String &attr_name)
	index operator write access to an attribute
void	set_content (const XS_String &s, bool cdata=false)
void	create_node_content (const XS_String &node_name, const XS_String &content)
	create node with string content

Protected Types
typedef XMLNode::AttributeMap	AttrMap

Protected Member Functions
void	close_pre (StackEntry &entry)
void	write_pre (StackEntry &entry)
void	write_attributes (StackEntry &entry)
void	write_post (StackEntry &entry)

Protected Attributes
tofstream *	_pofstream
std::ostream &	_out
XMLFormat	_format
std::stack< StackEntry >	_stack

Static Protected Attributes
static XS_String	s_empty_attr

Detailed Description

on the fly XML writer

Definition at line 2901 of file xmlstorage.h.

Member Typedef Documentation

AttrMap

typedef XMLNode::AttributeMap XMLStorage::XMLWriter::AttrMap

protected

Definition at line 2971 of file xmlstorage.h.

Member Enumeration Documentation

WRITESTATE

enum XMLStorage::XMLWriter::WRITESTATE

Enumerator
NOTHING
ATTRIBUTES
PRE_CLOSED
POST

Definition at line 2962 of file xmlstorage.h.

                    {
        NOTHING, /*PRE,*/ ATTRIBUTES, PRE_CLOSED, /*CONTENT,*/ POST
    };

Constructor & Destructor Documentation

XMLWriter() [1/2]

XMLStorage::XMLWriter::XMLWriter ( std::ostream &  out, const XMLFormat &  format = XMLFormat()  )

inline

Definition at line 2903 of file xmlstorage.h.

     :  _pofstream(NULL),
        _out(out),
        _format(format)
    {
        format.print_header(_out, false);   // _format._endl is printed in write_pre()
    }

XMLWriter() [2/2]

XMLStorage::XMLWriter::XMLWriter ( LPCTSTR  path, const XMLFormat &  format = XMLFormat()  )

inline

Definition at line 2911 of file xmlstorage.h.

     :  _pofstream(new tofstream(path)),
        _out(*_pofstream),
        _format(format)
    {
        format.print_header(_out, false);   // _format._endl is printed in write_pre()
    }

~XMLWriter()

XMLStorage::XMLWriter::~XMLWriter ( )

inline

Definition at line 2919 of file xmlstorage.h.

    {
        _out << _format._endl;
        delete _pofstream;
    }

Member Function Documentation

back()

bool XMLStorage::XMLWriter::back

(

)

go back to previous position

Definition at line 972 of file xmlstorage.cpp.

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

Referenced by create_node_content().

close_pre()

void XMLStorage::XMLWriter::close_pre ( StackEntry &  entry )

protected

Definition at line 983 of file xmlstorage.cpp.

{
    _out << '>';
 
    entry._state = PRE_CLOSED;
}

Referenced by create(), and write_post().

create()

void XMLStorage::XMLWriter::create

(

const XS_String &

name

)

create node and move to it

Definition at line 952 of file xmlstorage.cpp.

{
    if (!_stack.empty()) {
        StackEntry& last = _stack.top();
 
        if (last._state < PRE_CLOSED) {
            write_attributes(last);
            close_pre(last);
        }
 
        ++last._children;
    }
 
    StackEntry entry;
    entry._node_name = name;
    _stack.push(entry);
 
    write_pre(entry);
}

create_node_content()

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

inline

create node with string content

Definition at line 2954 of file xmlstorage.h.

    {
        create(node_name);
            set_content(content);
        back();
    }

operator[]()

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

inline

index operator write access to an attribute

Definition at line 2939 of file xmlstorage.h.

    {
        if (_stack.empty())
            return s_empty_attr;
 
        return _stack.top()._attributes[attr_name];
    }

put()

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

inline

attribute setting

Definition at line 2932 of file xmlstorage.h.

    {
        if (!_stack.empty())
            _stack.top()._attributes[attr_name] = value;
    }

set_content()

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

inline

Definition at line 2947 of file xmlstorage.h.

    {
        if (!_stack.empty())
            _stack.top()._content = EncodeXMLString(s.c_str(), cdata);
    }

Referenced by create_node_content().

write_attributes()

void XMLStorage::XMLWriter::write_attributes ( StackEntry &  entry )

protected

Definition at line 1004 of file xmlstorage.cpp.

{
    for(AttrMap::const_iterator it=entry._attributes.begin(); it!=entry._attributes.end(); ++it)
        _out << ' ' << EncodeXMLString(it->first) << "=\"" << EncodeXMLString(it->second) << "\"";
 
    entry._state = ATTRIBUTES;
}

Referenced by create(), and write_post().

write_post()

void XMLStorage::XMLWriter::write_post ( StackEntry &  entry )

protected

Definition at line 1012 of file xmlstorage.cpp.

{
    if (entry._state < ATTRIBUTES)
        write_attributes(entry);
 
    if (entry._children || !entry._content.empty()) {
        if (entry._state < PRE_CLOSED)
            close_pre(entry);
 
        _out << entry._content;
        //entry._state = CONTENT;
 
        if (_format._pretty>=PRETTY_LINEFEED && entry._content.empty())
            _out << _format._endl;
 
        if (_format._pretty==PRETTY_INDENT && entry._content.empty()) {
            for(size_t i=_stack.size(); --i>0; )
                _out << XML_INDENT_SPACE;
        }
 
        _out << "</" << EncodeXMLString(entry._node_name) << ">";
    } else {
        _out << "/>";
    }
 
    entry._state = POST;
}

Referenced by back().

write_pre()

void XMLStorage::XMLWriter::write_pre ( StackEntry &  entry )

protected

Definition at line 990 of file xmlstorage.cpp.

{
    if (_format._pretty >= PRETTY_LINEFEED)
        _out << _format._endl;
 
    if (_format._pretty == PRETTY_INDENT) {
        for(size_t i=_stack.size(); --i>0; )
            _out << XML_INDENT_SPACE;
    }
 
    _out << '<' << EncodeXMLString(entry._node_name);
    //entry._state = PRE;
}

Referenced by create().

Member Data Documentation

_format

XMLFormat XMLStorage::XMLWriter::_format

protected

Definition at line 2969 of file xmlstorage.h.

Referenced by write_post(), write_pre(), and ~XMLWriter().

_out

std::ostream& XMLStorage::XMLWriter::_out

protected

Definition at line 2968 of file xmlstorage.h.

Referenced by close_pre(), write_attributes(), write_post(), write_pre(), XMLWriter(), and ~XMLWriter().

_pofstream

tofstream* XMLStorage::XMLWriter::_pofstream

protected

Definition at line 2967 of file xmlstorage.h.

Referenced by ~XMLWriter().

_stack

std::stack<StackEntry> XMLStorage::XMLWriter::_stack

protected

Definition at line 2984 of file xmlstorage.h.

Referenced by back(), create(), operator[](), put(), set_content(), write_post(), and write_pre().

s_empty_attr

XS_String XMLStorage::XMLWriter::s_empty_attr

staticprotected

Definition at line 2986 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