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