OW_XMLNode.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_XMLNODE_HPP_INCLUDE_GUARD_
#define OW_XMLNODE_HPP_INCLUDE_GUARD_

#include "OW_config.h"
#include "OW_IntrusiveReference.hpp"
#include "OW_IntrusiveCountableBase.hpp"
#include "OW_XMLAttribute.hpp"
#include "OW_XMLFwd.hpp"

#include <iosfwd>

namespace OW_NAMESPACE
{

class XMLNodeImpl;

typedef IntrusiveReference<XMLNodeImpl> XMLNodeImplRef;

class OW_XML_API XMLNode
{
public:
   
   XMLNode(const String& name, const XMLAttributeArray& attrArray);
   
   XMLNode(const String& name);

   XMLNode();

   XMLNode(const XMLNode& arg);

   XMLNode& operator= (const XMLNode & arg);


   ~XMLNode();

   void setToNULL();

   String getName() const;
   
   void assignText(const String& text) const;

   void appendText(const String& text) const;
   
   String getAttribute(const String& name) const;
   
   void addAttribute(const XMLAttribute& attr) const;
   
   String mustGetAttribute(const String& name) const;
   
   XMLAttributeArray getAttrs() const;
   
   String getText() const;
   
   XMLNode findElement(const char* elementName) const;
   
   XMLNode mustFindElement(const char* elementName) const;
   
   XMLNode nextElement(const char* elementName);
   
   XMLNode mustNextElement(const char* elementName) const;
   
   void mustElement(const char* elementName) const;
   
   XMLNode mustElementChild(const char* elementName) const;
   
   XMLNode mustChildElement(const char* elementName) const;
   
   XMLNode mustChildElementChild(const char* elementName) const;
   
   XMLNode mustChildFindElement(const char* elementName) const;
   
   XMLNode findElementChild(const char* elementName) const;
   
   XMLNode mustFindElementChild(const char* elementName) const;
   
   XMLNode mustChildFindElementChild(const char* elementName) const;
   
   void setNext(const XMLNode& node) const;
   
   XMLNode getNext() const;
   
   void addChild(const XMLNode& node) const;
   
   XMLNode getChild() const;

   XMLNode mustGetChild() const;

   XMLNodeArray getChildren() const;

   void printNode( std::ostream& ostr ) const;

   String toString() const;

   typedef XMLNodeImplRef XMLNode::*safe_bool;
   operator safe_bool () const
      {  return (m_impl) ? &XMLNode::m_impl : 0; }
   bool operator!() const
      {  return !m_impl; }


private:

   XMLNode(const XMLNodeImplRef& ref);

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   XMLNodeImplRef m_impl;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   friend class XMLNodeImpl;
};

OW_XML_API std::ostream& operator<<(std::ostream& ostr, const XMLNode& node);

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

class OW_XML_API XMLNodeImpl : public IntrusiveCountableBase
{
public:
   XMLNodeImpl(const String& name, const XMLAttributeArray& attrArray);
   XMLNodeImpl(const String& name);
   XMLNodeImpl();
   String getNodeName() const;
   void assignText(const String& text);
   void appendText(const String& text);
   String getAttribute(const String& name, bool throwException = false) const;
   void addAttribute(const XMLAttribute& attr);
   XMLAttributeArray getAttrs() const;
   String getText() const;
   String getName() const;
   
   void mustElement(const char* elementName) const;
   XMLNodeImplRef findElement(const char* elementName, bool throwException = false) const;
   XMLNodeImplRef nextElement(const char* elementName, bool throwException = false) const;
   XMLNodeImplRef findElementChild(const char* elementName, bool throwException = false) const;
   XMLNodeImplRef mustNextElement(const char* elementName) const;
   XMLNodeImplRef mustElementChild(const char* elementName) const;
   XMLNodeImplRef mustChildElement(const char* elementName) const;
   XMLNodeImplRef mustChildElementChild(const char* elementName) const;
   XMLNodeImplRef mustChildFindElement(const char* elementName) const;
   XMLNodeImplRef mustChildFindElementChild(const char* elementName) const;
   
   void setNext(const XMLNodeImplRef& node);

   XMLNodeImplRef getNext() const;
   void addChild(const XMLNodeImplRef& node);

   XMLNodeImplRef mustGetChild() const;
   XMLNodeImplRef getChild() const;
   XMLNodeArray getChildren() const;
   void printNode( std::ostream& ostr ) const;
   String toString() const;

protected:
   XMLNodeImplRef m_nextNode;
   XMLNodeImplRef m_childNode;
   XMLNodeImplRef m_lastChildNode;

   XMLAttributeArray m_XMLAttributeArray;
   String m_strName;
   String m_strText;
};

#ifdef OW_WIN32
#pragma warning (pop)
#endif

} // end namespace OW_NAMESPACE

#endif

---