Home - sourcemod-central - file revision - public/INativeInvoker.h@ceafb87d38a7 Mercurial
summary | shortlog | changelog | graph | tags | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
public/INativeInvoker.h
author Erik Minekus <erik@minekus.com>
Thu Aug 01 09:26:34 2013 -0400 (2013-08-01)
changeset 3967 ceafb87d38a7
parent 3176 a47f6d56f0a1
permissions -rw-r--r--
Numerous code documentation fixups (bug 5720, r=psychonic). 
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2009 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or modify it under
     9  * the terms of the GNU General Public License, version 3.0, as published by the
    10  * Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to link the
    21  * code of this program (as well as its derivative works) to "Half-Life 2," the
    22  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    23  * by the Valve Corporation.  You must obey the GNU General Public License in
    24  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    25  * this exception to all derivative works.  AlliedModders LLC defines further
    26  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    27  * or <http://www.sourcemod.net/license.php>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #ifndef _INCLUDE_SOURCEMOD_INATIVEINVOKER_H_
    33 #define _INCLUDE_SOURCEMOD_INATIVEINVOKER_H_
    34 
    35 /**
    36  * @file INativeInvoker.h
    37  * @brief Interface for invoking natives.
    38  */
    39 
    40 #include <IShareSys.h>
    41 #include <sp_vm_api.h>
    42 
    43 #define SMINTERFACE_NINVOKE_NAME	"INativeInterface"
    44 #define SMINTERFACE_NINVOKE_VERSION	1
    45 
    46 #define NINVOKE_DEFAULT_MEMORY		16384
    47 
    48 namespace SourceMod
    49 {
    50 	class INativeInvoker : public SourcePawn::ICallable
    51 	{
    52 	public:
    53 		/**
    54 		 * @brief Virtual destructor - use delete to free this.
    55 		 */
    56 		virtual ~INativeInvoker()
    57 		{
    58 		}
    59 	public:
    60 		/**
    61 		 * @brief Begins a native call.
    62 		 *
    63 		 * During a call's preparation, no new calls may be started.
    64 		 *
    65 		 * @param pContext	Context to invoke native under.
    66 		 * @param name		Name of native.
    67 		 * @return			True if native was found, false otherwise.
    68 		 */
    69 		virtual bool Start(SourcePawn::IPluginContext *pContext, const char *name) = 0;
    70 
    71 		/**
    72 		 * @brief Invokes the native.  The preparation state is cleared immediately, meaning that 
    73 		 * this object can be re-used after or even from inside the native being called.
    74 		 *
    75 		 * @param result	Optional pointer to retrieve a result.
    76 		 * @return			SP_ERROR return code.
    77 		 */
    78 		virtual int Invoke(cell_t *result) = 0;
    79 	};
    80 
    81 	/**
    82 	 * @brief Factory for dealing with native invocations.
    83 	 */
    84 	class INativeInterface : public SMInterface
    85 	{
    86 	public:
    87 		/**
    88 		 * @brief Creates a virtual plugin.  This can be used as an environment to invoke natives.
    89 		 *
    90 		 * IPluginRuntime objects must be freed with the delete operator.
    91 		 *
    92 		 * @param name		Name, or NULL for anonymous.
    93 		 * @param bytes		Number of bytes for memory (NINVOKE_DEFAULT_MEMORY recommended).
    94 		 * @return			New runtime, or NULL on failure.
    95 		 */
    96 		virtual SourcePawn::IPluginRuntime *CreateRuntime(const char *name, size_t bytes) = 0;
    97 
    98 		/**
    99 		 * @brief Creates an object that can be used to invoke a single native code.
   100 		 *
   101 		 * @return			New native invoker (free with delete).
   102 		 */
   103 		virtual INativeInvoker *CreateInvoker() = 0;
   104 	};
   105 }
   106 
   107 #endif /* _INCLUDE_SOURCEMOD_INATIVEINVOKER_H_ */
sourcemod-central
Feed