1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/sourcemm/metamod_plugins.h Sat Sep 22 18:08:30 2007 +0000
1.3 @@ -0,0 +1,149 @@
1.4 +/* ======== SourceMM ========
1.5 +* Copyright (C) 2004-2007 Metamod:Source Development Team
1.6 +* No warranties of any kind
1.7 +*
1.8 +* License: zlib/libpng
1.9 +*
1.10 +* Author(s): David "BAILOPAN" Anderson
1.11 +* ============================
1.12 +*/
1.13 +
1.14 +#ifndef _INCLUDE_CPLUGIN_H
1.15 +#define _INCLUDE_CPLUGIN_H
1.16 +
1.17 +/**
1.18 + * @brief Implementation of Plugin API and Management routines
1.19 + * @file CPlugin.cpp
1.20 + */
1.21 +
1.22 +#include <interface.h>
1.23 +#include <eiface.h>
1.24 +#include <sh_list.h>
1.25 +#include <sh_string.h>
1.26 +#include "IPluginManager.h"
1.27 +#include "oslink.h"
1.28 +
1.29 +/**
1.30 + * History of plugin versions: (M=min, C=current)
1.31 + * 1: Initial interface
1.32 + * 2: Added GetLogTag()
1.33 + * 3: Moved GetApiVersion() to top (2005-04-16)
1.34 + * 4: Added AllPluginsLoaded() callback (2005-04-18)
1.35 + * 5: Bumped version for SourceHook V4 (2005-05-01)
1.36 + * 6: Added functions for console printing (2005-05-26)
1.37 + * M 7: Changed template libraries (2005-08-11)
1.38 + * New loading structure mechanism
1.39 + * New SourceHook version
1.40 + * 8: New SourceHook version (2005-12-23)
1.41 + * New ISmmAPI additions
1.42 + * 9: New ISmmPluginManager additions
1.43 + * C 10: Added VSP listen functions to ISmmAPI and IMetamodListener (2007-02-09)
1.44 + * C 11: New SourceHook version V5 (May, 2007)
1.45 + */
1.46 +
1.47 +#define PLAPI_MIN_VERSION 7
1.48 +
1.49 +namespace SourceMM
1.50 +{
1.51 + struct CNameAlias
1.52 + {
1.53 + SourceHook::String alias;
1.54 + SourceHook::String value;
1.55 + };
1.56 + /**
1.57 + * @brief Implements Plugin Manager API
1.58 + */
1.59 + class CPluginManager : public ISmmPluginManager
1.60 + {
1.61 + public:
1.62 + /**
1.63 + * @brief Internal structure for holding plugin data
1.64 + */
1.65 + class CPlugin
1.66 + {
1.67 + public:
1.68 + CPlugin();
1.69 + public:
1.70 + PluginId m_Id;
1.71 + SourceHook::String m_File;
1.72 + Pl_Status m_Status;
1.73 + PluginId m_Source;
1.74 + ISmmPlugin *m_API;
1.75 + HINSTANCE m_Lib;
1.76 + SourceHook::List<ConCommandBase *> m_Cvars;
1.77 + SourceHook::List<ConCommandBase *> m_Cmds;
1.78 + SourceHook::List<IMetamodListener *> m_Events;
1.79 + };
1.80 + public:
1.81 + CPluginManager();
1.82 + ~CPluginManager();
1.83 + void SetAllLoaded();
1.84 + public:
1.85 + PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
1.86 + bool Unload(PluginId id, bool force, char *error, size_t maxlen);
1.87 + bool Pause(PluginId id, char *error, size_t maxlen);
1.88 + bool Unpause(PluginId id, char *error, size_t maxlen);
1.89 + bool UnloadAll();
1.90 + void SetAlias(const char *alias, const char *value);
1.91 + public:
1.92 + bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source);
1.93 + bool QueryRunning(PluginId id, char *error, size_t maxlength);
1.94 + bool QueryHandle(PluginId id, void *&handle);
1.95 +
1.96 + void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
1.97 + void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
1.98 + void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
1.99 + void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
1.100 +
1.101 + /**
1.102 + * @brief Finds a plugin by Id
1.103 + *
1.104 + * @param id Id of plugin
1.105 + * @return CPlugin on success, NULL otherwise
1.106 + */
1.107 + CPlugin *FindById(PluginId id);
1.108 +
1.109 + CPlugin *FindByAPI(ISmmPlugin *api);
1.110 +
1.111 + /**
1.112 + * @brief Attempts to reload a failed plugin
1.113 + *
1.114 + * @param id Id of plugin
1.115 + * @param error Error message buffer
1.116 + * @param len Maximum length of buffer
1.117 + * @return True on success, false otherwise
1.118 + */
1.119 + bool Retry(PluginId id, char *error, size_t len);
1.120 +
1.121 + int GetPluginCount();
1.122 + const char *GetStatusText(CPlugin *pl);
1.123 +
1.124 + //get alias info
1.125 + const char *LookupAlias(const char *alias);
1.126 + SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_begin();
1.127 + SourceHook::List<SourceMM::CNameAlias *>::iterator _alias_end();
1.128 +
1.129 + //Internal iterators
1.130 + SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
1.131 + SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator _end();
1.132 + private:
1.133 + //These are identical internal functions for the wrappers above.
1.134 + CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
1.135 + bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
1.136 + bool _Pause(CPlugin *pl, char *error, size_t maxlen);
1.137 + bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
1.138 + void UnregAllConCmds(CPlugin *pl);
1.139 + private:
1.140 + PluginId m_LastId;
1.141 + SourceHook::List<CPlugin *> m_Plugins;
1.142 + SourceHook::List<CNameAlias *> m_Aliases;
1.143 + bool m_AllLoaded;
1.144 + };
1.145 +};
1.146 +
1.147 +typedef SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
1.148 +
1.149 +/** @brief Singleton for plugin manager */
1.150 +extern SourceMM::CPluginManager g_PluginMngr;
1.151 +
1.152 +#endif //_INCLUDE_CPLUGIN_H