// EMERGENT GAME TECHNOLOGIES PROPRIETARY INFORMATION
//
// This software is supplied under the terms of a license agreement or
// nondisclosure agreement with Emergent Game Technologies and may not 
// be copied or disclosed except in accordance with the terms of that 
// agreement.
//
//      Copyright (c) 1996-2007 Emergent Game Technologies.
//      All Rights Reserved.
//
// Emergent Game Technologies, Chapel Hill, North Carolina 27517
// http://www.emergent.net

#ifndef NISTREAM_H
#define NISTREAM_H

#include <NiBinaryStream.h>
#include <NiBinaryLoadSave.h>
#include <NiSemaphore.h>
#include <NiSystem.h>
#include <NiThread.h>

#include "NiMainLibType.h"
#include "NiObject.h"
#include "NiFixedString.h"
#include "NiTArray.h"
#include "NiTLargeArray.h"
#include "NiTStringMap.h"
#include "NiTSet.h"
#include "NiObjectGroup.h"
#include "NiTPointerList.h"
#include "NiTPointerMap.h"

NiSmartPointer(NiTexture);
NiSmartPointer(NiTexturePalette);

class NiSearchPath;
class NiAVObject;

class NIMAIN_ENTRY NiStream : public NiMemObject
{
public:
    NiStream();
    virtual ~NiStream();

    // top-level objects to process
    void InsertObject(NiObject* pkObject);
    void RemoveObject(NiObject* pkObject);
    void RemoveAllObjects();
    unsigned int GetObjectCount() const;
    NiObject* GetObjectAt(unsigned int i) const;

	typedef NiBinaryStream* (*LoadFile)(const char* pcFileName, NiStream* pkStream);
	static void SetLoadFileMethod(LoadFile pfnLoadFile);
	static NiBinaryStream* LoadFromLocalFile(const char* pcFileName, NiStream* pkStream);

	// file loads and saves
    virtual bool Load(const char* pcFileName);
    virtual bool Save(const char* pcFileName);

    // character stream loads and save
    virtual bool Load(char* pcBuffer, int iBufferSize);
    virtual bool Save(char*& pcBuffer, int& iBufferSize);

    // Direct stream loads and save
    virtual bool Load(NiBinaryStream* pkIstr);
    virtual bool Save(NiBinaryStream* pkOstr);

	void SetFileName(const char* pcFileName);
	const char* GetFileName();

    // Get/set whether this stream should be saved in little endian.  
    // By default, it will save out the same endianness as the current 
    // platform.
    bool GetSaveAsLittleEndian();
    void SetSaveAsLittleEndian(bool bLittle);

    // Get/set whether a loaded stream is little endian.  By default,
    // this will return the same endianness as the current platform.
    bool GetSourceIsLittleEndian();

    // background loading
    enum ThreadStatus
    {
        IDLE,
        LOADING,
        CANCELLING,
        PAUSING,
        PAUSED
    };

    class LoadState : public NiMemObject
    {
    public:
        float m_fReadProgress; // [0.0f..1.0f]
        float m_fLinkProgress; // [0.0f..1.0f]
    };

    void BackgroundLoad();
    void BackgroundLoadBegin(const char* pcFileName);
    void BackgroundLoadBegin(NiBinaryStream* pkIstr);
    ThreadStatus BackgroundLoadPoll(LoadState* pkState);
    void BackgroundLoadPause();
    void BackgroundLoadResume();
    void BackgroundLoadCancel();
    bool BackgroundLoadFinish();
    void BackgroundLoadCleanup();
    bool BackgroundLoadGetExitStatus() const;
    virtual void BackgroundLoadOnExit();

    const NiProcessorAffinity& GetAffinity() const;
    void SetAffinity(const NiProcessorAffinity& kAffinity);
    const NiThread::Priority GetPriority() const;
    void SetPriority(const NiThread::Priority ePriority);

    class BackgroundLoadProcedure : public NiThreadProcedure
    {
    public:
        BackgroundLoadProcedure(NiStream* pkStream)
        {
            m_pkStream = pkStream;
        }

        virtual unsigned int ThreadProcedure(void* pvArg);

        NiStream* m_pkStream;
    };

