core/IPluginManager.h
author Fyren <fyrenmoo@gmail.com>
Wed Sep 21 00:19:21 2011 -0700 (2011-09-21)
changeset 765 44703fe45c60
parent 539 db914129ae01
permissions -rw-r--r--
Triggering build.
dvander@513
     1
/*
dvander@371
     2
 * vim: set ts=4 :
dvander@371
     3
 * ======================================================
dvander@371
     4
 * Metamod:Source
ds@523
     5
 * Copyright (C) 2004-2008 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@396
    28
#ifndef _INCLUDE_METAMOD_IPLUGINMANAGER_H
dvander@396
    29
#define _INCLUDE_METAMOD_IPLUGINMANAGER_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@487
    36
#include <ISmmPluginExt.h>
dvander@487
    37
dvander@396
    38
namespace SourceMM
dvander@7
    39
{
dvander@7
    40
	/**
dvander@396
    41
	 * @brief Load sources
dvander@7
    42
	 */
dvander@396
    43
	enum
dvander@396
    44
	{
dvander@396
    45
		Pl_BadLoad=0,
dvander@396
    46
		Pl_Console=-1,
dvander@396
    47
		Pl_File=-2,
dvander@396
    48
		Pl_MinId=1,
dvander@396
    49
	};
dvander@396
    50
	
dvander@7
    51
	/**
dvander@396
    52
	 * @brief Status of a plugin at runtime
dvander@7
    53
	 */
dvander@396
    54
	enum Pl_Status
dvander@396
    55
	{
dvander@396
    56
		Pl_NotFound=-4,
dvander@396
    57
		Pl_Error=-3,
dvander@396
    58
		Pl_Refused=-2,
dvander@396
    59
		Pl_Paused=-1,
dvander@396
    60
		Pl_Running=0,
dvander@396
    61
	};
dvander@396
    62
dvander@513
    63
	/**
dvander@513
    64
	 * @brief Programmatic management of the "loaded plugin" list.
dvander@513
    65
	 */
dvander@396
    66
	class ISmmPluginManager
dvander@396
    67
	{
dvander@396
    68
	public:
dvander@396
    69
		/**
dvander@396
    70
		 * @brief Loads a plugin and returns its id.  If this is called before DLLInit(),
dvander@396
    71
		 *  then the plugin is considered to be "hot" - it might refuse its own load later!
dvander@396
    72
		 *  Also, a hot plugin might not have an error message.
dvander@396
    73
		 *
dvander@513
    74
		 * @param file 		String containing file name.
dvander@513
    75
		 * @param source 	Specifies who loaded the plugin.
dvander@513
    76
		 * @param already 	Whether or not the plugin was already loaded.
dvander@513
    77
		 * @param error 	String buffer for error messages.
dvander@513
    78
		 * @param maxlen 	Maximum length of buffer.
dvander@513
    79
		 * @return 			Id of plugin.
dvander@396
    80
		 */
dvander@396
    81
		virtual PluginId Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) =0;
dvander@122
    82
dvander@396
    83
		/**
dvander@513
    84
		 * @brief Unloads a plugin.
dvander@396
    85
		 *
dvander@513
    86
		 * @param id 		Id of plugin
dvander@513
    87
		 * @param force		True to forcefully unload, false to let plugin opt-out.
dvander@513
    88
		 * @param error 	String buffer for error messages
dvander@513
    89
		 * @param maxlen 	Maximum length of buffer
dvander@513
    90
		 * @return 			True on success, false otherwise
dvander@396
    91
		 */
dvander@396
    92
		virtual bool Unload(PluginId id, bool force, char *error, size_t maxlen) =0;
dvander@396
    93
	
dvander@396
    94
		/**
dvander@396
    95
		 * @brief Pauses a plugin
dvander@396
    96
		 *
dvander@513
    97
		 * @param id 		Id of plugin
dvander@513
    98
		 * @param error 	String buffer for error messages
dvander@513
    99
		 * @param maxlen 	Maximum length of buffer
dvander@513
   100
		 * @return 			True on success, false otherwise
dvander@396
   101
		 */
dvander@396
   102
		virtual bool Pause(PluginId id, char *error, size_t maxlen) =0;
dvander@396
   103
	
dvander@396
   104
		/**
dvander@396
   105
		 * @brief Unpauses a plugin
dvander@396
   106
		 *
dvander@513
   107
		 * @param id 		Id of plugin
dvander@513
   108
		 * @param error 	String buffer for error messages
dvander@513
   109
		 * @param maxlen 	Maximum length of buffer
dvander@513
   110
		 * @return 			True on success, false otherwise
dvander@396
   111
		 */
dvander@396
   112
		virtual bool Unpause(PluginId id, char *error, size_t maxlen) =0;
dvander@396
   113
	
dvander@396
   114
		/**
dvander@396
   115
		 * @brief Unloads all plugins forcefully
dvander@396
   116
		 * 
dvander@513
   117
		 * @return 			True on success, false otherwise
dvander@396
   118
		 */
dvander@396
   119
		virtual bool UnloadAll() =0;
dvander@396
   120
	
dvander@396
   121
		/**
dvander@396
   122
		 * @brief Returns information about a plugin
dvander@396
   123
		 *
dvander@397
   124
		 * @param id 		Id of plugin
dvander@397
   125
		 * @param file 		Pointer to store filename pointer, or NULL to ignore.
dvander@397
   126
		 * @param status 	Pointer to store status, or NULL to ignore.
dvander@397
   127
		 * @param source 	Pointer to store source, or NULL to ignore.
dvander@397
   128
		 * @return 			True on success, false if not found
dvander@396
   129
		 */
dvander@397
   130
		virtual bool Query(PluginId id, const char **file, Pl_Status *status, PluginId *source) =0;
dvander@396
   131
	
dvander@396
   132
		/** 
dvander@396
   133
		 * @brief Checks another plugin's QueryRunning() status.
dvander@396
   134
		 *
dvander@396
   135
		 * @param id		Id of plugin
dvander@396
   136
		 * @param error		Message buffer
dvander@513
   137
		 * @param maxlength	Size of error buffer
dvander@396
   138
		 * @return			Status value
dvander@396
   139
		 */
dvander@396
   140
		virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0;
dvander@396
   141
	
dvander@396
   142
		/**
dvander@396
   143
		 * @brief Returns the handle of a plugin (OS dependent meaning)
dvander@396
   144
		 * 
dvander@396
   145
		 * @param id		Id of plugin
dvander@397
   146
		 * @param handle	Pointer to store handle pointer, or NULL to ignore.
dvander@396
   147
		 * @return			True if plugin id is valid, false otherwise
dvander@396
   148
		 */
dvander@397
   149
		virtual bool QueryHandle(PluginId id, void **handle) =0;
dvander@396
   150
	};
dvander@396
   151
}
dvander@227
   152
dvander@396
   153
#if !defined METAMOD_NO_AUTO_NAMESPACE
dvander@396
   154
using namespace SourceMM;
dvander@396
   155
#endif
dvander@7
   156
dvander@7
   157
#endif //_INCLUDE_PLUGINMANAGER_H
dvander@396
   158