core/metamod_plugins.h
author Scott Ehlert <ds@alliedmods.net>
Thu Dec 10 00:59:50 2009 -0600 (2009-12-10)
changeset 689 4065ba5e9155
parent 539 db914129ae01
permissions -rw-r--r--
Rewrote user message caching code to always use IServerGameDLL::GetUserMessageInfo (bug 4117, r=dvander).

Games where the above function can crash are handled by detouring tier0's Error() function and jumping back to our own code. So in theory this should work on all games now.
dvander@371
     1
/**
dvander@371
     2
 * vim: set ts=4 :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
ds@523
     5
 * Copyright (C) 2004-2008 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@396
    38
#include <convar.h>
dvander@371
    39
#include <sh_list.h>
dvander@371
    40
#include <sh_string.h>
dvander@400
    41
#include <IPluginManager.h>
dvander@400
    42
#include <ISmmPluginExt.h>
dvander@371
    43
#include "metamod_oslink.h"
dvander@371
    44
dvander@371
    45
/**
dvander@371
    46
 * History of plugin versions: (M=min, C=current)
dvander@371
    47
 *     1: Initial interface
dvander@371
    48
 *     2: Added GetLogTag()
dvander@371
    49
 *     3: Moved GetApiVersion() to top  (2005-04-16)
dvander@371
    50
 *     4: Added AllPluginsLoaded() callback (2005-04-18)
dvander@371
    51
 *     5: Bumped version for SourceHook V4 (2005-05-01)
dvander@371
    52
 *     6: Added functions for console printing (2005-05-26)
dvander@375
    53
 *     7: Changed template libraries (2005-08-11)
dvander@371
    54
 * 	      New loading structure mechanism
dvander@371
    55
 *        New SourceHook version
dvander@371
    56
 *     8: New SourceHook version (2005-12-23)
dvander@371
    57
 *        New ISmmAPI additions
dvander@371
    58
 *     9: New ISmmPluginManager additions
dvander@375
    59
 *    10: Added VSP listen functions to ISmmAPI and IMetamodListener (2007-02-09)
dvander@375
    60
 *    11: New SourceHook version v4.5 (May, 2007)
dvander@375
    61
 *    12: Orange Box API
dvander@400
    62
 *    13: Breaking of API for next SH version and other API changes
dvander@400
    63
 * MC 14: ABI stability reached for 1.6.0 changes
dvander@371
    64
 */
dvander@371
    65
dvander@400
    66
#define PLAPI_MIN_VERSION	14
dvander@371
    67
dvander@396
    68
struct CNameAlias
dvander@371
    69
{
dvander@396
    70
	SourceHook::String alias;
dvander@396
    71
	SourceHook::String value;
dvander@396
    72
};
dvander@396
    73
/**
dvander@396
    74
 * @brief Implements Plugin Manager API
dvander@396
    75
 */
dvander@396
    76
