sourcemm/CPlugin.h
author David Anderson <dvander@alliedmods.net>
Fri Aug 12 17:33:59 2005 +0000 (2005-08-12)
changeset 97 7d3a2a8d5bf5
parent 71 8c6c2684f216
child 98 4c46acf7e76f
permissions -rw-r--r--
Replaced std::list with List class
dvander@7
     1
/* ======== SourceMM ========
dvander@9
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
dvander@7
     3
* No warranties of any kind
dvander@7
     4
*
dvander@7
     5
* License: zlib/libpng
dvander@7
     6
*
dvander@7
     7
* Author(s): David "BAILOPAN" Anderson
dvander@7
     8
* ============================
dvander@7
     9
*/
dvander@7
    10
dvander@7
    11
#ifndef _INCLUDE_CPLUGIN_H
dvander@7
    12
#define _INCLUDE_CPLUGIN_H
dvander@7
    13
dvander@7
    14
/**
dvander@7
    15
 * @brief Implementation of Plugin API and Management routines
dvander@7
    16
 * @file CPlugin.cpp
dvander@7
    17
 */
dvander@7
    18
dvander@67
    19
#include <interface.h>
dvander@67
    20
#include <eiface.h>
dvander@67
    21
#include <convar.h>
dvander@7
    22
#include "IPluginManager.h"
dvander@7
    23
#include "oslink.h"
dvander@97
    24
#include "smm_list.h"
dvander@97
    25
#include "smm_string.h"
dvander@7
    26
dvander@51
    27
/**
dvander@51
    28
 * History of plugin versions: (M=min, C=current)
dvander@51
    29
 *    1: Initial interface
dvander@51
    30
 *    2: Added GetLogTag()
dvander@51
    31
 *    3: Moved GetApiVersion() to top  (2005-04-16)
dvander@51
    32
 *    4: Added AllPluginsLoaded() callback (2005-04-18)
dvander@97
    33
 *    5: Bumped version for SourceHook V4 (2005-05-01)
dvander@97
    34
 *    6: Added functions for console printing (2005-05-26)
dvander@97
    35
 * MC 7: Changed template libraries (2005-08-11)
dvander@51
    36
 */
dvander@51
    37
dvander@97
    38
#define PLAPI_MIN_VERSION	6
dvander@51
    39
dvander@7
    40
namespace SourceMM
dvander@7
    41
{
dvander@7
    42
	/**
dvander@7
    43
	 * @brief Implements Plugin Manager API
dvander@7
    44
	 */
dvander@7
    45
	class CPluginManager : public ISmmPluginManager
dvander@7
    46
	{	
dvander@7
    47
	public:
dvander@7
    48
		/**
dvander@7
    49
		 * @brief Internal structure for holding plugin data
dvander@7
    50
		 */
dvander@7
    51
		class CPlugin
dvander@7
    52
		{
dvander@7
    53
		public:
dvander@7
    54
			CPlugin();
dvander@7
    55
		public:
dvander@7
    56
			PluginId m_Id;
dvander@97
    57
			String m_File;
dvander@7
    58
			Pl_Status m_Status;
dvander@7
    59
			PluginId m_Source;
dvander@7
    60
			ISmmPlugin *m_API;
dvander@7
    61
			HINSTANCE m_Lib;
dvander@7
    62
			factories fac_list;
dvander@97
    63
			List<ConCommandBase *> m_Cvars;
dvander@97
    64
			List<ConCommandBase *> m_Cmds;
dvander@7
    65
		};
dvander@7
    66
	public:
dvander@7
    67
		CPluginManager();
dvander@7
    68
		~CPluginManager();
dvander@18
    69
		void SetAllLoaded();
dvander@7
    70
	public:
dvander@7
    71
		PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
dvander@9
    72
		bool Unload(PluginId id, bool force, char *error, size_t maxlen);
dvander@7
    73
		bool Pause(PluginId id, char *error, size_t maxlen);
dvander@7
    74
		bool Unpause(PluginId id, char *error, size_t maxlen);
dvander@7
    75
		bool UnloadAll();
dvander@7
    76
	public:
dvander@7
    77
		bool Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source);
dvander@7
    78
dvander@67
    79
		void AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@67
    80
		void AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@67
    81
		void RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar);
dvander@67
    82
		void RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd);
dvander@67
    83
dvander@7
    84
		/**
dvander@7
    85
		 * @brief Finds a plugin by Id
dvander@7
    86
		 *
dvander@7
    87
		 * @param id Id of plugin
dvander@7
    88
		 * @return CPlugin on success, NULL otherwise
dvander@7
    89
		 */
dvander@7
    90
		CPlugin *FindById(PluginId id);
dvander@7
    91
dvander@67
    92
		CPlugin *FindByAPI(ISmmPlugin *api);
dvander@67
    93
dvander@29
    94
		/**
dvander@29
    95
		 * @brief Attempts to reload a failed plugin
dvander@29
    96
		 *
dvander@29
    97
		 * @param id Id of plugin
dvander@29
    98
		 * @param error Error message buffer
dvander@29
    99
		 * @param len Maximum length of buffer
dvander@29
   100
		 * @return True on success, false otherwise
dvander@29
   101
		 */
dvander@29
   102
		bool Retry(PluginId id, char *error, size_t len);
dvander@29
   103
dvander@7
   104
		//Internal iterators
dvander@97
   105
		List<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
dvander@97
   106
		List<SourceMM::CPluginManager::CPlugin *>::iterator _end();
dvander@7
   107
	private:
dvander@7
   108
		//These are identical internal functions for the wrappers above.
dvander@7
   109
		CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
dvander@9
   110
		bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
dvander@7
   111
		bool _Pause(CPlugin *pl, char *error, size_t maxlen);
dvander@7
   112
		bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
dvander@67
   113
		void UnregAllConCmds(CPlugin *pl);
dvander@7
   114
	private:
dvander@7
   115
		PluginId m_LastId;
dvander@97
   116
		List<CPlugin *> m_Plugins;
dvander@18
   117
		bool m_AllLoaded;
dvander@7
   118
	};
dvander@7
   119
};
dvander@7
   120
dvander@97
   121
typedef List<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
dvander@7
   122
dvander@7
   123
/** @brief Singleton for plugin manager */
dvander@7
   124
extern SourceMM::CPluginManager g_PluginMngr;
dvander@7
   125
dvander@7
   126
#endif //_INCLUDE_CPLUGIN_H