mirror of
https://github.com/alliedmodders/metamod-source.git
synced 2024-11-29 11:24:19 +01:00
49c7a8c7ca
Fixed ids starting at 3 (changed Pl_MinId) Doxyfile is no longer subdir based --HG-- extra : convert_revision : svn%3Ac2935e3e-5518-0410-8daf-afa5dab7d4e3/trunk%4030
115 lines
2.6 KiB
C++
115 lines
2.6 KiB
C++
/* ======== SourceMM ========
|
|
* Copyright (C) 2004-2005 Metamod:Source Development Team
|
|
* No warranties of any kind
|
|
*
|
|
* License: zlib/libpng
|
|
*
|
|
* Author(s): David "BAILOPAN" Anderson
|
|
* ============================
|
|
*/
|
|
|
|
#ifndef _INCLUDE_PLUGINMANAGER_H
|
|
#define _INCLUDE_PLUGINMANAGER_H
|
|
|
|
/**
|
|
* @brief Plugin Manager interface
|
|
* @file IPluginManager.h
|
|
*/
|
|
|
|
#include "ISmmPlugin.h"
|
|
|
|
/**
|
|
* @brief Status of a plugin at runtime
|
|
*/
|
|
enum Pl_Status
|
|
{
|
|
Pl_NotFound=-4,
|
|
Pl_Error=-3,
|
|
Pl_Refused=-2,
|
|
Pl_Paused=-1,
|
|
Pl_Running=0,
|
|
};
|
|
|
|
/**
|
|
* @brief Load sources
|
|
*/
|
|
enum
|
|
{
|
|
Pl_BadLoad=0,
|
|
Pl_Console=-1,
|
|
Pl_File=-2,
|
|
Pl_MinId=1,
|
|
};
|
|
|
|
typedef int PluginId;
|
|
struct factories;
|
|
|
|
class ISmmPluginManager
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Loads a plugin and returns its id
|
|
*
|
|
* @param file String containing file name
|
|
* @param source Specifies who loaded the plugin
|
|
* @param status Status of the plugin
|
|
* @param ismm Pointer to Smm API
|
|
* @param error String buffer for error messages
|
|
* @param maxlen Maximum length of buffer
|
|
* @return Id of plugin
|
|
*/
|
|
virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0;
|
|
|
|
/**
|
|
* @brief Unloads a plugin
|
|
*
|
|
* @param id Id of plugin
|
|
* @param error String buffer for error messages
|
|
* @param maxlen Maximum length of buffer
|
|
* @return True on success, false otherwise
|
|
*/
|
|
virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0;
|
|
|
|
/**
|
|
* @brief Pauses a plugin
|
|
*
|
|
* @param id Id of plugin
|
|
* @param error String buffer for error messages
|
|
* @param maxlen Maximum length of buffer
|
|
* @return True on success, false otherwise
|
|
*/
|
|
virtual bool Pause(PluginId id, char *error, size_t maxlen) =0;
|
|
|
|
/**
|
|
* @brief Unpauses a plugin
|
|
*
|
|
* @param id Id of plugin
|
|
* @param force If true, forces the plugin to unload
|
|
* @param error String buffer for error messages
|
|
* @param maxlen Maximum length of buffer
|
|
* @return True on success, false otherwise
|
|
*/
|
|
virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0;
|
|
|
|
/**
|
|
* @brief Unloads all plugins forcefully
|
|
*
|
|
* @return True on success, false otherwise
|
|
*/
|
|
virtual bool UnloadAll() =0;
|
|
|
|
/**
|
|
* @brief Returns information about a plugin
|
|
*
|
|
* @param id Id of plugin
|
|
* @param file Pointer to file string by reference
|
|
* @param list Pointer to factories by reference
|
|
* @param status By reference status of plugin
|
|
* @param source By reference source of plugin
|
|
* @return True on success, false if not found
|
|
*/
|
|
virtual bool Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source) =0;
|
|
};
|
|
|
|
#endif //_INCLUDE_PLUGINMANAGER_H
|