sourcemm/IPluginManager.h
author David Anderson <dvander@alliedmods.net>
Sat Sep 29 16:16:24 2007 +0000 (2007-09-29)
branchsourcemm-1.6.0
changeset 367 fc76472b980f
parent 347 e82968c21606
permissions -rw-r--r--
added file headers and svn props
     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_PLUGINMANAGER_H
    29 #define _INCLUDE_PLUGINMANAGER_H
    30 
    31 /**
    32  * @brief Plugin Manager interface
    33  * @file IPluginManager.h
    34  */
    35 
    36 typedef int PluginId;
    37 
    38 #include "ISmmPlugin.h"
    39 
    40 /**
    41  * @brief Load sources
    42  */
    43 enum
    44 {
    45 	Pl_BadLoad=0,
    46 	Pl_Console=-1,
    47 	Pl_File=-2,
    48 	Pl_MinId=1,
    49 };
    50 
    51 /**
    52  * @brief Status of a plugin at runtime
    53  */
    54 enum Pl_Status
    55 {
    56 	Pl_NotFound=-4,
    57 	Pl_Error=-3,
    58 	Pl_Refused=-2,
    59 	Pl_Paused=-1,
    60 	Pl_Running=0,
    61 };
    62 
    63 typedef int PluginId;
    64 struct factories;
    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 file string by reference
   127 	 * @param list Pointer to factories by reference
   128 	 * @param status By reference status of plugin
   129 	 * @param source By reference source of plugin
   130 	 * @return True on success, false if not found
   131 	 */
   132 	virtual bool Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source) =0;
   133 
   134 	/** 
   135 	 * @brief Checks another plugin's QueryRunning() status.
   136 	 *
   137 	 * @param id		Id of plugin
   138 	 * @param error		Message buffer
   139 	 * @param maxlen	Size of error buffer
   140 	 * @return			Status value
   141 	 */
   142 	virtual bool QueryRunning(PluginId id, char *error, size_t maxlength) =0;
   143 
   144 	/**
   145 	 * @brief Returns the handle of a plugin (OS dependent meaning)
   146 	 * 
   147 	 * @param id		Id of plugin
   148 	 * @param handle	By reference handle of plugin, if any
   149 	 * @return			True if plugin id is valid, false otherwise
   150 	 */
   151 	virtual bool QueryHandle(PluginId id, void *&handle) =0;
   152 };
   153 
   154 #endif //_INCLUDE_PLUGINMANAGER_H