    // version information
    static unsigned int GetVersionFromString(const char* pcVersionString);
    static unsigned int GetVersion(unsigned int uiMajor, unsigned int uiMinor,
        unsigned int uiPatch, unsigned int uiInternal);
    unsigned int GetFileVersion() const;
    unsigned int GetFileUserDefinedVersion() const;

    // error messages
	void SetLastError(unsigned int uiLastError);
    unsigned int GetLastError() const;
    const char* GetLastErrorMessage() const;
    void ResetLastErrorInfo();

    // optional image palette (allows image sharing across streams)
    void SetTexturePalette(NiTexturePalette* pkTexturePalette);
    NiTexturePalette* GetTexturePalette() const;

    // *** begin Emergent internal use only ***

    // string loads and saves
    void LoadCString(char*& pcString);
    void SaveCString(const char* pcString);
    void LoadFixedString(NiFixedString& kString);
    void SaveFixedString(const NiFixedString& kString);
    void LoadCStringAsFixedString(NiFixedString& kString);

    static const unsigned int NULL_LINKID; /* = 0xffffffff */

    virtual bool RegisterFixedString(const NiFixedString& kString);
    virtual bool RegisterSaveObject(NiObject* pkObject);
    virtual void ChangeObject(NiObject* pkNewObject);
    virtual unsigned int GetLinkIDFromObject(const NiObject* pkObject) const;
    virtual void SaveLinkID(const NiObject* pkObject);

    void ReadLinkID();
    unsigned int ReadMultipleLinkIDs();
    NiObject* ResolveLinkID();
    NiObject* GetObjectFromLinkID();
    unsigned int GetNumberOfLinkIDs();
    void SetNumberOfLinkIDs(unsigned int uiLinks);

    NiObjectGroup* GetGroupFromID(unsigned int uiID) const;
    unsigned int GetIDFromGroup(NiObjectGroup* pkGroup) const;

    // for internal read/write of class data members
    NiBinaryStream& Istr();
    NiBinaryStream& Ostr();

    // image palette access
    void SetTexture(const char* pcURL, NiTexture* pkTexture);
    NiTexture* GetTexture(const char* pcURL, NiTexture* pkSelf) const;

    NiSearchPath* GetSearchPath() const;
    void SetSearchPath(NiSearchPath* pkSearchPath);

    // last loaded RTTI string
    const char* GetLastLoadedRTTI() const;

    // Cached flag values for legacy NIF files.
    unsigned short GetLastNiAVObjectFlags() const;
    void SetLastNiAVObjectFlags(unsigned short usFlags);

    unsigned short GetLastNiTimeControllerFlags() const;
    void SetLastNiTimeControllerFlags(unsigned short usFlags);

    unsigned short GetLastNiPropertyFlags() const;
    void SetLastNiPropertyFlags(unsigned short usFlags);

    // Locking functions to protect cleanup code for threading issues.
    static void LockCleanupSection();
    static void UnlockCleanupSection();

    // support for object loader functions
    typedef NiObject* (*CreateFunction)(void);
    static int RegisterLoader(const char* pcClassName, CreateFunction pfnFunc);
    static void UnregisterLoader(const char* pcClassName);

    // Support for scene graph post-processing functions.
    typedef void (*PostProcessFunction)(NiStream&, NiObject*);
    static void RegisterPostProcessFunction(PostProcessFunction pfnFunc);
    static void UnregisterPostProcessFunction(PostProcessFunction pfnFunc);
    
    static void _SDMInit();
    static void _SDMShutdown();
    static NiObject* CreateObjectByRTTI(const char* pcRTTI);
    // *** end Emergent internal use only ***

protected:
    // load and save information
    virtual bool LoadHeader();
    virtual void SaveHeader();
    virtual bool LoadStream();
    virtual bool SaveStream();
    virtual void RegisterObjects();
    virtual void LoadTopLevelObjects();
    virtual void SaveTopLevelObjects();
    virtual bool LoadObject();
    virtual unsigned int PreSaveObjectSizeTable();
    virtual bool SaveObjectSizeTable(unsigned int uiStartOffset);
    virtual bool LoadObjectSizeTable();
    void FreeLoadData();
    void DoThreadPause();

