sourcemm/IPluginManager.h
author David Anderson <dvander@alliedmods.net>
Sat Oct 06 16:47:58 2007 +0000 (2007-10-06)
changeset 376 f2d55f90f697
parent 371 751179604513
child 396 ed81bca8944a
permissions -rw-r--r--
added format/formatargs api
dvander@371
     1
/**
dvander@371
     2
 * vim: set ts=4 :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
dvander@371
     5
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
dvander@371
     6
 * All rights reserved.
dvander@371
     7
 * ======================================================
dvander@371
     8
 *
dvander@371
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@371
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@371
    11
 * the use of this software.
dvander@371
    12
 * 
dvander@371
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@371
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@371
    15
 * freely, subject to the following restrictions:
dvander@371
    16
 *
dvander@371
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@371
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@371
    19
 * product, an acknowledgment in the product documentation would be 
dvander@371
    20
 * appreciated but is not required.
dvander@371
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@371
    22
 * misrepresented as being the original software.
dvander@371
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@371
    24
 *
dvander@371
    25
 * Version: $Id$
dvander@371
    26
 */
dvander@9
    27
dvander@7
    28
#ifndef _INCLUDE_PLUGINMANAGER_H
dvander@7
    29
#define _INCLUDE_PLUGINMANAGER_H
dvander@7
    30
dvander@9
    31
/**
dvander@9
    32
 * @brief Plugin Manager interface
dvander@9
    33
 * @file IPluginManager.h
dvander@9
    34
 */
dvander@9
    35
dvander@139
    36
typedef int PluginId;
dvander@139
    37
dvander@7
    38
#include "ISmmPlugin.h"
dvander@7
    39
dvander@7
    40
/**
dvander@122
    41
 * @brief Load sources
dvander@122
    42
 */
dvander@122
    43
enum
dvander@122
    44
{
dvander@122
    45
	Pl_BadLoad=0,
dvander@122
    46
	Pl_Console=-1,
dvander@122
    47
	Pl_File=-2,
dvander@122
    48
	Pl_MinId=1,
dvander@122
    49
};
dvander@122
    50
dvander@122
    51
/**
dvander@7
    52
 * @brief Status of a plugin at runtime
dvander@7
    53
 */
dvander@7
    54
enum Pl_Status
dvander@7
    55
{
dvander@7
    56
	Pl_NotFound=-4,
dvander@7
    57
	Pl_Error=-3,
dvander@7
    58
	Pl_Refused=-2,
dvander@7
    59
	Pl_Paused=-1,
dvander@7
    60
	Pl_Running=0,
dvander@7
    61
};
dvander@7
    62
dvander@29
    63
typedef int PluginId;
dvander@7
    64
struct factories;
dvander@7
    65
dvander@7
    66
class ISmmPluginManager
dvander@7
    67
{
dvander@7
    68
public:
dvander@7
    69
	/**
dvander@122
    70
	 * @brief Loads a plugin and returns its id.  If this is called before DLLInit(),
dvander@122
    71
	 *  then the plugin is considered to be "hot" - it might refuse its own load later!
dvander@122
    72
	 *  Also, a hot plugin might not have an error message.
dvander@7
    73
	 *
dvander@7
    74
	 * @param file String containing file name
dvander@7
    75
	 * @param source Specifies who loaded the plugin
dvander@7
    76
	 * @param status Status of the plugin 
dvander@7
    77
	 * @param ismm Pointer to Smm API
dvander@7
    78
	 * @param error String buffer for error messages
dvander@7
    79
	 * @param maxlen Maximum length of buffer
dvander@7
    80
	 * @return Id of plugin
dvander@7
    81
	 */
dvander@7
    82
	virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0;
dvander@7
    83
dvander@7
    84
	/**
dvander@7
    85
	 * @brief Unloads a plugin
dvander@7
    86
	 *
dvander@7
    87
	 * @param id Id of plugin
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@9
    92
	virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0;
dvander@7
    93
dvander@7
    94
	/**
dvander@7
    95
	 * @brief Pauses a plugin
dvander@7
    96
	 *
dvander@7
    97
	 * @param id Id of plugin
dvander@7
    98
	 * @param error String buffer for error messages
dvander@7
    99
	 * @param maxlen Maximum length of buffer
dvander@7
   100
	 * @return True on success, false otherwise
dvander@7
   101
	 */
dvander@7
   102
	virtual bool Pause(PluginId id, char *error, size_t maxlen) =0;
dvander@7
   103
dvander@7
   104
	/**
dvander@7
   105
	 * @brief Unpauses a plugin
dvander@7
   106
	 *
dvander@7
   107
	 * @param id Id of plugin
dvander@9
   108
	 * @param force If true, forces the plugin to unload
dvander@7
   109
	 * @param error String buffer for error messages
dvander@7
   110
	 * @param maxlen Maximum length of buffer
dvander@7
   111
	 * @return True on success, false otherwise
dvander@7
   112
	 */
dvander@7
   113
	virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0;
dvander@7
   114
dvander@7
   115
	/**
dvander@7
   116
	 * @brief Unloads all plugins forcefully
dvander@7
   117
	 * 
dvander@7
   118
	 * @return True on success, false otherwise
dvander@7
   119
	 */
dvander@7
   120
	virtual bool UnloadAll() =0;
dvander@7
   121
dvander@7
   122
	/**
dvander@7
   123
	 * @brief Returns information about a plugin
dvander@7
   124
	 *
dvander@7
   125
	 * @param id Id of plugin
dvander@7
   126
	 * @param file Pointer to file string by reference
dvander@7
   127
	 * @param list Pointer to factories by reference
dvander@7
   128
	 * @param status By reference status of plugin
dvander@7
   129
	 * @param source By reference source of plugin
dvander@7
   130
	 * @return True on success, false if not found
dvander@7
   131
	 */
dvander@138
   132
	virtual bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source) =0;
dvander@122
   133
dvander@122
   134
	/** 
dvander@122
   135
	 * @brief Checks another plugin's QueryRunning() status.
dvander@122
   136
	 *
dvander@122
   137
	 * @param id		Id of plugin
dvander@122
   138
	 * @param error		Message buffer
dvander@122
   139
	 * @param maxlen	Size of error buffer
dvander@122
   140
	 * @return			Status value
dvander@122
   141
	 */
dvander@122
   142
	virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0;
dvander@227
   143
dvander@227
   144
	/**
dvander@227
   145
	 * @brief Returns the handle of a plugin (OS dependent meaning)
dvander@227
   146
	 * 
dvander@227
   147
	 * @param id		Id of plugin
dvander@227
   148
	 * @param handle	By reference handle of plugin, if any
dvander@227
   149
	 * @return			True if plugin id is valid, false otherwise
dvander@227
   150
	 */
dvander@227
   151
	virtual bool QueryHandle(PluginId id, void *&handle) =0;
dvander@7
   152
};
dvander@7
   153
dvander@7
   154
#endif //_INCLUDE_PLUGINMANAGER_H