dvander@541: /* ======== SourceMM ======== dvander@541: * Copyright (C) 2004-2008 Metamod:Source Development Team dvander@541: * No warranties of any kind dvander@541: * dvander@541: * License: zlib/libpng dvander@541: * dvander@541: * Author(s): David "BAILOPAN" Anderson dvander@541: * ============================ dvander@541: */ dvander@541: dvander@541: #ifndef _INCLUDE_PLUGINMANAGER_H dvander@541: #define _INCLUDE_PLUGINMANAGER_H dvander@541: dvander@541: /** dvander@541: * @brief Plugin Manager interface dvander@541: * @file IPluginManager.h dvander@541: */ dvander@541: dvander@541: typedef int PluginId; dvander@541: dvander@541: #include "ISmmPlugin.h" dvander@541: dvander@541: /** dvander@541: * @brief Load sources dvander@541: */ dvander@541: enum dvander@541: { dvander@541: Pl_BadLoad=0, dvander@541: Pl_Console=-1, dvander@541: Pl_File=-2, dvander@541: Pl_MinId=1, dvander@541: }; dvander@541: dvander@541: /** dvander@541: * @brief Status of a plugin at runtime dvander@541: */ dvander@541: enum Pl_Status dvander@541: { dvander@541: Pl_NotFound=-4, dvander@541: Pl_Error=-3, dvander@541: Pl_Refused=-2, dvander@541: Pl_Paused=-1, dvander@541: Pl_Running=0, dvander@541: }; dvander@541: dvander@541: typedef int PluginId; dvander@541: struct factories; dvander@541: dvander@541: class ISmmPluginManager dvander@541: { dvander@541: public: dvander@541: /** dvander@541: * @brief Loads a plugin and returns its id. If this is called before DLLInit(), dvander@541: * then the plugin is considered to be "hot" - it might refuse its own load later! dvander@541: * Also, a hot plugin might not have an error message. dvander@541: * dvander@541: * @param file String containing file name dvander@541: * @param source Specifies who loaded the plugin dvander@541: * @param status Status of the plugin dvander@541: * @param ismm Pointer to Smm API dvander@541: * @param error String buffer for error messages dvander@541: * @param maxlen Maximum length of buffer dvander@541: * @return Id of plugin dvander@541: */ dvander@541: virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0; dvander@541: dvander@541: /** dvander@541: * @brief Unloads a plugin dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @param error String buffer for error messages dvander@541: * @param maxlen Maximum length of buffer dvander@541: * @return True on success, false otherwise dvander@541: */ dvander@541: virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0; dvander@541: dvander@541: /** dvander@541: * @brief Pauses a plugin dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @param error String buffer for error messages dvander@541: * @param maxlen Maximum length of buffer dvander@541: * @return True on success, false otherwise dvander@541: */ dvander@541: virtual bool Pause(PluginId id, char *error, size_t maxlen) =0; dvander@541: dvander@541: /** dvander@541: * @brief Unpauses a plugin dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @param force If true, forces the plugin to unload dvander@541: * @param error String buffer for error messages dvander@541: * @param maxlen Maximum length of buffer dvander@541: * @return True on success, false otherwise dvander@541: */ dvander@541: virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0; dvander@541: dvander@541: /** dvander@541: * @brief Unloads all plugins forcefully dvander@541: * dvander@541: * @return True on success, false otherwise dvander@541: */ dvander@541: virtual bool UnloadAll() =0; dvander@541: dvander@541: /** dvander@541: * @brief Returns information about a plugin dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @param file Pointer to file string by reference dvander@541: * @param list Pointer to factories by reference dvander@541: * @param status By reference status of plugin dvander@541: * @param source By reference source of plugin dvander@541: * @return True on success, false if not found dvander@541: */ dvander@541: virtual bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source) =0; dvander@541: dvander@541: /** dvander@541: * @brief Checks another plugin's QueryRunning() status. dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @param error Message buffer dvander@541: * @param maxlen Size of error buffer dvander@541: * @return Status value dvander@541: */ dvander@541: virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0; dvander@541: dvander@541: /** dvander@541: * @brief Returns the handle of a plugin (OS dependent meaning) dvander@541: * dvander@541: * @param id Id of plugin dvander@541: * @param handle By reference handle of plugin, if any dvander@541: * @return True if plugin id is valid, false otherwise dvander@541: */ dvander@541: virtual bool QueryHandle(PluginId id, void *&handle) =0; dvander@541: }; dvander@541: dvander@541: #endif //_INCLUDE_PLUGINMANAGER_H