dvander@367: /** dvander@367: * vim: set ts=4 : dvander@367: * ====================================================== dvander@367: * Metamod:Source dvander@367: * Copyright (C) 2004-2007 AlliedModders LLC and authors. dvander@367: * All rights reserved. dvander@367: * ====================================================== dvander@367: * dvander@367: * This software is provided 'as-is', without any express or implied warranty. dvander@367: * In no event will the authors be held liable for any damages arising from dvander@367: * the use of this software. dvander@367: * dvander@367: * Permission is granted to anyone to use this software for any purpose, dvander@367: * including commercial applications, and to alter it and redistribute it dvander@367: * freely, subject to the following restrictions: dvander@367: * dvander@367: * 1. The origin of this software must not be misrepresented; you must not dvander@367: * claim that you wrote the original software. If you use this software in a dvander@367: * product, an acknowledgment in the product documentation would be dvander@367: * appreciated but is not required. dvander@367: * 2. Altered source versions must be plainly marked as such, and must not be dvander@367: * misrepresented as being the original software. dvander@367: * 3. This notice may not be removed or altered from any source distribution. dvander@367: * dvander@367: * Version: $Id$ dvander@367: */ dvander@347: dvander@347: #ifndef _INCLUDE_PLUGINMANAGER_H dvander@347: #define _INCLUDE_PLUGINMANAGER_H dvander@347: dvander@347: /** dvander@347: * @brief Plugin Manager interface dvander@347: * @file IPluginManager.h dvander@347: */ dvander@347: dvander@347: typedef int PluginId; dvander@347: dvander@347: #include "ISmmPlugin.h" dvander@347: dvander@347: /** dvander@347: * @brief Load sources dvander@347: */ dvander@347: enum dvander@347: { dvander@347: Pl_BadLoad=0, dvander@347: Pl_Console=-1, dvander@347: Pl_File=-2, dvander@347: Pl_MinId=1, dvander@347: }; dvander@347: dvander@347: /** dvander@347: * @brief Status of a plugin at runtime dvander@347: */ dvander@347: enum Pl_Status dvander@347: { dvander@347: Pl_NotFound=-4, dvander@347: Pl_Error=-3, dvander@347: Pl_Refused=-2, dvander@347: Pl_Paused=-1, dvander@347: Pl_Running=0, dvander@347: }; dvander@347: dvander@347: typedef int PluginId; dvander@347: struct factories; dvander@347: dvander@347: class ISmmPluginManager dvander@347: { dvander@347: public: dvander@347: /** dvander@347: * @brief Loads a plugin and returns its id. If this is called before DLLInit(), dvander@347: * then the plugin is considered to be "hot" - it might refuse its own load later! dvander@347: * Also, a hot plugin might not have an error message. dvander@347: * dvander@347: * @param file String containing file name dvander@347: * @param source Specifies who loaded the plugin dvander@347: * @param status Status of the plugin dvander@347: * @param ismm Pointer to Smm API dvander@347: * @param error String buffer for error messages dvander@347: * @param maxlen Maximum length of buffer dvander@347: * @return Id of plugin dvander@347: */ dvander@347: virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0; dvander@347: dvander@347: /** dvander@347: * @brief Unloads a plugin dvander@347: * dvander@347: * @param id Id of plugin dvander@347: * @param error String buffer for error messages dvander@347: * @param maxlen Maximum length of buffer dvander@347: * @return True on success, false otherwise dvander@347: */ dvander@347: virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0; dvander@347: dvander@347: /** dvander@347: * @brief Pauses a plugin dvander@347: * dvander@347: * @param id Id of plugin dvander@347: * @param error String buffer for error messages dvander@347: * @param maxlen Maximum length of buffer dvander@347: * @return True on success, false otherwise dvander@347: */ dvander@347: virtual bool Pause(PluginId id, char *error, size_t maxlen) =0; dvander@347: dvander@347: /** dvander@347: * @brief Unpauses a plugin dvander@347: * dvander@347: * @param id Id of plugin dvander@347: * @param force If true, forces the plugin to unload dvander@347: * @param error String buffer for error messages dvander@347: * @param maxlen Maximum length of buffer dvander@347: * @return True on success, false otherwise dvander@347: */ dvander@347: virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0; dvander@347: dvander@347: /** dvander@347: * @brief Unloads all plugins forcefully dvander@347: * dvander@347: * @return True on success, false otherwise dvander@347: */ dvander@347: virtual bool UnloadAll() =0; dvander@347: dvander@347: /** dvander@347: * @brief Returns information about a plugin dvander@347: * dvander@347: * @param id Id of plugin dvander@347: * @param file Pointer to file string by reference dvander@347: * @param list Pointer to factories by reference dvander@347: * @param status By reference status of plugin dvander@347: * @param source By reference source of plugin dvander@347: * @return True on success, false if not found dvander@347: */ dvander@347: virtual bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source) =0; dvander@347: dvander@347: /** dvander@347: * @brief Checks another plugin's QueryRunning() status. dvander@347: * dvander@347: * @param id Id of plugin dvander@347: * @param error Message buffer dvander@347: * @param maxlen Size of error buffer dvander@347: * @return Status value dvander@347: */ dvander@347: virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0; dvander@347: dvander@347: /** dvander@347: * @brief Returns the handle of a plugin (OS dependent meaning) dvander@347: * dvander@347: * @param id Id of plugin dvander@347: * @param handle By reference handle of plugin, if any dvander@347: * @return True if plugin id is valid, false otherwise dvander@347: */ dvander@347: virtual bool QueryHandle(PluginId id, void *&handle) =0; dvander@347: }; dvander@347: dvander@347: #endif //_INCLUDE_PLUGINMANAGER_H