    // automatically set UpdateSelected flags for old NIF files
    // to max functionality
    void SetSelectiveUpdateFlagsForOldVersions();
    void SetSelectiveUpdateFlagsTTTFRecursive(NiAVObject* pkAVObject);

    // RTTI
    void LoadRTTIString(char* pcString);
    bool LoadRTTI();
    void SaveRTTI();
    void RTTIError(const char* pcRTTI);

    // NiFixedString
    unsigned int GetStringID(const NiFixedString& kString);
    void SaveFixedStringTable();
    bool LoadFixedStringTable();

    // block allocation 
    void LoadObjectGroups();
    void SaveObjectGroups();
    void UpdateObjectGroups();
    typedef NiTPrimitiveArray<NiObjectGroup*> NiObjectGroupArray;
    NiObjectGroupArray m_kGroups;

    unsigned int m_uiNifFileVersion;
    unsigned int m_uiNifFileUserDefinedVersion;
    char m_acFileName[NI_MAX_PATH];// needed to resolve names of external nifs
    bool m_bSaveLittleEndian;
    bool m_bSourceIsLittleEndian;

    NiSearchPath* m_pkSearchPath;
    
    NiTLargeObjectArray<NiObjectPtr> m_kObjects;
    NiTLargePrimitiveArray<unsigned int> m_kObjectSizes;
    NiTLargeObjectArray<NiObjectPtr> m_kTopObjects;
    NiTLargeObjectArray<NiFixedString> m_kFixedStrings;
    NiBinaryStream* m_pkIstr;
    NiBinaryStream* m_pkOstr;

    // ordered set of link id's for load-link phase
    NiUnsignedIntSet m_kLinkIDs;
    unsigned int m_uiLinkIndex;
    NiUnsignedIntSet m_kLinkIDBlocks;
    unsigned int m_uiLinkBlockIndex;

    // Hash table to convert registered object pointers to IDs at save time.
    NiTPointerMap<const NiObject*, unsigned int> m_kRegisterMap;

    // image palette for sharing NiTexture objects
    NiTexturePalettePtr m_spTexturePalette;

    // Legacy NIF flag conversion variables
    unsigned short m_usNiAVObjectFlags;
    unsigned short m_usNiTimeControllerFlags;
    unsigned short m_usNiPropertyFlags;

    // background loading
    void BackgroundLoadBegin();
    void BackgroundLoadEstimateProgress(LoadState& kLoadState);

    ThreadStatus m_eBackgroundLoadStatus;
    bool m_bBackgroundLoadExitStatus;
    unsigned int m_uiLoad;
    unsigned int m_uiLink;
    unsigned int m_uiPostLink;

    // NiThread implementation
    NiSemaphore m_kSemaphore;
    NiThread* m_pkThread;
    BackgroundLoadProcedure* m_pkBGLoadProc;
    NiThread::Priority m_ePriority;
    NiProcessorAffinity m_kAffinity;

    // error messages
    enum
    {
        STREAM_OKAY,
        FILE_NOT_LOADED,
        NOT_NIF_FILE,
        OLDER_VERSION,
        LATER_VERSION,
        NO_CREATE_FUNCTION,
        ENDIAN_MISMATCH
    };

    enum 
    {
        SKIPPABLE_MASK = 0x8000
    };

	static LoadFile ms_pfnLoadFile;

    // static data
    static const unsigned int ms_uiNifMinVersion;
    static const unsigned int ms_uiNifMaxVersion;
    static const unsigned int ms_uiNifMinUserDefinedVersion;
    static const unsigned int ms_uiNifMaxUserDefinedVersion;
    
    char m_acLastLoadedRTTI[NI_MAX_PATH];
    unsigned int m_uiLastError;
    char m_acLastErrorMessage[NI_MAX_PATH];

    // support for object loader functions
    static NiTStringPointerMap<CreateFunction>* ms_pkLoaders;

    // Support for scene graph post-processing functions.
    typedef NiTPrimitiveArray<PostProcessFunction> PostProcessFunctionArray;

    static PostProcessFunctionArray* ms_pkPostProcessFunctions;

    static NiCriticalSection ms_kCleanupCriticalSection;
};

#include "NiStream.inl"

#endif // NISTREAM_H