class CPluginManager : public ISmmPluginManager
dvander@396
    77
{	
dvander@396
    78
public:
dvander@396
    79
	/**
dvander@396
    80
	 * @brief Internal structure for holding plugin data
dvander@396
    81
	 */
dvander@396
    82
	class CPlugin
dvander@371
    83
	{
dvander@396
    84
	public:
dvander@396
    85
		CPlugin();
dvander@371
    86
	public:
dvander@396
    87
		PluginId m_Id;
dvander@396
    88
		SourceHook::String m_File;
dvander@396
    89
		Pl_Status m_Status;
dvander@396
    90
		PluginId m_Source;
dvander@396
    91
		ISmmPlugin *m_API;
dvander@396
    92
		HINSTANCE m_Lib;
dvander@396
    93
		SourceHook::List<ConCommandBase *> m_Cvars;
dvander@396
    94
		SourceHook::List<ConCommandBase *> m_Cmds;
dvander@396
    95
		SourceHook::List<IMetamodListener *> m_Events;
dvander@400
    96
		METAMOD_FN_UNLOAD m_UnloadFn;
dvander@396
    97
	};
dvander@396
    98
public:
dvander@396
    99
	CPluginManager();
dvander@396
   100
	~CPluginManager();
dvander@396
   101
	void SetAllLoaded();
dvander@396
   102
public:
dvander@396
   103
	PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
dvander@396
   104
	bool Unload(PluginId id, bool force, char *error, size_t maxlen);
dvander@396
   105
	bool Pause(PluginId id, char *error, size_t maxlen);
dvander@396
   106
	bool Unpause(PluginId id, char *error, size_t maxlen);
dvander@396
   107
	bool UnloadAll();
dvander@396
   108
	void SetAlias(const char *alias, const char *value);
dvander@396
   109
public:
dvander@397
   110
	bool Query(PluginId id, const char **file, Pl_Status *status, PluginId *source);
dvander@396
   111
	bool QueryRunning(PluginId id, char *error, size_t maxlength);
dvander@397
   112
	bool QueryHandle(PluginId id, void **handle);
dvander@371
   113
dvander@396
   114
	void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@396
   115
	void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@396
   116
	void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@396
   117
	void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@371
   118
dvander@396
   119
	/**
dvander@396
   120
	 * @brief Finds a plugin by Id
dvander@396
   121
	 *
dvander@396
   122
	 * @param id Id of plugin
dvander@396
   123
	 * @return CPlugin on success, NULL otherwise
dvander@396
   124
	 */
dvander@396
   125
	CPlugin *FindById(PluginId id);
dvander@371
   126
dvander@396
   127
	CPlugin *FindByAPI(ISmmPlugin *api);
dvander@371
   128
dvander@396
   129
	/**
dvander@396
   130
	 * @brief Attempts to reload a failed plugin
dvander@396
   131
	 *
dvander@396
   132
	 * @param id Id of plugin
dvander@396
   133
	 * @param error Error message buffer
dvander@396
   134
	 * @param len Maximum length of buffer
dvander@396
   135
	 * @return True on success, false otherwise
dvander@396
   136
	 */
dvander@396
   137
	bool Retry(PluginId id, char *error, size_t len);
dvander@371
   138
dvander@396
   139
	int GetPluginCount();
dvander@396
   140
	const char *GetStatusText(CPlugin *pl);
dvander@371
   141
dvander@396
   142
	//get alias info
dvander@396
   143
	const char *LookupAlias(const char *alias);
dvander@396
   144
	SourceHook::List<CNameAlias *>::iterator _alias_begin();
dvander@396
   145
	SourceHook::List<CNameAlias *>::iterator _alias_end();
dvander@396
   146
dvander@396
   147
	//Internal iterators
dvander@396
   148
	SourceHook::List<CPluginManager::CPlugin *>::iterator _begin();
dvander@396
   149
	SourceHook::List<CPluginManager::CPlugin *>::iterator _end();
dvander@396
   150
private:
dvander@396
   151
	//These are identical internal functions for the wrappers above.
dvander@396
   152
	CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
dvander@396
   153
	bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
dvander@396
   154
	bool _Pause(CPlugin *pl, char *error, size_t maxlen);
dvander@396
   155
	bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
dvander@396
   156
	void UnregAllConCmds(CPlugin *pl);
dvander@396
   157
private:
dvander@396
   158
	PluginId m_LastId;
dvander@396
   159
	SourceHook::List<CPlugin *> m_Plugins;
dvander@396
   160
	SourceHook::List<CNameAlias *> m_Aliases;
dvander@396
   161
	bool m_AllLoaded;
dvander@371
   162
};
dvander@371
   163
dvander@396
   164
typedef SourceHook::List<CPluginManager::CPlugin *>::iterator PluginIter;
dvander@371
   165
dvander@371
   166
/** @brief Singleton for plugin manager */
dvander@396
   167
extern CPluginManager g_PluginMngr;
dvander@371
   168
dvander@371
   169
#endif //_INCLUDE_CPLUGIN_H
dvander@371
   170