interfacecontainer2.hxx

Go to the documentation of this file.

/* -*- 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 .
 */
#ifndef INCLUDED_COMPHELPER_INTERFACECONTAINER2_H
#define INCLUDED_COMPHELPER_INTERFACECONTAINER2_H
 
#include <sal/config.h>
 
#include <vector>
 
#include <com/sun/star/lang/EventObject.hpp>
 
#include <com/sun/star/lang/DisposedException.hpp>
#include <comphelper/comphelperdllapi.h>
 
namespace com::sun::star::uno { class XInterface; }
namespace osl { class Mutex; }
 
namespace comphelper
{
 
namespace detail {
 
    union element_alias2
    {
        std::vector< css::uno::Reference< css::uno::XInterface > > *pAsVector;
        css::uno::XInterface * pAsInterface;
        element_alias2() : pAsInterface(nullptr) {}
    };
 
}
 
 
class OInterfaceContainerHelper2;
class COMPHELPER_DLLPUBLIC OInterfaceIteratorHelper2
{
public:
    OInterfaceIteratorHelper2( OInterfaceContainerHelper2 & rCont );
 
    ~OInterfaceIteratorHelper2();
 
    bool hasMoreElements() const
        { return nRemain != 0; }
    css::uno::XInterface * next();
 
    void remove();
 
private:
    OInterfaceContainerHelper2 & rCont;
    detail::element_alias2       aData;
    sal_Int32                    nRemain;
    bool                         bIsList;
 
    OInterfaceIteratorHelper2( const OInterfaceIteratorHelper2 & ) = delete;
    OInterfaceIteratorHelper2 &  operator = ( const OInterfaceIteratorHelper2 & ) = delete;
};
 
 
class COMPHELPER_DLLPUBLIC OInterfaceContainerHelper2
{
public:
    OInterfaceContainerHelper2( ::osl::Mutex & rMutex );
    ~OInterfaceContainerHelper2();
    sal_Int32 getLength() const;
 
    std::vector< css::uno::Reference< css::uno::XInterface > > getElements() const;
 
    sal_Int32 addInterface( const css::uno::Reference< css::uno::XInterface > & rxIFace );
    sal_Int32 removeInterface( const css::uno::Reference< css::uno::XInterface > & rxIFace );
    css::uno::Reference< css::uno::XInterface > getInterface(sal_Int32 nIndex) const;
    void disposeAndClear( const css::lang::EventObject & rEvt );
    void clear();
 
    template <typename ListenerT, typename FuncT>
    inline void forEach( FuncT const& func );
 
    template< typename ListenerT, typename EventT >
    inline void notifyEach( void ( SAL_CALL ListenerT::*NotificationMethod )( const EventT& ), const EventT& Event );
 
private:
friend class OInterfaceIteratorHelper2;
    detail::element_alias2  aData;
    ::osl::Mutex &          rMutex;
    bool                    bInUse;
    bool                    bIsList;
 
    OInterfaceContainerHelper2( const OInterfaceContainerHelper2 & ) = delete;
    OInterfaceContainerHelper2 & operator = ( const OInterfaceContainerHelper2 & ) = delete;
 
    /*
      Duplicate content of the container and release the old one without destroying.
      The mutex must be locked and the memberbInUse must be true.
     */
    void copyAndResetInUse();
 
private:
    template< typename ListenerT, typename EventT >
    class NotifySingleListener
    {
    private:
        typedef void ( SAL_CALL ListenerT::*NotificationMethod )( const EventT& );
        NotificationMethod const m_pMethod;
        const EventT&            m_rEvent;
    public:
        NotifySingleListener( NotificationMethod method, const EventT& event ) : m_pMethod( method ), m_rEvent( event ) { }
 
        void operator()( const css::uno::Reference<ListenerT>& listener ) const
        {
            (listener.get()->*m_pMethod)( m_rEvent );
        }
    };
};
 
template <typename ListenerT, typename FuncT>
inline void OInterfaceContainerHelper2::forEach( FuncT const& func )
{
    OInterfaceIteratorHelper2 iter( *this );
    while (iter.hasMoreElements()) {
        css::uno::Reference<ListenerT> const xListener( iter.next(), css::uno::UNO_QUERY );
        if (xListener.is()) {
            try {
                func( xListener );
            }
            catch (css::lang::DisposedException const& exc) {
                if (exc.Context == xListener)
                    iter.remove();
            }
        }
    }
}
 
template< typename ListenerT, typename EventT >
inline void OInterfaceContainerHelper2::notifyEach( void ( SAL_CALL ListenerT::*NotificationMethod )( const EventT& ), const EventT& Event )
{
    forEach< ListenerT, NotifySingleListener< ListenerT, EventT > >( NotifySingleListener< ListenerT, EventT >( NotificationMethod, Event ) );
}
 
}
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */