sourcemm/CPlugin.h
author David Anderson <dvander@alliedmods.net>
Tue Apr 19 07:41:07 2005 +0000 (2005-04-19)
changeset 29 10e6dc40505e
parent 18 8848d3ef28d8
child 33 3c7faa7abf09
permissions -rw-r--r--
Fixed retry command
Fixed ids starting at 3 (changed Pl_MinId)
Doxyfile is no longer subdir based
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@7
    20
#include "IPluginManager.h"
dvander@7
    21
#include "oslink.h"
dvander@7
    22
dvander@7
    23
namespace SourceMM
dvander@7
    24
{
dvander@7
    25
	/**
dvander@7
    26
	 * @brief Implements Plugin Manager API
dvander@7
    27
	 */
dvander@7
    28
	class CPluginManager : public ISmmPluginManager
dvander@7
    29
	{	
dvander@7
    30
	public:
dvander@7
    31
		/**
dvander@7
    32
		 * @brief Internal structure for holding plugin data
dvander@7
    33
		 */
dvander@7
    34
		class CPlugin
dvander@7
    35
		{
dvander@7
    36
		public:
dvander@7
    37
			CPlugin();
dvander@7
    38
		public:
dvander@7
    39
			PluginId m_Id;
dvander@7
    40
			std::string m_File;
dvander@7
    41
			Pl_Status m_Status;
dvander@7
    42
			PluginId m_Source;
dvander@7
    43
			ISmmPlugin *m_API;
dvander@7
    44
			HINSTANCE m_Lib;
dvander@7
    45
			factories fac_list;
dvander@7
    46
		};
dvander@7
    47
	public:
dvander@7
    48
		CPluginManager();
dvander@7
    49
		~CPluginManager();
dvander@18
    50
		void SetAllLoaded();
dvander@7
    51
	public:
dvander@7
    52
		PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen);
dvander@9
    53
		bool Unload(PluginId id, bool force, char *error, size_t maxlen);
dvander@7
    54
		bool Pause(PluginId id, char *error, size_t maxlen);
dvander@7
    55
		bool Unpause(PluginId id, char *error, size_t maxlen);
dvander@7
    56
		bool UnloadAll();
dvander@7
    57
	public:
dvander@7
    58
		bool Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source);
dvander@7
    59
dvander@7
    60
		/**
dvander@7
    61
		 * @brief Finds a plugin by Id
dvander@7
    62
		 *
dvander@7
    63
		 * @param id Id of plugin
dvander@7
    64
		 * @return CPlugin on success, NULL otherwise
dvander@7
    65
		 */
dvander@7
    66
		CPlugin *FindById(PluginId id);
dvander@7
    67
dvander@29
    68
		/**
dvander@29
    69
		 * @brief Attempts to reload a failed plugin
dvander@29
    70
		 *
dvander@29
    71
		 * @param id Id of plugin
dvander@29
    72
		 * @param error Error message buffer
dvander@29
    73
		 * @param len Maximum length of buffer
dvander@29
    74
		 * @return True on success, false otherwise
dvander@29
    75
		 */
dvander@29
    76
		bool Retry(PluginId id, char *error, size_t len);
dvander@29
    77
dvander@7
    78
		//Internal iterators
dvander@7
    79
		std::list<SourceMM::CPluginManager::CPlugin *>::iterator _begin();
dvander@7
    80
		std::list<SourceMM::CPluginManager::CPlugin *>::iterator _end();
dvander@7
    81
	private:
dvander@7
    82
		//These are identical internal functions for the wrappers above.
dvander@7
    83
		CPlugin *_Load(const char *file, PluginId source, char *error, size_t maxlen);
dvander@9
    84
		bool _Unload(CPlugin *pl, bool force, char *error, size_t maxlen);
dvander@7
    85
		bool _Pause(CPlugin *pl, char *error, size_t maxlen);
dvander@7
    86
		bool _Unpause(CPlugin *pl, char *error, size_t maxlen);
dvander@7
    87
	private:
dvander@7
    88
		PluginId m_LastId;
dvander@7
    89
		std::list<CPlugin *> m_Plugins;
dvander@18
    90
		bool m_AllLoaded;
dvander@7
    91
	};
dvander@7
    92
};
dvander@7
    93
dvander@7
    94
typedef std::list<SourceMM::CPluginManager::CPlugin *>::iterator PluginIter;
dvander@7
    95
dvander@7
    96
/** @brief Singleton for plugin manager */
dvander@7
    97
extern SourceMM::CPluginManager g_PluginMngr;
dvander@7
    98
dvander@7
    99
#endif //_INCLUDE_CPLUGIN_H