comphelper/source/property/ChainablePropertySet.cxx

   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 #include <comphelper/ChainablePropertySet.hxx>
  21 #include <comphelper/ChainablePropertySetInfo.hxx>
  22 #include <osl/mutex.hxx>
  23
  24 #include <boost/scoped_ptr.hpp>
  25
  26
  27 using namespace ::rtl;
  28 using namespace ::comphelper;
  29 using namespace ::com::sun::star;
  30 using namespace ::com::sun::star::uno;
  31 using namespace ::com::sun::star::lang;
  32 using namespace ::com::sun::star::beans;
  33
  34 ChainablePropertySet::ChainablePropertySet( comphelper::ChainablePropertySetInfo* pInfo, osl::SolarMutex* pMutex )
  35     throw()
  36 : mpInfo ( pInfo )
  37 , mpMutex ( pMutex )
  38 , mxInfo ( pInfo )
  39 {
  40 }
  41
  42 ChainablePropertySet::~ChainablePropertySet()
  43     throw()
  44 {
  45 }
  46
  47 // XPropertySet
  48 Reference< XPropertySetInfo > SAL_CALL ChainablePropertySet::getPropertySetInfo(  )
  49     throw(RuntimeException)
  50 {
  51     return mxInfo;
  52 }
  53
  54 void SAL_CALL ChainablePropertySet::setPropertyValue( const ::rtl::OUString& rPropertyName, const Any& rValue )
  55     throw(UnknownPropertyException, PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
  56 {
  57     // acquire mutex in c-tor and releases it in the d-tor (exception safe!).
  58     boost::scoped_ptr< osl::SolarGuard > pMutexGuard;
  59     if (mpMutex)
  60         pMutexGuard.reset( new osl::SolarGuard(mpMutex) );
  61
  62     PropertyInfoHash::const_iterator aIter = mpInfo->maMap.find ( rPropertyName );
  63
  64     if( aIter == mpInfo->maMap.end())
  65         throw UnknownPropertyException( rPropertyName, static_cast< XPropertySet* >( this ) );
  66
  67     _preSetValues();
  68     _setSingleValue( *((*aIter).second), rValue );
  69     _postSetValues();
  70 }
  71
  72 Any SAL_CALL ChainablePropertySet::getPropertyValue( const ::rtl::OUString& rPropertyName )
  73     throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
  74 {
  75     // acquire mutex in c-tor and releases it in the d-tor (exception safe!).
  76     boost::scoped_ptr< osl::SolarGuard > pMutexGuard;
  77     if (mpMutex)
  78         pMutexGuard.reset( new osl::SolarGuard(mpMutex) );
  79
  80     PropertyInfoHash::const_iterator aIter = mpInfo->maMap.find ( rPropertyName );
  81
  82     if( aIter == mpInfo->maMap.end())
  83         throw UnknownPropertyException( rPropertyName, static_cast< XPropertySet* >( this ) );
  84
  85     Any aAny;
  86     _preGetValues ();
  87     _getSingleValue( *((*aIter).second), aAny );
  88     _postGetValues ();
  89
  90     return aAny;
  91 }
  92
  93 void SAL_CALL ChainablePropertySet::addPropertyChangeListener( const ::rtl::OUString&, const Reference< XPropertyChangeListener >& )
  94     throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
  95 {
  96     // todo
  97 }
  98
  99 void SAL_CALL ChainablePropertySet::removePropertyChangeListener( const ::rtl::OUString&, const Reference< XPropertyChangeListener >& )
 100     throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 101 {
 102     // todo
 103 }
 104
 105 void SAL_CALL ChainablePropertySet::addVetoableChangeListener( const ::rtl::OUString&, const Reference< XVetoableChangeListener >& )
 106     throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 107 {
 108     // todo
 109 }
 110
 111 void SAL_CALL ChainablePropertySet::removeVetoableChangeListener( const ::rtl::OUString&, const Reference< XVetoableChangeListener >& )
 112     throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 113 {
 114     // todo
 115 }
 116
 117 // XMultiPropertySet
 118 void SAL_CALL ChainablePropertySet::setPropertyValues( const Sequence< ::rtl::OUString >& aPropertyNames, const Sequence< Any >& aValues )
 119     throw(PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
 120 {
 121     // acquire mutex in c-tor and releases it in the d-tor (exception safe!).
 122     boost::scoped_ptr< osl::SolarGuard > pMutexGuard;
 123     if (mpMutex)
 124         pMutexGuard.reset( new osl::SolarGuard(mpMutex) );
 125
 126     const sal_Int32 nCount = aPropertyNames.getLength();
 127
 128     if( nCount != aValues.getLength() )
 129         throw IllegalArgumentException();
 130
 131     if( nCount )
 132     {
 133         _preSetValues();
 134
 135         const Any * pAny = aValues.getConstArray();
 136         const OUString * pString = aPropertyNames.getConstArray();
 137         PropertyInfoHash::const_iterator aEnd = mpInfo->maMap.end(), aIter;
 138
 139         for ( sal_Int32 i = 0; i < nCount; ++i, ++pString, ++pAny )
 140         {
 141             aIter = mpInfo->maMap.find ( *pString );
 142             if ( aIter == aEnd )
 143                 throw UnknownPropertyException( *pString, static_cast< XPropertySet* >( this ) );
 144
 145             _setSingleValue ( *((*aIter).second), *pAny );
 146         }
 147
 148         _postSetValues();
 149     }
 150 }
 151
 152 Sequence< Any > SAL_CALL ChainablePropertySet::getPropertyValues( const Sequence< ::rtl::OUString >& aPropertyNames )
 153     throw(RuntimeException)
 154 {
 155     // acquire mutex in c-tor and releases it in the d-tor (exception safe!).
 156     boost::scoped_ptr< osl::SolarGuard > pMutexGuard;
 157     if (mpMutex)
 158         pMutexGuard.reset( new osl::SolarGuard(mpMutex) );
 159
 160     const sal_Int32 nCount = aPropertyNames.getLength();
 161
 162     Sequence < Any > aValues ( nCount );
 163
 164     if( nCount )
 165     {
 166         _preGetValues();
 167
 168         Any * pAny = aValues.getArray();
 169         const OUString * pString = aPropertyNames.getConstArray();
 170         PropertyInfoHash::const_iterator aEnd = mpInfo->maMap.end(), aIter;
 171
 172         for ( sal_Int32 i = 0; i < nCount; ++i, ++pString, ++pAny )
 173         {
 174             aIter = mpInfo->maMap.find ( *pString );
 175             if ( aIter == aEnd )
 176                 throw UnknownPropertyException( *pString, static_cast< XPropertySet* >( this ) );
 177
 178             _getSingleValue ( *((*aIter).second), *pAny );
 179         }
 180
 181         _postGetValues();
 182     }
 183     return aValues;
 184 }
 185
 186 void SAL_CALL ChainablePropertySet::addPropertiesChangeListener( const Sequence< ::rtl::OUString >&, const Reference< XPropertiesChangeListener >& )
 187     throw(RuntimeException)
 188 {
 189     // todo
 190 }
 191
 192 void SAL_CALL ChainablePropertySet::removePropertiesChangeListener( const Reference< XPropertiesChangeListener >& )
 193     throw(RuntimeException)
 194 {
 195     // todo
 196 }
 197
 198 void SAL_CALL ChainablePropertySet::firePropertiesChangeEvent( const Sequence< ::rtl::OUString >&, const Reference< XPropertiesChangeListener >& )
 199     throw(RuntimeException)
 200 {
 201     // todo
 202 }
 203
 204 // XPropertyState
 205 PropertyState SAL_CALL ChainablePropertySet::getPropertyState( const ::rtl::OUString& PropertyName )
 206     throw(UnknownPropertyException, RuntimeException)
 207 {
 208     PropertyInfoHash::const_iterator aIter =  mpInfo->maMap.find( PropertyName );
 209     if( aIter == mpInfo->maMap.end())
 210         throw UnknownPropertyException( PropertyName, static_cast< XPropertySet* >( this ) );
 211
 212     PropertyState aState;
 213
 214     _preGetPropertyState();
 215     _getPropertyState( *((*aIter).second), aState );
 216     _postGetPropertyState();
 217
 218     return aState;
 219 }
 220
 221 Sequence< PropertyState > SAL_CALL ChainablePropertySet::getPropertyStates( const Sequence< ::rtl::OUString >& rPropertyNames )
 222     throw(UnknownPropertyException, RuntimeException)
 223 {
 224     const sal_Int32 nCount = rPropertyNames.getLength();
 225
 226     Sequence< PropertyState > aStates( nCount );
 227     if( nCount )
 228     {
 229         PropertyState * pState = aStates.getArray();
 230         const OUString * pString = rPropertyNames.getConstArray();
 231         PropertyInfoHash::const_iterator aEnd = mpInfo->maMap.end(), aIter;
 232         _preGetPropertyState();
 233
 234         for ( sal_Int32 i = 0; i < nCount; ++i, ++pString, ++pState )
 235         {
 236             aIter = mpInfo->maMap.find ( *pString );
 237             if ( aIter == aEnd )
 238                 throw UnknownPropertyException( *pString, static_cast< XPropertySet* >( this ) );
 239
 240             _getPropertyState ( *((*aIter).second), *pState );
 241         }
 242         _postGetPropertyState();
 243     }
 244     return aStates;
 245 }
 246
 247 void SAL_CALL ChainablePropertySet::setPropertyToDefault( const ::rtl::OUString& rPropertyName )
 248     throw(UnknownPropertyException, RuntimeException)
 249 {
 250     PropertyInfoHash::const_iterator aIter = mpInfo->maMap.find ( rPropertyName );
 251
 252     if( aIter == mpInfo->maMap.end())
 253         throw UnknownPropertyException( rPropertyName, static_cast< XPropertySet* >( this ) );
 254     _setPropertyToDefault( *((*aIter).second) );
 255 }
 256
 257 Any SAL_CALL ChainablePropertySet::getPropertyDefault( const ::rtl::OUString& rPropertyName )
 258     throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 259 {
 260     PropertyInfoHash::const_iterator aIter = mpInfo->maMap.find ( rPropertyName );
 261
 262     if( aIter == mpInfo->maMap.end())
 263         throw UnknownPropertyException( rPropertyName, static_cast< XPropertySet* >( this ) );
 264     return _getPropertyDefault( *((*aIter).second) );
 265 }
 266
 267 void ChainablePropertySet::_preGetPropertyState ()
 268     throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException )
 269 {
 270     OSL_FAIL( "you have to implement this yourself!");
 271 }
 272
 273 void ChainablePropertySet::_getPropertyState( const comphelper::PropertyInfo&, PropertyState& )
 274     throw(UnknownPropertyException )
 275 {
 276     OSL_FAIL( "you have to implement this yourself!");
 277 }
 278
 279 void ChainablePropertySet::_postGetPropertyState ()
 280     throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException )
 281 {
 282     OSL_FAIL( "you have to implement this yourself!");
 283 }
 284
 285 void ChainablePropertySet::_setPropertyToDefault( const comphelper::PropertyInfo& )
 286     throw(UnknownPropertyException )
 287 {
 288     OSL_FAIL( "you have to implement this yourself!");
 289 }
 290
 291 Any ChainablePropertySet::_getPropertyDefault( const comphelper::PropertyInfo& )
 292     throw(UnknownPropertyException, WrappedTargetException )
 293 {
 294     OSL_FAIL( "you have to implement this yourself!");
 295
 296     Any aAny;
 297     return aAny;
 298 }
 299
 300 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */