ZQuestFile.hpp

#ifndef ATHENA_NO_ZQUEST
// This file is part of libAthena.
//
// libAthena is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// libAthena is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with libAthena.  If not, see <http://www.gnu.org/licenses/>

#ifndef ZQUEST_HPP
#define ZQUEST_HPP


#include "athena/Global.hpp"
#include <string>
#include <vector>
#include <memory>

#define ZQUEST_VERSION_CHECK(major, minor, revision) \
    (major | (minor << 8) | (revision << 16))

namespace athena
{
class ZQuestFile
{
public:
    static const atUint32 Major;
    static const atUint32 Minor;
    static const atUint32 Revision;
    static const atUint32 Version;

    static const atUint32 Magic;

    enum Game
    {
        NoGame, 
        LoZ,    
        AoL,    
        ALttP,  
        LA,     
        OoT,    
        OoT3D,  
        MM,     
        OoS,    
        OoA,    
        FS,     
        WW,     
        FSA,    
        MC,     
        TP,     
        PH,     
        ST,     
        SS,     
        ALBW,   
        // Add more games here

        // This must always be last
        GameCount 
    };

    ZQuestFile();

    ZQuestFile(Game game, Endian endian, std::unique_ptr<atUint8[]>&& data, atUint32 length, const std::string& gameString = std::string());

    void setGame(Game game);

    Game game() const;

    void setEndian(Endian endian);

    Endian endian() const;

    void setData(std::unique_ptr<atUint8[]>&& data, atUint32 length);

    atUint8* data() const;

    atUint32 length() const;

    void setGameString(const std::string& gameString);
    std::string gameString() const;

    static const std::vector<std::string> gameStringList();
protected:
    Game        m_game;
    std::string m_gameString;
    Endian      m_endian;
    std::unique_ptr<atUint8[]> m_data;
    atUint32    m_length;

    // Game strings support
};
} // zelda

#endif // ZQUEST_HPP
#endif // ATHENA_NO_ZQUEST