Added support for CS: Global Offensive (
bug 5228, r=DS).
3 * ======================================================
5 * Copyright (C) 2004-2008 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_METAMOD_IPLUGINMANAGER_H
29 #define _INCLUDE_METAMOD_IPLUGINMANAGER_H
32 * @brief Plugin Manager interface
33 * @file IPluginManager.h
36 #include <ISmmPluginExt.h>
52 * @brief Status of a plugin at runtime
64 * @brief Programmatic management of the "loaded plugin" list.
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 already Whether or not the plugin was already loaded.
77 * @param error String buffer for error messages.
78 * @param maxlen Maximum length of buffer.
79 * @return Id of plugin.
81 virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0;
84 * @brief Unloads a plugin.
86 * @param id Id of plugin
87 * @param force True to forcefully unload, false to let plugin opt-out.
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 error String buffer for error messages
109 * @param maxlen Maximum length of buffer
110 * @return True on success, false otherwise
112 virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0;
115 * @brief Unloads all plugins forcefully
117 * @return True on success, false otherwise
119 virtual bool UnloadAll() =0;
122 * @brief Returns information about a plugin
124 * @param id Id of plugin
125 * @param file Pointer to store filename pointer, or NULL to ignore.
126 * @param status Pointer to store status, or NULL to ignore.
127 * @param source Pointer to store source, or NULL to ignore.
128 * @return True on success, false if not found
130 virtual bool Query(PluginId id, const char **file, Pl_Status *status, PluginId *source) =0;
133 * @brief Checks another plugin's QueryRunning() status.
135 * @param id Id of plugin
136 * @param error Message buffer
137 * @param maxlength Size of error buffer
138 * @return Status value
140 virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0;
143 * @brief Returns the handle of a plugin (OS dependent meaning)
145 * @param id Id of plugin
146 * @param handle Pointer to store handle pointer, or NULL to ignore.
147 * @return True if plugin id is valid, false otherwise
149 virtual bool QueryHandle(PluginId id, void **handle) =0;
153 #if !defined METAMOD_NO_AUTO_NAMESPACE
154 using namespace SourceMM;
157 #endif //_INCLUDE_PLUGINMANAGER_H