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