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