mirror of
https://github.com/ddnet/ddnet.git
synced 2024-09-21 01:54:19 +00:00
85 lines
3.8 KiB
C++
85 lines
3.8 KiB
C++
/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
|
|
/* If you are missing that file, acquire a complete release at teeworlds.com. */
|
|
#ifndef ENGINE_CONSOLE_H
|
|
#define ENGINE_CONSOLE_H
|
|
|
|
#include "kernel.h"
|
|
|
|
class IConsole : public IInterface
|
|
{
|
|
MACRO_INTERFACE("console", 0)
|
|
public:
|
|
|
|
enum
|
|
{
|
|
OUTPUT_LEVEL_STANDARD=0,
|
|
OUTPUT_LEVEL_ADDINFO,
|
|
OUTPUT_LEVEL_DEBUG
|
|
};
|
|
|
|
// TODO: rework this interface to reduce the amount of virtual calls
|
|
class IResult
|
|
{
|
|
protected:
|
|
unsigned m_NumArgs;
|
|
public:
|
|
IResult() { m_NumArgs = 0; }
|
|
virtual ~IResult() {}
|
|
|
|
virtual int GetInteger(unsigned Index) = 0;
|
|
virtual float GetFloat(unsigned Index) = 0;
|
|
virtual const char *GetString(unsigned Index) = 0;
|
|
virtual int GetVictim() = 0;
|
|
|
|
int NumArguments() const { return m_NumArgs; }
|
|
};
|
|
|
|
class CCommandInfo
|
|
{
|
|
public:
|
|
const char *m_pName;
|
|
const char *m_pHelp;
|
|
const char *m_pParams;
|
|
int m_Level;
|
|
};
|
|
|
|
typedef void (*FPrintCallback)(const char *pStr, void *pUser);
|
|
typedef void (*FPossibleCallback)(const char *pCmd, void *pUser);
|
|
typedef void (*FCommandCallback)(IResult *pResult, void *pUserData, int ClientId);
|
|
typedef void (*FChainCommandCallback)(IResult *pResult, void *pUserData, FCommandCallback pfnCallback, void *pCallbackUserData);
|
|
|
|
typedef bool (*FCompareClientsCallback)(int ClientLevel, int Victim, void *pUserData);
|
|
typedef bool (*FClientOnlineCallback)(int ClientId, void *pUserData);
|
|
|
|
virtual CCommandInfo *GetCommandInfo(const char *pName, int FlagMask) = 0;
|
|
virtual void PossibleCommands(const char *pStr, int FlagMask, FPossibleCallback pfnCallback, void *pUser) = 0;
|
|
virtual void ParseArguments(int NumArgs, const char **ppArguments) = 0;
|
|
|
|
virtual void Register(const char *pName, const char *pParams,
|
|
int Flags, FCommandCallback pfnFunc, void *pUser, const char *pHelp, const int Level) = 0;
|
|
virtual void List(const int Level, int Flags, int Page = 0) = 0;
|
|
virtual void Chain(const char *pName, FChainCommandCallback pfnChainFunc, void *pUser) = 0;
|
|
virtual void StoreCommands(bool Store, int ClientId) = 0;
|
|
|
|
virtual bool LineIsValid(const char *pStr) = 0;
|
|
virtual void ExecuteLine(const char *Sptr, const int ClientLevel, const int ClientId, FPrintCallback pfnAlternativePrintCallback = 0, void *pUserData = 0, FPrintCallback pfnAlternativePrintResponseCallback = 0, void *pResponseUserData = 0) = 0;
|
|
virtual void ExecuteLineStroked(int Stroke, const char *pStr, const int ClientLevel, const int ClientId, FPrintCallback pfnAlternativePrintCallback = 0, void *pUserData = 0, FPrintCallback pfnAlternativePrintResponseCallback = 0, void *pResponseUserData = 0) = 0;
|
|
virtual void ExecuteFile(const char *pFilename, FPrintCallback pfnAlternativePrintCallback = 0, void *pUserData = 0, FPrintCallback pfnAlternativePrintResponseCallback = 0, void *pResponseUserData = 0) = 0;
|
|
|
|
virtual void RegisterPrintCallback(FPrintCallback pfnPrintCallback, void *pUserData) = 0;
|
|
virtual void RegisterAlternativePrintCallback(FPrintCallback pfnAlternativePrintCallback, void *pAlternativeUserData) = 0;
|
|
virtual void ReleaseAlternativePrintCallback() = 0;
|
|
virtual void RegisterPrintResponseCallback(FPrintCallback pfnPrintResponseCallback, void *pUserData) = 0;
|
|
virtual void RegisterAlternativePrintResponseCallback(FPrintCallback pfnAlternativePrintCallback, void *pAlternativeUserData) = 0;
|
|
virtual void ReleaseAlternativePrintResponseCallback() = 0;
|
|
virtual void Print(int Level, const char *pFrom, const char *pStr) = 0;
|
|
virtual void PrintResponse(int Level, const char *pFrom, const char *pStr) = 0;
|
|
|
|
virtual void RegisterCompareClientsCallback(FCompareClientsCallback pfnCallback, void *pUserData) = 0;
|
|
virtual void RegisterClientOnlineCallback(FClientOnlineCallback pfnCallback, void *pUserData) = 0;
|
|
};
|
|
|
|
extern IConsole *CreateConsole(int FlagMask);
|
|
|
|
#endif // FILE_ENGINE_CONSOLE_H
|