1
0
Fork 0
libreoffice/comphelper/source/container/interfacecontainer2.cxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

420 lines
12 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 <comphelper/interfacecontainer2.hxx>
#include <comphelper/multicontainer2.hxx>
#include <o3tl/safeint.hxx>
#include <osl/diagnose.h>
#include <osl/mutex.hxx>
#include <memory>
#include <com/sun/star/lang/XEventListener.hpp>
using namespace osl;
using namespace com::sun::star::uno;
using namespace com::sun::star::lang;
namespace comphelper
{
OInterfaceIteratorHelper2::OInterfaceIteratorHelper2( OInterfaceContainerHelper2 & rCont_ )
: rCont( rCont_ )
{
MutexGuard aGuard( rCont.rMutex );
if( rCont.bInUse )
// worst case, two iterators at the same time
rCont.copyAndResetInUse();
bIsList = rCont_.bIsList;
aData = rCont_.aData;
if( bIsList )
{
rCont.bInUse = true;
nRemain = aData.pAsVector->size();
}
else if( aData.pAsInterface )
{
aData.pAsInterface->acquire();
nRemain = 1;
}
else
nRemain = 0;
}
OInterfaceIteratorHelper2::~OInterfaceIteratorHelper2()
{
bool bShared;
{
MutexGuard aGuard( rCont.rMutex );
// bResetInUse protect the iterator against recursion
bShared = aData.pAsVector == rCont.aData.pAsVector && rCont.bIsList;
if( bShared )
{
OSL_ENSURE( rCont.bInUse, "OInterfaceContainerHelper2 must be in use" );
rCont.bInUse = false;
}
}
if( !bShared )
{
if( bIsList )
// Sequence owned by the iterator
delete aData.pAsVector;
else if( aData.pAsInterface )
// Interface is acquired by the iterator
aData.pAsInterface->release();
}
}
XInterface * OInterfaceIteratorHelper2::next()
{
if( nRemain )
{
nRemain--;
if( bIsList )
return (*aData.pAsVector)[nRemain].get();
else if( aData.pAsInterface )
return aData.pAsInterface;
}
// exception
return nullptr;
}
void OInterfaceIteratorHelper2::remove()
{
if( bIsList )
{
OSL_ASSERT( nRemain >= 0 &&
o3tl::make_unsigned(nRemain) < aData.pAsVector->size() );
rCont.removeInterface( (*aData.pAsVector)[nRemain] );
}
else
{
OSL_ASSERT( 0 == nRemain );
rCont.removeInterface( aData.pAsInterface );
}
}
OInterfaceContainerHelper2::OInterfaceContainerHelper2( Mutex & rMutex_ )
: rMutex( rMutex_ )
, bInUse( false )
, bIsList( false )
{
}
OInterfaceContainerHelper2::~OInterfaceContainerHelper2()
{
OSL_ENSURE( !bInUse, "~OInterfaceContainerHelper2 but is in use" );
if( bIsList )
delete aData.pAsVector;
else if( aData.pAsInterface )
aData.pAsInterface->release();
}
sal_Int32 OInterfaceContainerHelper2::getLength() const
{
MutexGuard aGuard( rMutex );
if( bIsList )
return aData.pAsVector->size();
else if( aData.pAsInterface )
return 1;
return 0;
}
std::vector< Reference<XInterface> > OInterfaceContainerHelper2::getElements() const
{
std::vector< Reference<XInterface> > rVec;
MutexGuard aGuard( rMutex );
if( bIsList )
rVec = *aData.pAsVector;
else if( aData.pAsInterface )
{
rVec.emplace_back( aData.pAsInterface );
}
return rVec;
}
void OInterfaceContainerHelper2::copyAndResetInUse()
{
OSL_ENSURE( bInUse, "OInterfaceContainerHelper2 not in use" );
if( bInUse )
{
// this should be the worst case. If an iterator is active
// and a new Listener is added.
if( bIsList )
aData.pAsVector = new std::vector< Reference< XInterface > >( *aData.pAsVector );
else if( aData.pAsInterface )
aData.pAsInterface->acquire();
bInUse = false;
}
}
sal_Int32 OInterfaceContainerHelper2::addInterface( const Reference<XInterface> & rListener )
{
OSL_ASSERT( rListener.is() );
if ( !rListener.is() )
return 0;
MutexGuard aGuard( rMutex );
if( bInUse )
copyAndResetInUse();
if( bIsList )
{
aData.pAsVector->push_back( rListener );
return aData.pAsVector->size();
}
else if( aData.pAsInterface )
{
std::vector< Reference< XInterface > > * pVec = new std::vector< Reference< XInterface > >( 2 );
(*pVec)[0] = aData.pAsInterface;
(*pVec)[1] = rListener;
aData.pAsInterface->release();
aData.pAsVector = pVec;
bIsList = true;
return 2;
}
else
{
aData.pAsInterface = rListener.get();
if( rListener.is() )
rListener->acquire();
return 1;
}
}
sal_Int32 OInterfaceContainerHelper2::removeInterface( const Reference<XInterface> & rListener )
{
OSL_ASSERT( rListener.is() );
MutexGuard aGuard( rMutex );
if( bInUse )
copyAndResetInUse();
if( bIsList )
{
// It is not valid to compare the pointer directly, but it's faster.
auto it = std::find_if(aData.pAsVector->begin(), aData.pAsVector->end(),
[&rListener](const css::uno::Reference<css::uno::XInterface>& rItem) {
return rItem.get() == rListener.get(); });
// interface not found, use the correct compare method
if (it == aData.pAsVector->end())
it = std::find(aData.pAsVector->begin(), aData.pAsVector->end(), rListener);
if (it != aData.pAsVector->end())
aData.pAsVector->erase(it);
if( aData.pAsVector->size() == 1 )
{
XInterface * p = (*aData.pAsVector)[0].get();
p->acquire();
delete aData.pAsVector;
aData.pAsInterface = p;
bIsList = false;
return 1;
}
else
return aData.pAsVector->size();
}
else if( aData.pAsInterface && Reference<XInterface>( aData.pAsInterface ) == rListener )
{
aData.pAsInterface->release();
aData.pAsInterface = nullptr;
}
return aData.pAsInterface ? 1 : 0;
}
Reference<XInterface> OInterfaceContainerHelper2::getInterface( sal_Int32 nIndex ) const
{
MutexGuard aGuard( rMutex );
if (bIsList)
return (*aData.pAsVector)[nIndex];
assert(aData.pAsInterface && nIndex == 0);
return aData.pAsInterface;
}
void OInterfaceContainerHelper2::disposeAndClear( const EventObject & rEvt )
{
ClearableMutexGuard aGuard( rMutex );
OInterfaceIteratorHelper2 aIt( *this );
// Release container, in case new entries come while disposing
OSL_ENSURE( !bIsList || bInUse, "OInterfaceContainerHelper2 not in use" );
if( !bIsList && aData.pAsInterface )
aData.pAsInterface->release();
// set the member to null, use the iterator to delete the values
aData.pAsInterface = nullptr;
bIsList = false;
bInUse = false;
aGuard.clear();
while( aIt.hasMoreElements() )
{
try
{
Reference<XEventListener > xLst( aIt.next(), UNO_QUERY );
if( xLst.is() )
xLst->disposing( rEvt );
}
catch ( RuntimeException & )
{
// be robust, if e.g. a remote bridge has disposed already.
// there is no way to delegate the error to the caller :o(.
}
}
}
void OInterfaceContainerHelper2::clear()
{
MutexGuard aGuard( rMutex );
// Release container, in case new entries come while disposing
OSL_ENSURE( !bIsList || bInUse, "OInterfaceContainerHelper2 not in use" );
if (bInUse)
copyAndResetInUse();
if (bIsList)
delete aData.pAsVector;
else if (aData.pAsInterface)
aData.pAsInterface->release();
aData.pAsInterface = nullptr;
bIsList = false;
}
// specialized class for type
OMultiTypeInterfaceContainerHelper2::OMultiTypeInterfaceContainerHelper2( Mutex & rMutex_ )
: rMutex( rMutex_ )
{
}
OMultiTypeInterfaceContainerHelper2::~OMultiTypeInterfaceContainerHelper2()
{
}
std::vector< css::uno::Type > OMultiTypeInterfaceContainerHelper2::getContainedTypes() const
{
::osl::MutexGuard aGuard( rMutex );
std::vector< Type > aInterfaceTypes;
aInterfaceTypes.reserve( m_aMap.size() );
for (const auto& rItem : m_aMap)
{
// are interfaces added to this container?
if( rItem.second->getLength() )
// yes, put the type in the array
aInterfaceTypes.push_back(rItem.first);
}
return aInterfaceTypes;
}
OMultiTypeInterfaceContainerHelper2::t_type2ptr::iterator OMultiTypeInterfaceContainerHelper2::findType(const Type & rKey )
{
return std::find_if(m_aMap.begin(), m_aMap.end(),
[&rKey](const t_type2ptr::value_type& rItem) { return rItem.first == rKey; });
}
OMultiTypeInterfaceContainerHelper2::t_type2ptr::const_iterator OMultiTypeInterfaceContainerHelper2::findType(const Type & rKey ) const
{
return std::find_if(m_aMap.begin(), m_aMap.end(),
[&rKey](const t_type2ptr::value_type& rItem) { return rItem.first == rKey; });
}
OInterfaceContainerHelper2 * OMultiTypeInterfaceContainerHelper2::getContainer( const Type & rKey ) const
{
::osl::MutexGuard aGuard( rMutex );
auto iter = findType( rKey );
if( iter != m_aMap.end() )
return (*iter).second.get();
return nullptr;
}
sal_Int32 OMultiTypeInterfaceContainerHelper2::addInterface(
const Type & rKey, const Reference< XInterface > & rListener )
{
::osl::MutexGuard aGuard( rMutex );
auto iter = findType( rKey );
if( iter == m_aMap.end() )
{
OInterfaceContainerHelper2 * pLC = new OInterfaceContainerHelper2( rMutex );
m_aMap.emplace_back(rKey, pLC);
return pLC->addInterface( rListener );
}
return (*iter).second->addInterface( rListener );
}
sal_Int32 OMultiTypeInterfaceContainerHelper2::removeInterface(
const Type & rKey, const Reference< XInterface > & rListener )
{
::osl::MutexGuard aGuard( rMutex );
// search container with id nUik
auto iter = findType( rKey );
// container found?
if( iter != m_aMap.end() )
return (*iter).second->removeInterface( rListener );
// no container with this id. Always return 0
return 0;
}
void OMultiTypeInterfaceContainerHelper2::disposeAndClear( const EventObject & rEvt )
{
t_type2ptr::size_type nSize = 0;
std::unique_ptr<OInterfaceContainerHelper2 *[]> ppListenerContainers;
{
::osl::MutexGuard aGuard( rMutex );
nSize = m_aMap.size();
if( nSize )
{
typedef OInterfaceContainerHelper2* ppp;
ppListenerContainers.reset(new ppp[nSize]);
t_type2ptr::size_type i = 0;
for (const auto& rItem : m_aMap)
{
ppListenerContainers[i++] = rItem.second.get();
}
}
}
// create a copy, because do not fire event in a guarded section
for( t_type2ptr::size_type i = 0; i < nSize; i++ )
{
if( ppListenerContainers[i] )
ppListenerContainers[i]->disposeAndClear( rEvt );
}
}
void OMultiTypeInterfaceContainerHelper2::clear()
{
::osl::MutexGuard aGuard( rMutex );
for (auto& rItem : m_aMap)
rItem.second->clear();
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */