include/comphelper/configurationlistener.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
  10 #ifndef INCLUDED_COMPHELPER_CONFIGURATIONLISTENER_HXX
  11 #define INCLUDED_COMPHELPER_CONFIGURATIONLISTENER_HXX
  12
  13 #include <algorithm>
  14 #include <vector>
  15 #include <iterator>
  16 #include <comphelper/comphelperdllapi.h>
  17 #include <com/sun/star/lang/XComponent.hpp>
  18 #include <com/sun/star/beans/XPropertySet.hpp>
  19 #include <com/sun/star/beans/PropertyChangeEvent.hpp>
  20 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  21 #include <rtl/ref.hxx>
  22 #include <cppuhelper/implbase.hxx>
  23 #include <comphelper/processfactory.hxx>
  24 #include <comphelper/configurationhelper.hxx>
  25
  26 namespace comphelper {
  27
  28 class ConfigurationListener;
  29
  30 class COMPHELPER_DLLPUBLIC ConfigurationListenerPropertyBase {
  31 public:
  32     OUString maName;
  33     rtl::Reference<ConfigurationListener> mxListener;
  34
  35     virtual ~ConfigurationListenerPropertyBase() {}
  36     virtual void setProperty(const css::uno::Any &aProperty) = 0;
  37     void dispose() { mxListener.clear(); }
  38 };
  39
  40 /// Access to this class must be protected by the SolarMutex
  41 template< typename uno_type > class ConfigurationListenerProperty : public ConfigurationListenerPropertyBase
  42 {
  43     uno_type maValue;
  44 protected:
  45     virtual void setProperty(const css::uno::Any &aProperty) override
  46     {
  47         aProperty >>= maValue;
  48     }
  49 public:
  50     /**
  51      * Provide a mirror of the configmgr's version of this property
  52      * for the lifecycle of this property. The property value tracks
  53      * the same value in the configuration.
  54      */
  55     inline ConfigurationListenerProperty(const rtl::Reference< ConfigurationListener > &xListener,
  56                                              const OUString &rProp );
  57
  58     virtual inline ~ConfigurationListenerProperty() override;
  59
  60     uno_type get() const { return maValue; }
  61 };
  62
  63 class COMPHELPER_DLLPUBLIC ConfigurationListener :
  64         public cppu::WeakImplHelper< css::beans::XPropertyChangeListener >
  65 {
  66     css::uno::Reference< css::beans::XPropertySet > mxConfig;
  67     std::vector< ConfigurationListenerPropertyBase * > maListeners;
  68 public:
  69     /// Public health warning, you -must- dispose this if you use it.
  70     ConfigurationListener(const OUString &rPath,
  71                           css::uno::Reference< css::uno::XComponentContext >
  72                           const & xContext = comphelper::getProcessComponentContext())
  73         : mxConfig( ConfigurationHelper::openConfig( xContext, rPath, EConfigurationModes::ReadOnly ),
  74                     css::uno::UNO_QUERY_THROW )
  75     { }
  76
  77     virtual ~ConfigurationListener() override
  78     {
  79         dispose();
  80     }
  81
  82     /// Listen for the specific property denoted by the listener
  83     void addListener(ConfigurationListenerPropertyBase *pListener);
  84
  85     /// Stop listening.
  86     void removeListener(ConfigurationListenerPropertyBase *pListener);
  87
  88     /// Release various circular references
  89     void dispose();
  90
  91     // XPropertyChangeListener implementation
  92     virtual void SAL_CALL disposing(css::lang::EventObject const &) override;
  93
  94     /// Notify of the property change
  95     virtual void SAL_CALL propertyChange(
  96         css::beans::PropertyChangeEvent const &rEvt ) override;
  97 };
  98
  99 template< typename uno_type > ConfigurationListenerProperty< uno_type >::ConfigurationListenerProperty(const rtl::Reference< ConfigurationListener > &xListener, const OUString &rProp )
 100     : maValue()
 101 {
 102     maName = rProp;
 103     mxListener = xListener;
 104     mxListener->addListener(this);
 105 }
 106
 107 template< typename uno_type > ConfigurationListenerProperty< uno_type >::~ConfigurationListenerProperty()
 108 {
 109     if (mxListener.is())
 110         mxListener->removeListener(this);
 111 }
 112
 113 } // namespace comphelper
 114
 115 #endif // INCLUDED_COMPHELPER_CONFIGURATIONLISTENER_HXX
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */