core-legacy/IPluginManager.h
author David Anderson <dvander@alliedmods.net>
Mon Nov 18 11:22:15 2013 -0800 (2013-11-18)
changeset 881 9c07bcf2b4d4
parent 545 07e5df11f9fc
permissions -rw-r--r--
Push build.
dvander@541
     1
/* ======== SourceMM ========
dvander@541
     2
* Copyright (C) 2004-2008 Metamod:Source Development Team
dvander@541
     3
* No warranties of any kind
dvander@541
     4
*
dvander@541
     5
* License: zlib/libpng
dvander@541
     6
*
dvander@541
     7
* Author(s): David "BAILOPAN" Anderson
dvander@541
     8
* ============================
dvander@541
     9
*/
dvander@541
    10
dvander@541
    11
#ifndef _INCLUDE_PLUGINMANAGER_H
dvander@541
    12
#define _INCLUDE_PLUGINMANAGER_H
dvander@541
    13
dvander@541
    14
/**
dvander@541
    15
 * @brief Plugin Manager interface
dvander@541
    16
 * @file IPluginManager.h
dvander@541
    17
 */
dvander@541
    18
dvander@541
    19
typedef int PluginId;
dvander@541
    20
dvander@541
    21
#include "ISmmPlugin.h"
dvander@541
    22
dvander@541
    23
/**
dvander@541
    24
 * @brief Load sources
dvander@541
    25
 */
dvander@541
    26
enum
dvander@541
    27
{
dvander@541
    28
	Pl_BadLoad=0,
dvander@541
    29
	Pl_Console=-1,
dvander@541
    30
	Pl_File=-2,
dvander@541
    31
	Pl_MinId=1,
dvander@541
    32
};
dvander@541
    33
dvander@541
    34
/**
dvander@541
    35
 * @brief Status of a plugin at runtime
dvander@541
    36
 */
dvander@541
    37
enum Pl_Status
dvander@541
    38
{
dvander@541
    39
	Pl_NotFound=-4,
dvander@541
    40
	Pl_Error=-3,
dvander@541
    41
	Pl_Refused=-2,
dvander@541
    42
	Pl_Paused=-1,
dvander@541
    43
	Pl_Running=0,
dvander@541
    44
};
dvander@541
    45
dvander@541
    46
typedef int PluginId;
dvander@541
    47
struct factories;
dvander@541
    48
dvander@541
    49
class ISmmPluginManager
dvander@541
    50
{
dvander@541
    51
public:
dvander@541
    52
	/**
dvander@541
    53
	 * @brief Loads a plugin and returns its id.  If this is called before DLLInit(),
dvander@541
    54
	 *  then the plugin is considered to be "hot" - it might refuse its own load later!
dvander@541
    55
	 *  Also, a hot plugin might not have an error message.
dvander@541
    56
	 *
dvander@541
    57
	 * @param file String containing file name
dvander@541
    58
	 * @param source Specifies who loaded the plugin
dvander@541
    59
	 * @param status Status of the plugin 
dvander@541
    60
	 * @param ismm Pointer to Smm API
dvander@541
    61
	 * @param error String buffer for error messages
dvander@541
    62
	 * @param maxlen Maximum length of buffer
dvander@541
    63
	 * @return Id of plugin
dvander@541
    64
	 */
dvander@541
    65
	virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0;
dvander@541
    66
dvander@541
    67
	/**
dvander@541
    68
	 * @brief Unloads a plugin
dvander@541
    69
	 *
dvander@541
    70
	 * @param id Id of plugin
dvander@541
    71
	 * @param error String buffer for error messages
dvander@541
    72
	 * @param maxlen Maximum length of buffer
dvander@541
    73
	 * @return True on success, false otherwise
dvander@541
    74
	 */
dvander@541
    75
	virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0;
dvander@541
    76
dvander@541
    77
	/**
dvander@541
    78
	 * @brief Pauses a plugin
dvander@541
    79
	 *
dvander@541
    80
	 * @param id Id of plugin
dvander@541
    81
	 * @param error String buffer for error messages
dvander@541
    82
	 * @param maxlen Maximum length of buffer
dvander@541
    83
	 * @return True on success, false otherwise
dvander@541
    84
	 */
dvander@541
    85
	virtual bool Pause(PluginId id, char *error, size_t maxlen) =0;
dvander@541
    86
dvander@541
    87
	/**
dvander@541
    88
	 * @brief Unpauses a plugin
dvander@541
    89
	 *
dvander@541
    90
	 * @param id Id of plugin
dvander@541
    91
	 * @param force If true, forces the plugin to unload
dvander@541
    92
	 * @param error String buffer for error messages
dvander@541
    93
	 * @param maxlen Maximum length of buffer
dvander@541
    94
	 * @return True on success, false otherwise
dvander@541
    95
	 */
dvander@541
    96
	virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0;
dvander@541
    97
dvander@541
    98
	/**
dvander@541
    99
	 * @brief Unloads all plugins forcefully
dvander@541
   100
	 * 
dvander@541
   101
	 * @return True on success, false otherwise
dvander@541
   102
	 */
dvander@541
   103
	virtual bool UnloadAll() =0;
dvander@541
   104
dvander@541
   105
	/**
dvander@541
   106
	 * @brief Returns information about a plugin
dvander@541
   107
	 *
dvander@541
   108
	 * @param id Id of plugin
dvander@541
   109
	 * @param file Pointer to file string by reference
dvander@541
   110
	 * @param list Pointer to factories by reference
dvander@541
   111
	 * @param status By reference status of plugin
dvander@541
   112
	 * @param source By reference source of plugin
dvander@541
   113
	 * @return True on success, false if not found
dvander@541
   114
	 */
dvander@541
   115
	virtual bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source) =0;
dvander@541
   116
dvander@541
   117
	/** 
dvander@541
   118
	 * @brief Checks another plugin's QueryRunning() status.
dvander@541
   119
	 *
dvander@541
   120
	 * @param id		Id of plugin
dvander@541
   121
	 * @param error		Message buffer
dvander@541
   122
	 * @param maxlen	Size of error buffer
dvander@541
   123
	 * @return			Status value
dvander@541
   124
	 */
dvander@541
   125
	virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0;
dvander@541
   126
dvander@541
   127
	/**
dvander@541
   128
	 * @brief Returns the handle of a plugin (OS dependent meaning)
dvander@541
   129
	 * 
dvander@541
   130
	 * @param id		Id of plugin
dvander@541
   131
	 * @param handle	By reference handle of plugin, if any
dvander@541
   132
	 * @return			True if plugin id is valid, false otherwise
dvander@541
   133
	 */
dvander@541
   134
	virtual bool QueryHandle(PluginId id, void *&handle) =0;
dvander@541
   135
};
dvander@541
   136
dvander@541
   137
#endif //_INCLUDE_PLUGINMANAGER_H