spl/xml/XmlDocument.h

/*
 *  Much of this code is extracted from the tinyxml project, attributed below.
 */
/*
www.sourceforge.net/projects/tinyxml
Original code (2.0 and earlier )copyright (c) 2000-2006 Lee Thomason (www.grinninglizard.com)

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any
damages arising from the use of this software.

Permission is granted to anyone to use this software for any
purpose, including commercial applications, and to alter it and
redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must
not claim that you wrote the original software. If you use this
software in a product, an acknowledgment in the product documentation
would be appreciated but is not required.

2. Altered source versions must be plainly marked as such, and
must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source
distribution.
*/
#ifndef _xmldocument_h
#define _xmldocument_h

#include <spl/Debug.h>
#include <spl/collection/Array.h>
#include <spl/io/FileStream.h>
#include <spl/RefCountPtr.h>
#include <spl/io/StringStream.h>
#include <spl/io/TextStream.h>
#include <spl/xml/XmlNode.h>

class XmlDocument : public XmlNode
{
private:
        XmlDocument( const XmlDocument& copy );

protected:
        friend void _TestTinyXml();
        
        // [internal use]
        virtual XmlNodePtr Clone() const;

        static bool m_condenseWhiteSpace;

        static int m_tabsize;
        
        bool m_useMicrosoftBOM;         

        virtual const char *_Parse( const char *p, XmlParsingData* data = NULL, XmlEncoding encoding = TIXML_DEFAULT_ENCODING );
                
        XmlDocument();
        void CopyTo( XmlDocument& target ) const;
        virtual void WriteTo(TextWriter& writer) const;

public:
        
        virtual ~XmlDocument();
        
        void operator =( const XmlDocument& copy );

        virtual String Name() const;

        void Write( TextWriter& xmlout ) const;

        inline void Write( const String& filename ) const
        {
                TextWriter tw(FileStreamPtr(new FileStream(filename, File::FILEMODE_Truncate, File::FILEACC_Write)));
                Write(tw);
        }

        static XmlDocumentPtr Parse( TextReader& xmlin, XmlParsingData* data = NULL, XmlEncoding encoding = TIXML_DEFAULT_ENCODING );

        inline static XmlDocumentPtr Parse( const String& filename )
        {
                TextReader tw(File::OpenRead(filename));
                return Parse(tw);
        }
        
        inline static XmlDocumentPtr ParseXml( const String& xml, XmlParsingData* data = NULL, XmlEncoding encoding = TIXML_DEFAULT_ENCODING )
        {
                TextReader tw(StringStreamPtr(new StringStream(xml)));
                return Parse(tw, data, encoding);
        }

        XmlElementPtr RootElement();

        inline static void SetTabSize( int _tabsize ) { m_tabsize = _tabsize; }
        inline static int TabSize()     { return m_tabsize; }
        
        inline static void SetCondenseWhiteSpace(bool condense) { m_condenseWhiteSpace = condense; }
        inline static bool CondenseWhiteSpace() { return m_condenseWhiteSpace; }
        static inline bool IsWhiteSpaceCondensed() { return m_condenseWhiteSpace; }

        virtual XmlDocumentPtr    ToDocument()    const; 

        virtual StringPtr InnerXml() const;
        virtual StringPtr ToString() const;
                                                
#ifdef DEBUG
        virtual void ValidateMem() const;
        virtual void CheckMem() const;
#endif
};

REGISTER_TYPEOF( 536, XmlDocument );

#endif