dvander@2545: /**
dvander@2545:  * vim: set ts=4 :
dvander@2545:  * =============================================================================
dvander@2545:  * SourceMod
dvander@2545:  * Copyright (C) 2004-2009 AlliedModders LLC.  All rights reserved.
dvander@2545:  * =============================================================================
dvander@2545:  *
dvander@2545:  * This program is free software; you can redistribute it and/or modify it under
dvander@2545:  * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2545:  * Free Software Foundation.
dvander@2545:  * 
dvander@2545:  * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2545:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2545:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2545:  * details.
dvander@2545:  *
dvander@2545:  * You should have received a copy of the GNU General Public License along with
dvander@2545:  * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2545:  *
dvander@2545:  * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2545:  * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2545:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2545:  * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2545:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2545:  * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2545:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2545:  * or <http://www.sourcemod.net/license.php>.
dvander@2545:  *
dvander@2545:  * Version: $Id$
dvander@2545:  */
dvander@2545: 
dvander@2545: #ifndef _INCLUDE_SOURCEMOD_INATIVEINVOKER_H_
dvander@2545: #define _INCLUDE_SOURCEMOD_INATIVEINVOKER_H_
dvander@2545: 
dvander@2545: /**
dvander@2545:  * @file INativeInvoker.h
dvander@2545:  * @brief Interface for invoking natives.
dvander@2545:  */
dvander@2545: 
dvander@2545: #include <IShareSys.h>
theY4Kman@3176: #include <sp_vm_api.h>
dvander@2545: 
dvander@2545: #define SMINTERFACE_NINVOKE_NAME	"INativeInterface"
dvander@2545: #define SMINTERFACE_NINVOKE_VERSION	1
dvander@2545: 
dvander@2545: #define NINVOKE_DEFAULT_MEMORY		16384
dvander@2545: 
dvander@2545: namespace SourceMod
dvander@2545: {
dvander@2545: 	class INativeInvoker : public SourcePawn::ICallable
dvander@2545: 	{
dvander@2545: 	public:
dvander@2545: 		/**
dvander@2545: 		 * @brief Virtual destructor - use delete to free this.
dvander@2545: 		 */
dvander@2545: 		virtual ~INativeInvoker()
dvander@2545: 		{
dvander@2545: 		}
dvander@2545: 	public:
dvander@2545: 		/**
dvander@2545: 		 * @brief Begins a native call.
dvander@2545: 		 *
dvander@2545: 		 * During a call's preparation, no new calls may be started.
dvander@2545: 		 *
dvander@2545: 		 * @param pContext	Context to invoke native under.
dvander@2545: 		 * @param name		Name of native.
dvander@2545: 		 * @return			True if native was found, false otherwise.
dvander@2545: 		 */
theY4Kman@3176: 		virtual bool Start(SourcePawn::IPluginContext *pContext, const char *name) = 0;
dvander@2545: 
dvander@2545: 		/**
dvander@2545: 		 * @brief Invokes the native.  The preparation state is cleared immediately, meaning that 
dvander@2545: 		 * this object can be re-used after or even from inside the native being called.
dvander@2545: 		 *
dvander@2545: 		 * @param result	Optional pointer to retrieve a result.
dvander@2545: 		 * @return			SP_ERROR return code.
dvander@2545: 		 */
dvander@2545: 		virtual int Invoke(cell_t *result) = 0;
dvander@2545: 	};
dvander@2545: 
dvander@2545: 	/**
dvander@2545: 	 * @brief Factory for dealing with native invocations.
dvander@2545: 	 */
dvander@2545: 	class INativeInterface : public SMInterface
dvander@2545: 	{
dvander@2545: 	public:
dvander@2545: 		/**
dvander@2545: 		 * @brief Creates a virtual plugin.  This can be used as an environment to invoke natives.
dvander@2545: 		 *
dvander@2545: 		 * IPluginRuntime objects must be freed with the delete operator.
dvander@2545: 		 *
dvander@2545: 		 * @param name		Name, or NULL for anonymous.
dvander@2545: 		 * @param bytes		Number of bytes for memory (NINVOKE_DEFAULT_MEMORY recommended).
dvander@2545: 		 * @return			New runtime, or NULL on failure.
dvander@2545: 		 */
theY4Kman@3176: 		virtual SourcePawn::IPluginRuntime *CreateRuntime(const char *name, size_t bytes) = 0;
dvander@2545: 
dvander@2545: 		/**
dvander@2545: 		 * @brief Creates an object that can be used to invoke a single native code.
dvander@2545: 		 *
dvander@2545: 		 * @return			New native invoker (free with delete).
dvander@2545: 		 */
dvander@2545: 		virtual INativeInvoker *CreateInvoker() = 0;
dvander@2545: 	};
dvander@2545: }
dvander@2545: 
dvander@2545: #endif /* _INCLUDE_SOURCEMOD_INATIVEINVOKER_H_ */