gff3file.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_GFF3FILE_H
#define AURORA_GFF3FILE_H

#include <vector>
#include <map>

#include <boost/noncopyable.hpp>

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

#include "src/aurora/types.h"
#include "src/aurora/aurorafile.h"

namespace Common {
    class SeekableReadStream;
}

namespace Aurora {

class LocString;
class GFF3Struct;

class GFF3File : boost::noncopyable, public AuroraFile {
public:
    GFF3File(Common::SeekableReadStream *gff3, uint32 id = 0xFFFFFFFF, bool repairNWNPremium = false);
    GFF3File(const Common::UString &gff3, FileType type, uint32 id = 0xFFFFFFFF, bool repairNWNPremium = false);
    virtual ~GFF3File();

    uint32 getType() const;

    const GFF3Struct &getTopLevel() const;


private:
    struct Header {
        uint32 structOffset;       
        uint32 structCount;        
        uint32 fieldOffset;        
        uint32 fieldCount;         
        uint32 labelOffset;        
        uint32 labelCount;         
        uint32 fieldDataOffset;    
        uint32 fieldDataCount;     
        uint32 fieldIndicesOffset; 
        uint32 fieldIndicesCount;  
        uint32 listIndicesOffset;  
        uint32 listIndicesCount;   

        Header();

        void read(Common::SeekableReadStream &gff3);
    };

    typedef Common::PtrVector<GFF3Struct> StructArray;
    typedef std::vector<GFF3List> ListArray;


    Common::ScopedPtr<Common::SeekableReadStream> _stream;

    Header _header; 

    bool   _repairNWNPremium;
    uint32 _offsetCorrection;

    StructArray _structs; 
    ListArray   _lists;   

    std::vector<uint32> _listOffsetToIndex;


    // .--- Loading helpers
    void load(uint32 id);
    void loadHeader(uint32 id);
    void loadStructs();
    void loadLists();
    // '---

    // .--- Helper methods called by GFF3Struct
    Common::SeekableReadStream &getStream(uint32 offset) const;
    Common::SeekableReadStream &getFieldData() const;

    const GFF3Struct &getStruct(uint32 i) const;
    const GFF3List   &getList  (uint32 i) const;
    // '---

    friend class GFF3Struct;
};

class GFF3Struct {
public:
    enum FieldType {
        kFieldTypeNone        = - 1, 
        kFieldTypeByte        =   0, 
        kFieldTypeChar        =   1, 
        kFieldTypeUint16      =   2, 
        kFieldTypeSint16      =   3, 
        kFieldTypeUint32      =   4, 
        kFieldTypeSint32      =   5, 
        kFieldTypeUint64      =   6, 
        kFieldTypeSint64      =   7, 
        kFieldTypeFloat       =   8, 
        kFieldTypeDouble      =   9, 
        kFieldTypeExoString   =  10, 
        kFieldTypeResRef      =  11, 
        kFieldTypeLocString   =  12, 
        kFieldTypeVoid        =  13, 
        kFieldTypeStruct      =  14, 
        kFieldTypeList        =  15, 
        kFieldTypeOrientation =  16, 
        kFieldTypeVector      =  17, 
        kFieldTypeStrRef      =  18  
    };

    uint32 getID() const;

    size_t getFieldCount() const;
    bool hasField(const Common::UString &field) const;

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

    FieldType getFieldType(const Common::UString &field) const;


    // .--- Read field values
    char   getChar(const Common::UString &field, char   def = '\0' ) const;
    uint64 getUint(const Common::UString &field, uint64 def = 0    ) const;
     int64 getSint(const Common::UString &field,  int64 def = 0    ) const;
    bool   getBool(const Common::UString &field, bool   def = false) const;

    double getDouble(const Common::UString &field, double def = 0.0) const;

    Common::UString getString(const Common::UString &field,
                              const Common::UString &def = "") const;

    bool getLocString(const Common::UString &field, LocString &str) const;

    void getVector     (const Common::UString &field,
                        float &x, float &y, float &z          ) const;
    void getOrientation(const Common::UString &field,
                        float &a, float &b, float &c, float &d) const;

    void getVector     (const Common::UString &field,
                        double &x, double &y, double &z           ) const;
    void getOrientation(const Common::UString &field,
                        double &a, double &b, double &c, double &d) const;

    Common::SeekableReadStream *getData(const Common::UString &field) const;
    // '---

    // .--- Structs and lists of structs
    const GFF3Struct &getStruct(const Common::UString &field) const;
    const GFF3List   &getList  (const Common::UString &field) const;
    // '---

private:
    struct Field {
        FieldType type;     
        uint32    data;     
        bool      extended; 

        Field();
        Field(FieldType t, uint32 d);
    };

    typedef std::map<Common::UString, Field> FieldMap;


    const GFF3File *_parent; 

    uint32 _id;         
    uint32 _fieldIndex; 
    uint32 _fieldCount; 

    FieldMap _fields; 

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


    // .--- Loader
    GFF3Struct(const GFF3File &parent, uint32 offset);
    ~GFF3Struct();

    void load(uint32 offset);

    void readField  (Common::SeekableReadStream &data, uint32 index);
    void readFields (Common::SeekableReadStream &data, uint32 index, uint32 count);
    void readIndices(Common::SeekableReadStream &data,
                     std::vector<uint32> &indices, uint32 count) const;

    Common::UString readLabel(Common::SeekableReadStream &data, uint32 index) const;
    // '---

    // .--- Field and field data accessors
    const Field *getField(const Common::UString &name) const;
    Common::SeekableReadStream &getData(const Field &field) const;
    // '---

    friend class GFF3File;

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

} // End of namespace Aurora

#endif // AURORA_GFF3FILE_H