nuclear@0: /************************************************************************************ nuclear@0: nuclear@0: Filename : OVR_Delegates.h nuclear@0: Content : C++ Delegates nuclear@0: Created : June 15, 2014 nuclear@0: Authors : Chris Taylor nuclear@0: nuclear@0: Copyright : Copyright 2014 Oculus VR, LLC All Rights reserved. nuclear@0: nuclear@0: Licensed under the Oculus VR Rift SDK License Version 3.2 (the "License"); nuclear@0: you may not use the Oculus VR Rift SDK except in compliance with the License, nuclear@0: which is provided at the time of installation or download, or which nuclear@0: otherwise accompanies this software in either electronic or hard copy form. nuclear@0: nuclear@0: You may obtain a copy of the License at nuclear@0: nuclear@0: http://www.oculusvr.com/licenses/LICENSE-3.2 nuclear@0: nuclear@0: Unless required by applicable law or agreed to in writing, the Oculus VR SDK nuclear@0: distributed under the License is distributed on an "AS IS" BASIS, nuclear@0: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. nuclear@0: See the License for the specific language governing permissions and nuclear@0: limitations under the License. nuclear@0: nuclear@0: ************************************************************************************/ nuclear@0: nuclear@0: /* nuclear@0: Based on The Impossibly Fast C++ Delegates by Sergey Ryazanov from nuclear@0: http://www.codeproject.com/KB/cpp/ImpossiblyFastCppDelegate.aspx (2005) nuclear@0: */ nuclear@0: nuclear@0: /* nuclear@0: Usage: nuclear@0: nuclear@0: Declare a delegate with a void (int) signature, also known as a nuclear@0: function that returns void and has one parameter that is an int: nuclear@0: typedef Delegate1 MyDelegate; nuclear@0: MyDelegate d; nuclear@0: nuclear@0: Point the delegate to a member function: nuclear@0: d.SetMember(&a); nuclear@0: d = MyDelegate::FromMember(&a); nuclear@0: nuclear@0: Point the delegate to a const member function: nuclear@0: d.SetConstMember(&c); nuclear@0: d = MyDelegate::FromConstMember(&c); nuclear@0: nuclear@0: Point the delegate to a free function: nuclear@0: d.SetFree<&FreeFunctionX>(); nuclear@0: d = MyDelegate::FromFree<&FreeFunctionX>(); nuclear@0: nuclear@0: Invoke the function via the delegate (works for all 3 cases): nuclear@0: d(1000); nuclear@0: nuclear@0: By default the delegates are uninitialized. nuclear@0: To clear an array of delegates quickly just zero the memory. nuclear@0: nuclear@0: This implementation is nicer than FastDelegates in my opinion nuclear@0: because it is simple and easy to read. It is a little slower nuclear@0: for virtual functions, but the size of the delegate is small, nuclear@0: and it will only get better as compilers improve. nuclear@0: */ nuclear@0: nuclear@0: #ifndef OVR_Delegates_h nuclear@0: #define OVR_Delegates_h nuclear@0: nuclear@0: #include "OVR_Types.h" nuclear@0: nuclear@0: namespace OVR { nuclear@0: nuclear@0: nuclear@0: template nuclear@0: class Delegate0 nuclear@0: { nuclear@0: typedef ret_type (*StubPointer)(void *); nuclear@0: typedef Delegate0 this_type; nuclear@0: nuclear@0: void *_object; nuclear@0: StubPointer _stub; nuclear@0: nuclear@0: OVR_FORCE_INLINE Delegate0(void *object, StubPointer stub) nuclear@0: { nuclear@0: _object = object; nuclear@0: _stub = stub; nuclear@0: } nuclear@0: nuclear@0: // Stubs nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type FreeStub(void * /*object*/) nuclear@0: { nuclear@0: return (F)(); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type MemberStub(void *object) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type ConstMemberStub(void *object) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(); nuclear@0: } nuclear@0: nuclear@0: public: nuclear@0: OVR_FORCE_INLINE Delegate0() : _object(0), _stub(0){} nuclear@0: nuclear@0: // Function invocation nuclear@0: nuclear@0: OVR_FORCE_INLINE ret_type operator()() const nuclear@0: { nuclear@0: return (*_stub)(_object); nuclear@0: } nuclear@0: nuclear@0: // Use stub pointer as a validity flag and equality checker nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator==(const this_type &rhs) const nuclear@0: { nuclear@0: return _object == rhs._object && _stub == rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!=(const this_type &rhs) const nuclear@0: { nuclear@0: return _object != rhs._object || _stub != rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool IsValid() const nuclear@0: { nuclear@0: return _stub != 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!() const nuclear@0: { nuclear@0: return _stub == 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE void Invalidate() nuclear@0: { nuclear@0: _stub = 0; nuclear@0: } nuclear@0: nuclear@0: // Delegate creation from a function nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromFree() nuclear@0: { nuclear@0: return this_type(0, &FreeStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromMember(T *object) nuclear@0: { nuclear@0: return this_type(object, &MemberStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromConstMember(T const *object) nuclear@0: { nuclear@0: return this_type(const_cast( object ), &ConstMemberStub); nuclear@0: } nuclear@0: nuclear@0: // In-place assignment to a different function nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetFree() nuclear@0: { nuclear@0: *this = FromFree(); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetMember(T *object) nuclear@0: { nuclear@0: *this = FromMember(object); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetConstMember(T const *object) nuclear@0: { nuclear@0: *this = FromConstMember(object); nuclear@0: } nuclear@0: }; nuclear@0: nuclear@0: nuclear@0: template nuclear@0: class Delegate1 nuclear@0: { nuclear@0: typedef ret_type (*StubPointer)(void *, arg1_type); nuclear@0: typedef Delegate1 this_type; nuclear@0: nuclear@0: void *_object; nuclear@0: StubPointer _stub; nuclear@0: nuclear@0: OVR_FORCE_INLINE Delegate1(void *object, StubPointer stub) nuclear@0: { nuclear@0: _object = object; nuclear@0: _stub = stub; nuclear@0: } nuclear@0: nuclear@0: // Stubs nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type FreeStub(void * /*object*/, arg1_type a1) nuclear@0: { nuclear@0: return (F)(a1); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type MemberStub(void *object, arg1_type a1) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(a1); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type ConstMemberStub(void *object, arg1_type a1) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(a1); nuclear@0: } nuclear@0: nuclear@0: public: nuclear@0: OVR_FORCE_INLINE Delegate1() : _object(0), _stub(0){} nuclear@0: nuclear@0: // Function invocation nuclear@0: nuclear@0: OVR_FORCE_INLINE ret_type operator()(arg1_type a1) const nuclear@0: { nuclear@0: return (*_stub)(_object, a1); nuclear@0: } nuclear@0: nuclear@0: // Use stub pointer as a validity flag and equality checker nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator==(const this_type &rhs) const nuclear@0: { nuclear@0: return _object == rhs._object && _stub == rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!=(const this_type &rhs) const nuclear@0: { nuclear@0: return _object != rhs._object || _stub != rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool IsValid() const nuclear@0: { nuclear@0: return _stub != 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!() const nuclear@0: { nuclear@0: return _stub == 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE void Invalidate() nuclear@0: { nuclear@0: _stub = 0; nuclear@0: } nuclear@0: nuclear@0: // Delegate creation from a function nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromFree() nuclear@0: { nuclear@0: return this_type(0, &FreeStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromMember(T *object) nuclear@0: { nuclear@0: return this_type(object, &MemberStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromConstMember(T const *object) nuclear@0: { nuclear@0: return this_type(const_cast( object ), &ConstMemberStub); nuclear@0: } nuclear@0: nuclear@0: // In-place assignment to a different function nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetFree() nuclear@0: { nuclear@0: *this = FromFree(); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetMember(T *object) nuclear@0: { nuclear@0: *this = FromMember(object); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetConstMember(T const *object) nuclear@0: { nuclear@0: *this = FromConstMember(object); nuclear@0: } nuclear@0: }; nuclear@0: nuclear@0: nuclear@0: template nuclear@0: class Delegate2 nuclear@0: { nuclear@0: typedef ret_type (*StubPointer)(void *, arg1_type, arg2_type); nuclear@0: typedef Delegate2 this_type; nuclear@0: nuclear@0: void *_object; nuclear@0: StubPointer _stub; nuclear@0: nuclear@0: OVR_FORCE_INLINE Delegate2(void *object, StubPointer stub) nuclear@0: { nuclear@0: _object = object; nuclear@0: _stub = stub; nuclear@0: } nuclear@0: nuclear@0: // Stubs nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type FreeStub(void * /*object*/, arg1_type a1, arg2_type a2) nuclear@0: { nuclear@0: return (F)(a1, a2); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type MemberStub(void *object, arg1_type a1, arg2_type a2) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(a1, a2); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type ConstMemberStub(void *object, arg1_type a1, arg2_type a2) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(a1, a2); nuclear@0: } nuclear@0: nuclear@0: public: nuclear@0: OVR_FORCE_INLINE Delegate2() : _object(0), _stub(0){} nuclear@0: nuclear@0: // Function invocation nuclear@0: nuclear@0: OVR_FORCE_INLINE ret_type operator()(arg1_type a1, arg2_type a2) const nuclear@0: { nuclear@0: return (*_stub)(_object, a1, a2); nuclear@0: } nuclear@0: nuclear@0: // Use stub pointer as a validity flag and equality checker nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator==(const this_type &rhs) const nuclear@0: { nuclear@0: return _object == rhs._object && _stub == rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!=(const this_type &rhs) const nuclear@0: { nuclear@0: return _object != rhs._object || _stub != rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool IsValid() const nuclear@0: { nuclear@0: return _stub != 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!() const nuclear@0: { nuclear@0: return _stub == 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE void Invalidate() nuclear@0: { nuclear@0: _stub = 0; nuclear@0: } nuclear@0: nuclear@0: // Delegate creation from a function nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromFree() nuclear@0: { nuclear@0: return this_type(0, &FreeStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromMember(T *object) nuclear@0: { nuclear@0: return this_type(object, &MemberStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromConstMember(T const *object) nuclear@0: { nuclear@0: return this_type(const_cast( object ), &ConstMemberStub); nuclear@0: } nuclear@0: nuclear@0: // In-place assignment to a different function nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetFree() nuclear@0: { nuclear@0: *this = FromFree(); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetMember(T *object) nuclear@0: { nuclear@0: *this = FromMember(object); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetConstMember(T const *object) nuclear@0: { nuclear@0: *this = FromConstMember(object); nuclear@0: } nuclear@0: }; nuclear@0: nuclear@0: nuclear@0: template nuclear@0: class Delegate3 nuclear@0: { nuclear@0: typedef ret_type (*StubPointer)(void *, arg1_type, arg2_type, arg3_type); nuclear@0: typedef Delegate3 this_type; nuclear@0: nuclear@0: void *_object; nuclear@0: StubPointer _stub; nuclear@0: nuclear@0: OVR_FORCE_INLINE Delegate3(void *object, StubPointer stub) nuclear@0: { nuclear@0: _object = object; nuclear@0: _stub = stub; nuclear@0: } nuclear@0: nuclear@0: // Stubs nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type FreeStub(void * /*object*/, arg1_type a1, arg2_type a2, arg3_type a3) nuclear@0: { nuclear@0: return (F)(a1, a2, a3); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type MemberStub(void *object, arg1_type a1, arg2_type a2, arg3_type a3) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(a1, a2, a3); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE ret_type ConstMemberStub(void *object, arg1_type a1, arg2_type a2, arg3_type a3) nuclear@0: { nuclear@0: T *p = static_cast(object); nuclear@0: return (p->*F)(a1, a2, a3); nuclear@0: } nuclear@0: nuclear@0: public: nuclear@0: OVR_FORCE_INLINE Delegate3() : _object(0), _stub(0){} nuclear@0: nuclear@0: // Function invocation nuclear@0: nuclear@0: OVR_FORCE_INLINE ret_type operator()(arg1_type a1, arg2_type a2, arg3_type a3) const nuclear@0: { nuclear@0: return (*_stub)(_object, a1, a2, a3); nuclear@0: } nuclear@0: nuclear@0: // Use stub pointer as a validity flag and equality checker nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator==(const this_type &rhs) const nuclear@0: { nuclear@0: return _object == rhs._object && _stub == rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!=(const this_type &rhs) const nuclear@0: { nuclear@0: return _object != rhs._object || _stub != rhs._stub; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool IsValid() const nuclear@0: { nuclear@0: return _stub != 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE bool operator!() const nuclear@0: { nuclear@0: return _stub == 0; nuclear@0: } nuclear@0: nuclear@0: OVR_FORCE_INLINE void Invalidate() nuclear@0: { nuclear@0: _stub = 0; nuclear@0: } nuclear@0: nuclear@0: // Delegate creation from a function nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromFree() nuclear@0: { nuclear@0: return this_type(0, &FreeStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromMember(T *object) nuclear@0: { nuclear@0: return this_type(object, &MemberStub); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: static OVR_FORCE_INLINE this_type FromConstMember(T const *object) nuclear@0: { nuclear@0: return this_type(const_cast( object ), &ConstMemberStub); nuclear@0: } nuclear@0: nuclear@0: // In-place assignment to a different function nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetFree() nuclear@0: { nuclear@0: *this = FromFree(); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetMember(T *object) nuclear@0: { nuclear@0: *this = FromMember(object); nuclear@0: } nuclear@0: nuclear@0: template nuclear@0: OVR_FORCE_INLINE void SetConstMember(T const *object) nuclear@0: { nuclear@0: *this = FromConstMember(object); nuclear@0: } nuclear@0: }; nuclear@0: nuclear@0: // Add more here if needed, but keep in mind that a short, simple interface nuclear@0: // is rewarded by making the delegates faster... nuclear@0: nuclear@0: nuclear@0: } // namespace OVR nuclear@0: nuclear@0: #endif // OVR_Delegates_h