pavolmarko@1: /* ======== SourceHook ======== dvander@10: * Copyright (C) 2004-2005 Metamod:Source Development Team pavolmarko@1: * No warranties of any kind pavolmarko@1: * dvander@10: * License: zlib/libpng dvander@10: * dvander@10: * Author(s): Pavol "PM OnoTo" Marko 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@117: #include "sh_list.h" pavolmarko@117: #include "sh_vector.h" pavolmarko@117: #include "sh_tinyhash.h" ds@86: pavolmarko@1: // Set this to 1 to enable runtime code generation (faster) pavolmarko@117: // (unused at the moment, but may come back, so I'm leaving it in here!) 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@117: private: pavolmarko@1: /** pavolmarko@6: * @brief A hook can be removed if you have this information pavolmarko@1: */ pavolmarko@6: struct RemoveHookInfo pavolmarko@6: { pavolmarko@58: RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman, pavolmarko@41: ISHDelegate *phandler, bool ppost) pavolmarko@58: : plug(pplug), iface(piface), thisptr_offs(tpo), pavolmarko@58: hookman(phookman), handler(phandler), post(ppost) pavolmarko@6: { pavolmarko@6: } pavolmarko@6: pavolmarko@6: Plugin plug; pavolmarko@6: void *iface; pavolmarko@58: int thisptr_offs; pavolmarko@41: HookManagerPubFunc hookman; pavolmarko@6: ISHDelegate *handler; pavolmarko@6: bool post; pavolmarko@6: }; pavolmarko@6: pavolmarko@117: struct HookInfo pavolmarko@117: { pavolmarko@117: ISHDelegate *handler; //!< Pointer to the handler pavolmarko@117: bool paused; //!< If true, the hook should not be executed pavolmarko@117: Plugin plug; //!< The owner plugin pavolmarko@117: int thisptr_offs; //!< This pointer offset pavolmarko@117: }; pavolmarko@117: pavolmarko@117: class CHookList : public IHookList pavolmarko@117: { pavolmarko@117: public: pavolmarko@117: List m_List; pavolmarko@117: pavolmarko@117: friend class CIter; pavolmarko@117: pavolmarko@117: class CIter : public IHookList::IIter pavolmarko@117: { pavolmarko@117: friend class CHookList; pavolmarko@117: pavolmarko@117: CHookList *m_pList; pavolmarko@117: List::iterator m_Iter; pavolmarko@117: pavolmarko@117: void SkipPaused(); pavolmarko@117: public: pavolmarko@117: CIter(CHookList *pList); pavolmarko@117: pavolmarko@117: virtual ~CIter(); pavolmarko@117: pavolmarko@117: void GoToBegin(); pavolmarko@117: pavolmarko@117: bool End(); pavolmarko@117: void Next(); pavolmarko@117: ISHDelegate *Handler(); pavolmarko@117: int ThisPtrOffs(); pavolmarko@117: pavolmarko@117: CIter *m_pNext; // When stored in m_FreeIters pavolmarko@117: }; pavolmarko@117: pavolmarko@117: CIter *m_FreeIters; pavolmarko@117: pavolmarko@117: CHookList(); pavolmarko@117: CHookList(const CHookList &other); pavolmarko@117: virtual ~CHookList(); pavolmarko@117: pavolmarko@117: void operator=(const CHookList &other); pavolmarko@117: pavolmarko@117: IIter *GetIter(); pavolmarko@117: void ReleaseIter(IIter *pIter); pavolmarko@117: }; pavolmarko@117: pavolmarko@117: // I know, data hiding... But I'm a lazy bastard! pavolmarko@117: pavolmarko@117: class CIface : public IIface pavolmarko@117: { pavolmarko@117: public: pavolmarko@117: void *m_Ptr; pavolmarko@117: CHookList m_PreHooks; pavolmarko@117: CHookList m_PostHooks; pavolmarko@117: public: pavolmarko@117: CIface(void *ptr); pavolmarko@117: virtual ~CIface(); pavolmarko@117: pavolmarko@117: void *GetPtr(); pavolmarko@117: IHookList *GetPreHooks(); pavolmarko@117: IHookList *GetPostHooks(); pavolmarko@117: pavolmarko@117: bool operator==(void *ptr) pavolmarko@117: { pavolmarko@117: return m_Ptr == ptr; pavolmarko@117: } pavolmarko@117: }; pavolmarko@1: pavolmarko@117: class CVfnPtr : public IVfnPtr pavolmarko@117: { pavolmarko@117: public: pavolmarko@117: typedef List IfaceList; pavolmarko@117: typedef IfaceList::iterator IfaceListIter; pavolmarko@117: pavolmarko@117: void *m_Ptr; pavolmarko@117: void *m_OrigEntry; pavolmarko@117: pavolmarko@117: IfaceList m_Ifaces; pavolmarko@117: pavolmarko@117: public: pavolmarko@117: CVfnPtr(void *ptr); pavolmarko@117: virtual ~CVfnPtr(); pavolmarko@117: pavolmarko@117: void *GetVfnPtr(); pavolmarko@117: void *GetOrigEntry(); pavolmarko@117: pavolmarko@117: virtual IIface *FindIface(void *ptr); pavolmarko@117: pavolmarko@117: bool operator==(void *ptr) pavolmarko@117: { pavolmarko@117: return m_Ptr == ptr; pavolmarko@117: } pavolmarko@117: }; pavolmarko@117: pavolmarko@117: class CHookManagerInfo : public IHookManagerInfo pavolmarko@41: { pavolmarko@117: public: pavolmarko@117: typedef List VfnPtrList; pavolmarko@117: typedef VfnPtrList::iterator VfnPtrListIter; pavolmarko@117: pavolmarko@117: Plugin m_Plug; pavolmarko@117: HookManagerPubFunc m_Func; pavolmarko@117: pavolmarko@117: int m_VtblOffs; pavolmarko@117: int m_VtblIdx; pavolmarko@117: const char *m_Proto; pavolmarko@117: void *m_HookfuncVfnptr; pavolmarko@117: pavolmarko@117: VfnPtrList m_VfnPtrs; pavolmarko@117: pavolmarko@117: public: pavolmarko@117: virtual ~CHookManagerInfo(); pavolmarko@117: pavolmarko@117: IVfnPtr *FindVfnPtr(void *vfnptr); pavolmarko@117: pavolmarko@117: void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto); pavolmarko@117: void SetHookfuncVfnptr(void *hookfunc_vfnptr); pavolmarko@117: }; pavolmarko@117: /** pavolmarko@117: * @brief A list of CHookManagerInfo classes pavolmarko@117: */ pavolmarko@117: typedef List HookManInfoList; pavolmarko@117: pavolmarko@117: class CCallClassImpl : public GenericCallClass pavolmarko@117: { pavolmarko@117: public: pavolmarko@117: pavolmarko@117: typedef SourceHook::CVector OrigFuncs; pavolmarko@117: typedef SourceHook::THash OrigVTables; pavolmarko@117: pavolmarko@117: void *m_Ptr; //!< Pointer to the actual object pavolmarko@117: size_t m_ObjSize; //!< Size of the instance pavolmarko@117: OrigVTables m_VT; //!< Info about vtables & functions pavolmarko@117: pavolmarko@117: int m_RefCounter; pavolmarko@117: pavolmarko@117: CCallClassImpl(void *ptr, size_t size); pavolmarko@117: virtual ~CCallClassImpl(); pavolmarko@117: pavolmarko@41: bool operator==(void *other) pavolmarko@41: { pavolmarko@117: return m_Ptr == other; pavolmarko@41: } pavolmarko@117: pavolmarko@117: void *GetThisPtr(); pavolmarko@117: void *GetOrigFunc(int vtbloffs, int vtblidx); pavolmarko@117: pavolmarko@117: void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry); pavolmarko@117: void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx); pavolmarko@41: }; pavolmarko@117: pavolmarko@1: /** pavolmarko@41: * @brief A list of CallClass structures pavolmarko@1: */ pavolmarko@117: typedef List Impl_CallClassList; pavolmarko@1: pavolmarko@1: Impl_CallClassList m_CallClasses; //!< A list of already generated callclasses pavolmarko@6: HookManInfoList m_HookMans; //!< A list of hook managers pavolmarko@1: pavolmarko@1: /** pavolmarko@6: * @brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index pavolmarko@1: */ pavolmarko@117: HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end, pavolmarko@41: const char *proto, int vtblofs, int vtblidx); pavolmarko@1: pavolmarko@117: void ApplyCallClassPatches(CCallClassImpl &cc); pavolmarko@58: void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry); pavolmarko@58: void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx); pavolmarko@1: pavolmarko@117: void SetPluginPaused(Plugin plug, bool paused); pavolmarko@117: 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@117: virtual ~CSourceHookImpl(); pavolmarko@1: pavolmarko@1: /** pavolmarko@58: * @brief Returns the interface version pavolmarko@58: */ pavolmarko@58: int GetIfaceVersion(); pavolmarko@58: pavolmarko@58: /** pavolmarko@58: * @brief Returns the implemnetation version pavolmarko@58: */ pavolmarko@58: int GetImplVersion(); pavolmarko@58: pavolmarko@58: /** pavolmarko@6: * @brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers pavolmarko@1: */ pavolmarko@1: void UnloadPlugin(Plugin plug); pavolmarko@1: pavolmarko@1: /** pavolmarko@6: * @brief Shut down the whole system, unregister all hook managers 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@6: * @param ifacesize The size of the class iface points to pavolmarko@6: * @param myHookMan A hook manager function that should be capable of handling the 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@41: bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, 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@41: * @param thisptr_offs This pointer adjuster pavolmarko@41: * @param myHookMan A hook manager function that should be capable of handling the function pavolmarko@41: * @param handler A pointer to a FastDelegate containing the hook handler pavolmarko@41: * @param post Set to true if you want a post handler pavolmarko@41: */ pavolmarko@41: bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post); pavolmarko@41: pavolmarko@41: /** pavolmarko@41: * @brief Removes a hook. pavolmarko@41: * pavolmarko@41: * @ return True if the function succeeded, false otherwise pavolmarko@41: * pavolmarko@41: * @param info A RemoveHookInfo structure, describing the hook pavolmarko@41: */ pavolmarko@41: bool RemoveHook(RemoveHookInfo info); pavolmarko@41: pavolmarko@41: /** pavolmarko@6: * @brief Checks whether a plugin has (a) hook manager(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@8: * @brief Pauses all hooks of a plugin pavolmarko@8: * pavolmarko@8: * @param plug The unique identifier of the plugin pavolmarko@8: */ pavolmarko@8: void PausePlugin(Plugin plug); pavolmarko@8: pavolmarko@8: /** pavolmarko@8: * @brief Unpauses all hooks of a plugin pavolmarko@8: * pavolmarko@8: * @param plug The unique identifier of the plugin pavolmarko@8: */ pavolmarko@8: void UnpausePlugin(Plugin plug); pavolmarko@8: pavolmarko@8: /** 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@58: * @param size Size of the class instance pavolmarko@1: */ pavolmarko@58: GenericCallClass *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@41: virtual void ReleaseCallClass(GenericCallClass *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@6: // For hook managers pavolmarko@58: virtual META_RES &GetCurResRef(); //!< Gets the reference to the current meta result pavolmarko@58: virtual META_RES &GetPrevResRef(); //!< Gets the reference to the previous meta result pavolmarko@58: virtual META_RES &GetStatusRef(); //!< Gets the reference to the status variable pavolmarko@58: virtual void* &GetIfacePtrRef(); //!< Gets the reference to the iface ptr 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: }; pavolmarko@1: } pavolmarko@1: dvander@34: #endif dvander@34: