Added Dynamic Hooking to BinTools (bug 2616 r=dvander,DS)

public/extensions/IBinTools.h

@@ -34,8 +34,16 @@
 
 #include <IShareSys.h>
 
+
 #define SMINTERFACE_BINTOOLS_NAME		"IBinTools"
-#define SMINTERFACE_BINTOOLS_VERSION	2
+#define SMINTERFACE_BINTOOLS_VERSION	3
+
+#if defined HOOKING_ENABLED
+#include <sourcehook_pibuilder.h>
+
+#define SMINTERFACE_BINTOOLS2_NAME		"IBinTools2"
+#define SMINTERFACE_BINTOOLS2_VERSION	1
+#endif
 
 /**
  * @brief Function calling encoding utilities
@@ -135,8 +143,109 @@ namespace SourceMod
 		 * @brief Destroys all resources used by this object.
 		 */
 		virtual void Destroy() =0;
+
+#if defined HOOKING_ENABLED
+
+		/**
+		 * @brief Gets the Return type info.
+		 *
+		 * @return				A PassInfo pointer.
+		 */
+		virtual const SourceHook::PassInfo *GetSHReturnInfo() =0;
+
+		/**
+		* @brief Returns the calling convention.
+		*
+		* @return				CallConvention value.
+		*/
+		virtual SourceHook::ProtoInfo::CallConvention GetSHCallConvention() =0;
+
+		/**
+		* @brief Returns parameter info.
+		*
+		* @param num			Parameter number to get (starting from 0).
+		* @return				A PassInfo pointer.
+		*/
+		virtual const SourceHook::PassInfo *GetSHParamInfo(unsigned int num) =0;
+
+		/**
+		 * @brief Returns the offset of a given param.
+		 *
+		 * @param num			Parameter number to get (starting from 0).
+		 * @return				Parameter offset.
+		 */
+		virtual unsigned int GetParamOffset(unsigned int num) =0;
+
+#endif
 	};
 
+#if defined HOOKING_ENABLED
+
+	/**
+	 * @brief Delegate object that intermediates between SourceHook and the callback function.
+	 */
+	class ISMDelegate : public SourceHook::ISHDelegate
+	{
+	private:
+		/**
+		 * @brief Internally used callback function - Do not call!
+		 */
+		virtual void Call() =0;        /**< Do not call */
+	public:
+		/**
+		 * @brief Retrieves the User data buffer.
+		 *
+		 * @return					User data pointer.
+		 */
+		virtual void *GetUserData() =0;
+	};
+
+	/**
+	 * @brief Wrapper around a virtual hook.
+	 */
+	class IHookWrapper
+	{
+	public:
+		/**
+		 * @brief Creates a hook delegate to pass to SourceHook.
+		 *
+		 * @param data				User data pointer.
+		 * @return					A new ISMDelegate for the hook.
+		 */
+		virtual ISMDelegate *CreateDelegate(void *data) =0;
+
+		/**
+		 * @brief Gets the number of params in the hooked function.
+		 *
+		 * @return					Number of params.
+		 */
+		virtual unsigned int GetParamCount() =0;
+
+		/**
+		 * @brief Returns the offset of a given param.
+		 *
+		 * @param argnum			Parameter number from 0 to GetParamCount-1.
+		 * @param size				Optional buffer to store the size of the param.
+		 * @return					Parameter offset or -1 on error.
+		 */
+		virtual unsigned int GetParamOffset(unsigned int argnum, unsigned int *size) =0;
+
+		/**
+		 * @brief Initiates a recall on the function.
+		 *
+		 * @param params			Parameter buffer.
+		 * @param retval			Buffer to store the return value in.
+		 */
+		virtual void PerformRecall(void *params, void *retval) =0;
+
+		/**
+		 * @brief Destroys this HookWrapper.
+		 */
+		virtual void Destroy() =0;
+	};
+
+#endif
+
 	/**
 	 * @brief Binary tools interface.
 	 */
@@ -196,6 +305,82 @@ namespace SourceMod
 											const PassInfo paramInfo[],
 											unsigned int numParams) =0;
 	};
+
+#if defined HOOKING_ENABLED
+
+	/**
+	 * @brief Binary tools interface.
+	 */
+	class IBinTools2 : public SMInterface
+	{
+	public:
+		virtual const char *GetInterfaceName()
+		{
+			return SMINTERFACE_BINTOOLS2_NAME;
+		}
+		virtual unsigned int GetInterfaceVersion()
+		{
+			return SMINTERFACE_BINTOOLS2_VERSION;
+		}
+	public:
+
+		/**
+		 * @brief Creates a call decoder.
+		 *
+		 * Note: CallConv_ThisCall requires an implicit first parameter
+		 * of PassType_Basic / PASSFLAG_BYVAL / sizeof(void *).  However,
+		 * this should only be given to the Execute() function, and never
+		 * listed in the paramInfo array.
+		 *
+		 * @param address			Address to use as a call.
+		 * @param protoInfo			Parameter type information.
+		 * @return					A new ICallWrapper function.
+		 */
+		virtual ICallWrapper *CreateCall(void *address,
+			const SourceHook::ProtoInfo *protoInfo) =0;
+
+		/**
+		 * @brief Creates a vtable call decoder.
+		 *
+		 * Note: CallConv_ThisCall requires an implicit first parameter
+		 * of PassType_Basic / PASSFLAG_BYVAL / sizeof(void *).  However,
+		 * this should only be given to the Execute() function, and never
+		 * listed in the paramInfo array.
+		 *
+		 * @param protoInfo			Parameter type information.
+		 * @param info				Function offset information.
+		 * @return					A new ICallWrapper function.
+		 */
+		virtual ICallWrapper *CreateVirtualCall(const SourceHook::ProtoInfo *protoInfo,
+			const SourceHook::MemFuncInfo *info) =0;
+		
+
+		/**
+		 * @brief Callback function pointer for Virtual Hooks.
+		 *
+		 * @param wrapper			Call wrapper for this hook.
+		 * @param deleg				Delegate for this call.
+		 * @param params				Array of parameters.
+		 * @param ret				Storage buffer for the return value.
+		 */
+		typedef void (*VIRTUAL_HOOK_PROTO)(IHookWrapper *wrapper, ISMDelegate *deleg, void *params, void *ret);
+
+		/**
+		 * @brief Creates a hook on a virtual function.
+		 *
+		 * @param pSH				Global SourceHook pointer.
+		 * @param protoInfo			Parameter type information.
+		 * @param info				Function offset information.
+		 * @param f					Callback function pointer.
+		 */
+		virtual IHookWrapper *CreateVirtualHook(SourceHook::ISourceHook *pSH, 
+			const SourceHook::ProtoInfo *protoInfo, 
+			const SourceHook::MemFuncInfo *info, 
+			VIRTUAL_HOOK_PROTO f) =0;
+	};
+
+#endif
+
 }
 
 #endif //_INCLUDE_SMEXT_BINTOOLS_H_