framework/source/classes/propertysethelper.cxx

   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: propertysethelper.cxx,v $
  10  * $Revision: 1.7 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_framework.hxx"
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36
  37 #include <classes/propertysethelper.hxx>
  38 #include <threadhelp/transactionguard.hxx>
  39 #include <threadhelp/readguard.hxx>
  40 #include <threadhelp/writeguard.hxx>
  41
  42 //_________________________________________________________________________________________________________________
  43 //      interface includes
  44
  45 //_________________________________________________________________________________________________________________
  46 //      other includes
  47
  48 //_________________________________________________________________________________________________________________
  49 //      namespace
  50
  51 namespace framework{
  52
  53 //_________________________________________________________________________________________________________________
  54 //  non exported definitions
  55
  56 //-----------------------------------------------------------------------------
  57 PropertySetHelper::PropertySetHelper(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR                       ,
  58                                            LockHelper*                                             pExternalLock               ,
  59                                            TransactionManager*                                     pExternalTransactionManager ,
  60                                            sal_Bool                                                bReleaseLockOnCall          )
  61     : m_xSMGR                (xSMGR                                )
  62     , m_lSimpleChangeListener(pExternalLock->getShareableOslMutex())
  63     , m_lVetoChangeListener  (pExternalLock->getShareableOslMutex())
  64     , m_bReleaseLockOnCall   (bReleaseLockOnCall                   )
  65     , m_rLock                (*pExternalLock                       )
  66     , m_rTransactionManager  (*pExternalTransactionManager         )
  67 {
  68 }
  69
  70 //-----------------------------------------------------------------------------
  71 PropertySetHelper::~PropertySetHelper()
  72 {
  73 }
  74
  75 //-----------------------------------------------------------------------------
  76 void PropertySetHelper::impl_setPropertyChangeBroadcaster(const css::uno::Reference< css::uno::XInterface >& xBroadcaster)
  77 {
  78     TransactionGuard aTransaction(m_rTransactionManager, E_SOFTEXCEPTIONS);
  79
  80     // SAFE ->
  81     WriteGuard aWriteLock(m_rLock);
  82     m_xBroadcaster = xBroadcaster;
  83     aWriteLock.unlock();
  84     // <- SAFE
  85 }
  86
  87 //-----------------------------------------------------------------------------
  88 void SAL_CALL PropertySetHelper::impl_addPropertyInfo(const css::beans::Property& aProperty)
  89     throw(css::beans::PropertyExistException,
  90           css::uno::Exception               )
  91 {
  92     TransactionGuard aTransaction(m_rTransactionManager, E_SOFTEXCEPTIONS);
  93
  94     // SAFE ->
  95     WriteGuard aWriteLock(m_rLock);
  96
  97     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(aProperty.Name);
  98     if (pIt != m_lProps.end())
  99         throw css::beans::PropertyExistException();
 100
 101     m_lProps[aProperty.Name] = aProperty;
 102     // <- SAFE
 103 }
 104
 105 //-----------------------------------------------------------------------------
 106 void SAL_CALL PropertySetHelper::impl_removePropertyInfo(const ::rtl::OUString& sProperty)
 107     throw(css::beans::UnknownPropertyException,
 108           css::uno::Exception                 )
 109 {
 110     TransactionGuard aTransaction(m_rTransactionManager, E_SOFTEXCEPTIONS);
 111
 112     // SAFE ->
 113     WriteGuard aWriteLock(m_rLock);
 114
 115     PropertySetHelper::TPropInfoHash::iterator pIt = m_lProps.find(sProperty);
 116     if (pIt == m_lProps.end())
 117         throw css::beans::UnknownPropertyException();
 118
 119     m_lProps.erase(pIt);
 120     // <- SAFE
 121 }
 122
 123 //-----------------------------------------------------------------------------
 124 void SAL_CALL PropertySetHelper::impl_enablePropertySet()
 125 {
 126 }
 127
 128 //-----------------------------------------------------------------------------
 129 void SAL_CALL PropertySetHelper::impl_disablePropertySet()
 130 {
 131     TransactionGuard aTransaction(m_rTransactionManager, E_SOFTEXCEPTIONS);
 132
 133     // SAFE ->
 134     WriteGuard aWriteLock(m_rLock);
 135
 136     css::uno::Reference< css::uno::XInterface > xThis(static_cast< css::beans::XPropertySet* >(this), css::uno::UNO_QUERY);
 137     css::lang::EventObject aEvent(xThis);
 138
 139     m_lSimpleChangeListener.disposeAndClear(aEvent);
 140     m_lVetoChangeListener.disposeAndClear(aEvent);
 141     m_lProps.free();
 142
 143     aWriteLock.unlock();
 144     // <- SAFE
 145 }
 146
 147 //-----------------------------------------------------------------------------
 148 sal_Bool PropertySetHelper::impl_existsVeto(const css::beans::PropertyChangeEvent& aEvent)
 149 {
 150     /*  Dont use the lock here!
 151         The used helper is threadsafe and it lives for the whole lifetime of
 152         our own object.
 153     */
 154     ::cppu::OInterfaceContainerHelper* pVetoListener = m_lVetoChangeListener.getContainer(aEvent.PropertyName);
 155     if (! pVetoListener)
 156         return sal_False;
 157
 158     ::cppu::OInterfaceIteratorHelper pListener(*pVetoListener);
 159     while (pListener.hasMoreElements())
 160     {
 161         try
 162         {
 163             css::uno::Reference< css::beans::XVetoableChangeListener > xListener(
 164                 ((css::beans::XVetoableChangeListener*)pListener.next()),
 165                 css::uno::UNO_QUERY_THROW);
 166             xListener->vetoableChange(aEvent);
 167         }
 168         catch(const css::uno::RuntimeException&)
 169             { pListener.remove(); }
 170         catch(const css::beans::PropertyVetoException&)
 171             { return sal_True; }
 172     }
 173
 174     return sal_False;
 175 }
 176
 177 //-----------------------------------------------------------------------------
 178 void PropertySetHelper::impl_notifyChangeListener(const css::beans::PropertyChangeEvent& aEvent)
 179 {
 180     /*  Dont use the lock here!
 181         The used helper is threadsafe and it lives for the whole lifetime of
 182         our own object.
 183     */
 184     ::cppu::OInterfaceContainerHelper* pSimpleListener = m_lSimpleChangeListener.getContainer(aEvent.PropertyName);
 185     if (! pSimpleListener)
 186         return;
 187
 188     ::cppu::OInterfaceIteratorHelper pListener(*pSimpleListener);
 189     while (pListener.hasMoreElements())
 190     {
 191         try
 192         {
 193             css::uno::Reference< css::beans::XPropertyChangeListener > xListener(
 194                 ((css::beans::XVetoableChangeListener*)pListener.next()),
 195                 css::uno::UNO_QUERY_THROW);
 196             xListener->propertyChange(aEvent);
 197         }
 198         catch(const css::uno::RuntimeException&)
 199             { pListener.remove(); }
 200     }
 201 }
 202
 203 //-----------------------------------------------------------------------------
 204 css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL PropertySetHelper::getPropertySetInfo()
 205     throw(css::uno::RuntimeException)
 206 {
 207     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 208
 209     css::uno::Reference< css::beans::XPropertySetInfo > xInfo(static_cast< css::beans::XPropertySetInfo* >(this), css::uno::UNO_QUERY_THROW);
 210     return xInfo;
 211 }
 212
 213 //-----------------------------------------------------------------------------
 214 void SAL_CALL PropertySetHelper::setPropertyValue(const ::rtl::OUString& sProperty,
 215                                                   const css::uno::Any&   aValue   )
 216     throw(css::beans::UnknownPropertyException,
 217           css::beans::PropertyVetoException   ,
 218           css::lang::IllegalArgumentException ,
 219           css::lang::WrappedTargetException   ,
 220           css::uno::RuntimeException          )
 221 {
 222     // TODO look for e.g. readonly props and reject setProp() call!
 223
 224     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 225
 226     // SAFE ->
 227     WriteGuard aWriteLock(m_rLock);
 228
 229     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(sProperty);
 230     if (pIt == m_lProps.end())
 231         throw css::beans::UnknownPropertyException();
 232
 233     css::beans::Property aPropInfo = pIt->second;
 234
 235     sal_Bool bLocked = sal_True;
 236     if (m_bReleaseLockOnCall)
 237     {
 238         aWriteLock.unlock();
 239         bLocked = sal_False;
 240         // <- SAFE
 241     }
 242
 243     css::uno::Any aCurrentValue = impl_getPropertyValue(aPropInfo.Name, aPropInfo.Handle);
 244
 245     if (! bLocked)
 246     {
 247         // SAFE ->
 248         aWriteLock.lock();
 249         bLocked = sal_True;
 250     }
 251
 252     sal_Bool bWillBeChanged = (aCurrentValue != aValue);
 253     if (! bWillBeChanged)
 254         return;
 255
 256     css::beans::PropertyChangeEvent aEvent;
 257     aEvent.PropertyName   = aPropInfo.Name;
 258     aEvent.Further        = sal_False;
 259     aEvent.PropertyHandle = aPropInfo.Handle;
 260     aEvent.OldValue       = aCurrentValue;
 261     aEvent.NewValue       = aValue;
 262     aEvent.Source         = css::uno::Reference< css::uno::XInterface >(m_xBroadcaster.get(), css::uno::UNO_QUERY);
 263
 264     if (m_bReleaseLockOnCall)
 265     {
 266         aWriteLock.unlock();
 267         bLocked = sal_False;
 268         // <- SAFE
 269     }
 270
 271     if (impl_existsVeto(aEvent))
 272         throw css::beans::PropertyVetoException();
 273
 274     impl_setPropertyValue(aPropInfo.Name, aPropInfo.Handle, aValue);
 275
 276     impl_notifyChangeListener(aEvent);
 277 }
 278
 279 //-----------------------------------------------------------------------------
 280 css::uno::Any SAL_CALL PropertySetHelper::getPropertyValue(const ::rtl::OUString& sProperty)
 281     throw(css::beans::UnknownPropertyException,
 282           css::lang::WrappedTargetException   ,
 283           css::uno::RuntimeException          )
 284 {
 285     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 286
 287     // SAFE ->
 288     ReadGuard aReadLock(m_rLock);
 289
 290     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(sProperty);
 291     if (pIt == m_lProps.end())
 292         throw css::beans::UnknownPropertyException();
 293
 294     css::beans::Property aPropInfo = pIt->second;
 295
 296     sal_Bool bLocked = sal_True;
 297     if (m_bReleaseLockOnCall)
 298     {
 299         aReadLock.unlock();
 300         bLocked = sal_False;
 301         // <- SAFE
 302     }
 303
 304     return impl_getPropertyValue(aPropInfo.Name, aPropInfo.Handle);
 305 }
 306
 307 //-----------------------------------------------------------------------------
 308 void SAL_CALL PropertySetHelper::addPropertyChangeListener(const ::rtl::OUString&                                            sProperty,
 309                                                            const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
 310     throw(css::beans::UnknownPropertyException,
 311           css::lang::WrappedTargetException   ,
 312           css::uno::RuntimeException          )
 313 {
 314     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 315
 316     // SAFE ->
 317     ReadGuard aReadLock(m_rLock);
 318
 319     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(sProperty);
 320     if (pIt == m_lProps.end())
 321         throw css::beans::UnknownPropertyException();
 322
 323     aReadLock.unlock();
 324     // <- SAFE
 325
 326     m_lSimpleChangeListener.addInterface(sProperty, xListener);
 327 }
 328
 329 //-----------------------------------------------------------------------------
 330 void SAL_CALL PropertySetHelper::removePropertyChangeListener(const ::rtl::OUString&                                            sProperty,
 331                                                               const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener)
 332     throw(css::beans::UnknownPropertyException,
 333           css::lang::WrappedTargetException   ,
 334           css::uno::RuntimeException          )
 335 {
 336     TransactionGuard aTransaction(m_rTransactionManager, E_SOFTEXCEPTIONS);
 337
 338     // SAFE ->
 339     ReadGuard aReadLock(m_rLock);
 340
 341     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(sProperty);
 342     if (pIt == m_lProps.end())
 343         throw css::beans::UnknownPropertyException();
 344
 345     aReadLock.unlock();
 346     // <- SAFE
 347
 348     m_lSimpleChangeListener.removeInterface(sProperty, xListener);
 349 }
 350
 351 //-----------------------------------------------------------------------------
 352 void SAL_CALL PropertySetHelper::addVetoableChangeListener(const ::rtl::OUString&                                            sProperty,
 353                                                            const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
 354     throw(css::beans::UnknownPropertyException,
 355           css::lang::WrappedTargetException   ,
 356           css::uno::RuntimeException          )
 357 {
 358     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 359
 360     // SAFE ->
 361     ReadGuard aReadLock(m_rLock);
 362
 363     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(sProperty);
 364     if (pIt == m_lProps.end())
 365         throw css::beans::UnknownPropertyException();
 366
 367     aReadLock.unlock();
 368     // <- SAFE
 369
 370     m_lVetoChangeListener.addInterface(sProperty, xListener);
 371 }
 372
 373 //-----------------------------------------------------------------------------
 374 void SAL_CALL PropertySetHelper::removeVetoableChangeListener(const ::rtl::OUString&                                            sProperty,
 375                                                               const css::uno::Reference< css::beans::XVetoableChangeListener >& xListener)
 376     throw(css::beans::UnknownPropertyException,
 377           css::lang::WrappedTargetException   ,
 378           css::uno::RuntimeException          )
 379 {
 380     TransactionGuard aTransaction(m_rTransactionManager, E_SOFTEXCEPTIONS);
 381
 382     // SAFE ->
 383     ReadGuard aReadLock(m_rLock);
 384
 385     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(sProperty);
 386     if (pIt == m_lProps.end())
 387         throw css::beans::UnknownPropertyException();
 388
 389     aReadLock.unlock();
 390     // <- SAFE
 391
 392     m_lVetoChangeListener.removeInterface(sProperty, xListener);
 393 }
 394
 395 //-----------------------------------------------------------------------------
 396 css::uno::Sequence< css::beans::Property > SAL_CALL PropertySetHelper::getProperties()
 397     throw(css::uno::RuntimeException)
 398 {
 399     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 400
 401     // SAFE ->
 402     ReadGuard aReadLock(m_rLock);
 403
 404     sal_Int32                                        c     = (sal_Int32)m_lProps.size();
 405     css::uno::Sequence< css::beans::Property >       lProps(c);
 406     PropertySetHelper::TPropInfoHash::const_iterator pIt   ;
 407
 408     for (  pIt  = m_lProps.begin();
 409            pIt != m_lProps.end()  ;
 410          ++pIt                    )
 411     {
 412         lProps[--c] = pIt->second;
 413     }
 414
 415     return lProps;
 416     // <- SAFE
 417 }
 418
 419 //-----------------------------------------------------------------------------
 420 css::beans::Property SAL_CALL PropertySetHelper::getPropertyByName(const ::rtl::OUString& sName)
 421     throw(css::beans::UnknownPropertyException,
 422           css::uno::RuntimeException          )
 423 {
 424     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 425
 426     // SAFE ->
 427     ReadGuard aReadLock(m_rLock);
 428
 429     PropertySetHelper::TPropInfoHash::const_iterator pIt = m_lProps.find(sName);
 430     if (pIt == m_lProps.end())
 431         throw css::beans::UnknownPropertyException();
 432
 433     return pIt->second;
 434     // <- SAFE
 435 }
 436
 437 //-----------------------------------------------------------------------------
 438 sal_Bool SAL_CALL PropertySetHelper::hasPropertyByName(const ::rtl::OUString& sName)
 439     throw(css::uno::RuntimeException)
 440 {
 441     TransactionGuard aTransaction(m_rTransactionManager, E_HARDEXCEPTIONS);
 442
 443     // SAFE ->
 444     ReadGuard aReadLock(m_rLock);
 445
 446     PropertySetHelper::TPropInfoHash::iterator pIt    = m_lProps.find(sName);
 447     sal_Bool                                   bExist = (pIt != m_lProps.end());
 448
 449     return bExist;
 450     // <- SAFE
 451 }
 452
 453 } // namespace framework