rawdata.h

/***************************************************************************
 *   Copyright (C) 2005-2008 by the FIFE team                              *
 *   http://www.fifengine.de                                               *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_VFS_RAW_RAWDATA_H
#define FIFE_VFS_RAW_RAWDATA_H

// Standard C++ library includes
#include <vector>

// Platform specific includes
#include "util/base/fife_stdint.h"

// 3rd party library includes
#include <boost/shared_ptr.hpp>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder

#include "rawdatasource.h"

namespace FIFE {

    class RawData {
        public:
            RawData(RawDataSource* datasource);
            virtual ~RawData();
            
            std::vector<uint8_t> getDataInBytes();

            std::vector<std::string> getDataInLines();


            uint32_t getDataLength() const;

            uint32_t getCurrentIndex() const;

            void setIndex(uint32_t index);

            void moveIndex(int32_t offset);

            template <typename T> T readSingle() {
                T val;
                readInto(reinterpret_cast<uint8_t*>(&val), sizeof(T));
                return val;
            }

            void readInto(uint8_t* buffer, size_t len);

            uint8_t read8();

            uint16_t read16Little();

            uint32_t read32Little();

            uint16_t read16Big();

            uint32_t read32Big();

            std::string readString(size_t len);

            void read(std::string& outbuffer, int32_t size=-1);
            
            bool getLine(std::string& buffer);

        private:
            RawDataSource* m_datasource;
            size_t m_index_current;

            template <typename T> T littleToHost(T value) const {
                if (littleEndian())
                    return value;
                else
                    return revert(value);
            }

            template <typename T> T bigToHost(T value) const {
                if (!littleEndian())
                    return value;
                else
                    return revert(value);
            }

            template <typename T> T revert(T value) const {
                T retval;
                for (uint32_t i = 0; i < sizeof(T); ++i)
                    reinterpret_cast<uint8_t*>(&retval)[i] = reinterpret_cast<uint8_t*>(&value)[sizeof(T)-1-i];

                return retval;
            }

            RawData(const RawData&);
            RawData& operator=(const RawData&) { return *this; };

            static bool littleEndian();
    };
    typedef boost::shared_ptr<RawData> RawDataPtr;

    class IndexSaver {
        public:
            IndexSaver(RawData* d) : m_rd(d), m_index(m_rd->getCurrentIndex()) {}

            ~IndexSaver() {
                m_rd->setIndex(m_index);
            }

        private:
            RawData* m_rd;
            uint32_t m_index;

            IndexSaver(const IndexSaver&);
            IndexSaver& operator=(const IndexSaver&) { return *this; }
    };

}//FIFE

#endif