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