core/ConCmdManager.h
author David Anderson <danderson@mozilla.com>
Thu Aug 08 20:26:36 2013 -0700 (2013-08-08)
changeset 3979 bdad6d9c8351
parent 3942 7aaa00382627
child 4076 a1aeeac165e7
permissions -rw-r--r--
Use SSE when available for floating-point operations (bug 5841, r=her).
ds@579
     1
/**
ds@579
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
ds@579
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
ds@579
    28
 *
ds@579
    29
 * Version: $Id$
ds@579
    30
 */
ds@579
    31
ds@579
    32
#ifndef _INCLUDE_SOURCEMOD_CONCMDMANAGER_H_
ds@579
    33
#define _INCLUDE_SOURCEMOD_CONCMDMANAGER_H_
ds@579
    34
ds@579
    35
#include "sm_globals.h"
ds@579
    36
#include "sourcemm_api.h"
ds@579
    37
#include "ForwardSys.h"
ds@579
    38
#include "sm_trie.h"
ds@579
    39
#include "sm_memtable.h"
ds@579
    40
#include <sh_list.h>
ds@579
    41
#include <sh_string.h>
ds@579
    42
#include <IRootConsoleMenu.h>
ds@579
    43
#include <IAdminSystem.h>
dvander@1584
    44
#include "concmd_cleaner.h"
ds@579
    45
ds@579
    46
using namespace SourceHook;
ds@579
    47
ds@579
    48
enum CmdType
ds@579
    49
{
ds@579
    50
	Cmd_Server,
ds@579
    51
	Cmd_Admin,
ds@579
    52
};
ds@579
    53
ds@579
    54
struct AdminCmdInfo
ds@579
    55
{
ds@579
    56
	AdminCmdInfo()
ds@579
    57
	{
ds@579
    58
		cmdGrpId = -1;
ds@579
    59
		flags = 0;
ds@579
    60
		eflags = 0;
ds@579
    61
	}
ds@579
    62
	int cmdGrpId;			/* index into cmdgroup string table */
ds@579
    63
	FlagBits flags;			/* default flags */
ds@579
    64
	FlagBits eflags;		/* effective flags */
ds@579
    65
};
ds@579
    66
ds@579
    67
struct CmdHook
ds@579
    68
{
ds@579
    69
	CmdHook()
ds@579
    70
	{
ds@579
    71
		pf = NULL;
ds@579
    72
		pAdmin = NULL;
ds@579
    73
	}
ds@579
    74
	IPluginFunction *pf;	/* function hook */
ds@579
    75
	String helptext;		/* help text */
ds@579
    76
	AdminCmdInfo *pAdmin;	/* admin requirements, if any */
ds@579
    77
};
ds@579
    78
ds@579
    79
struct ConCmdInfo
ds@579
    80
{
ds@579
    81
	ConCmdInfo()
ds@579
    82
	{
ds@579
    83
		sourceMod = false;
ds@579
    84
		pCmd = NULL;
ds@579
    85
	}
ds@579
    86
	bool sourceMod;					/**< Determines whether or not concmd was created by a SourceMod plugin */
ds@579
    87
	ConCommand *pCmd;				/**< Pointer to the command itself */
ds@579
    88
	List<CmdHook *> srvhooks;		/**< Hooks as a server command */
ds@579
    89
	List<CmdHook *> conhooks;		/**< Hooks as a console command */
dvander@1119
    90
	AdminCmdInfo admin;				/**< Admin info, if any */
ds@579
    91
};
ds@579
    92
dvander@3302
    93
typedef List<ConCmdInfo *> ConCmdList;
dvander@3302
    94
ds@579
    95
class ConCmdManager :
ds@579
    96
	public SMGlobalClass,
ds@579
    97
	public IRootConsoleCommand,
dvander@1584
    98
	public IPluginsListener,
dvander@1584
    99
	public IConCommandTracker
