508 lines
14 KiB
C++
508 lines
14 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#include <sal/config.h>
|
|
|
|
#include <boost/noncopyable.hpp>
|
|
#include <osl/mutex.hxx>
|
|
#include <cppuhelper/weakagg.hxx>
|
|
#include <cppuhelper/interfacecontainer.hxx>
|
|
#include <cppuhelper/exc_hlp.hxx>
|
|
|
|
using namespace osl;
|
|
using namespace com::sun::star::uno;
|
|
|
|
/** */ //for docpp
|
|
namespace cppu
|
|
{
|
|
|
|
// due to static Reflection destruction from usr, ther must be a mutex leak (#73272#)
|
|
inline static Mutex & getWeakMutex()
|
|
{
|
|
static Mutex * s_pMutex = 0;
|
|
if (! s_pMutex)
|
|
s_pMutex = new Mutex();
|
|
return *s_pMutex;
|
|
}
|
|
|
|
|
|
//-- OWeakConnectionPoint ----------------------------------------------------
|
|
|
|
class OWeakConnectionPoint: public XAdapter, private boost::noncopyable
|
|
{
|
|
public:
|
|
/**
|
|
Hold the weak object without an acquire (only the pointer).
|
|
*/
|
|
OWeakConnectionPoint( OWeakObject* pObj )
|
|
: m_aRefCount( 0 )
|
|
, m_pObject(pObj)
|
|
, m_aReferences( getWeakMutex() )
|
|
{}
|
|
|
|
// XInterface
|
|
Any SAL_CALL queryInterface( const Type & rType ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
void SAL_CALL acquire() throw() SAL_OVERRIDE;
|
|
void SAL_CALL release() throw() SAL_OVERRIDE;
|
|
|
|
// XAdapter
|
|
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL queryAdapted() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
void SAL_CALL addReference( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XReference >& xRef ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
void SAL_CALL removeReference( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XReference >& xRef ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
/// Called from the weak object if the reference count goes to zero.
|
|
void SAL_CALL dispose() throw(::com::sun::star::uno::RuntimeException);
|
|
|
|
private:
|
|
virtual ~OWeakConnectionPoint() {}
|
|
|
|
/// The reference counter.
|
|
oslInterlockedCount m_aRefCount;
|
|
/// The weak object
|
|
OWeakObject* m_pObject;
|
|
/// The container to hold the weak references
|
|
OInterfaceContainerHelper m_aReferences;
|
|
};
|
|
|
|
// XInterface
|
|
Any SAL_CALL OWeakConnectionPoint::queryInterface( const Type & rType )
|
|
throw(com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
return ::cppu::queryInterface(
|
|
rType, static_cast< XAdapter * >( this ), static_cast< XInterface * >( this ) );
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakConnectionPoint::acquire() throw()
|
|
{
|
|
osl_atomic_increment( &m_aRefCount );
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakConnectionPoint::release() throw()
|
|
{
|
|
if (! osl_atomic_decrement( &m_aRefCount ))
|
|
delete this;
|
|
}
|
|
|
|
void SAL_CALL OWeakConnectionPoint::dispose() throw(::com::sun::star::uno::RuntimeException)
|
|
{
|
|
Any ex;
|
|
OInterfaceIteratorHelper aIt( m_aReferences );
|
|
while( aIt.hasMoreElements() )
|
|
{
|
|
try
|
|
{
|
|
((XReference *)aIt.next())->dispose();
|
|
}
|
|
catch (com::sun::star::lang::DisposedException &) {}
|
|
catch (RuntimeException &)
|
|
{
|
|
ex = cppu::getCaughtException();
|
|
}
|
|
}
|
|
if (ex.hasValue())
|
|
{
|
|
cppu::throwException(ex);
|
|
}
|
|
}
|
|
|
|
// XInterface
|
|
Reference< XInterface > SAL_CALL OWeakConnectionPoint::queryAdapted() throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
Reference< XInterface > ret;
|
|
|
|
ClearableMutexGuard guard(getWeakMutex());
|
|
|
|
if (m_pObject)
|
|
{
|
|
oslInterlockedCount n = osl_atomic_increment( &m_pObject->m_refCount );
|
|
|
|
if (n > 1)
|
|
{
|
|
// The refence is incremented. The object cannot be destroyed.
|
|
// Release the guard at the earliest point.
|
|
guard.clear();
|
|
// WeakObject has a (XInterface *) cast operator
|
|
ret = *m_pObject;
|
|
n = osl_atomic_decrement( &m_pObject->m_refCount );
|
|
}
|
|
else
|
|
// Another thread wait in the dispose method at the guard
|
|
n = osl_atomic_decrement( &m_pObject->m_refCount );
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakConnectionPoint::addReference(const Reference< XReference >& rRef)
|
|
throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
m_aReferences.addInterface( (const Reference< XInterface > &)rRef );
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakConnectionPoint::removeReference(const Reference< XReference >& rRef)
|
|
throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
m_aReferences.removeInterface( (const Reference< XInterface > &)rRef );
|
|
}
|
|
|
|
|
|
|
|
//-- OWeakObject -------------------------------------------------------
|
|
|
|
|
|
#ifdef _MSC_VER
|
|
// Accidentally occurs in msvc mapfile = > had to be outlined.
|
|
OWeakObject::OWeakObject()
|
|
: m_refCount( 0 ),
|
|
m_pWeakConnectionPoint( 0 )
|
|
{
|
|
}
|
|
#endif
|
|
|
|
// XInterface
|
|
Any SAL_CALL OWeakObject::queryInterface( const Type & rType ) throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
return ::cppu::queryInterface(
|
|
rType,
|
|
static_cast< XWeak * >( this ), static_cast< XInterface * >( this ) );
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakObject::acquire() throw()
|
|
{
|
|
osl_atomic_increment( &m_refCount );
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakObject::release() throw()
|
|
{
|
|
if (osl_atomic_decrement( &m_refCount ) == 0) {
|
|
// notify/clear all weak-refs before object's dtor is executed
|
|
// (which may check weak-refs to this object):
|
|
disposeWeakConnectionPoint();
|
|
// destroy object:
|
|
delete this;
|
|
}
|
|
}
|
|
|
|
void OWeakObject::disposeWeakConnectionPoint()
|
|
{
|
|
OSL_PRECOND( m_refCount == 0, "OWeakObject::disposeWeakConnectionPoint: only to be called with a ref count of 0!" );
|
|
if (m_pWeakConnectionPoint != 0) {
|
|
OWeakConnectionPoint * const p = m_pWeakConnectionPoint;
|
|
m_pWeakConnectionPoint = 0;
|
|
try {
|
|
p->dispose();
|
|
}
|
|
catch (RuntimeException const& exc) {
|
|
OSL_FAIL(
|
|
OUStringToOString(
|
|
exc.Message, RTL_TEXTENCODING_ASCII_US ).getStr() );
|
|
static_cast<void>(exc);
|
|
}
|
|
p->release();
|
|
}
|
|
}
|
|
|
|
OWeakObject::~OWeakObject()
|
|
{
|
|
}
|
|
|
|
// XWeak
|
|
Reference< XAdapter > SAL_CALL OWeakObject::queryAdapter()
|
|
throw (::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
if (!m_pWeakConnectionPoint)
|
|
{
|
|
// only acquire mutex if member is not created
|
|
MutexGuard aGuard( getWeakMutex() );
|
|
if( !m_pWeakConnectionPoint )
|
|
{
|
|
OWeakConnectionPoint * p = new OWeakConnectionPoint(this);
|
|
p->acquire();
|
|
m_pWeakConnectionPoint = p;
|
|
}
|
|
}
|
|
|
|
return m_pWeakConnectionPoint;
|
|
}
|
|
|
|
|
|
//-- OWeakAggObject ----------------------------------------------------
|
|
|
|
OWeakAggObject::~OWeakAggObject()
|
|
{
|
|
}
|
|
|
|
// XInterface
|
|
void OWeakAggObject::acquire() throw()
|
|
{
|
|
Reference<XInterface > x( xDelegator );
|
|
if (x.is())
|
|
x->acquire();
|
|
else
|
|
OWeakObject::acquire();
|
|
}
|
|
|
|
// XInterface
|
|
void OWeakAggObject::release() throw()
|
|
{
|
|
Reference<XInterface > x( xDelegator );
|
|
if (x.is())
|
|
x->release();
|
|
else
|
|
OWeakObject::release();
|
|
}
|
|
|
|
// XInterface
|
|
Any OWeakAggObject::queryInterface( const Type & rType ) throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
Reference< XInterface > x( xDelegator ); // harden ref
|
|
return (x.is() ? x->queryInterface( rType ) : queryAggregation( rType ));
|
|
}
|
|
|
|
// XAggregation
|
|
Any OWeakAggObject::queryAggregation( const Type & rType ) throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
return ::cppu::queryInterface(
|
|
rType,
|
|
static_cast< XInterface * >( static_cast< OWeakObject * >( this ) ),
|
|
static_cast< XAggregation * >( this ),
|
|
static_cast< XWeak * >( this ) );
|
|
}
|
|
|
|
// XAggregation
|
|
void OWeakAggObject::setDelegator( const Reference<XInterface > & rDelegator ) throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
xDelegator = rDelegator;
|
|
}
|
|
|
|
}
|
|
|
|
/** */ //for docpp
|
|
namespace com
|
|
{
|
|
/** */ //for docpp
|
|
namespace sun
|
|
{
|
|
/** */ //for docpp
|
|
namespace star
|
|
{
|
|
/** */ //for docpp
|
|
namespace uno
|
|
{
|
|
|
|
|
|
|
|
//-- OWeakRefListener -----------------------------------------------------
|
|
|
|
class OWeakRefListener: public XReference, private boost::noncopyable
|
|
{
|
|
public:
|
|
OWeakRefListener(const Reference< XInterface >& xInt);
|
|
virtual ~OWeakRefListener();
|
|
|
|
// XInterface
|
|
Any SAL_CALL queryInterface( const Type & rType ) throw(RuntimeException, std::exception) SAL_OVERRIDE;
|
|
void SAL_CALL acquire() throw() SAL_OVERRIDE;
|
|
void SAL_CALL release() throw() SAL_OVERRIDE;
|
|
|
|
// XReference
|
|
void SAL_CALL dispose() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
/// The reference counter.
|
|
oslInterlockedCount m_aRefCount;
|
|
/// The connection point of the weak object
|
|
Reference< XAdapter > m_XWeakConnectionPoint;
|
|
};
|
|
|
|
OWeakRefListener::OWeakRefListener(const Reference< XInterface >& xInt)
|
|
: m_aRefCount( 1 )
|
|
{
|
|
try
|
|
{
|
|
Reference< XWeak > xWeak( Reference< XWeak >::query( xInt ) );
|
|
|
|
if (xWeak.is())
|
|
{
|
|
m_XWeakConnectionPoint = xWeak->queryAdapter();
|
|
|
|
if (m_XWeakConnectionPoint.is())
|
|
{
|
|
m_XWeakConnectionPoint->addReference((XReference*)this);
|
|
}
|
|
}
|
|
}
|
|
catch (RuntimeException &) { OSL_ASSERT( false ); } // assert here, but no unexpected()
|
|
osl_atomic_decrement( &m_aRefCount );
|
|
}
|
|
|
|
OWeakRefListener::~OWeakRefListener()
|
|
{
|
|
try
|
|
{
|
|
if (m_XWeakConnectionPoint.is())
|
|
{
|
|
acquire(); // dont die again
|
|
m_XWeakConnectionPoint->removeReference((XReference*)this);
|
|
}
|
|
}
|
|
catch (RuntimeException &) { OSL_ASSERT( false ); } // assert here, but no unexpected()
|
|
}
|
|
|
|
// XInterface
|
|
Any SAL_CALL OWeakRefListener::queryInterface( const Type & rType ) throw(RuntimeException, std::exception)
|
|
{
|
|
return ::cppu::queryInterface(
|
|
rType, static_cast< XReference * >( this ), static_cast< XInterface * >( this ) );
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakRefListener::acquire() throw()
|
|
{
|
|
osl_atomic_increment( &m_aRefCount );
|
|
}
|
|
|
|
// XInterface
|
|
void SAL_CALL OWeakRefListener::release() throw()
|
|
{
|
|
if( ! osl_atomic_decrement( &m_aRefCount ) )
|
|
delete this;
|
|
}
|
|
|
|
void SAL_CALL OWeakRefListener::dispose()
|
|
throw(::com::sun::star::uno::RuntimeException, std::exception)
|
|
{
|
|
Reference< XAdapter > xAdp;
|
|
{
|
|
MutexGuard guard(cppu::getWeakMutex());
|
|
if( m_XWeakConnectionPoint.is() )
|
|
{
|
|
xAdp = m_XWeakConnectionPoint;
|
|
m_XWeakConnectionPoint.clear();
|
|
}
|
|
}
|
|
|
|
if( xAdp.is() )
|
|
xAdp->removeReference((XReference*)this);
|
|
}
|
|
|
|
|
|
//-- WeakReferenceHelper ----------------------------------------------------------
|
|
|
|
WeakReferenceHelper::WeakReferenceHelper(const Reference< XInterface >& xInt)
|
|
: m_pImpl( 0 )
|
|
{
|
|
if (xInt.is())
|
|
{
|
|
m_pImpl = new OWeakRefListener(xInt);
|
|
m_pImpl->acquire();
|
|
}
|
|
}
|
|
|
|
WeakReferenceHelper::WeakReferenceHelper(const WeakReferenceHelper& rWeakRef)
|
|
: m_pImpl( 0 )
|
|
{
|
|
Reference< XInterface > xInt( rWeakRef.get() );
|
|
if (xInt.is())
|
|
{
|
|
m_pImpl = new OWeakRefListener(xInt);
|
|
m_pImpl->acquire();
|
|
}
|
|
}
|
|
|
|
void WeakReferenceHelper::clear()
|
|
{
|
|
try
|
|
{
|
|
if (m_pImpl)
|
|
{
|
|
if (m_pImpl->m_XWeakConnectionPoint.is())
|
|
{
|
|
m_pImpl->m_XWeakConnectionPoint->removeReference(
|
|
(XReference*)m_pImpl);
|
|
m_pImpl->m_XWeakConnectionPoint.clear();
|
|
}
|
|
m_pImpl->release();
|
|
m_pImpl = 0;
|
|
}
|
|
}
|
|
catch (RuntimeException &) { OSL_ASSERT( false ); } // assert here, but no unexpected()
|
|
}
|
|
|
|
WeakReferenceHelper& WeakReferenceHelper::operator=(const WeakReferenceHelper& rWeakRef)
|
|
{
|
|
if (this == &rWeakRef)
|
|
{
|
|
return *this;
|
|
}
|
|
Reference< XInterface > xInt( rWeakRef.get() );
|
|
return operator = ( xInt );
|
|
}
|
|
|
|
WeakReferenceHelper & SAL_CALL
|
|
WeakReferenceHelper::operator= (const Reference< XInterface > & xInt)
|
|
{
|
|
try
|
|
{
|
|
clear();
|
|
if (xInt.is())
|
|
{
|
|
m_pImpl = new OWeakRefListener(xInt);
|
|
m_pImpl->acquire();
|
|
}
|
|
}
|
|
catch (RuntimeException &) { OSL_ASSERT( false ); } // assert here, but no unexpected()
|
|
return *this;
|
|
}
|
|
|
|
WeakReferenceHelper::~WeakReferenceHelper()
|
|
{
|
|
clear();
|
|
}
|
|
|
|
Reference< XInterface > WeakReferenceHelper::get() const
|
|
{
|
|
try
|
|
{
|
|
Reference< XAdapter > xAdp;
|
|
{
|
|
MutexGuard guard(cppu::getWeakMutex());
|
|
if( m_pImpl && m_pImpl->m_XWeakConnectionPoint.is() )
|
|
xAdp = m_pImpl->m_XWeakConnectionPoint;
|
|
}
|
|
|
|
if (xAdp.is())
|
|
return xAdp->queryAdapted();
|
|
}
|
|
catch (RuntimeException &) { OSL_ASSERT( false ); } // assert here, but no unexpected()
|
|
|
|
return Reference< XInterface >();
|
|
}
|
|
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|