pavolmarko@1: /* ======== SourceHook ======== pavolmarko@1: * By PM pavolmarko@1: * No warranties of any kind pavolmarko@1: * pavolmarko@1: * This file declares necessary stuff for the sourcehook implementation. pavolmarko@1: * ============================ pavolmarko@1: */ pavolmarko@1: pavolmarko@1: #ifndef __SOURCEHOOK_IMPL_H__ pavolmarko@1: #define __SOURCEHOOK_IMPL_H__ pavolmarko@1: pavolmarko@1: #include "sourcehook.h" pavolmarko@1: pavolmarko@1: // Set this to 1 to enable runtime code generation (faster) pavolmarko@1: #define SH_RUNTIME_CODEGEN 1 pavolmarko@1: pavolmarko@1: namespace SourceHook pavolmarko@1: { pavolmarko@1: /** pavolmarko@1: * @brief The SourceHook implementation class pavolmarko@1: */ pavolmarko@1: class CSourceHookImpl : public ISourceHook pavolmarko@1: { pavolmarko@1: /** pavolmarko@1: * @brief A list of HookerInfo structures pavolmarko@1: */ pavolmarko@1: typedef std::list HookerInfoList; pavolmarko@1: pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief A list of Impl_CallClass structures pavolmarko@1: */ pavolmarko@1: typedef std::list Impl_CallClassList; pavolmarko@1: pavolmarko@1: Impl_CallClassList m_CallClasses; //!< A list of already generated callclasses pavolmarko@1: HookerInfoList m_Hookers; //!< A list of hookers pavolmarko@1: pavolmarko@1: int m_PageSize; //!< Stores the system's page size pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Finds a hooker for a function based on a text-prototype, a vtable offset and a vtable index pavolmarko@1: */ pavolmarko@1: HookerInfoList::iterator FindHooker(HookerInfoList::iterator begin, HookerInfoList::iterator end, pavolmarko@1: const char *proto, int vtblofs, int vtblidx, int thisptrofs); pavolmarko@1: pavolmarko@1: void FreeCallClass(CallClass &cc); pavolmarko@1: bool ApplyCallClassPatch(CallClass &cc, int vtbl_offs, int vtbl_idx, void *orig_entry); pavolmarko@1: pavolmarko@1: static const int MAX_VTABLE_LEN = 4096; //!< Maximal vtable length in bytes pavolmarko@1: pavolmarko@1: META_RES m_Status, m_PrevRes, m_CurRes; pavolmarko@1: const void *m_OrigRet; pavolmarko@1: const void *m_OverrideRet; pavolmarko@1: void *m_IfacePtr; pavolmarko@1: public: pavolmarko@1: CSourceHookImpl(); pavolmarko@1: ~CSourceHookImpl(); pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hookers pavolmarko@1: */ pavolmarko@1: void UnloadPlugin(Plugin plug); pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Shut down the whole system, unregister all hookers pavolmarko@1: */ pavolmarko@1: void CompleteShutdown(); pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Add a hook. pavolmarko@1: * pavolmarko@1: * @return True if the function succeeded, false otherwise pavolmarko@1: * pavolmarko@1: * @param plug The unique identifier of the plugin that calls this function pavolmarko@1: * @param iface The interface pointer pavolmarko@1: * @param myHooker A hooker (hook manager) function that should be capable of handling the corresponding function pavolmarko@1: * @param handler A pointer to a FastDelegate containing the hook handler pavolmarko@1: * @param post Set to true if you want a post handler pavolmarko@1: */ pavolmarko@1: bool AddHook(Plugin plug, void *iface, int ifacesize, Hooker myHooker, ISHDelegate *handler, bool post); pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Removes a hook. pavolmarko@1: * pavolmarko@1: * @return True if the function succeeded, false otherwise pavolmarko@1: * pavolmarko@1: * @param plug The unique identifier of the plugin that calls this function pavolmarko@1: * @param iface The interface pointer pavolmarko@1: * @param vtableoffset Offset to the vtable, in bytes pavolmarko@1: * @param vtableidx Pointer to the vtable index of the function pavolmarko@1: * @param proto A text version of the function prototype; generated by the macros pavolmarko@1: * @param handler A pointer to a FastDelegate containing the hook handler pavolmarko@1: * @param post Set to true if you want a post handler pavolmarko@1: */ pavolmarko@1: bool RemoveHook(Plugin plug, void *iface, Hooker myHooker, ISHDelegate *handler, bool post); pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Checks whether a plugin has (a) hooker(s) that is/are currently used by other plugins pavolmarko@1: * pavolmarko@1: * @param plug The unique identifier of the plugin in question pavolmarko@1: */ pavolmarko@1: bool IsPluginInUse(Plugin plug); pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Return a pointer to a callclass. Generate a new one if required. pavolmarko@1: * pavolmarko@1: * @param iface The interface pointer pavolmarko@1: */ pavolmarko@1: void *GetCallClass(void *iface, size_t size); pavolmarko@1: pavolmarko@1: /** pavolmarko@1: * @brief Release a callclass pavolmarko@1: * pavolmarko@1: * @param ptr Pointer to the callclass pavolmarko@1: */ pavolmarko@1: virtual void ReleaseCallClass(void *ptr); pavolmarko@1: pavolmarko@1: virtual void SetRes(META_RES res); //!< Sets the meta result pavolmarko@1: virtual META_RES GetPrevRes(); //!< Gets the meta result of the previously called handler pavolmarko@1: virtual META_RES GetStatus(); //!< Gets the highest meta result pavolmarko@1: virtual const void *GetOrigRet(); //!< Gets the original result. If not in post function, undefined pavolmarko@1: virtual const void *GetOverrideRet(); //!< Gets the override result. If none is specified, NULL pavolmarko@1: virtual void *GetIfacePtr(); //!< Gets the interface pointer pavolmarko@1: pavolmarko@1: ////////////////////////////////////////////////////////////////////////// pavolmarko@1: // For hookers pavolmarko@1: virtual META_RES &GetCurResRef(); //!< Gets the pointer to the current meta result pavolmarko@1: virtual META_RES &GetPrevResRef(); //!< Gets the pointer to the previous meta result pavolmarko@1: virtual META_RES &GetStatusRef(); //!< Gets the pointer to the status variable pavolmarko@1: virtual void SetOrigRet(const void *ptr); //!< Sets the original return pointer pavolmarko@1: virtual void SetOverrideRet(const void *ptr); //!< Sets the override result pointer pavolmarko@1: virtual void SetIfacePtr(void *ptr); //!< Sets the interface this pointer pavolmarko@1: }; pavolmarko@1: } pavolmarko@1: pavolmarko@1: #endif