sourcemm/IPluginManager.h
author David Anderson <dvander@alliedmods.net>
Thu Apr 28 17:24:39 2005 +0000 (2005-04-28)
changeset 40 dc68364fda90
parent 29 10e6dc40505e
child 122 7c36121e2dfe
permissions -rw-r--r--
Reorganized makefiles a tad
dvander@9
     1
/* ======== SourceMM ========
dvander@9
     2
* Copyright (C) 2004-2005 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@7
    19
#include "ISmmPlugin.h"
dvander@7
    20
dvander@7
    21
/**
dvander@7
    22
 * @brief Status of a plugin at runtime
dvander@7
    23
 */
dvander@7
    24
enum Pl_Status
dvander@7
    25
{
dvander@7
    26
	Pl_NotFound=-4,
dvander@7
    27
	Pl_Error=-3,
dvander@7
    28
	Pl_Refused=-2,
dvander@7
    29
	Pl_Paused=-1,
dvander@7
    30
	Pl_Running=0,
dvander@7
    31
};
dvander@7
    32
dvander@7
    33
/**
dvander@7
    34
 * @brief Load sources
dvander@7
    35
 */
dvander@7
    36
enum
dvander@7
    37
{
dvander@7
    38
	Pl_BadLoad=0,
dvander@29
    39
	Pl_Console=-1,
dvander@29
    40
	Pl_File=-2,
dvander@29
    41
	Pl_MinId=1,
dvander@7
    42
};
dvander@7
    43
dvander@29
    44
typedef int PluginId;
dvander@7
    45
struct factories;
dvander@7
    46
dvander@7
    47
class ISmmPluginManager
dvander@7
    48
{
dvander@7
    49
public:
dvander@7
    50
	/**
dvander@7
    51
	 * @brief Loads a plugin and returns its id
dvander@7
    52
	 *
dvander@7
    53
	 * @param file String containing file name
dvander@7
    54
	 * @param source Specifies who loaded the plugin
dvander@7
    55
	 * @param status Status of the plugin 
dvander@7
    56
	 * @param ismm Pointer to Smm API
dvander@7
    57
	 * @param error String buffer for error messages
dvander@7
    58
	 * @param maxlen Maximum length of buffer
dvander@7
    59
	 * @return Id of plugin
dvander@7
    60
	 */
dvander@7
    61
	virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0;
dvander@7
    62
dvander@7
    63
	/**
dvander@7
    64
	 * @brief Unloads a plugin
dvander@7
    65
	 *
dvander@7
    66
	 * @param id Id of plugin
dvander@7
    67
	 * @param error String buffer for error messages
dvander@7
    68
	 * @param maxlen Maximum length of buffer
dvander@7
    69
	 * @return True on success, false otherwise
dvander@7
    70
	 */
dvander@9
    71
	virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0;
dvander@7
    72
dvander@7
    73
	/**
dvander@7
    74
	 * @brief Pauses a plugin
dvander@7
    75
	 *
dvander@7
    76
	 * @param id Id of plugin
dvander@7
    77
	 * @param error String buffer for error messages
dvander@7
    78
	 * @param maxlen Maximum length of buffer
dvander@7
    79
	 * @return True on success, false otherwise
dvander@7
    80
	 */
dvander@7
    81
	virtual bool Pause(PluginId id, char *error, size_t maxlen) =0;
dvander@7
    82
dvander@7
    83
	/**
dvander@7
    84
	 * @brief Unpauses a plugin
dvander@7
    85
	 *
dvander@7
    86
	 * @param id Id of plugin
dvander@9
    87
	 * @param force If true, forces the plugin to unload
dvander@7
    88
	 * @param error String buffer for error messages
dvander@7
    89
	 * @param maxlen Maximum length of buffer
dvander@7
    90
	 * @return True on success, false otherwise
dvander@7
    91
	 */
dvander@7
    92
	virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0;
dvander@7
    93
dvander@7
    94
	/**
dvander@7
    95
	 * @brief Unloads all plugins forcefully
dvander@7
    96
	 * 
dvander@7
    97
	 * @return True on success, false otherwise
dvander@7
    98
	 */
dvander@7
    99
	virtual bool UnloadAll() =0;
dvander@7
   100
dvander@7
   101
	/**
dvander@7
   102
	 * @brief Returns information about a plugin
dvander@7
   103
	 *
dvander@7
   104
	 * @param id Id of plugin
dvander@7
   105
	 * @param file Pointer to file string by reference
dvander@7
   106
	 * @param list Pointer to factories by reference
dvander@7
   107
	 * @param status By reference status of plugin
dvander@7
   108
	 * @param source By reference source of plugin
dvander@7
   109
	 * @return True on success, false if not found
dvander@7
   110
	 */
dvander@7
   111
	virtual bool Query(PluginId id, const char *&file, factories *&list, Pl_Status &status, PluginId &source) =0;
dvander@7
   112
};
dvander@7
   113
dvander@7
   114
#endif //_INCLUDE_PLUGINMANAGER_H