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