sourcemm/CPlugin.h
author David Anderson <dvander@alliedmods.net>
Sun May 01 18:24:48 2005 +0000 (2005-05-01)
changeset 51 7985801b5b42
parent 33 3c7faa7abf09
child 67 1753f7a9b2f2
permissions -rw-r--r--
Bumped min/max api to 5:5
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@7
    19
#include <list>
dvander@33
    20
#include <string>
dvander@7
    21
#include "IPluginManager.h"
dvander@7
    22
#include "oslink.h"
dvander@7
    23
dvander@51
    24
/**
dvander@51
    25
 * History of plugin versions: (M=min, C=current)
dvander@51
    26
 *    1: Initial interface
dvander@51
    27
 *    2: Added GetLogTag()
dvander@51
    28
 *    3: Moved GetApiVersion() to top  (2005-04-16)
dvander@51
    29
 *    4: Added AllPluginsLoaded() callback (2005-04-18)
dvander@51
    30
 * MC 5: Bumped version for SourceHook V4 (2005-05-01)
dvander@51
    31
 */
dvander@51
    32
dvander@51
    33
#define PLAPI_MIN_VERSION	5
dvander@51
    34
dvander@7
    35
namespace SourceMM
dvander@7
    36
{
dvander@7
    37
	/**
dvander@7
    38
	 * @brief Implements Plugin Manager API
dvander@7
    39
	 */
dvander@7
    40
	class CPluginManager : public ISmmPluginManager
dvander@7
    41
	{	
dvander@7
    42
	public:
dvander@7
    43
		/**
dvander@7
    44
		 * @brief Internal structure for holding plugin data
dvander@7
    45
		 */
dvander@7
    46
		class CPlugin
dvander@7
    47
		{
dvander@7
    48
		public:
dvander@7
    49
			CPlugin();
dvander@7
    50
		public:
dvander@7
    51
			PluginId m_Id;
dvander@7
    52
			std::string m_File;
dvander@7
    53
			Pl_Status m_Status;
dvander@7
    54
			PluginId m_Source;
dvander@7
    55
			ISmmPlugin *m_API;
dvander@7
    56
			HINSTANCE m_Lib;
dvander@7
    57
			factories fac_list;
dvander@7
    58
		};
dvander@7
    59
	public:
dvander@7
    60
		CPluginManager();
dvander@7
    61
		~CPluginManager();
dvander@18
    62
		void SetAllLoaded();
dvander@7
    63
	public:
dvander@7
    64
		PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
dvander@9
    65
		bool Unload(PluginId id, bool force, char *error, size_t maxlen);
dvander@7
    66
		bool Pause(PluginId id, char *error, size_t maxlen);
dvander@7
    67
		bool Unpause(PluginId id, char *error, size_t maxlen);
dvander@7
    68
		bool UnloadAll();
dvander@7
    69
	public:
dvander@7
    70
		bool Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source);
dvander@7
    71
dvander@7
    72
		/**
dvander@7
    73
		 * @brief Finds a plugin by Id
dvander@7
    74
		 *
dvander@7
    75
		 * @param id Id of plugin
dvander@7
    76
		 * @return CPlugin on success, NULL otherwise
dvander@7
    77
		 */
dvander@7
    78
		CPlugin *FindById(PluginId id);
dvander@7
    79
dvander@29
    80
		/**
dvander@29
    81
		 * @brief Attempts to reload a failed plugin
dvander@29
    82
		 *
dvander@29
    83
		 * @param id Id of plugin
dvander@29
    84
		 * @param error Error message buffer
dvander@29
    85
		 * @param len Maximum length of buffer
dvander@29
    86
		 * @return True on success, false otherwise
dvander@29
    87
		 */
dvander@29
    88
		bool Retry(PluginId id, char *error, size_t len);
dvander@29
    89
dvander@7
    90
		//Internal iterators
dvander@7
    91
		std::list<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
dvander@7
    92
		std::list<SourceMM::CPluginManager::CPlugin *>::iterator _end();
dvander@7
    93
	private:
dvander@7
    94
		//These are identical internal functions for the wrappers above.
dvander@7
    95
		CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
dvander@9
    96
		bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
dvander@7
    97
		bool _Pause(CPlugin *pl, char *error, size_t maxlen);
dvander@7
    98
		bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
dvander@7
    99
	private:
dvander@7
   100
		PluginId m_LastId;
dvander@7
   101
		std::list<CPlugin *> m_Plugins;
dvander@18
   102
		bool m_AllLoaded;
dvander@7
   103
	};
dvander@7
   104
};
dvander@7
   105
dvander@7
   106
typedef std::list<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
dvander@7
   107
dvander@7
   108
/** @brief Singleton for plugin manager */
dvander@7
   109
extern SourceMM::CPluginManager g_PluginMngr;
dvander@7
   110
dvander@7
   111
#endif //_INCLUDE_CPLUGIN_H