RecordFile.h

Go to the documentation of this file.

// RecordFile.h
//
// Copyright (c) 2010, 2015 Michael Imamura.
//
// Licensed under GrokkSoft HoverRace SourceCode License v1.0(the "License");
// you may not use this file except in compliance with the License.
//
// A copy of the license should have been attached to the package from which
// you have taken this file. If you can not find the license you can not use
// this file.
//
//
// The author makes no representations about the suitability of
// this software for any purpose.  It is provided "as is" "AS IS",
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied.
//
// See the License for the specific language governing permissions
// and limitations under the License.

#pragma once

#include "../Util/Inspectable.h"
#include "../Util/OS.h"

#include "ObjStream.h"

#if defined(_WIN32) && defined(HR_ENGINE_SHARED)
#   ifdef MR_ENGINE
#       define MR_DllDeclare   __declspec( dllexport )
#   else
#       define MR_DllDeclare   __declspec( dllimport )
#   endif
#else
#   define MR_DllDeclare
#endif

namespace HoverRace {
namespace Parcel {

class MR_DllDeclare RecordFile : public Util::Inspectable
{
    using SUPER = Util::Inspectable;

public:
    RecordFile() : SUPER() { }
    virtual ~RecordFile() { }

    virtual bool CreateForWrite(const Util::OS::path_t &filename,
        MR_UInt32 numRecords, const char *title = nullptr) = 0;
    virtual bool OpenForWrite(const Util::OS::path_t &filename) = 0;
    virtual bool OpenForRead(const Util::OS::path_t &filename,
        bool validateChecksum = false) = 0;

    // Checksum stuff
    virtual bool ApplyChecksum(const Util::OS::path_t &filename) = 0;

    virtual DWORD GetAlignMode() = 0;

    virtual MR_UInt32 GetNbRecords() const = 0;
    virtual void SelectRecord(MR_UInt32 i) = 0;
    virtual bool BeginANewRecord() = 0;

    virtual ObjStreamPtr StreamIn() = 0;

    virtual ObjStreamPtr StreamOut() = 0;
};

}  // namespace Parcel
}  // namespace HoverRace

#undef MR_DllDeclare