mirror of
https://github.com/ddnet/ddnet.git
synced 2024-11-14 03:58:18 +00:00
115 lines
3.9 KiB
C++
115 lines
3.9 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 <engine/storage.h>
|
|
#include "kernel.h"
|
|
|
|
class IConsole : public IInterface
|
|
{
|
|
MACRO_INTERFACE("console", 0)
|
|
public:
|
|
|
|
// TODO: rework/cleanup
|
|
enum
|
|
{
|
|
OUTPUT_LEVEL_STANDARD=0,
|
|
OUTPUT_LEVEL_ADDINFO,
|
|
OUTPUT_LEVEL_DEBUG,
|
|
|
|
ACCESS_LEVEL_ADMIN=0,
|
|
ACCESS_LEVEL_MOD,
|
|
ACCESS_LEVEL_HELPER,
|
|
ACCESS_LEVEL_USER,
|
|
|
|
TEMPCMD_NAME_LENGTH=32,
|
|
TEMPCMD_HELP_LENGTH=96,
|
|
TEMPCMD_PARAMS_LENGTH=96,
|
|
|
|
MAX_PRINT_CB=4,
|
|
|
|
CLIENT_ID_GAME=-2,
|
|
CLIENT_ID_NO_GAME=-3,
|
|
};
|
|
|
|
// 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;
|
|
|
|
int NumArguments() const { return m_NumArgs; }
|
|
int m_ClientID;
|
|
|
|
// DDRace
|
|
|
|
virtual int GetVictim() = 0;
|
|
};
|
|
|
|
class CCommandInfo
|
|
{
|
|
protected:
|
|
int m_AccessLevel;
|
|
public:
|
|
CCommandInfo() { m_AccessLevel = ACCESS_LEVEL_ADMIN; }
|
|
virtual ~CCommandInfo() {}
|
|
const char *m_pName;
|
|
const char *m_pHelp;
|
|
const char *m_pParams;
|
|
|
|
virtual const CCommandInfo *NextCommandInfo(int AccessLevel, int FlagMask) const = 0;
|
|
|
|
int GetAccessLevel() const { return m_AccessLevel; }
|
|
};
|
|
|
|
typedef void (*FTeeHistorianCommandCallback)(int ClientID, int FlagMask, const char *pCmd, IResult *pResult, void *pUser);
|
|
typedef void (*FPrintCallback)(const char *pStr, void *pUser, bool Highlighted);
|
|
typedef void (*FPossibleCallback)(const char *pCmd, void *pUser);
|
|
typedef void (*FCommandCallback)(IResult *pResult, void *pUserData);
|
|
typedef void (*FChainCommandCallback)(IResult *pResult, void *pUserData, FCommandCallback pfnCallback, void *pCallbackUserData);
|
|
|
|
virtual const CCommandInfo *FirstCommandInfo(int AccessLevel, int Flagmask) const = 0;
|
|
virtual const CCommandInfo *GetCommandInfo(const char *pName, int FlagMask, bool Temp) = 0;
|
|
virtual void PossibleCommands(const char *pStr, int FlagMask, bool Temp, 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) = 0;
|
|
virtual void RegisterTemp(const char *pName, const char *pParams, int Flags, const char *pHelp) = 0;
|
|
virtual void DeregisterTemp(const char *pName) = 0;
|
|
virtual void DeregisterTempAll() = 0;
|
|
virtual void Chain(const char *pName, FChainCommandCallback pfnChainFunc, void *pUser) = 0;
|
|
virtual void StoreCommands(bool Store) = 0;
|
|
|
|
virtual bool LineIsValid(const char *pStr) = 0;
|
|
virtual void ExecuteLine(const char *Sptr, int ClientID = -1, bool InterpretSemicolons = true) = 0;
|
|
virtual void ExecuteLineFlag(const char *Sptr, int FlasgMask, int ClientID = -1, bool InterpretSemicolons = true) = 0;
|
|
virtual void ExecuteLineStroked(int Stroke, const char *pStr, int ClientID = -1, bool InterpretSemicolons = true) = 0;
|
|
virtual void ExecuteFile(const char *pFilename, int ClientID = -1, bool LogFailure = false, int StorageType = IStorage::TYPE_ALL) = 0;
|
|
|
|
virtual int RegisterPrintCallback(int OutputLevel, FPrintCallback pfnPrintCallback, void *pUserData) = 0;
|
|
virtual void SetPrintOutputLevel(int Index, int OutputLevel) = 0;
|
|
virtual void Print(int Level, const char *pFrom, const char *pStr, bool Highlighted = false) = 0;
|
|
virtual void SetTeeHistorianCommandCallback(FTeeHistorianCommandCallback pfnCallback, void *pUser) = 0;
|
|
|
|
virtual void SetAccessLevel(int AccessLevel) = 0;
|
|
|
|
virtual void ResetServerGameSettings() = 0;
|
|
|
|
// DDRace
|
|
|
|
bool m_Cheated;
|
|
virtual void SetFlagMask(int FlagMask) = 0;
|
|
};
|
|
|
|
extern IConsole *CreateConsole(int FlagMask);
|
|
|
|
#endif // FILE_ENGINE_CONSOLE_H
|