sourcemm/metamod_plugins.h
author David Anderson <dvander@alliedmods.net>
Thu Oct 04 19:18:19 2007 +0000 (2007-10-04)
branchsourcemm-1.6.0
changeset 369 2b8c2ea08b6d
parent 367 fc76472b980f
permissions -rw-r--r--
fixed usermessages not printing
removed old ConMsg extraction code
dvander@367
     1
/**
dvander@367
     2
 * vim: set ts=4 :
dvander@367
     3
 * ======================================================
dvander@367
     4
 * Metamod:Source
dvander@367
     5
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
dvander@367
     6
 * All rights reserved.
dvander@367
     7
 * ======================================================
dvander@367
     8
 *
dvander@367
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@367
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@367
    11
 * the use of this software.
dvander@367
    12
 * 
dvander@367
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@367
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@367
    15
 * freely, subject to the following restrictions:
dvander@367
    16
 *
dvander@367
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@367
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@367
    19
 * product, an acknowledgment in the product documentation would be 
dvander@367
    20
 * appreciated but is not required.
dvander@367
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@367
    22
 * misrepresented as being the original software.
dvander@367
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@367
    24
 *
dvander@367
    25
 * Version: $Id$
dvander@367
    26
 */
dvander@352
    27
dvander@352
    28
#ifndef _INCLUDE_CPLUGIN_H
dvander@352
    29
#define _INCLUDE_CPLUGIN_H
dvander@352
    30
dvander@352
    31
/**
dvander@352
    32
 * @brief Implementation of Plugin API and Management routines
dvander@352
    33
 * @file CPlugin.cpp
dvander@352
    34
 */
dvander@352
    35
dvander@352
    36
#include <interface.h>
dvander@352
    37
#include <eiface.h>
dvander@352
    38
#include <sh_list.h>
dvander@352
    39
#include <sh_string.h>
dvander@352
    40
#include "IPluginManager.h"
dvander@359
    41
#include "metamod_oslink.h"
dvander@352
    42
dvander@352
    43
/**
dvander@352
    44
 * History of plugin versions: (M=min, C=current)
dvander@352
    45
 *     1: Initial interface
dvander@352
    46
 *     2: Added GetLogTag()
dvander@352
    47
 *     3: Moved GetApiVersion() to top  (2005-04-16)
dvander@352
    48
 *     4: Added AllPluginsLoaded() callback (2005-04-18)
dvander@352
    49
 *     5: Bumped version for SourceHook V4 (2005-05-01)
dvander@352
    50
 *     6: Added functions for console printing (2005-05-26)
dvander@352
    51
 * M   7: Changed template libraries (2005-08-11)
dvander@352
    52
 * 	      New loading structure mechanism
dvander@352
    53
 *        New SourceHook version
dvander@352
    54
 *     8: New SourceHook version (2005-12-23)
dvander@352
    55
 *        New ISmmAPI additions
dvander@352
    56
 *     9: New ISmmPluginManager additions
dvander@352
    57
 *  C 10: Added VSP listen functions to ISmmAPI and IMetamodListener (2007-02-09)
dvander@352
    58
 *  C 11: New SourceHook version V5 (May, 2007)
dvander@352
    59
 */
dvander@352
    60
dvander@352
    61
#define PLAPI_MIN_VERSION	7
dvander@352
    62
dvander@352
    63
