CommandParserInterface.h

Go to the documentation of this file.

#ifndef __COMMAND_PARSER_INTERFACE
#define __COMMAND_PARSER_INTERFACE

#include "RakMemoryOverride.h"
#include "RakNetTypes.h"
#include "DS_OrderedList.h"
#include "Export.h"

namespace RakNet
{
class TransportInterface;

struct RAK_DLL_EXPORT RegisteredCommand
{
    const char *command;
    const char *commandHelp;
    unsigned char parameterCount;
};

int RAK_DLL_EXPORT RegisteredCommandComp( const char* const & key, const RegisteredCommand &data );

class RAK_DLL_EXPORT CommandParserInterface
{
public:
    CommandParserInterface();
    virtual ~CommandParserInterface();

    virtual const char *GetName(void) const=0;

    virtual void  OnNewIncomingConnection(const SystemAddress &systemAddress, TransportInterface *transport);

    virtual void OnConnectionLost(const SystemAddress &systemAddress, TransportInterface *transport);

    virtual void SendHelp(TransportInterface *transport, const SystemAddress &systemAddress)=0;

    virtual bool OnCommand(const char *command, unsigned numParameters, char **parameterList, TransportInterface *transport, const SystemAddress &systemAddress, const char *originalString)=0;

    virtual void OnTransportChange(TransportInterface *transport);

    virtual bool GetRegisteredCommand(const char *command, RegisteredCommand *rc);

    static void ParseConsoleString(char *str, const char delineator, unsigned char delineatorToggle, unsigned *numParameters, char **parameterList, unsigned parameterListLength);

    virtual void SendCommandList(TransportInterface *transport, const SystemAddress &systemAddress);

    static const unsigned char VARIABLE_NUMBER_OF_PARAMETERS;

    // Currently only takes static strings - doesn't make a copy of what you pass.
    // parameterCount is the number of parameters that the sender has to include with the command.
    // Pass 255 to parameterCount to indicate variable number of parameters

    virtual void RegisterCommand(unsigned char parameterCount, const char *command, const char *commandHelp);

    virtual void ReturnResult(bool res, const char *command, TransportInterface *transport, const SystemAddress &systemAddress);
    virtual void ReturnResult(char *res, const char *command, TransportInterface *transport, const SystemAddress &systemAddress);
    virtual void ReturnResult(SystemAddress res, const char *command, TransportInterface *transport, const SystemAddress &systemAddress);
    virtual void ReturnResult(int res, const char *command,TransportInterface *transport, const SystemAddress &systemAddress);

    virtual void ReturnResult(const char *command,TransportInterface *transport, const SystemAddress &systemAddress);

protected:
    DataStructures::OrderedList<const char*, RegisteredCommand, RegisteredCommandComp> commandList;
};

} // namespace RakNet

#endif