foxpro.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 COMMON_FOXPRO_H
#define COMMON_FOXPRO_H

#include <boost/noncopyable.hpp>

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

namespace Common {

class SeekableReadStream;
class WriteStream;

class FoxPro : boost::noncopyable {
public:
    enum Type {
        kTypeDouble   = 0x42, // 'B'
        kTypeString   = 0x43, // 'C'
        kTypeDate     = 0x44, // 'D'
        kTypeFloat    = 0x46, // 'F'
        kTypeGeneral  = 0x47, // 'G'
        kTypeInteger  = 0x49, // 'I'
        kTypeBool     = 0x4C, // 'L'
        kTypeMemo     = 0x4D, // 'M'
        kTypeNumber   = 0x4E, // 'N'
        kTypePicture  = 0x50, // 'P'
        kTypeDateTime = 0x54, // 'T'
        kTypeCurrency = 0x59  // 'Y'
    };

    struct Field {
        UString name;

        Type   type;
        uint32 offset;
        uint8  size;
        uint8  decimals;

        byte flags;

        uint32 autoIncNext;
        uint8  autoIncStep;
    };

    struct Record {
        bool deleted; 
        std::vector<byte *> fields; 
    };

    FoxPro();
    ~FoxPro();

    void load(SeekableReadStream *dbf, SeekableReadStream *cdx = 0,
              SeekableReadStream *fpt = 0);
    void save(WriteStream *dbf, WriteStream *cdx = 0, WriteStream *fpt = 0) const;

    void getLastUpdate(uint16 &lastUpdateYear, uint8 &lastUpdateMonth, uint8 &lastUpdateDay) const;

    bool hasIndex() const;
    bool hasMemo () const;

    size_t getFieldCount () const;
    size_t getRecordCount() const;

    const std::vector<Field>  &getFields () const;
    const std::vector<Record> &getRecords() const;

    UString getString(const Record &record, size_t field) const;
    int32   getInt   (const Record &record, size_t field) const;
    bool    getBool  (const Record &record, size_t field) const;
    double  getDouble(const Record &record, size_t field) const;

    void getDate(const Record &record, size_t field, uint16 &year, uint8 &month, uint8 &day);

    SeekableReadStream *getMemo(const Record &record, size_t field) const;


    void deleteRecord(size_t record);

    size_t addFieldString(const UString &name, uint8 size);
    size_t addFieldNumber(const UString &name, uint8 size, uint8 decimals);
    size_t addFieldInt   (const UString &name);
    size_t addFieldBool  (const UString &name);
    size_t addFieldDate  (const UString &name);
    size_t addFieldMemo  (const UString &name);

    size_t addRecord();


    void setString(size_t record, size_t field, const UString &value);
    void setInt   (size_t record, size_t field, int32 value);
    void setBool  (size_t record, size_t field, bool value);
    void setDouble(size_t record, size_t field, double value);

    void setDate(size_t record, size_t field, uint16 year, uint8 month, uint8 day);

    void setMemo(size_t record, size_t field, SeekableReadStream *value = 0);

private:
    uint16 _lastUpdateYear;
    uint8  _lastUpdateMonth;
    uint8  _lastUpdateDay;

    bool _hasIndex;
    bool _hasMemo;

    std::vector<Field>  _fields;
    std::vector<Record> _records;

    PtrList<byte, DeallocatorArray> _pool;

    uint16 _memoBlockSize;
    PtrVector<byte, DeallocatorArray> _memos;

    // Loading helpers
    void loadHeader (SeekableReadStream &dbf, uint32 &recordSize, uint32 &recordCount,
                     uint32 &firstRecordPos);
    void loadFields (SeekableReadStream &dbf, uint32 recordSize);
    void loadRecords(SeekableReadStream &dbf, uint32 recordSize, uint32 recordCount);
    void loadMemos  (SeekableReadStream &fpt);

    // Saving helpers
    void saveHeader (WriteStream &dbf) const;
    void saveFields (WriteStream &dbf) const;
    void saveRecords(WriteStream &dbf) const;
    void saveMemos  (WriteStream &fpt) const;

    void addField(uint8 size);
    void updateUpdate();

    static void checkName(const UString &name);

    static bool getInt(const byte *data, size_t size, int32 &i);
};

} // End of namespace Common

#endif // COMMON_FOXPRO_H