ds@579
   100
{
skamonkey@3899
   101
#if SOURCE_ENGINE == SE_DOTA
skamonkey@3942
   102
	friend void CommandCallback(const CCommandContext &context, const CCommand &command);
skamonkey@3899
   103
#elif SOURCE_ENGINE >= SE_ORANGEBOX
faluco@1541
   104
	friend void CommandCallback(const CCommand &command);
faluco@1541
   105
#else
ds@579
   106
	friend void CommandCallback();
faluco@1541
   107
#endif
ds@579
   108
public:
ds@579
   109
	ConCmdManager();
ds@579
   110
	~ConCmdManager();
ds@579
   111
public: //SMGlobalClass
ds@579
   112
	void OnSourceModAllInitialized();
ds@579
   113
	void OnSourceModShutdown();
ds@579
   114
public: //IPluginsListener
ds@579
   115
	void OnPluginDestroyed(IPlugin *plugin);
ds@579
   116
public: //IRootConsoleCommand
faluco@1541
   117
	void OnRootConsoleCommand(const char *cmdname, const CCommand &command);
dvander@1584
   118
public: //IConCommandTracker
dvander@1584
   119
	void OnUnlinkConCommandBase(ConCommandBase *pBase, const char *name, bool is_read_safe);
ds@579
   120
public:
ds@579
   121
	bool AddServerCommand(IPluginFunction *pFunction, const char *name, const char *description, int flags);
ds@579
   122
	bool AddAdminCommand(IPluginFunction *pFunction, 
ds@579
   123
						 const char *name, 
ds@579
   124
						 const char *group,
ds@579
   125
						 int adminflags,
ds@579
   126
						 const char *description, 
ds@579
   127
						 int flags);
dvander@1335
   128
	ResultType DispatchClientCommand(int client, const char *cmd, int args, ResultType type);
dvander@1435
   129
	void UpdateAdminCmdFlags(const char *cmd, OverrideType type, FlagBits bits, bool remove);
dvander@893
   130
	bool LookForSourceModCommand(const char *cmd);
dvander@1349
   131
	bool LookForCommandAdminFlags(const char *cmd, FlagBits *pFlags);
skamonkey@3389
   132
	bool CheckClientCommandAccess(int client, const char *cmd, FlagBits flags);
skamonkey@3389
   133
	bool CheckAdminCommandAccess(AdminId adm, const char *cmd, FlagBits flags);
ds@579
   134
private:
faluco@1541
   135
	void InternalDispatch(const CCommand &command);
ds@579
   136
	ResultType RunAdminCommand(ConCmdInfo *pInfo, int client, int args);
ds@579
   137
	ConCmdInfo *AddOrFindCommand(const char *name, const char *description, int flags);
ds@579
   138
	void SetCommandClient(int client);
ds@579
   139
	void AddToCmdList(ConCmdInfo *info);
dvander@1584
   140
	void RemoveConCmd(ConCmdInfo *info, const char *cmd, bool is_read_safe, bool untrack);
dvander@1584
   141
	void RemoveConCmds(List<CmdHook *> &cmdlist);
ds@579
   142
	void RemoveConCmds(List<CmdHook *> &cmdlist, IPluginContext *pContext);
ds@579
   143
	bool CheckAccess(int client, const char *cmd, AdminCmdInfo *pAdmin);
dvander@3302
   144
dvander@3302
   145
	// Case insensitive
dvander@3302
   146
	ConCmdList::iterator FindInList(const char *name);
dvander@3302
   147
dvander@3302
   148
	// Case sensitive
dvander@3302
   149
	ConCmdInfo *FindInTrie(const char *name);
dvander@769
   150
public:
dvander@769
   151
	inline int GetCommandClient()
dvander@769
   152
	{
dvander@769
   153
		return m_CmdClient;
dvander@769
   154
	}
dvander@1119
   155
	inline const List<ConCmdInfo *> & GetCommandList()
dvander@1119
   156
	{
dvander@1119
   157
		return m_CmdList;
dvander@1119
   158
	}
ds@579
   159
private:
ds@579
   160
	Trie *m_pCmds;					/* command lookup */
ds@579
   161
	Trie *m_pCmdGrps;				/* command group lookup */
dvander@3302
   162
	ConCmdList m_CmdList;			/* command list */
ds@579
   163
	int m_CmdClient;				/* current client */
ds@579
   164
	BaseStringTable m_Strings;		/* string table */
ds@579
   165
};
ds@579
   166
ds@579
   167
extern ConCmdManager g_ConCmds;
ds@579
   168
ds@579
   169
#endif // _INCLUDE_SOURCEMOD_CONCMDMANAGER_H_
dvander@2806
   170