configmgr/source/api2/notifierimpl.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: notifierimpl.hxx,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef CONFIGMGR_API_NOTIFIERIMPL_HXX_
  32 #define CONFIGMGR_API_NOTIFIERIMPL_HXX_
  33
  34 #include "listenercontainer.hxx"
  35
  36 #include "noderef.hxx"
  37 #include "valueref.hxx"
  38
  39 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  40 #include <com/sun/star/beans/XVetoableChangeListener.hpp>
  41 #include <com/sun/star/beans/XPropertiesChangeListener.hpp>
  42 #include <com/sun/star/beans/PropertyVetoException.hpp>
  43 #include <com/sun/star/container/XContainerListener.hpp>
  44 #include <com/sun/star/util/XChangesListener.hpp>
  45
  46 #include "propertiesfilterednotifier.hxx"
  47
  48 #include <vos/refernce.hxx>
  49
  50 namespace configmgr
  51 {
  52     namespace configapi
  53     {
  54 // ---------------------------------------------------------------------------------------------------
  55
  56         struct SubNodeHash
  57         {
  58             size_t operator() (const configuration::SubNodeID& rKey) const {return rKey.hashCode();}
  59         };
  60         struct SubNodeEq
  61         {
  62             bool operator() (const configuration::SubNodeID& lhs,const configuration::SubNodeID& rhs) const {return lhs == rhs;}
  63         };
  64         struct SubNodeToIndex
  65         {
  66             rtl::Reference< configuration::Tree > aTree;
  67
  68             SubNodeToIndex( rtl::Reference< configuration::Tree > const& rTree ) : aTree(rTree) {}
  69
  70             bool findKeysForIndex(unsigned int nNode, std::vector<configuration::SubNodeID>& aList)
  71             {
  72                 aList.clear();
  73                 configuration::getAllChildrenHelper(configuration::findNodeFromIndex(aTree,nNode), aList);
  74                 return !aList.empty();
  75             }
  76             unsigned int findIndexForKey(configuration::SubNodeID const& aNode)
  77             {
  78                 return aNode.getParentID().toIndex();
  79             }
  80         };
  81
  82         /// manages collections of event listeners observing a whole config tree, thread-safe
  83         class NotifierImpl : public vos::OReference
  84         {
  85         public:
  86             SpecialListenerContainer <configuration::SubNodeID,SubNodeHash,SubNodeEq,SubNodeToIndex> m_aListeners;
  87
  88         public:
  89             /// construct this around the given Implementation, for the given tree
  90             explicit
  91             NotifierImpl(rtl::Reference< configuration::Tree > const& aTree);
  92             ~NotifierImpl();
  93
  94             /// Add a <type scope='com::sun::star::lang'>XEventListener</type> observing <var>aNode</var>.
  95             void add(configuration::NodeID const& aNode, uno::Reference< css::lang::XEventListener > const& xListener)
  96             {
  97                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
  98
  99                 // ignore the names for now
 100                 m_aListeners.addListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 101             }
 102
 103             /// Add a <type scope='com::sun::star::container'>XContainerListener</type> observing <var>aNode</var>.
 104             void add(configuration::NodeID const& aNode, uno::Reference< css::container::XContainerListener > const& xListener)
 105             {
 106                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 107
 108                 // ignore the names for now
 109                 m_aListeners.addListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 110             }
 111
 112             /// Add a <type scope='com::sun::star::util'>XChangesListener</type> observing <var>aNode</var> and its descendants.
 113             void add(configuration::NodeID const& aNode, uno::Reference< css::util::XChangesListener > const& xListener)
 114             {
 115                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 116
 117                 // ignore the names for now
 118                 m_aListeners.addListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 119             }
 120
 121             /// Add a <type scope='com::sun::star::beans'>XPropertyChangeListener</type> observing <var>aNode</var>.
 122             void addNamed(configuration::SubNodeID const& aNode, uno::Reference< css::beans::XPropertyChangeListener > const& xListener)
 123             {
 124                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 125
 126                 // ignore the names for now
 127                 m_aListeners.addSpecialListener(aNode,xListener.get());
 128             }
 129             /// Add a <type scope='com::sun::star::beans'>XPropertyChangeListener</type> observing <var>aNode</var>.
 130             void addForAll(configuration::NodeID const& aNode, uno::Reference< css::beans::XPropertyChangeListener > const& xListener)
 131             {
 132                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 133
 134                 // ignore the names for now
 135                 m_aListeners.addListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 136             }
 137             /// Add a <type scope='com::sun::star::beans'>XVetoableChangeListener</type> constraining <var>aNode</var>.
 138             void addNamed(configuration::SubNodeID const& aNode, uno::Reference< css::beans::XVetoableChangeListener > const& xListener)
 139             {
 140                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 141
 142                 // ignore the names for now
 143                 m_aListeners.addSpecialListener(aNode,xListener.get());
 144             }
 145             /// Add a <type scope='com::sun::star::beans'>XVetoableChangeListener</type> constraining <var>aNode</var>.
 146             void addForAll(configuration::NodeID const& aNode, uno::Reference< css::beans::XVetoableChangeListener > const& xListener)
 147             {
 148                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 149
 150                 // ignore the names for now
 151                 m_aListeners.addListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 152             }
 153
 154             /** Add a <type scope='com::sun::star::beans'>XPropertiesChangeListener</type>
 155                 observing all properties of <var>aNode</var>.
 156             */
 157             void add(configuration::NodeID const& aNode, uno::Reference< css::beans::XPropertiesChangeListener > const& xListener)
 158             {
 159                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 160
 161                 // ignore the names for now
 162                 m_aListeners.addListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 163             }
 164
 165             /** Add a <type scope='com::sun::star::beans'>XPropertiesChangeListener</type>
 166                 observing the properties of <var>aNode</var> (optimally only those given by <var>aNames</var>.
 167             */
 168             void add(configuration::NodeID const& aNode, uno::Reference< css::beans::XPropertiesChangeListener > const& xListener, uno::Sequence< rtl::OUString> const& aNames)
 169             {
 170                 OSL_PRECOND(xListener.is(), "ERROR: Unexpected NULL listener");
 171                 OSL_PRECOND(aNames.getLength() > 0, "ERROR: Unexpected empty sequence");
 172
 173                 uno::Reference< css::beans::XPropertiesChangeListener > xForwarder( new PropertiesFilteredNotifier(xListener,aNames) );
 174                 // ignore the names for now
 175                 add(aNode,xForwarder);
 176             }
 177
 178         // ---------------------------------------------------------------------------------------------------
 179             /// Remove a <type scope='com::sun::star::lang'>XEventListener</type> observing <var>aNode</var>.
 180             void remove(configuration::NodeID const& aNode, uno::Reference< css::lang::XEventListener > const& xListener)
 181             {
 182                 // ignore the names for now
 183                 m_aListeners.removeListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 184             }
 185
 186             /// Remove a <type scope='com::sun::star::container'>XContainerListener</type> observing <var>aNode</var>.
 187             void remove(configuration::NodeID const& aNode, uno::Reference< css::container::XContainerListener > const& xListener)
 188             {
 189                 // ignore the names for now
 190                 m_aListeners.removeListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 191             }
 192
 193             /// Remove a <type scope='com::sun::star::util'>XChangesListener</type> observing <var>aNode</var> and its descendants.
 194             void remove(configuration::NodeID const& aNode, uno::Reference< css::util::XChangesListener > const& xListener)
 195             {
 196                 // ignore the names for now
 197                 m_aListeners.removeListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 198             }
 199
 200             /// Remove a <type scope='com::sun::star::beans'>XPropertyChangeListener</type> observing <var>aNode</var>.
 201             void removeNamed(configuration::SubNodeID const& aNode, uno::Reference< css::beans::XPropertyChangeListener > const& xListener)
 202             {
 203                 // ignore the names for now
 204                 m_aListeners.removeSpecialListener(aNode,xListener.get());
 205             }
 206             /// Remove a <type scope='com::sun::star::beans'>XPropertyChangeListener</type> observing <var>aNode</var>.
 207             void removeForAll(configuration::NodeID const& aNode, uno::Reference< css::beans::XPropertyChangeListener > const& xListener)
 208             {
 209                 // ignore the names for now
 210                 m_aListeners.removeListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 211             }
 212             /// Remove a <type scope='com::sun::star::beans'>XVetoableChangeListener</type> constraining <var>aNode</var>.
 213             void removeNamed(configuration::SubNodeID const& aNode, uno::Reference< css::beans::XVetoableChangeListener > const& xListener)
 214             {
 215                 // ignore the names for now
 216                 m_aListeners.removeSpecialListener(aNode,xListener.get());
 217             }
 218             /// Remove a <type scope='com::sun::star::beans'>XVetoableChangeListener</type> constraining <var>aNode</var>.
 219             void removeForAll(configuration::NodeID const& aNode, uno::Reference< css::beans::XVetoableChangeListener > const& xListener)
 220             {
 221                 // ignore the names for now
 222                 m_aListeners.removeListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 223             }
 224
 225
 226             /** Remove a <type scope='com::sun::star::beans'>XPropertiesChangeListener</type>
 227                 observing any properties of <var>aNode</var>.
 228             */
 229             void remove(configuration::NodeID const& aNode, uno::Reference< css::beans::XPropertiesChangeListener > const& xListener)
 230             {
 231                 // ignore the names for now
 232                 m_aListeners.removeListener(aNode.toIndex(),getCppuType(&xListener),xListener.get());
 233             }
 234         // ---------------------------------------------------------------------------------------------------
 235         };
 236
 237 // ---------------------------------------------------------------------------------------------------
 238     }
 239 }
 240
 241 #endif // CONFIGMGR_API_NOTIFIERIMPL_HXX_