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