2dafile.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef AURORA_2DAFILE_H
#define AURORA_2DAFILE_H

#include <vector>
#include <map>

#include <boost/noncopyable.hpp>

#include "src/common/types.h"
#include "src/common/ustring.h"
#include "src/common/ptrvector.h"

#include "src/aurora/aurorafile.h"

namespace Common {
    class SeekableReadStream;
    class WriteStream;
    class StreamTokenizer;
}

namespace Aurora {

class TwoDAFile;
class GDAFile;

class TwoDARow : boost::noncopyable {
public:
    const Common::UString &getString(size_t column) const;
    const Common::UString &getString(const Common::UString &column) const;

    int32 getInt(size_t column) const;
    int32 getInt(const Common::UString &column) const;

    float getFloat(size_t column) const;
    float getFloat(const Common::UString &column) const;

    bool empty(size_t column) const;
    bool empty(const Common::UString &column) const;

private:
    TwoDAFile *_parent; 

    std::vector<Common::UString> _data;

    TwoDARow(TwoDAFile &parent);
    ~TwoDARow();

    const Common::UString &getCell(size_t n) const;

    friend class TwoDAFile;

    template<typename T>
    friend void Common::DeallocatorDefault::destroy(T *);
};

class TwoDAFile : boost::noncopyable, public AuroraFile {
public:
    TwoDAFile(Common::SeekableReadStream &twoda);
    TwoDAFile(const GDAFile &gda);
    ~TwoDAFile();

    size_t getRowCount() const;

    size_t getColumnCount() const;

    const std::vector<Common::UString> &getHeaders() const;

    size_t headerToColumn(const Common::UString &header) const;

    const TwoDARow &getRow(size_t row) const;

    const TwoDARow &getRow(const Common::UString &header, const Common::UString &value) const;

    // .--- 2DA file writers
    void writeASCII(Common::WriteStream &out) const;
    bool writeASCII(const Common::UString &fileName) const;

    void writeBinary(Common::WriteStream &out) const;
    bool writeBinary(const Common::UString &fileName) const;

    void writeCSV(Common::WriteStream &out) const;
    bool writeCSV(const Common::UString &fileName) const;
    // '---

private:
    typedef std::map<Common::UString, size_t, Common::UString::iless> HeaderMap;

    Common::UString _defaultString; 
    int32           _defaultInt;    
    float           _defaultFloat;  

    std::vector<Common::UString> _headers;
    HeaderMap _headerMap;

    TwoDARow _emptyRow;
    Common::PtrVector<TwoDARow> _rows;

    // Loading helpers
    void load(Common::SeekableReadStream &twoda);
    void read2a(Common::SeekableReadStream &twoda);
    void read2b(Common::SeekableReadStream &twoda);

    // ASCII loading helpers
    void readDefault2a(Common::SeekableReadStream &twoda, Common::StreamTokenizer &tokenize);
    void readHeaders2a(Common::SeekableReadStream &twoda, Common::StreamTokenizer &tokenize);
    void readRows2a   (Common::SeekableReadStream &twoda, Common::StreamTokenizer &tokenize);

    // Binary loading helpers
    void readHeaders2b (Common::SeekableReadStream &twoda);
    void skipRowNames2b(Common::SeekableReadStream &twoda);
    void readRows2b    (Common::SeekableReadStream &twoda);

    // GDA loading/conversion helpers
    void load(const GDAFile &gda);

    void createHeaderMap();

    static int32 parseInt(const Common::UString &str);
    static float parseFloat(const Common::UString &str);

    friend class TwoDARow;
};

} // End of namespace Aurora

#endif // AURORA_2DAFILE_H