1
0
mirror of https://github.com/alliedmodders/metamod-source.git synced 2024-12-10 22:24:12 +01:00
HLMetaModOfficial/sourcemm/CPlugin.h
David Anderson 00322f8833 initial import of 1.2 api changes
--HG--
extra : convert_revision : svn%3Ac2935e3e-5518-0410-8daf-afa5dab7d4e3/trunk%40167
2005-12-23 23:38:38 +00:00

132 lines
3.6 KiB
C++

/* ======== SourceMM ========
* Copyright (C) 2004-2005 Metamod:Source Development Team
* No warranties of any kind
*
* License: zlib/libpng
*
* Author(s): David "BAILOPAN" Anderson
* ============================
*/
#ifndef _INCLUDE_CPLUGIN_H
#define _INCLUDE_CPLUGIN_H
/**
* @brief Implementation of Plugin API and Management routines
* @file CPlugin.cpp
*/
#include <interface.h>
#include <eiface.h>
#include <convar.h>
#include "IPluginManager.h"
#include "oslink.h"
#include "sh_list.h"
#include "sh_string.h"
/**
* History of plugin versions: (M=min, C=current)
* 1: Initial interface
* 2: Added GetLogTag()
* 3: Moved GetApiVersion() to top (2005-04-16)
* 4: Added AllPluginsLoaded() callback (2005-04-18)
* 5: Bumped version for SourceHook V4 (2005-05-01)
* 6: Added functions for console printing (2005-05-26)
* M 7: Changed template libraries (2005-08-11)
* New loading structure mechanism
* New SourceHook version
* C 8: New SourceHook version (2005-12-23)
* New ISmmAPI additions
*/
#define PLAPI_MIN_VERSION 7
namespace SourceMM
{
/**
* @brief Implements Plugin Manager API
*/
class CPluginManager : public ISmmPluginManager
{
public:
/**
* @brief Internal structure for holding plugin data
*/
class CPlugin
{
public:
CPlugin();
public:
PluginId m_Id;
SourceHook::String m_File;
Pl_Status m_Status;
PluginId m_Source;
ISmmPlugin *m_API;
HINSTANCE m_Lib;
SourceHook::List<ConCommandBase *> m_Cvars;
SourceHook::List<ConCommandBase *> m_Cmds;
SourceHook::List<IMetamodListener *> m_Events;
};
public:
CPluginManager();
~CPluginManager();
void SetAllLoaded();
public:
PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
bool Unload(PluginId id, bool force, char *error, size_t maxlen);
bool Pause(PluginId id, char *error, size_t maxlen);
bool Unpause(PluginId id, char *error, size_t maxlen);
bool UnloadAll();
public:
bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source);
bool QueryRunning(PluginId id, char *error, size_t maxlength);
void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
/**
* @brief Finds a plugin by Id
*
* @param id Id of plugin
* @return CPlugin on success, NULL otherwise
*/
CPlugin *FindById(PluginId id);
CPlugin *FindByAPI(ISmmPlugin *api);
/**
* @brief Attempts to reload a failed plugin
*
* @param id Id of plugin
* @param error Error message buffer
* @param len Maximum length of buffer
* @return True on success, false otherwise
*/
bool Retry(PluginId id, char *error, size_t len);
//Internal iterators
SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _end();
private:
//These are identical internal functions for the wrappers above.
CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
bool _Pause(CPlugin *pl, char *error, size_t maxlen);
bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
void UnregAllConCmds(CPlugin *pl);
private:
PluginId m_LastId;
SourceHook::List<CPlugin *> m_Plugins;
bool m_AllLoaded;
};
};
typedef SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
/** @brief Singleton for plugin manager */
extern SourceMM::CPluginManager g_PluginMngr;
#endif //_INCLUDE_CPLUGIN_H