namespace SourceMM
dvander@352
    64
{
dvander@352
    65
	struct CNameAlias
dvander@352
    66
	{
dvander@352
    67
		SourceHook::String alias;
dvander@352
    68
		SourceHook::String value;
dvander@352
    69
	};
dvander@352
    70
	/**
dvander@352
    71
	 * @brief Implements Plugin Manager API
dvander@352
    72
	 */
dvander@352
    73
	class CPluginManager : public ISmmPluginManager
dvander@352
    74
	{	
dvander@352
    75
	public:
dvander@352
    76
		/**
dvander@352
    77
		 * @brief Internal structure for holding plugin data
dvander@352
    78
		 */
dvander@352
    79
		class CPlugin
dvander@352
    80
		{
dvander@352
    81
		public:
dvander@352
    82
			CPlugin();
dvander@352
    83
		public:
dvander@352
    84
			PluginId m_Id;
dvander@352
    85
			SourceHook::String m_File;
dvander@352
    86
			Pl_Status m_Status;
dvander@352
    87
			PluginId m_Source;
dvander@352
    88
			ISmmPlugin *m_API;
dvander@352
    89
			HINSTANCE m_Lib;
dvander@352
    90
			SourceHook::List<ConCommandBase *> m_Cvars;
dvander@352
    91
			SourceHook::List<ConCommandBase *> m_Cmds;
dvander@352
    92
			SourceHook::List<IMetamodListener *> m_Events;
dvander@352
    93
		};
dvander@352
    94
	public:
dvander@352
    95
		CPluginManager();
dvander@352
    96
		~CPluginManager();
dvander@352
    97
		void SetAllLoaded();
dvander@352
    98
	public:
dvander@352
    99
		PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
dvander@352
   100
		bool Unload(PluginId id, bool force, char *error, size_t maxlen);
dvander@352
   101
		bool Pause(PluginId id, char *error, size_t maxlen);
dvander@352
   102
		bool Unpause(PluginId id, char *error, size_t maxlen);
dvander@352
   103
		bool UnloadAll();
dvander@352
   104
		void SetAlias(const char *alias, const char *value);
dvander@352
   105
	public:
dvander@352
   106
		bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source);
dvander@352
   107
		bool QueryRunning(PluginId id, char *error, size_t maxlength);
dvander@352
   108
		bool QueryHandle(PluginId id, void *&handle);
dvander@352
   109
dvander@352
   110
		void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@352
   111
		void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@352
   112
		void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@352
   113
		void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@352
   114
dvander@352
   115
		/**
dvander@352
   116
		 * @brief Finds a plugin by Id
dvander@352
   117
		 *
dvander@352
   118
		 * @param id Id of plugin
dvander@352
   119
		 * @return CPlugin on success, NULL otherwise
dvander@352
   120
		 */
dvander@352
   121
		CPlugin *FindById(PluginId id);
dvander@352
   122
dvander@352
   123
		CPlugin *FindByAPI(ISmmPlugin *api);
dvander@352
   124
dvander@352
   125
		/**
dvander@352
   126
		 * @brief Attempts to reload a failed plugin
dvander@352
   127
		 *
dvander@352
   128
		 * @param id Id of plugin
dvander@352
   129
		 * @param error Error message buffer
dvander@352
   130
		 * @param len Maximum length of buffer
dvander@352
   131
		 * @return True on success, false otherwise
dvander@352
   132
		 */
dvander@352
   133
		bool Retry(PluginId id, char *error, size_t len);
dvander@352
   134
dvander@352
   135
		int GetPluginCount();
dvander@352
   136
		const char *GetStatusText(CPlugin *pl);
dvander@352
   137
dvander@352
   138
		//get alias info
dvander@352
   139
		const char *LookupAlias(const char *alias);
dvander@352
   140
		SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_begin();
dvander@352
   141
		SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_end();
dvander@352
   142
dvander@352
   143
		//Internal iterators
dvander@352
   144
		SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
dvander@352
   145
		SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _end();
dvander@352
   146
	private:
dvander@352
   147
		//These are identical internal functions for the wrappers above.
dvander@352
   148
		CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
dvander@352
   149
		bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
dvander@352
   150
		bool _Pause(CPlugin *pl, char *error, size_t maxlen);
dvander@352
   151
		bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
dvander@352
   152
		void UnregAllConCmds(CPlugin *pl);
dvander@352
   153
	private:
dvander@352
   154
		PluginId m_LastId;
dvander@352
   155
		SourceHook::List<CPlugin *> m_Plugins;
dvander@352
   156
		SourceHook::List<CNameAlias *> m_Aliases;
dvander@352
   157
		bool m_AllLoaded;
dvander@352
   158
	};
dvander@352
   159
};
dvander@352
   160
dvander@352
   161
typedef SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
dvander@352
   162
dvander@352
   163
/** @brief Singleton for plugin manager */
dvander@352
   164
extern SourceMM::CPluginManager g_PluginMngr;
dvander@352
   165
dvander@352
   166
#endif //_INCLUDE_CPLUGIN_H
dvander@366
   167