irrXML.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine" and the "irrXML" project.
// For conditions of distribution and use, see copyright notice in irrlicht.h and/or irrXML.h

#ifndef __IRR_XML_H_INCLUDED__
#define __IRR_XML_H_INCLUDED__

#include <stdio.h>
#include "IrrCompileConfig.h"

namespace irr
{
namespace io
{
    enum ETEXT_FORMAT
    {
        ETF_ASCII,

        ETF_UTF8,

        ETF_UTF16_BE,

        ETF_UTF16_LE,

        ETF_UTF32_BE,

        ETF_UTF32_LE
    };


    enum EXML_NODE
    {
        EXN_NONE,

        EXN_ELEMENT,

        EXN_ELEMENT_END,

        EXN_TEXT,

        EXN_COMMENT,

        EXN_CDATA,

        EXN_UNKNOWN
    };


    class IFileReadCallBack
    {
    public:

        virtual ~IFileReadCallBack() {}


        virtual int read(void* buffer, int sizeToRead) = 0;

        virtual long getSize() const = 0;
    };


    class IXMLBase
    {
    };


    template<class char_type, class super_class>
    class IIrrXMLReader : public super_class
    {
    public:

        virtual ~IIrrXMLReader() {}


        virtual bool read() = 0;

        virtual EXML_NODE getNodeType() const = 0;


        virtual unsigned int getAttributeCount() const = 0;


        virtual const char_type* getAttributeName(int idx) const = 0;


        virtual const char_type* getAttributeValue(int idx) const = 0;


        virtual const char_type* getAttributeValue(const char_type* name) const = 0;


        virtual const char_type* getAttributeValueSafe(const char_type* name) const = 0;


        virtual int getAttributeValueAsInt(const char_type* name) const = 0;


        virtual int getAttributeValueAsInt(int idx) const = 0;


        virtual float getAttributeValueAsFloat(const char_type* name) const = 0;


        virtual float getAttributeValueAsFloat(int idx) const = 0;


        virtual const char_type* getNodeName() const = 0;


        virtual const char_type* getNodeData() const = 0;

        virtual bool isEmptyElement() const = 0;


        virtual ETEXT_FORMAT getSourceFormat() const = 0;


        virtual ETEXT_FORMAT getParserFormat() const = 0;
    };


    template <typename T>
    struct xmlChar
    {
        T c;
        xmlChar<T>() {}
        xmlChar<T>(char in) : c(static_cast<T>(in)) {}
        xmlChar<T>(wchar_t in) : c(static_cast<T>(in)) {}
#if defined(__BORLANDC__)
        // Note - removing explicit for borland was to get it to even compile.
        // There haven't been any kind of tests for that besides that.
        xmlChar<T>(unsigned char in) : c(static_cast<T>(in)) {}
        xmlChar<T>(unsigned short in) : c(static_cast<T>(in)) {}
        xmlChar<T>(unsigned int in) : c(static_cast<T>(in)) {}
        xmlChar<T>(unsigned long in) : c(static_cast<T>(in)) {}
#else 
        explicit xmlChar<T>(unsigned char in) : c(static_cast<T>(in)) {}
        explicit xmlChar<T>(unsigned short in) : c(static_cast<T>(in)) {}
        explicit xmlChar<T>(unsigned int in) : c(static_cast<T>(in)) {}
        explicit xmlChar<T>(unsigned long in) : c(static_cast<T>(in)) {}
#endif
        operator T() const { return c; }
        void operator=(int t) { c=static_cast<T>(t); }
    };


    typedef xmlChar<unsigned short> char16;


    typedef xmlChar<unsigned int> char32;


    typedef IIrrXMLReader<char, IXMLBase> IrrXMLReader;


    typedef IIrrXMLReader<char16, IXMLBase> IrrXMLReaderUTF16;


    typedef IIrrXMLReader<char32, IXMLBase> IrrXMLReaderUTF32;



    IRRLICHT_API IrrXMLReader* IRRCALLCONV createIrrXMLReader(const char* filename);


    IRRLICHT_API IrrXMLReader* IRRCALLCONV createIrrXMLReader(FILE* file);


    IRRLICHT_API IrrXMLReader* IRRCALLCONV createIrrXMLReader(IFileReadCallBack* callback,
                                                                bool deleteCallback = false);


    IRRLICHT_API IrrXMLReaderUTF16* IRRCALLCONV createIrrXMLReaderUTF16(const char* filename);


    IRRLICHT_API IrrXMLReaderUTF16* IRRCALLCONV createIrrXMLReaderUTF16(FILE* file);


    IRRLICHT_API IrrXMLReaderUTF16* IRRCALLCONV createIrrXMLReaderUTF16(IFileReadCallBack* callback,
                                                                        bool deleteCallback = false);



    IRRLICHT_API IrrXMLReaderUTF32* IRRCALLCONV createIrrXMLReaderUTF32(const char* filename);


    IRRLICHT_API IrrXMLReaderUTF32* IRRCALLCONV createIrrXMLReaderUTF32(FILE* file);


    IRRLICHT_API IrrXMLReaderUTF32* IRRCALLCONV createIrrXMLReaderUTF32(IFileReadCallBack* callback,
                                                                        bool deleteCallback = false);


} // end namespace io
} // end namespace irr

#endif // __IRR_XML_H_INCLUDED__