FileList.h

Go to the documentation of this file.

#include "NativeFeatureIncludes.h"
#if _RAKNET_SUPPORT_FileOperations==1

#ifndef __FILE_LIST
#define __FILE_LIST

#include "Export.h"
#include "DS_List.h"
#include "RakMemoryOverride.h"
#include "RakNetTypes.h"
#include "FileListNodeContext.h"
#include "RakString.h"

#ifdef _MSC_VER
#pragma warning( push )
#endif

namespace RakNet
{
    class BitStream;
}

namespace RakNet
{
class RakPeerInterface;
class FileList;


struct FileListNode
{
    RakNet::RakString filename;

    RakNet::RakString fullPathToFile;

    char *data;

    BitSize_t dataLengthBytes;

    unsigned fileLengthBytes;

    FileListNodeContext context; 

    bool isAReference;
};

class RAK_DLL_EXPORT FileListProgress
{
public:
    // GetInstance() and DestroyInstance(instance*)
    STATIC_FACTORY_DECLARATIONS(FileListProgress)

    FileListProgress() {}
    virtual ~FileListProgress() {}

    virtual void OnAddFilesFromDirectoryStarted(FileList *fileList, char *dir) {
        (void) fileList;
        (void) dir;
    }

    virtual void OnDirectory(FileList *fileList, char *dir, unsigned int directoriesRemaining) {
        (void) fileList;
        (void) dir;
        (void) directoriesRemaining;
    }

    virtual void OnFile(FileList *fileList, char *dir, char *fileName, unsigned int fileSize) {
        (void) fileList;
        (void) dir;
        (void) fileName;
        (void) fileSize;
    }

    virtual void OnFilePush(const char *fileName, unsigned int fileLengthBytes, unsigned int offset, unsigned int bytesBeingSent, bool done, SystemAddress targetSystem)
    {
        (void) fileName;
        (void) fileLengthBytes;
        (void) offset;
        (void) bytesBeingSent;
        (void) done;
        (void) targetSystem;
    }

    virtual void OnFilePushesComplete( SystemAddress systemAddress )
    {
        (void) systemAddress;
    }

    virtual void OnSendAborted( SystemAddress systemAddress )
    {
        (void) systemAddress;
    }
};

class RAK_DLL_EXPORT FLP_Printf : public FileListProgress
{
public:
    // GetInstance() and DestroyInstance(instance*)
    STATIC_FACTORY_DECLARATIONS(FLP_Printf)

    FLP_Printf() {}
    virtual ~FLP_Printf() {}

    virtual void OnAddFilesFromDirectoryStarted(FileList *fileList, char *dir);

    virtual void OnDirectory(FileList *fileList, char *dir, unsigned int directoriesRemaining);

    virtual void OnFilePushesComplete( SystemAddress systemAddress );

    virtual void OnSendAborted( SystemAddress systemAddress );
};

class RAK_DLL_EXPORT FileList
{
public:
    // GetInstance() and DestroyInstance(instance*)
    STATIC_FACTORY_DECLARATIONS(FileList)

    FileList();
    ~FileList();
    void AddFilesFromDirectory(const char *applicationDirectory, const char *subDirectory, bool writeHash, bool writeData, bool recursive, FileListNodeContext context);

    void Clear(void);

    void Serialize(RakNet::BitStream *outBitStream);

    bool Deserialize(RakNet::BitStream *inBitStream);

    void ListMissingOrChangedFiles(const char *applicationDirectory, FileList *missingOrChangedFiles, bool alwaysWriteHash, bool neverWriteHash);

    void GetDeltaToCurrent(FileList *input, FileList *output, const char *dirSubset, const char *remoteSubdir);

    void PopulateDataFromDisk(const char *applicationDirectory, bool writeFileData, bool writeFileHash, bool removeUnknownFiles);

    void FlagFilesAsReferences(void);

    void WriteDataToDisk(const char *applicationDirectory);

    void AddFile(const char *filename, const char *fullPathToFile, const char *data, const unsigned dataLength, const unsigned fileLength, FileListNodeContext context, bool isAReference=false, bool takeDataPointer=false);

    void AddFile(const char *filepath, const char *filename, FileListNodeContext context);

    void DeleteFiles(const char *applicationDirectory);

    void AddCallback(FileListProgress *cb);

    void RemoveCallback(FileListProgress *cb);

    void ClearCallbacks(void);

    void GetCallbacks(DataStructures::List<FileListProgress*> &callbacks);

    // Here so you can read it, but don't modify it
    DataStructures::List<FileListNode> fileList;

    static bool FixEndingSlash(char *str);
protected:
    DataStructures::List<FileListProgress*> fileListProgressCallbacks;
};

} // namespace RakNet

#ifdef _MSC_VER
#pragma warning( pop )
#endif

#endif

#endif // _RAKNET_SUPPORT_FileOperations