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