XMLParser.h

/***********************************************************************
    created:    12/3/2005
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIXMLParser_h_
#define _CEGUIXMLParser_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/PropertySet.h"

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT XMLParser :
        public PropertySet,
        public AllocatedObject<XMLParser>
    {
    public:
        XMLParser(void);

        virtual ~XMLParser(void);

        bool initialise(void);

        void cleanup(void);

        virtual void parseXML(XMLHandler& handler, const RawDataContainer& source, const String& schemaName) = 0;

        virtual void parseXMLFile(XMLHandler& handler, const String& filename, const String& schemaName, const String& resourceGroup);

        virtual void parseXMLString(XMLHandler& handler, const String& source, const String& schemaName);

        const String& getIdentifierString() const;

    protected:
        virtual bool initialiseImpl(void) = 0;

        virtual void cleanupImpl(void) = 0;

        // data fields
        String d_identifierString;                 

    private:
        bool d_initialised;     
    };

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIXMLParser_h_