gff3writer.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_GFF3WRITER_H
#define AURORA_GFF3WRITER_H

#include <list>

#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>

#include "glm/glm.hpp"

#include "src/aurora/gff3file.h"
#include "src/aurora/locstring.h"

namespace Aurora {

class GFF3WriterStruct;
class GFF3WriterList;

typedef boost::shared_ptr<GFF3WriterStruct> GFF3WriterStructPtr;
typedef boost::shared_ptr<GFF3WriterList> GFF3WriterListPtr;

class GFF3Writer : boost::noncopyable {
public:
    // TODO: Add a constructor consuming a GFF3File object.
    GFF3Writer(uint32 id, uint32 version = MKTAG('V', '3', '.', '2'));

    GFF3WriterStructPtr getTopLevel();

    void write(Common::WriteStream &stream);

private:
    struct Field : boost::noncopyable {
        GFF3Struct::FieldType type;
        uint32 labelIndex;

        uint32 uint32Value;
        uint64 uint64Value;

        int32 int32Value;
        int64 int64Value;

        float floatValue;
        double doubleValue;

        glm::vec4 vectorValue;

        Common::UString stringValue;

        LocString locStringValue;

        Common::ScopedArray<byte> voidData;
        uint32 voidSize;
    };

    typedef boost::shared_ptr<Field> FieldPtr;

    uint32 _id;
    uint32 _version;

    std::vector<GFF3WriterStructPtr> _structs;
    std::vector<GFF3WriterListPtr> _lists;

    std::vector<Common::UString> _labels;
    std::vector<FieldPtr> _fields;

    friend class GFF3WriterList;
    friend class GFF3WriterStruct;

    uint32 addLabel(const Common::UString &label);
    static uint32 getFieldDataSize(FieldPtr field);

    size_t createField(GFF3Struct::FieldType type, const Common::UString &label);
};

class GFF3WriterList : boost::noncopyable {
public:
    GFF3WriterList(GFF3Writer *parent);

    GFF3WriterStructPtr addStruct(const Common::UString &label);

    size_t getSize() const;

private:
    friend class GFF3Writer;
    friend class GFF3WriterStruct;

    GFF3Writer *_parent;
    std::vector<size_t> _strcts;
};

class GFF3WriterStruct : boost::noncopyable {
public:
    GFF3WriterStruct(GFF3Writer *parent, uint32 id = 0xFFFFFFFF);

    uint32 getID() const;
    size_t getFieldCount() const;

    GFF3WriterStructPtr addStruct(const Common::UString &label);
    GFF3WriterListPtr addList(const Common::UString &label);

    void addByte(const Common::UString &label, byte value);
    void addChar(const Common::UString &label, char value);
    void addFloat(const Common::UString &label, float value);
    void addDouble(const Common::UString &label, double value);
    void addUint16(const Common::UString &label, uint16 value);
    void addUint32(const Common::UString &label, uint32 value);
    void addUint64(const Common::UString &label, uint64 value);
    void addSint16(const Common::UString &label, int16 value);
    void addSint32(const Common::UString &label, int32 value);
    void addSint64(const Common::UString &label, int64 value);
    void addExoString(const Common::UString &label, const Common::UString &value);
    void addStrRef(const Common::UString &label, uint32 value);
    void addResRef(const Common::UString &label, const Common::UString &value);
    void addVoid(const Common::UString &label, const byte *data, uint32 size);
    void addVector(const Common::UString &label, glm::vec3 value);
    void addOrientation(const Common::UString &label, glm::vec4 value);
    void addLocString(const Common::UString &label, const LocString &value);

private:
    GFF3Writer::FieldPtr createField(GFF3Struct::FieldType type, const Common::UString &label);

    uint32 _id;
    GFF3Writer *_parent;
    std::vector<size_t> _fieldIndices;

    friend class GFF3Writer;
    friend class GFF3WriterList;
};

} // End of namespace Aurora

#endif // AURORA_GFF3WRITER_H