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