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