include/comphelper/propmultiplex.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_COMPHELPER_PROPMULTIPLEX_HXX
  21 #define INCLUDED_COMPHELPER_PROPMULTIPLEX_HXX
  22
  23 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  24 #include <cppuhelper/implbase.hxx>
  25 #include <comphelper/comphelperdllapi.h>
  26 #include <rtl/ref.hxx>
  27 #include <mutex>
  28 #include <vector>
  29
  30 namespace com::sun::star::beans { class XPropertySet; }
  31
  32 //= property helper classes
  33
  34
  35 namespace comphelper
  36 {
  37
  38
  39     class OPropertyChangeMultiplexer;
  40
  41
  42     //= OPropertyChangeListener
  43
  44     /// simple listener adapter for property sets
  45     class COMPHELPER_DLLPUBLIC OPropertyChangeListener
  46     {
  47         friend class OPropertyChangeMultiplexer;
  48
  49         rtl::Reference<OPropertyChangeMultiplexer> m_xAdapter;
  50         // We have our own mutex here for the m_xAdapter field, because we sit between two different objects
  51         // which often have their own mutexes, and if we use a mutex from one of them,
  52         // we end up with ABBA deadlock risks.
  53         std::mutex                  m_aAdapterMutex;
  54
  55     public:
  56         virtual ~OPropertyChangeListener();
  57
  58         /// @throws css::uno::RuntimeException
  59         virtual void _propertyChanged(const css::beans::PropertyChangeEvent& _rEvent) = 0;
  60         /// @throws css::uno::RuntimeException
  61         virtual void _disposing(const css::lang::EventObject& _rSource);
  62
  63     protected:
  64         /** If the derivee also owns the mutex which we know as reference, then call this within your
  65             derivee's dtor.
  66         */
  67         void    disposeAdapter();
  68
  69     private:
  70         void    setAdapter( OPropertyChangeMultiplexer* _pAdapter );
  71     };
  72
  73
  74     //= OPropertyChangeMultiplexer
  75
  76     /// multiplexer for property changes
  77     // workaround for incremental linking bugs in MSVC2019
  78     class SAL_DLLPUBLIC_TEMPLATE OPropertyChangeMultiplexer_Base : public cppu::WeakImplHelper< css::beans::XPropertyChangeListener > {};
  79     class COMPHELPER_DLLPUBLIC OPropertyChangeMultiplexer final : public OPropertyChangeMultiplexer_Base
  80     {
  81         friend class OPropertyChangeListener;
  82         std::vector< OUString >                         m_aProperties;
  83         css::uno::Reference< css::beans::XPropertySet>  m_xSet;
  84         OPropertyChangeListener*                        m_pListener;
  85         sal_Int32                                       m_nLockCount;
  86         bool                                            m_bListening        : 1;
  87         bool const                                      m_bAutoSetRelease   : 1;
  88
  89
  90         virtual ~OPropertyChangeMultiplexer() override;
  91     public:
  92         OPropertyChangeMultiplexer(OPropertyChangeListener* _pListener, const  css::uno::Reference< css::beans::XPropertySet>& _rxSet, bool _bAutoReleaseSet = true);
  93
  94     // XEventListener
  95         virtual void SAL_CALL disposing( const  css::lang::EventObject& Source ) override;
  96
  97     // XPropertyChangeListener
  98         virtual void SAL_CALL propertyChange( const  css::beans::PropertyChangeEvent& evt ) override;
  99
 100         /// incremental lock
 101         void        lock();
 102         /// incremental unlock
 103         void        unlock();
 104         /// get the lock count
 105         sal_Int32   locked() const { return m_nLockCount; }
 106
 107         void addProperty(const OUString& aPropertyName);
 108         void dispose();
 109     };
 110
 111
 112 }   // namespace comphelper
 113
 114
 115 #endif // INCLUDED_COMPHELPER_PROPMULTIPLEX_HXX
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */