sourcemm/CPlugin.h
author Scott Ehlert <ds@alliedmods.net>
Thu Feb 08 09:19:19 2007 +0000 (2007-02-08)
changeset 280 946485e00593
parent 227 b93cfe2e3a0b
child 282 7a237e9ea5a1
permissions -rw-r--r--
Renamed convar.h to convar_smm.h in order to avoid potential compiling problems with the order of include directories.
dvander@7
     1
/* ======== SourceMM ========
dvander@175
     2
* Copyright (C) 2004-2006 Metamod:Source Development Team
dvander@7
     3
* No warranties of any kind
dvander@7
     4
*
dvander@7
     5
* License: zlib/libpng
dvander@7
     6
*
dvander@7
     7
* Author(s): David "BAILOPAN" Anderson
dvander@7
     8
* ============================
dvander@7
     9
*/
dvander@7
    10
dvander@7
    11
#ifndef _INCLUDE_CPLUGIN_H
dvander@7
    12
#define _INCLUDE_CPLUGIN_H
dvander@7
    13
dvander@7
    14
/**
dvander@7
    15
 * @brief Implementation of Plugin API and Management routines
dvander@7
    16
 * @file CPlugin.cpp
dvander@7
    17
 */
dvander@7
    18
dvander@67
    19
#include <interface.h>
dvander@67
    20
#include <eiface.h>
ds@280
    21
#include "convar_smm.h"
dvander@7
    22
#include "IPluginManager.h"
dvander@7
    23
#include "oslink.h"
dvander@98
    24
#include "sh_list.h"
dvander@98
    25
#include "sh_string.h"
dvander@7
    26
dvander@51
    27
/**
dvander@51
    28
 * History of plugin versions: (M=min, C=current)
dvander@51
    29
 *    1: Initial interface
dvander@51
    30
 *    2: Added GetLogTag()
dvander@51
    31
 *    3: Moved GetApiVersion() to top  (2005-04-16)
dvander@51
    32
 *    4: Added AllPluginsLoaded() callback (2005-04-18)
dvander@97
    33
 *    5: Bumped version for SourceHook V4 (2005-05-01)
dvander@97
    34
 *    6: Added functions for console printing (2005-05-26)
ds@192
    35
 *  M 7: Changed template libraries (2005-08-11)
dvander@122
    36
 *		 New loading structure mechanism
dvander@122
    37
 *	     New SourceHook version
dvander@227
    38
 *    8: New SourceHook version (2005-12-23)
dvander@166
    39
 *       New ISmmAPI additions
dvander@227
    40
 *  C 9: New ISmmPluginManager additions
dvander@51
    41
 */
dvander@51
    42
dvander@105
    43
#define PLAPI_MIN_VERSION	7
dvander@51
    44
dvander@7
    45
namespace SourceMM
dvander@7
    46
{
dvander@205
    47
	struct CNameAlias
dvander@205
    48
	{
dvander@205
    49
		SourceHook::String alias;
dvander@205
    50
		SourceHook::String value;
dvander@205
    51
	};
dvander@7
    52
	/**
dvander@7
    53
	 * @brief Implements Plugin Manager API
dvander@7
    54
	 */
dvander@7
    55
	class CPluginManager : public ISmmPluginManager
dvander@7
    56
	{	
dvander@7
    57
	public:
dvander@7
    58
		/**
dvander@7
    59
		 * @brief Internal structure for holding plugin data
dvander@7
    60
		 */
dvander@7
    61
		class CPlugin
dvander@7
    62
		{
dvander@7
    63
		public:
dvander@7
    64
			CPlugin();
dvander@7
    65
		public:
dvander@7
    66
			PluginId m_Id;
dvander@98
    67
			SourceHook::String m_File;
dvander@7
    68
			Pl_Status m_Status;
dvander@7
    69
			PluginId m_Source;
dvander@7
    70
			ISmmPlugin *m_API;
dvander@7
    71
			HINSTANCE m_Lib;
dvander@98
    72
			SourceHook::List<ConCommandBase *> m_Cvars;
dvander@98
    73
			SourceHook::List<ConCommandBase *> m_Cmds;
dvander@138
    74
			SourceHook::List<IMetamodListener *> m_Events;
dvander@7
    75
		};
dvander@7
    76
	public:
dvander@7
    77
		CPluginManager();
dvander@7
    78
		~CPluginManager();
dvander@18
    79
		void SetAllLoaded();
dvander@7
    80
	public:
dvander@7
    81
		PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
dvander@9
    82
		bool Unload(PluginId id, bool force, char *error, size_t maxlen);
dvander@7
    83
		bool Pause(PluginId id, char *error, size_t maxlen);
dvander@7
    84
		bool Unpause(PluginId id, char *error, size_t maxlen);
dvander@7
    85
		bool UnloadAll();
dvander@205
    86
		void SetAlias(const char *alias, const char *value);
dvander@7
    87
	public:
dvander@138
    88
		bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source);
dvander@122
    89
		bool QueryRunning(PluginId id, char *error, size_t maxlength);
dvander@227
    90
		bool QueryHandle(PluginId id, void *&handle);
dvander@7
    91
dvander@67
    92
		void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@67
    93
		void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@67
    94
		void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@67
    95
		void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@67
    96
dvander@7
    97
		/**
dvander@7
    98
		 * @brief Finds a plugin by Id
dvander@7
    99
		 *
dvander@7
   100
		 * @param id Id of plugin
dvander@7
   101
		 * @return CPlugin on success, NULL otherwise
dvander@7
   102
		 */
dvander@7
   103
		CPlugin *FindById(PluginId id);
dvander@7
   104
dvander@67
   105
		CPlugin *FindByAPI(ISmmPlugin *api);
dvander@67
   106
dvander@29
   107
		/**
dvander@29
   108
		 * @brief Attempts to reload a failed plugin
dvander@29
   109
		 *
dvander@29
   110
		 * @param id Id of plugin
dvander@29
   111
		 * @param error Error message buffer
dvander@29
   112
		 * @param len Maximum length of buffer
dvander@29
   113
		 * @return True on success, false otherwise
dvander@29
   114
		 */
dvander@29
   115
		bool Retry(PluginId id, char *error, size_t len);
dvander@29
   116
dvander@205
   117
		//get alias info
dvander@205
   118
		const char *LookupAlias(const char *alias);
dvander@205
   119
		SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_begin();
dvander@205
   120
		SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_end();
dvander@205
   121
dvander@7
   122
		//Internal iterators
dvander@98
   123
		SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
dvander@98
   124
		SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _end();
dvander@7
   125
	private:
dvander@7
   126
		//These are identical internal functions for the wrappers above.
dvander@7
   127
		CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
dvander@9
   128
		bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
dvander@7
   129
		bool _Pause(CPlugin *pl, char *error, size_t maxlen);
dvander@7
   130
		bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
dvander@67
   131
		void UnregAllConCmds(CPlugin *pl);
dvander@7
   132
	private:
dvander@7
   133
		PluginId m_LastId;
dvander@98
   134
		SourceHook::List<CPlugin *> m_Plugins;
dvander@205
   135
		SourceHook::List<CNameAlias *> m_Aliases;
dvander@18
   136
		bool m_AllLoaded;
dvander@7
   137
	};
dvander@7
   138
};
dvander@7
   139
dvander@98
   140
typedef SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
dvander@7
   141
dvander@7
   142
/** @brief Singleton for plugin manager */
dvander@7
   143
extern SourceMM::CPluginManager g_PluginMngr;
dvander@7
   144
dvander@7
   145
#endif //_INCLUDE_CPLUGIN_H