* Major rewrite

include/Athena/ZQuestFile.hpp

@@ -0,0 +1,164 @@
+// 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>
+
+#define ZQUEST_VERSION_CHECK(major, minor, revision) \
+    (major | (minor << 8) | (revision << 16))
+
+namespace Athena
+{
+/*!
+ * \brief ZQuestFile is an export format for save data.
+ */
+class ZQuestFile
+{
+public:
+    /*!
+     * \brief The current major version of the ZQuest format
+     */
+    static const Uint32 Major;
+    /*!
+     * \brief The current minor version of the ZQuest format
+     */
+    static const Uint32 Minor;
+    /*!
+     * \brief The current revision of the ZQuest format
+     */
+    static const Uint32 Revision;
+    /*!
+     * \brief The current version of the ZQuest format
+     */
+    static const Uint32 Version;
+
+    /*!
+     * \brief The magic number used to identify the file e.g. "ZQS1"
+     */
+    static const Uint32 Magic;
+
+    /*!
+     * \enum Game
+     * \brief The list of games currently supported by ZQuest
+     */
+    enum Game
+    {
+        NoGame, //!< None or Unsupported
+        LoZ,    //!< Legend of Zelda
+        AoL,    //!< Adventure of Link
+        ALttP,  //!< A Link to the Past
+        LA,     //!< Links Awakening
+        OoT,    //!< Ocarin of Time
+        OoT3D,  //!< Ocarina of Time 3D
+        MM,     //!< Majora's Mask
+        OoS,    //!< Oracle of Season
+        OoA,    //!< Oracle of Ages
+        FS,     //!< Four Swords
+        WW,     //!< Wind Waker
+        FSA,    //!< Four Swords Adventures
+        MC,     //!< Minish Cap
+        TP,     //!< Twilight Princess
+        PH,     //!< Phantom Hourglass
+        ST,     //!< Spirit Tracks
+        SS,     //!< Skyward Sword
+        ALBW,   //!< A Link Between Worlds
+        // Add more games here
+
+        // This must always be last
+        GameCount //!< Total number of supported games
+    };
+
+    /*!
+     * \brief ZQuest
+     */
+    ZQuestFile();
+
+    /*!
+     * \brief ZQuest
+     * \param game
+     * \param endian
+     * \param data
+     * \param length
+     */
+    ZQuestFile(Game game, Endian endian, Uint8* data, Uint32 length, const std::string& gameString = std::string());
+    ~ZQuestFile();
+
+    /*!
+     * \brief setGame
+     * \param game
+     */
+    void setGame(Game game);
+
+    /*!
+     * \brief game
+     * \return
+     */
+    Game game() const;
+
+    /*!
+     * \brief setEndian
+     * \param endian
+     */
+    void setEndian(Endian endian);
+
+    /*!
+     * \brief endian
+     * \return
+     */
+    Endian endian() const;
+
+    /*!
+     * \brief setData
+     * \param data   The data to assign
+     * \param length The length of the data
+     */
+    void setData(Uint8* data, Uint32 length);
+
+    /*!
+     * \brief data
+     * \return
+     */
+    Uint8* data() const;
+
+    /*!
+     * \brief length
+     * \return
+     */
+    Uint32 length() const;
+
+    void setGameString(const std::string& gameString);
+    /*!
+     * \brief gameString
+     * \return
+     */
+    std::string gameString() const;
+
+    static const std::vector<std::string> gameStringList();
+private:
+    Game        m_game;
+    std::string m_gameString;
+    Endian      m_endian;
+    Uint8*      m_data;
+    Uint32      m_length;
+
+    // Game strings support
+};
+} // zelda
+
+#endif // ZQUEST_HPP