comphelper/source/property/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.12 $
  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_comphelper.hxx"
  33
  34 #include "comphelper/propertysetinfo.hxx"
  35 #include "comphelper/propertysethelper.hxx"
  36
  37 ///////////////////////////////////////////////////////////////////////
  38
  39 using namespace ::rtl;
  40 using namespace ::comphelper;
  41 using namespace ::com::sun::star;
  42 using namespace ::com::sun::star::uno;
  43 using namespace ::com::sun::star::beans;
  44 using namespace ::com::sun::star::lang;
  45
  46 namespace comphelper
  47 {
  48 class PropertySetHelperImpl
  49 {
  50 public:
  51     PropertyMapEntry* find( const OUString& aName ) const throw();
  52
  53     PropertySetInfo* mpInfo;
  54 };
  55 }
  56
  57 PropertyMapEntry* PropertySetHelperImpl::find( const OUString& aName ) const throw()
  58 {
  59     PropertyMap::const_iterator aIter = mpInfo->getPropertyMap()->find( aName );
  60
  61     if( mpInfo->getPropertyMap()->end() != aIter )
  62     {
  63         return (*aIter).second;
  64     }
  65     else
  66     {
  67         return NULL;
  68     }
  69 }
  70
  71 ///////////////////////////////////////////////////////////////////////
  72
  73 PropertySetHelper::PropertySetHelper( )
  74 {
  75     mp = new PropertySetHelperImpl;
  76     mp->mpInfo = new PropertySetInfo;
  77     mp->mpInfo->acquire();
  78 }
  79
  80 PropertySetHelper::PropertySetHelper( comphelper::PropertySetInfo* pInfo ) throw()
  81 {
  82     mp = new PropertySetHelperImpl;
  83     mp->mpInfo = pInfo;
  84     pInfo->acquire();
  85 }
  86
  87 PropertySetHelper::PropertySetHelper( comphelper::PropertySetInfo* pInfo, __sal_NoAcquire ) throw()
  88 {
  89     mp = new PropertySetHelperImpl;
  90     mp->mpInfo = pInfo;
  91 }
  92
  93 PropertySetHelper::~PropertySetHelper() throw()
  94 {
  95     mp->mpInfo->release();
  96     delete mp;
  97 }
  98
  99 void PropertySetHelper::setInfo( comphelper::PropertySetInfo* pInfo ) throw()
 100 {
 101     OSL_ENSURE( pInfo != NULL, "need pInfo" );
 102     OSL_ENSURE( mp->mpInfo != NULL, "where's the old pInfo?" );
 103
 104     mp->mpInfo->release();
 105     mp->mpInfo = pInfo;
 106     mp->mpInfo->acquire();
 107 }
 108
 109 // XPropertySet
 110 Reference< XPropertySetInfo > SAL_CALL PropertySetHelper::getPropertySetInfo(  ) throw(RuntimeException)
 111 {
 112     return mp->mpInfo;
 113 }
 114
 115 void SAL_CALL PropertySetHelper::setPropertyValue( const ::rtl::OUString& aPropertyName, const Any& aValue ) throw(UnknownPropertyException, PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
 116 {
 117     PropertyMapEntry* aEntries[2];
 118     aEntries[0] = mp->find( aPropertyName );
 119
 120     if( NULL == aEntries[0] )
 121         throw UnknownPropertyException( aPropertyName, static_cast< XPropertySet* >( this ) );
 122
 123     aEntries[1] = NULL;
 124
 125     _setPropertyValues( (const PropertyMapEntry**)aEntries, &aValue );
 126 }
 127
 128 Any SAL_CALL PropertySetHelper::getPropertyValue( const ::rtl::OUString& PropertyName ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 129 {
 130     PropertyMapEntry* aEntries[2];
 131     aEntries[0] = mp->find( PropertyName );
 132
 133     if( NULL == aEntries[0] )
 134         throw UnknownPropertyException( PropertyName, static_cast< XPropertySet* >( this ) );
 135
 136     aEntries[1] = NULL;
 137
 138     Any aAny;
 139     _getPropertyValues( (const PropertyMapEntry**)aEntries, &aAny );
 140
 141     return aAny;
 142 }
 143
 144 void SAL_CALL PropertySetHelper::addPropertyChangeListener( const ::rtl::OUString&, const Reference< XPropertyChangeListener >& ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 145 {
 146     // todo
 147 }
 148
 149 void SAL_CALL PropertySetHelper::removePropertyChangeListener( const ::rtl::OUString&, const Reference< XPropertyChangeListener >& ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 150 {
 151     // todo
 152 }
 153
 154 void SAL_CALL PropertySetHelper::addVetoableChangeListener( const ::rtl::OUString&, const Reference< XVetoableChangeListener >& ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 155 {
 156     // todo
 157 }
 158
 159 void SAL_CALL PropertySetHelper::removeVetoableChangeListener( const ::rtl::OUString&, const Reference< XVetoableChangeListener >& ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 160 {
 161     // todo
 162 }
 163
 164 // XMultiPropertySet
 165 void SAL_CALL PropertySetHelper::setPropertyValues( const Sequence< ::rtl::OUString >& aPropertyNames, const Sequence< Any >& aValues ) throw(PropertyVetoException, IllegalArgumentException, WrappedTargetException, RuntimeException)
 166 {
 167     const sal_Int32 nCount = aPropertyNames.getLength();
 168
 169     if( nCount != aValues.getLength() )
 170         throw IllegalArgumentException();
 171
 172     if( nCount )
 173     {
 174         PropertyMapEntry** pEntries = new PropertyMapEntry*[nCount+1];
 175         pEntries[nCount] = NULL;
 176         const OUString* pNames = aPropertyNames.getConstArray();
 177
 178         sal_Bool bUnknown = sal_False;
 179         sal_Int32 n;
 180         for( n = 0; !bUnknown && ( n < nCount ); n++, pNames++ )
 181         {
 182             pEntries[n] = mp->find( *pNames );
 183             bUnknown = NULL == pEntries[n];
 184         }
 185
 186         if( !bUnknown )
 187             _setPropertyValues( (const PropertyMapEntry**)pEntries, aValues.getConstArray() );
 188
 189         delete[] pEntries;
 190
 191         if( bUnknown )
 192             throw UnknownPropertyException( *pNames, static_cast< XPropertySet* >( this ) );
 193     }
 194 }
 195
 196 Sequence< Any > SAL_CALL PropertySetHelper::getPropertyValues( const Sequence< ::rtl::OUString >& aPropertyNames ) throw(RuntimeException)
 197 {
 198     const sal_Int32 nCount = aPropertyNames.getLength();
 199
 200     Sequence< Any > aValues;
 201     if( nCount )
 202     {
 203         PropertyMapEntry** pEntries = new PropertyMapEntry*[nCount+1];
 204         pEntries[nCount] = NULL;
 205         const OUString* pNames = aPropertyNames.getConstArray();
 206
 207         sal_Bool bUnknown = sal_False;
 208         sal_Int32 n;
 209         for( n = 0; !bUnknown && ( n < nCount ); n++, pNames++ )
 210         {
 211             pEntries[n] = mp->find( *pNames );
 212             bUnknown = NULL == pEntries[n];
 213         }
 214
 215         if( !bUnknown )
 216         {
 217             aValues.realloc(nCount);
 218             _getPropertyValues( (const PropertyMapEntry**)pEntries, aValues.getArray() );
 219         }
 220
 221         delete[] pEntries;
 222
 223         if( bUnknown )
 224             throw UnknownPropertyException( *pNames, static_cast< XPropertySet* >( this ) );
 225     }
 226
 227     return aValues;
 228 }
 229
 230 void SAL_CALL PropertySetHelper::addPropertiesChangeListener( const Sequence< ::rtl::OUString >&, const Reference< XPropertiesChangeListener >& ) throw(RuntimeException)
 231 {
 232     // todo
 233 }
 234
 235 void SAL_CALL PropertySetHelper::removePropertiesChangeListener( const Reference< XPropertiesChangeListener >& ) throw(RuntimeException)
 236 {
 237     // todo
 238 }
 239
 240 void SAL_CALL PropertySetHelper::firePropertiesChangeEvent( const Sequence< ::rtl::OUString >&, const Reference< XPropertiesChangeListener >& ) throw(RuntimeException)
 241 {
 242     // todo
 243 }
 244
 245 // XPropertyState
 246 PropertyState SAL_CALL PropertySetHelper::getPropertyState( const ::rtl::OUString& PropertyName ) throw(UnknownPropertyException, RuntimeException)
 247 {
 248     PropertyMapEntry* aEntries[2];
 249
 250     aEntries[0] = mp->find( PropertyName );
 251     if( aEntries[0] == NULL )
 252         throw UnknownPropertyException( PropertyName, static_cast< XPropertySet* >( this ) );
 253
 254     aEntries[1] = NULL;
 255
 256     PropertyState aState;
 257     _getPropertyStates( (const PropertyMapEntry**)aEntries, &aState );
 258
 259     return aState;
 260 }
 261
 262 Sequence< PropertyState > SAL_CALL PropertySetHelper::getPropertyStates( const Sequence< ::rtl::OUString >& aPropertyName ) throw(UnknownPropertyException, RuntimeException)
 263 {
 264     const sal_Int32 nCount = aPropertyName.getLength();
 265
 266     Sequence< PropertyState > aStates( nCount );
 267
 268     if( nCount )
 269     {
 270         const OUString* pNames = aPropertyName.getConstArray();
 271
 272         sal_Bool bUnknown = sal_False;
 273
 274         PropertyMapEntry** pEntries = new PropertyMapEntry*[nCount+1];
 275
 276         sal_Int32 n;
 277         for( n = 0; !bUnknown && (n < nCount); n++, pNames++ )
 278         {
 279             pEntries[n] = mp->find( *pNames );
 280             bUnknown = NULL == pEntries[n];
 281         }
 282
 283         pEntries[nCount] = NULL;
 284
 285         if( !bUnknown )
 286             _getPropertyStates( (const PropertyMapEntry**)pEntries, aStates.getArray() );
 287
 288         delete[] pEntries;
 289
 290         if( bUnknown )
 291             throw UnknownPropertyException( *pNames, static_cast< XPropertySet* >( this ) );
 292     }
 293
 294     return aStates;
 295 }
 296
 297 void SAL_CALL PropertySetHelper::setPropertyToDefault( const ::rtl::OUString& PropertyName ) throw(UnknownPropertyException, RuntimeException)
 298 {
 299     PropertyMapEntry *pEntry  = mp->find( PropertyName );
 300     if( NULL == pEntry )
 301         throw UnknownPropertyException( PropertyName, static_cast< XPropertySet* >( this ) );
 302
 303     _setPropertyToDefault( pEntry );
 304 }
 305
 306 Any SAL_CALL PropertySetHelper::getPropertyDefault( const ::rtl::OUString& aPropertyName ) throw(UnknownPropertyException, WrappedTargetException, RuntimeException)
 307 {
 308     PropertyMapEntry* pEntry = mp->find( aPropertyName );
 309     if( NULL == pEntry )
 310         throw UnknownPropertyException( aPropertyName, static_cast< XPropertySet* >( this ) );
 311
 312     return _getPropertyDefault( pEntry );
 313 }
 314
 315 void PropertySetHelper::_getPropertyStates( const comphelper::PropertyMapEntry**, PropertyState* ) throw(UnknownPropertyException )
 316 {
 317     OSL_ENSURE( sal_False, "you have to implement this yourself!");
 318 }
 319
 320 void PropertySetHelper::_setPropertyToDefault( const comphelper::PropertyMapEntry* )  throw(UnknownPropertyException )
 321 {
 322     OSL_ENSURE( sal_False, "you have to implement this yourself!");
 323 }
 324
 325 Any PropertySetHelper::_getPropertyDefault( const comphelper::PropertyMapEntry* ) throw(UnknownPropertyException, WrappedTargetException )
 326 {
 327     OSL_ENSURE( sal_False, "you have to implement this yourself!");
 328
 329     Any aAny;
 330     return aAny;
 331 }