From: Zhiyi Zhang zzhang@codeweavers.com
This also fix a double free in uisettings_Release(). --- dlls/windows.ui/private.h | 127 ++++++++++++++++++++++++++++++ dlls/windows.ui/uisettings.c | 148 ++++++----------------------------- 2 files changed, 150 insertions(+), 125 deletions(-)
diff --git a/dlls/windows.ui/private.h b/dlls/windows.ui/private.h index 6e611e5d5d3..06d6f5e19b1 100644 --- a/dlls/windows.ui/private.h +++ b/dlls/windows.ui/private.h @@ -28,6 +28,7 @@ #include "winstring.h"
#include "activation.h" +#include "weakreference.h"
#define WIDL_using_Windows_Foundation #include "windows.foundation.h" @@ -78,4 +79,130 @@ extern IActivationFactory *inputpane_factory; #define DEFINE_IINSPECTABLE( pfx, iface_type, impl_type, base_iface ) \ DEFINE_IINSPECTABLE_( pfx, iface_type, impl_type, impl_from_##iface_type, iface_type##_iface, &impl->base_iface )
+/* WeakReference helper + * + * How to add IWeakReferenceSource and IWeakReference support to an existing COM object: + * 1. Add DEFINE_WEAKREF(pfx, iface_type, struct impl_type); + * 2. Add "IWeakReferenceSource IWeakReferenceSource_iface;" and "struct weakref *weakref;" to the + * object struct definition. + * 3. Support IID_IWeakReferenceSource in object_QueryInterface(). + * 4. Replace ALL object->refcount usage with object->weakref->ref_strong. + * 5. Allocate a struct weakref in the object initialisation function and add the following + * ``` + * object->IWeakReferenceSource_iface.lpVtbl = &pfx##_weakref_source_vtbl; + * weakref->IWeakReference_iface.lpVtbl = &pfx##_weakref_vtbl; + * weakref->ref_strong = 1; + * weakref->ref_weak = 1; + * weakref->object = (IUnknown *)&object->iface_type##_iface; + * object->weakref = weakref; + * ``` + * 6. Call "IWeakReference_Release( &impl->weakref->IWeakReference_iface );" in object_Release() + * when object->weakref->ref_strong reaches zero. + */ + +/* The control block is contained in struct weakref so that we don't have to allocate a separate + * struct for it */ +struct weakref +{ + IWeakReference IWeakReference_iface; + IUnknown *object; + /* control block */ + LONG ref_strong; + LONG ref_weak; +}; + +#define DEFINE_WEAKREF(pfx, iface_type, impl_type) \ +static inline struct weakref *pfx##_impl_from_IWeakReference(IWeakReference *iface) \ +{ \ + return CONTAINING_RECORD(iface, struct weakref, IWeakReference_iface); \ +} \ +static HRESULT WINAPI pfx##_weakref_QueryInterface(IWeakReference *iface, REFIID iid, void **out) \ +{ \ + struct weakref *impl = pfx##_impl_from_IWeakReference(iface); \ + TRACE("iface %p, iid %s, out %p.\n", iface, debugstr_guid(iid), out); \ + if (IsEqualGUID(iid, &IID_IUnknown) || IsEqualGUID(iid, &IID_IWeakReference)) \ + { \ + *out = &impl->IWeakReference_iface; \ + IWeakReference_AddRef(*out); \ + return S_OK; \ + } \ + FIXME("%s not implemented, returning E_NOINTERFACE.\n", debugstr_guid(iid)); \ + *out = NULL; \ + return E_NOINTERFACE; \ +} \ +static ULONG WINAPI pfx##_weakref_AddRef(IWeakReference *iface) \ +{ \ + struct weakref *impl = pfx##_impl_from_IWeakReference(iface); \ + ULONG ref = InterlockedIncrement(&impl->ref_weak); \ + TRACE("iface %p increasing refcount to %lu.\n", iface, ref); \ + return ref; \ +} \ +static ULONG WINAPI pfx##_weakref_Release(IWeakReference *iface) \ +{ \ + struct weakref *impl = pfx##_impl_from_IWeakReference(iface); \ + ULONG ref = InterlockedDecrement(&impl->ref_weak); \ + TRACE("iface %p, ref %lu.\n", iface, ref); \ + if (!ref) free(impl); \ + return ref; \ +} \ +static HRESULT WINAPI pfx##_weakref_Resolve(IWeakReference *iface, REFIID iid, IInspectable **out) \ +{ \ + struct weakref *impl = pfx##_impl_from_IWeakReference(iface); \ + HRESULT hr; \ + LONG ref; \ + TRACE("iface %p, iid %s, out %p.\n", iface, debugstr_guid(iid), out); \ + *out = NULL; \ + do \ + { \ + if (!(ref = ReadNoFence(&impl->ref_strong))) \ + return S_OK; \ + } while (ref != InterlockedCompareExchange(&impl->ref_strong, ref + 1, ref)); \ + hr = IUnknown_QueryInterface(impl->object, iid, (void **)out); \ + InterlockedDecrement(&impl->ref_strong); \ + return hr; \ +} \ +static const struct IWeakReferenceVtbl pfx##_weakref_vtbl = \ +{ \ + pfx##_weakref_QueryInterface, \ + pfx##_weakref_AddRef, \ + pfx##_weakref_Release, \ + pfx##_weakref_Resolve, \ +}; \ +static inline impl_type *pfx##_impl_from_IWeakReferenceSource(IWeakReferenceSource *iface) \ +{ \ + return CONTAINING_RECORD(iface, impl_type, IWeakReferenceSource_iface); \ +} \ +static HRESULT WINAPI pfx##_weakref_source_QueryInterface(IWeakReferenceSource *iface, \ + REFIID iid, void **out) \ +{ \ + impl_type *impl = pfx##_impl_from_IWeakReferenceSource(iface); \ + return pfx##_QueryInterface(&impl->iface_type##_iface, iid, out); \ +} \ +static ULONG WINAPI pfx##_weakref_source_AddRef(IWeakReferenceSource *iface) \ +{ \ + impl_type *impl = pfx##_impl_from_IWeakReferenceSource(iface); \ + return pfx##_AddRef(&impl->iface_type##_iface); \ +} \ +static ULONG WINAPI pfx##_weakref_source_Release(IWeakReferenceSource *iface) \ +{ \ + impl_type *impl = pfx##_impl_from_IWeakReferenceSource(iface); \ + return pfx##_Release(&impl->iface_type##_iface); \ +} \ +static HRESULT WINAPI pfx##_weakref_source_GetWeakReference(IWeakReferenceSource *iface, \ + IWeakReference **ref) \ +{ \ + impl_type *impl = pfx##_impl_from_IWeakReferenceSource(iface); \ + TRACE("iface %p, ref %p stub.\n", iface, ref); \ + *ref = &impl->weakref->IWeakReference_iface; \ + IWeakReference_AddRef(*ref); \ + return S_OK; \ +} \ +static const struct IWeakReferenceSourceVtbl pfx##_weakref_source_vtbl = \ +{ \ + pfx##_weakref_source_QueryInterface, \ + pfx##_weakref_source_AddRef, \ + pfx##_weakref_source_Release, \ + pfx##_weakref_source_GetWeakReference, \ +}; + #endif diff --git a/dlls/windows.ui/uisettings.c b/dlls/windows.ui/uisettings.c index d5eae44b797..720e5add4cf 100644 --- a/dlls/windows.ui/uisettings.c +++ b/dlls/windows.ui/uisettings.c @@ -35,9 +35,7 @@ struct uisettings IUISettings4 IUISettings4_iface; IUISettings5 IUISettings5_iface; IWeakReferenceSource IWeakReferenceSource_iface; - IWeakReference IWeakReference_iface; - LONG ref_strong; - LONG ref_weak; + struct weakref *weakref; };
static inline struct uisettings *impl_from_IUISettings( IUISettings *iface ) @@ -94,21 +92,23 @@ static HRESULT WINAPI uisettings_QueryInterface( IUISettings *iface, REFIID iid, static ULONG WINAPI uisettings_AddRef( IUISettings *iface ) { struct uisettings *impl = impl_from_IUISettings( iface ); - ULONG ref = InterlockedIncrement( &impl->ref_strong ); + ULONG ref = InterlockedIncrement( &impl->weakref->ref_strong ); TRACE( "iface %p, ref %lu.\n", iface, ref ); - IWeakReference_AddRef( &impl->IWeakReference_iface ); return ref; }
static ULONG WINAPI uisettings_Release( IUISettings *iface ) { struct uisettings *impl = impl_from_IUISettings( iface ); - ULONG ref = InterlockedDecrement( &impl->ref_strong ); + ULONG ref = InterlockedDecrement( &impl->weakref->ref_strong );
TRACE( "iface %p, ref %lu.\n", iface, ref );
- IWeakReference_Release( &impl->IWeakReference_iface ); - if (!ref) free( impl ); + if (!ref) + { + IWeakReference_Release( &impl->weakref->IWeakReference_iface ); + free( impl ); + } return ref; }
@@ -480,119 +480,7 @@ static const struct IUISettings5Vtbl uisettings5_vtbl = uisettings5_remove_AutoHideScrollBarsChanged, };
-static inline struct uisettings *impl_from_IWeakReference( IWeakReference *iface ) -{ - return CONTAINING_RECORD( iface, struct uisettings, IWeakReference_iface ); -} - -static HRESULT WINAPI weak_reference_QueryInterface( IWeakReference *iface, REFIID iid, void **out ) -{ - struct uisettings *impl = impl_from_IWeakReference( iface ); - - TRACE( "iface %p, iid %s, out %p.\n", iface, debugstr_guid(iid), out ); - - if (IsEqualGUID( iid, &IID_IUnknown ) || - IsEqualGUID( iid, &IID_IWeakReference )) - { - *out = &impl->IWeakReference_iface; - IInspectable_AddRef( *out ); - return S_OK; - } - - FIXME( "%s not implemented, returning E_NOINTERFACE.\n", debugstr_guid(iid) ); - *out = NULL; - return E_NOINTERFACE; -} - -static ULONG WINAPI weak_reference_AddRef( IWeakReference *iface ) -{ - struct uisettings *impl = impl_from_IWeakReference( iface ); - ULONG ref = InterlockedIncrement( &impl->ref_weak ); - TRACE("iface %p increasing refcount to %lu.\n", iface, ref); - return ref; -} - -static ULONG WINAPI weak_reference_Release( IWeakReference *iface ) -{ - struct uisettings *impl = impl_from_IWeakReference( iface ); - ULONG ref = InterlockedDecrement( &impl->ref_weak ); - if (!ref) - free( impl ); - return ref; -} - -static HRESULT WINAPI weak_reference_Resolve( IWeakReference *iface, REFIID iid, IInspectable **out ) -{ - struct uisettings *impl = impl_from_IWeakReference( iface ); - HRESULT hr; - LONG ref; - - TRACE( "iface %p, iid %s, out %p stub.\n", iface, debugstr_guid(iid), out ); - - *out = NULL; - - do - { - if (!(ref = ReadNoFence( &impl->ref_strong ))) - return S_OK; - } while (ref != InterlockedCompareExchange( &impl->ref_strong, ref + 1, ref )); - - hr = IUISettings_QueryInterface( &impl->IUISettings_iface, iid, (void **)out ); - InterlockedDecrement( &impl->ref_strong ); - return hr; -} - -static const struct IWeakReferenceVtbl weak_reference_vtbl = -{ - weak_reference_QueryInterface, - weak_reference_AddRef, - weak_reference_Release, - /* IWeakReference methods */ - weak_reference_Resolve, -}; - -static inline struct uisettings *impl_from_IWeakReferenceSource( IWeakReferenceSource *iface ) -{ - return CONTAINING_RECORD( iface, struct uisettings, IWeakReferenceSource_iface ); -} - -static HRESULT WINAPI weak_reference_source_QueryInterface( IWeakReferenceSource *iface, REFIID iid, void **out ) -{ - struct uisettings *impl = impl_from_IWeakReferenceSource( iface ); - return uisettings_QueryInterface( &impl->IUISettings_iface, iid, out ); -} - -static ULONG WINAPI weak_reference_source_AddRef( IWeakReferenceSource *iface ) -{ - struct uisettings *impl = impl_from_IWeakReferenceSource( iface ); - return uisettings_AddRef( &impl->IUISettings_iface ); -} - -static ULONG WINAPI weak_reference_source_Release( IWeakReferenceSource *iface ) -{ - struct uisettings *impl = impl_from_IWeakReferenceSource( iface ); - return uisettings_Release( &impl->IUISettings_iface ); -} - -static HRESULT WINAPI weak_reference_source_GetWeakReference( IWeakReferenceSource *iface, IWeakReference **ref ) -{ - struct uisettings *impl = impl_from_IWeakReferenceSource(iface); - - TRACE("iface %p, ref %p stub.\n", iface, ref); - - *ref = &impl->IWeakReference_iface; - IWeakReference_AddRef( *ref ); - return S_OK; -} - -static const struct IWeakReferenceSourceVtbl weak_reference_source_vtbl = -{ - weak_reference_source_QueryInterface, - weak_reference_source_AddRef, - weak_reference_source_Release, - /* IWeakReferenceSource methods */ - weak_reference_source_GetWeakReference, -}; +DEFINE_WEAKREF(uisettings, IUISettings, struct uisettings);
struct uisettings_statics { @@ -662,6 +550,7 @@ static HRESULT WINAPI factory_GetTrustLevel( IActivationFactory *iface, TrustLev static HRESULT WINAPI factory_ActivateInstance( IActivationFactory *iface, IInspectable **instance ) { struct uisettings *impl; + struct weakref *weakref;
TRACE( "iface %p, instance %p.\n", iface, instance );
@@ -671,15 +560,24 @@ static HRESULT WINAPI factory_ActivateInstance( IActivationFactory *iface, IInsp return E_OUTOFMEMORY; }
+ if (!(weakref = calloc( 1, sizeof(*weakref) ))) + { + *instance = NULL; + free( impl ); + return E_OUTOFMEMORY; + } + impl->IUISettings_iface.lpVtbl = &uisettings_vtbl; impl->IUISettings2_iface.lpVtbl = &uisettings2_vtbl; impl->IUISettings3_iface.lpVtbl = &uisettings3_vtbl; impl->IUISettings4_iface.lpVtbl = &uisettings4_vtbl; impl->IUISettings5_iface.lpVtbl = &uisettings5_vtbl; - impl->IWeakReferenceSource_iface.lpVtbl = &weak_reference_source_vtbl; - impl->IWeakReference_iface.lpVtbl = &weak_reference_vtbl; - impl->ref_strong = 1; - impl->ref_weak = 1; + impl->IWeakReferenceSource_iface.lpVtbl = &uisettings_weakref_source_vtbl; + weakref->IWeakReference_iface.lpVtbl = &uisettings_weakref_vtbl; + weakref->ref_strong = 1; + weakref->ref_weak = 1; + weakref->object = (IUnknown *)&impl->IUISettings5_iface; + impl->weakref = weakref;
*instance = (IInspectable *)&impl->IUISettings5_iface; return S_OK;