o3de/Code/Legacy/CrySystem/XML/XMLBinaryReader.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */


#ifndef CRYINCLUDE_CRYSYSTEM_XML_XMLBINARYREADER_H
#define CRYINCLUDE_CRYSYSTEM_XML_XMLBINARYREADER_H
#pragma once


#include "XMLBinaryHeaders.h"
#include "IXml.h"
#include "CryFile.h"

class CBinaryXmlData;

namespace XMLBinary
{
    class XMLBinaryReader
    {
    public:
        enum EResult
        {
            eResult_Success,
            eResult_NotBinXml,
            eResult_Error
        };

        enum EBufferMemoryHandling
        {
            eBufferMemoryHandling_MakeCopy,
            eBufferMemoryHandling_TakeOwnership
        };

    public:
        XMLBinaryReader();
        ~XMLBinaryReader();

        XmlNodeRef LoadFromFile(const char* filename, EResult& result);

        // Note: if bufferMemoryHandling == eBufferMemoryHandling_TakeOwnership and
        // returned result is eResult_Success, then buffer's memory is owned and
        // will be released by XMLBinaryReader (by a 'delete[] buffer' call).
        // Otherwise, the caller is responsible for releasing buffer's memory.
        XmlNodeRef LoadFromBuffer(EBufferMemoryHandling bufferMemoryHandling, const char* buffer, size_t size, EResult& result);

        const char* GetErrorDescription() const;

    private:
        void Check(const char* buffer, size_t size, EResult& result);
        void CheckHeader(const BinaryFileHeader& layout, size_t size, EResult& result);
        CBinaryXmlData* Create(const char* buffer, size_t size, EResult& result);
        void SetErrorDescription(const char* text);

    private:
        char m_errorDescription[64];
    };
}

#endif // CRYINCLUDE_CRYSYSTEM_XML_XMLBINARYREADER_H