1.1 --- a/sourcehook/sourcehook.h Sat Oct 08 01:15:02 2005 +0000
1.2 +++ b/sourcehook/sourcehook.h Wed Oct 12 20:25:15 2005 +0000
1.3 @@ -20,10 +20,10 @@
1.4 // 1 - Initial revision
1.5 // 2 - Changed to virtual functions for iterators and all queries
1.6 // 3 - Added "hook loop status variable"
1.7 -// Future: Thread safe interface?
1.8 +// 4 - Reentrant
1.9
1.10 -#define SH_IFACE_VERSION 3
1.11 -#define SH_IMPL_VERSION 2
1.12 +#define SH_IFACE_VERSION 4
1.13 +#define SH_IMPL_VERSION 3
1.14
1.15 #ifndef SH_GLOB_SHPTR
1.16 #define SH_GLOB_SHPTR g_SHPtr
1.17 @@ -274,15 +274,6 @@
1.18 typedef CallClass<void> GenericCallClass;
1.19
1.20 /**
1.21 - * @brief SH informs the loop in the hook manager about its status through this
1.22 - */
1.23 - enum HookLoopStatus
1.24 - {
1.25 - HLS_Continue=0,
1.26 - HLS_Stop
1.27 - };
1.28 -
1.29 - /**
1.30 * @brief The main SourceHook interface
1.31 */
1.32 class ISourceHook
1.33 @@ -360,14 +351,15 @@
1.34 virtual void *GetIfacePtr() = 0; //!< Gets the interface pointer
1.35 //////////////////////////////////////////////////////////////////////////
1.36 // For hook managers
1.37 - virtual META_RES &GetCurResRef() = 0; //!< Gets the reference to the current meta result
1.38 - virtual META_RES &GetPrevResRef() = 0; //!< Gets the reference to the previous meta result
1.39 - virtual META_RES &GetStatusRef() = 0; //!< Gets the reference to the status variable
1.40 - virtual void* &GetIfacePtrRef() = 0; //!< Gets the reference to the interface this pointer
1.41 - virtual void SetOrigRet(const void *ptr) = 0; //!< Sets the original return pointer
1.42 - virtual void SetOverrideRet(const void *ptr) = 0; //!< Sets the override result pointer
1.43 - virtual HookLoopStatus &GetStatusVarRef(IIface *pIface) = 0; //!< gets the reference to the hook status loop variable
1.44 - virtual void HookLoopDone() = 0;
1.45 + virtual void HookLoopBegin(IIface *pIface) = 0; //!< Should be called when a hook loop begins
1.46 + virtual void HookLoopEnd() = 0; //!< Should be called when a hook loop exits
1.47 + virtual void SetCurResPtr(META_RES *mres) = 0; //!< Sets pointer to the current meta result
1.48 + virtual void SetPrevResPtr(META_RES *mres) = 0; //!< Sets pointer to previous meta result
1.49 + virtual void SetStatusPtr(META_RES *mres) = 0; //!< Sets pointer to the status variable
1.50 + virtual void SetIfacePtrPtr(void **pp) = 0; //!< Sets pointer to the interface this pointer
1.51 + virtual void SetOrigRetPtr(const void *ptr) = 0; //!< Sets the original return pointer
1.52 + virtual void SetOverrideRetPtr(const void *ptr) = 0; //!< Sets the override result pointer
1.53 + virtual bool ShouldContinue() = 0; //!< Returns false if the hook loop should exit
1.54 };
1.55 }
1.56
1.57 @@ -543,30 +535,31 @@
1.58 return (reinterpret_cast<EmptyClass*>(this)->*mfp)params; \
1.59 } \
1.60 /* 2) Declare some vars and set it up */ \
1.61 + SH_GLOB_SHPTR->HookLoopBegin(ifinfo); \
1.62 IHookList *prelist = ifinfo->GetPreHooks(); \
1.63 IHookList *postlist = ifinfo->GetPostHooks(); \
1.64 - HookLoopStatus &hls = SH_GLOB_SHPTR->GetStatusVarRef(ifinfo); \
1.65 - hls = HLS_Continue; \
1.66 + META_RES status = MRES_IGNORED; \
1.67 + META_RES prev_res; \
1.68 + META_RES cur_res; \
1.69 + SH_GLOB_SHPTR->SetStatusPtr(&status); \
1.70 + SH_GLOB_SHPTR->SetPrevResPtr(&prev_res); \
1.71 + SH_GLOB_SHPTR->SetCurResPtr(&cur_res); \
1.72 rettype orig_ret; \
1.73 rettype override_ret; \
1.74 rettype plugin_ret; \
1.75 - META_RES &cur_res = SH_GLOB_SHPTR->GetCurResRef(); \
1.76 - META_RES &prev_res = SH_GLOB_SHPTR->GetPrevResRef(); \
1.77 - META_RES &status = SH_GLOB_SHPTR->GetStatusRef(); \
1.78 - void* &ifptr = SH_GLOB_SHPTR->GetIfacePtrRef(); \
1.79 - status = MRES_IGNORED; \
1.80 - SH_GLOB_SHPTR->SetOrigRet(reinterpret_cast<void*>(&orig_ret)); \
1.81 - SH_GLOB_SHPTR->SetOverrideRet(NULL);
1.82 + void* ifptr; \
1.83 + SH_GLOB_SHPTR->SetIfacePtrPtr(&ifptr); \
1.84 + SH_GLOB_SHPTR->SetOrigRetPtr(reinterpret_cast<void*>(&orig_ret)); \
1.85 + SH_GLOB_SHPTR->SetOverrideRetPtr(NULL);
1.86
1.87 #define SH_CALL_HOOKS(post, params) \
1.88 - if (hls == HLS_Continue) \
1.89 + if (SH_GLOB_SHPTR->ShouldContinue()) \
1.90 { \
1.91 prev_res = MRES_IGNORED; \
1.92 for (AutoHookIter iter(post##list); !iter.End(); iter.Next()) \
1.93 { \
1.94 cur_res = MRES_IGNORED; \
1.95 ifptr = reinterpret_cast<void*>(reinterpret_cast<char*>(this) - iter.ThisPtrOffs()); \
1.96 - hls = HLS_Continue; \
1.97 plugin_ret = reinterpret_cast<CSHDelegate<FD>*>(iter.Handler())->GetDeleg() params; \
1.98 prev_res = cur_res; \
1.99 if (cur_res > status) \
1.100 @@ -574,9 +567,9 @@
1.101 if (cur_res >= MRES_OVERRIDE) \
1.102 { \
1.103 override_ret = plugin_ret; \
1.104 - SH_GLOB_SHPTR->SetOverrideRet(&override_ret); \
1.105 + SH_GLOB_SHPTR->SetOverrideRetPtr(&override_ret); \
1.106 } \
1.107 - if (hls == HLS_Stop) \
1.108 + if (!SH_GLOB_SHPTR->ShouldContinue()) \
1.109 { \
1.110 iter.SetToZero(); \
1.111 break; \
1.112 @@ -595,6 +588,7 @@
1.113 orig_ret = override_ret;
1.114
1.115 #define SH_RETURN() \
1.116 + SH_GLOB_SHPTR->HookLoopEnd(); \
1.117 return status >= MRES_OVERRIDE ? override_ret : orig_ret;
1.118
1.119 #define SH_HANDLEFUNC(ifacetype, ifacefunc, paramtypes, params, rettype) \
1.120 @@ -625,32 +619,33 @@
1.121 return; \
1.122 } \
1.123 /* 2) Declare some vars and set it up */ \
1.124 + SH_GLOB_SHPTR->HookLoopBegin(ifinfo); \
1.125 IHookList *prelist = ifinfo->GetPreHooks(); \
1.126 IHookList *postlist = ifinfo->GetPostHooks(); \
1.127 - META_RES &cur_res = SH_GLOB_SHPTR->GetCurResRef(); \
1.128 - HookLoopStatus &hls = SH_GLOB_SHPTR->GetStatusVarRef(ifinfo); \
1.129 - hls = HLS_Continue; \
1.130 - META_RES &prev_res = SH_GLOB_SHPTR->GetPrevResRef(); \
1.131 - META_RES &status = SH_GLOB_SHPTR->GetStatusRef(); \
1.132 - void* &ifptr = SH_GLOB_SHPTR->GetIfacePtrRef(); \
1.133 - status = MRES_IGNORED; \
1.134 - SH_GLOB_SHPTR->SetOverrideRet(NULL); \
1.135 - SH_GLOB_SHPTR->SetOrigRet(NULL);
1.136 + META_RES status = MRES_IGNORED; \
1.137 + META_RES prev_res; \
1.138 + META_RES cur_res; \
1.139 + SH_GLOB_SHPTR->SetStatusPtr(&status); \
1.140 + SH_GLOB_SHPTR->SetPrevResPtr(&prev_res); \
1.141 + SH_GLOB_SHPTR->SetCurResPtr(&cur_res); \
1.142 + void* ifptr; \
1.143 + SH_GLOB_SHPTR->SetIfacePtrPtr(&ifptr); \
1.144 + SH_GLOB_SHPTR->SetOverrideRetPtr(NULL); \
1.145 + SH_GLOB_SHPTR->SetOrigRetPtr(NULL);
1.146
1.147 #define SH_CALL_HOOKS_void(post, params) \
1.148 - if (hls == HLS_Continue) \
1.149 + if (SH_GLOB_SHPTR->ShouldContinue()) \
1.150 { \
1.151 prev_res = MRES_IGNORED; \
1.152 for (AutoHookIter iter(post##list); !iter.End(); iter.Next()) \
1.153 { \
1.154 cur_res = MRES_IGNORED; \
1.155 ifptr = reinterpret_cast<void*>(reinterpret_cast<char*>(this) - iter.ThisPtrOffs()); \
1.156 - hls = HLS_Continue; \
1.157 reinterpret_cast<CSHDelegate<FD>*>(iter.Handler())->GetDeleg() params; \
1.158 prev_res = cur_res; \
1.159 if (cur_res > status) \
1.160 status = cur_res; \
1.161 - if (hls == HLS_Stop) \
1.162 + if (!SH_GLOB_SHPTR->ShouldContinue()) \
1.163 { \
1.164 iter.SetToZero(); \
1.165 break; \
1.166 @@ -666,7 +661,8 @@
1.167 (reinterpret_cast<EmptyClass*>(this)->*mfp)params; \
1.168 }
1.169
1.170 -#define SH_RETURN_void()
1.171 +#define SH_RETURN_void() \
1.172 + SH_GLOB_SHPTR->HookLoopEnd();
1.173
1.174 #define SH_HANDLEFUNC_void(ifacetype, ifacefunc, paramtypes, params) \
1.175 SH_SETUPCALLS_void(paramtypes, params) \