3 * ======================================================
5 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
7 * ======================================================
9 * This software is provided 'as-is', without any express or implied warranty.
10 * In no event will the authors be held liable for any damages arising from
11 * the use of this software.
13 * Permission is granted to anyone to use this software for any purpose,
14 * including commercial applications, and to alter it and redistribute it
15 * freely, subject to the following restrictions:
17 * 1. The origin of this software must not be misrepresented; you must not
18 * claim that you wrote the original software. If you use this software in a
19 * product, an acknowledgment in the product documentation would be
20 * appreciated but is not required.
21 * 2. Altered source versions must be plainly marked as such, and must not be
22 * misrepresented as being the original software.
23 * 3. This notice may not be removed or altered from any source distribution.
28 #ifndef _INCLUDE_PLUGINMANAGER_H
29 #define _INCLUDE_PLUGINMANAGER_H
32 * @brief Plugin Manager interface
33 * @file IPluginManager.h
38 #include "ISmmPlugin.h"
52 * @brief Status of a plugin at runtime
66 class ISmmPluginManager
70 * @brief Loads a plugin and returns its id. If this is called before DLLInit(),
71 * then the plugin is considered to be "hot" - it might refuse its own load later!
72 * Also, a hot plugin might not have an error message.
74 * @param file String containing file name
75 * @param source Specifies who loaded the plugin
76 * @param status Status of the plugin
77 * @param ismm Pointer to Smm API
78 * @param error String buffer for error messages
79 * @param maxlen Maximum length of buffer
80 * @return Id of plugin
82 virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0;
85 * @brief Unloads a plugin
87 * @param id Id of plugin
88 * @param error String buffer for error messages
89 * @param maxlen Maximum length of buffer
90 * @return True on success, false otherwise
92 virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0;
95 * @brief Pauses a plugin
97 * @param id Id of plugin
98 * @param error String buffer for error messages
99 * @param maxlen Maximum length of buffer
100 * @return True on success, false otherwise
102 virtual bool Pause(PluginId id, char *error, size_t maxlen) =0;
105 * @brief Unpauses a plugin
107 * @param id Id of plugin
108 * @param force If true, forces the plugin to unload
109 * @param error String buffer for error messages
110 * @param maxlen Maximum length of buffer
111 * @return True on success, false otherwise
113 virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0;
116 * @brief Unloads all plugins forcefully
118 * @return True on success, false otherwise
120 virtual bool UnloadAll() =0;
123 * @brief Returns information about a plugin
125 * @param id Id of plugin
126 * @param file Pointer to file string by reference
127 * @param list Pointer to factories by reference
128 * @param status By reference status of plugin
129 * @param source By reference source of plugin
130 * @return True on success, false if not found
132 virtual bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source) =0;
135 * @brief Checks another plugin's QueryRunning() status.
137 * @param id Id of plugin
138 * @param error Message buffer
139 * @param maxlen Size of error buffer
140 * @return Status value
142 virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0;
145 * @brief Returns the handle of a plugin (OS dependent meaning)
147 * @param id Id of plugin
148 * @param handle By reference handle of plugin, if any
149 * @return True if plugin id is valid, false otherwise
151 virtual bool QueryHandle(PluginId id, void *&handle) =0;
154 #endif //_INCLUDE_PLUGINMANAGER_H