Files
libreoffice/include/comphelper/compbase.hxx
Noel Grandin c68c744b68 pass unique_lock as param in WeakComponentImplHelperBase::disposing
so that subclasses can drop the lock while calling listeners

Change-Id: I6105438110af08f10b0ed50057b28172c3442b95
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/127434
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2021-12-25 13:56:27 +01:00

111 lines
4.0 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* 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/.
*/
#pragma once
#include <sal/config.h>
#include <comphelper/comphelperdllapi.h>
#include <comphelper/interfacecontainer4.hxx>
#include <cppuhelper/weak.hxx>
#include <cppuhelper/queryinterface.hxx>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <mutex>
namespace comphelper
{
/**
Serves two purposes
(1) extracts code that doesn't need to be templated
(2) helps to handle the custom where we have conflicting interfaces
e.g. multiple UNO interfaces that extend css::lang::XComponent
*/
class COMPHELPER_DLLPUBLIC WeakComponentImplHelperBase : public cppu::OWeakObject,
public css::lang::XComponent
{
public:
WeakComponentImplHelperBase();
virtual ~WeakComponentImplHelperBase() override;
// css::lang::XComponent
virtual void SAL_CALL dispose() override;
virtual void SAL_CALL
addEventListener(css::uno::Reference<css::lang::XEventListener> const& rxListener) override;
virtual void SAL_CALL
removeEventListener(css::uno::Reference<css::lang::XEventListener> const& rxListener) override;
/**
Called by dispose for subclasses to do dispose() work.
The mutex is held when called, and subclasses can unlock() the guard if necessary.
*/
virtual void disposing(std::unique_lock<std::mutex>&);
protected:
comphelper::OInterfaceContainerHelper4<css::lang::XEventListener> maEventListeners;
mutable std::mutex m_aMutex;
bool m_bDisposed = false;
};
template <typename... Ifc>
class SAL_DLLPUBLIC_TEMPLATE WeakComponentImplHelper : public WeakComponentImplHelperBase,
public css::lang::XTypeProvider,
public Ifc...
{
public:
virtual void SAL_CALL acquire() noexcept final override { OWeakObject::acquire(); }
virtual void SAL_CALL release() noexcept final override { OWeakObject::release(); }
// css::lang::XComponent
virtual void SAL_CALL dispose() noexcept final override
{
WeakComponentImplHelperBase::dispose();
}
virtual void SAL_CALL addEventListener(
css::uno::Reference<css::lang::XEventListener> const& rxListener) final override
{
WeakComponentImplHelperBase::addEventListener(rxListener);
}
virtual void SAL_CALL removeEventListener(
css::uno::Reference<css::lang::XEventListener> const& rxListener) final override
{
WeakComponentImplHelperBase::removeEventListener(rxListener);
}
virtual css::uno::Any SAL_CALL queryInterface(css::uno::Type const& rType) override
{
css::uno::Any aReturn = ::cppu::queryInterface(
rType, static_cast<css::uno::XWeak*>(this),
static_cast<css::lang::XComponent*>(static_cast<WeakComponentImplHelperBase*>(this)),
static_cast<css::lang::XTypeProvider*>(this), static_cast<Ifc*>(this)...);
if (aReturn.hasValue())
return aReturn;
return OWeakObject::queryInterface(rType);
}
// css::lang::XTypeProvider
virtual css::uno::Sequence<css::uno::Type> SAL_CALL getTypes() override
{
static const css::uno::Sequence<css::uno::Type> aTypeList{
cppu::UnoType<css::uno::XWeak>::get(), cppu::UnoType<css::lang::XComponent>::get(),
cppu::UnoType<css::lang::XTypeProvider>::get(), cppu::UnoType<Ifc>::get()...
};
return aTypeList;
}
virtual css::uno::Sequence<sal_Int8> SAL_CALL getImplementationId() override
{
return css::uno::Sequence<sal_Int8>();
}
};
} // namespace comphelper
/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */