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