DataBlock_Function.h

/* START_LICENSE_HEADER

Copyright (C) 2000 Martin Piper, original design and program code
Copyright (C) 2001 Replica Software

This program file is copyright (C) Replica Software and can only be used under license.
For more information visit: http://www.replicanet.com/
Or email: info@replicanet.com

END_LICENSE_HEADER */
#include "RNPlatform/Inc/MemoryTracking.h"
#ifndef __DATABLOCK_FUNCTION_H__
#define __DATABLOCK_FUNCTION_H__

#include "RNReplicaNet/Inc/DataBlock.h"
#include "RNPlatform/Inc/MessageHelper.h"
#include "RNPlatform/Inc/RegistryManagerMap.h"
#include <list>

namespace RNReplicaNet
{

struct CombinedDataPacket;
struct SessionBlock_Function;

class DataBlock_Function : public DataBlock
{
public:
    RN_CLASS_MINIMAL_RTTI();
    typedef void (tDataBlock_Function_funcp)(void *classp,void *data,void *thisDataBlock);

    DataBlock_Function();

    virtual ~DataBlock_Function();

    virtual void Poll(DataBlockReason *reason,const bool discardOlderIncluded = false,const unsigned int discardOrder = 0);

    virtual void ParseMessage(MessageHelper *message);

    static DataBlock_Function *Register(void *classp,tDataBlock_Function_funcp *funcp);

    void RegisterInClassPointer(void *classp,tDataBlock_Function_funcp *funcp)
    {
        mClassp = classp;
        mData = funcp;
    }

    static void SetSessionIDFilter(const int numSessionIDs = 0,const int *sessionIDs = 0);

    void AddFunctionStateChange(void *data,int len,const char *debug = 0);

    bool IsAttached(void *data);

    virtual void OwnerChanged(const int sessionID);

protected:  // User defined DataBlocks have access to these variables.
    void FreeSessionBlocks(void);
    void *mClassp;
    tDataBlock_Function_funcp *mData;

    RegistryManagerMap<int,SessionBlock_Function> mPerSessionFunction;

    std::list<CombinedDataPacket *> mFunctionStateChanges;

    static int mConfiguredNumSessions;
    static int *mConfiguredSessionIDs;
};

// Specialise this template to allow different variable types to be used with DataBlock_Function
template<typename T>
void FunctionAddVariable(DynamicMessageHelper &message, T &variable)
{
    message.AddVariable(&variable,sizeof(variable));
}

// Specialise this template to allow different variable types to be used with DataBlock_Function
template<typename T>
void FunctionGetVariable(MessageHelper &message, T &variable)
{
    message.GetVariable(&variable,sizeof(variable));
}

} // namespace RNReplicaNet


