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