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