/* _RO_DO_REGISTERBLOCK_FUNCTION_VAR macro starts here */
#define _RO_DO_REGISTERBLOCK_FUNCTION_VAR(x)    \
    {\
        RNReplicaNet::DataBlock_Function *datablock = 0;    \
        datablock = RNReplicaNet::DataBlock_Function::Register((void *)this,&x);    \
        mDataBlockFunction_##x = datablock; \
        _RO_DO_SETDATABLOCKVARIABLENAME(x);
/* _RO_DO_REGISTERBLOCK_FUNCTION_VAR macro ends here */

// For member function wrapping. A lot of macro work
/* _RO_MAKE_MEMBERFUNC macro starts here */
#define _RO_MAKE_MEMBERFUNC(x)  Call_##x
/* _RO_MAKE_MEMBERFUNC macro ends here */

/* _RO_DO_MEMBERFUNC_PRESTAGE_DEF macro starts here */
#define _RO_DO_MEMBERFUNC_PRESTAGE_DEF(x,y) \
void _MAKE_RO(x)::_RO_MAKE_MEMBERFUNC(y)(
/* _RO_DO_MEMBERFUNC_PRESTAGE_DEF macro ends here */


/* _RO_DO_MEMBERFUNC_PRESTAGE macro starts here */
#ifdef REPLICANET_VISUALDEBUGGER
#define _RO_DO_MEMBERFUNC_PRESTAGE(x)   \
)   \
{   \
    if (!mDataBlocksRegistered) \
    {   \
        return; \
    }   \
    RNReplicaNet::DynamicMessageHelper message; \
    message.SetBufferSize(256); \
    std::string debug;
#else //ifdef REPLICANET_VISUALDEBUGGER
#define _RO_DO_MEMBERFUNC_PRESTAGE(x)   \
)   \
{   \
    if (!mDataBlocksRegistered) \
    {   \
        return; \
    }   \
    RNReplicaNet::DynamicMessageHelper message; \
    message.SetBufferSize(256);
#endif //ifdef REPLICANET_VISUALDEBUGGER
/* _RO_DO_MEMBERFUNC_PRESTAGE macro ends here */

/* _RO_DO_MEMBERFUNC_ADDVAR macro starts here */
#define _RO_DO_MEMBERFUNC_ADDVAR(x) \
    RNReplicaNet::FunctionAddVariable(message,x);
// Updated version of this macro, does the same as _RO_DO_MEMBERFUNC_ADDVAR but also includes the string variable type for extra debug info.
#ifdef REPLICANET_VISUALDEBUGGER
#define _RO_DO_MEMBERFUNC_ADDVAR2(x,y)  \
    RNReplicaNet::FunctionAddVariable(message,x);   \
    if (RNReplicaNet::XPURL::GetDebugHandler()) \
    {   \
        debug += #y;    \
        debug += "\n";  \
        debug += RNReplicaNet::MessageHelper::DumpAsHex(&x,sizeof(x));  \
        debug += "\n";  \
    }
#else // ifdef REPLICANET_VISUALDEBUGGER
#define _RO_DO_MEMBERFUNC_ADDVAR2(x,y)  \
    RNReplicaNet::FunctionAddVariable(message,x);
#endif // ifdef REPLICANET_VISUALDEBUGGER
/* _RO_DO_MEMBERFUNC_ADDVAR macro ends here */

/* _RO_DO_MEMBERFUNC_POSTSTAGE macro starts here */
#ifdef REPLICANET_VISUALDEBUGGER
#define _RO_DO_MEMBERFUNC_POSTSTAGE(x)  \
    RNReplicaNet::DataBlock_Function *datablock = (RNReplicaNet::DataBlock_Function *) mDataBlockFunction_##x;  \
    datablock->AddFunctionStateChange(message.GetBuffer(),message.GetSize(),debug.c_str()); \
}
#else //ifdef REPLICANET_VISUALDEBUGGER
#define _RO_DO_MEMBERFUNC_POSTSTAGE(x)  \
    RNReplicaNet::DataBlock_Function *datablock = (RNReplicaNet::DataBlock_Function *) mDataBlockFunction_##x;  \
    datablock->AddFunctionStateChange(message.GetBuffer(),message.GetSize());   \
}
#endif //ifdef REPLICANET_VISUALDEBUGGER
/* _RO_DO_MEMBERFUNC_POSTSTAGE macro ends here */


/* _RO_DO_MEMBERFUNC_CRACK_START macro starts here */
#define _RO_DO_MEMBERFUNC_CRACK_START(x,y)  \
void _MAKE_RO(x)::y(void *classp,void *opaque_message,void *thisDataBlock)  \
{   \
    _MAKE_RO(x) *thisclass = (_MAKE_RO(x) *) classp;    \
    RNReplicaNet::MessageHelper *message = (RNReplicaNet::MessageHelper *) opaque_message;  \
    message = message;
/* _RO_DO_MEMBERFUNC_CRACK_START macro ends here */

/* _RO_DO_MEMBERFUNC_MESSAGE_CRACK macro starts here */
#define _RO_DO_MEMBERFUNC_MESSAGE_CRACK(x)  \
    RNReplicaNet::FunctionGetVariable(*message,x);
/* _RO_DO_MEMBERFUNC_MESSAGE_CRACK macro ends here */


/* _RO_DO_MEMBERFUNC_CRACK_END macro starts here */
#define _RO_DO_MEMBERFUNC_CRACK_END(x,y)    \
    if (!((RNReplicaNet::DataBlock*)thisDataBlock)->GetDiscardThisUpdate()) \
    {   \
        ((x*)thisclass)->y(
/* _RO_DO_MEMBERFUNC_CRACK_END macro ends here */

/* _RO_DO_MEMBERFUNC_CRACK_END2 macro starts here */
#define _RO_DO_MEMBERFUNC_CRACK_END2()  \
    );  \
    }   \
}
/* _RO_DO_MEMBERFUNC_CRACK_END2 macro ends here */

#endif