framework/source/uielement/constitemcontainer.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: constitemcontainer.cxx,v $
  10  * $Revision: 1.9 $
  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 //      my own includes
  35 //_________________________________________________________________________________________________________________
  36 #include <uielement/constitemcontainer.hxx>
  37 #include <uielement/rootitemcontainer.hxx>
  38 #include <uielement/itemcontainer.hxx>
  39 #include <threadhelp/resetableguard.hxx>
  40
  41 //_________________________________________________________________________________________________________________
  42 //      interface includes
  43 //_________________________________________________________________________________________________________________
  44 #include <com/sun/star/beans/PropertyAttribute.hpp>
  45
  46 //_________________________________________________________________________________________________________________
  47 //      other includes
  48 //_________________________________________________________________________________________________________________
  49 #include <cppuhelper/implbase1.hxx>
  50
  51 using namespace cppu;
  52 using namespace com::sun::star::uno;
  53 using namespace com::sun::star::lang;
  54 using namespace com::sun::star::beans;
  55 using namespace com::sun::star::container;
  56
  57 const char WRONG_TYPE_EXCEPTION[] = "Type must be com::sun::star::uno::Sequence< com::sun::star::beans::PropertyValue >";
  58
  59 const int PROPHANDLE_UINAME     = 1;
  60 const int PROPCOUNT             = 1;
  61 const rtl::OUString PROPNAME_UINAME( RTL_CONSTASCII_USTRINGPARAM( "UIName" ));
  62
  63 namespace framework
  64 {
  65
  66 /**
  67  * The class which implements the PropertySetInfo interface.
  68  */
  69 extern "C"
  70 {
  71 static int SAL_CALL compare_OUString_Property_Impl( const void *arg1, const void *arg2 ) SAL_THROW( () )
  72 {
  73    return ((::rtl::OUString *)arg1)->compareTo( ((Property *)arg2)->Name );
  74 }
  75 }
  76
  77 class OPropertySetHelperInfo_Impl
  78     : public WeakImplHelper1< ::com::sun::star::beans::XPropertySetInfo >
  79 {
  80     Sequence < Property > aInfos;
  81
  82 public:
  83     OPropertySetHelperInfo_Impl( IPropertyArrayHelper & rHelper_ ) SAL_THROW( () );
  84
  85     // XPropertySetInfo-Methoden
  86     virtual Sequence< Property > SAL_CALL getProperties(void) throw(::com::sun::star::uno::RuntimeException);
  87     virtual Property SAL_CALL getPropertyByName(const ::rtl::OUString& PropertyName) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  88     virtual sal_Bool SAL_CALL hasPropertyByName(const ::rtl::OUString& PropertyName) throw(::com::sun::star::uno::RuntimeException);
  89 };
  90
  91
  92 /**
  93  * Create an object that implements XPropertySetInfo IPropertyArrayHelper.
  94  */
  95 OPropertySetHelperInfo_Impl::OPropertySetHelperInfo_Impl(
  96     IPropertyArrayHelper & rHelper_ )
  97     SAL_THROW( () )
  98     :aInfos( rHelper_.getProperties() )
  99 {
 100 }
 101
 102 /**
 103  * Return the sequence of properties, which are provided throug the constructor.
 104  */
 105 Sequence< Property > OPropertySetHelperInfo_Impl::getProperties(void) throw(::com::sun::star::uno::RuntimeException)
 106 {
 107     return aInfos;
 108 }
 109
 110 /**
 111  * Return the sequence of properties, which are provided throug the constructor.
 112  */
 113 Property OPropertySetHelperInfo_Impl::getPropertyByName( const ::rtl::OUString & PropertyName ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException)
 114 {
 115     Property * pR;
 116     pR = (Property *)bsearch( &PropertyName, aInfos.getConstArray(), aInfos.getLength(),
 117                               sizeof( Property ),
 118                               compare_OUString_Property_Impl );
 119     if( !pR ) {
 120         throw UnknownPropertyException();
 121     }
 122
 123     return *pR;
 124 }
 125
 126 /**
 127  * Return the sequence of properties, which are provided throug the constructor.
 128  */
 129 sal_Bool OPropertySetHelperInfo_Impl::hasPropertyByName( const ::rtl::OUString & PropertyName ) throw(::com::sun::star::uno::RuntimeException)
 130 {
 131     Property * pR;
 132     pR = (Property *)bsearch( &PropertyName, aInfos.getConstArray(), aInfos.getLength(),
 133                               sizeof( Property ),
 134                               compare_OUString_Property_Impl );
 135     return pR != NULL;
 136 }
 137
 138 //*****************************************************************************************************************
 139 //      XInterface, XTypeProvider
 140 //*****************************************************************************************************************
 141 DEFINE_XINTERFACE_6     (   ConstItemContainer                                              ,
 142                             OWeakObject                                                     ,
 143                             DIRECT_INTERFACE( ::com::sun::star::lang::XTypeProvider         ),
 144                             DIRECT_INTERFACE( ::com::sun::star::container::XElementAccess   ),
 145                             DIRECT_INTERFACE( ::com::sun::star::container::XIndexAccess     ),
 146                             DIRECT_INTERFACE( ::com::sun::star::beans::XFastPropertySet         ),
 147                             DIRECT_INTERFACE( ::com::sun::star::beans::XPropertySet                 ),
 148                             DIRECT_INTERFACE( ::com::sun::star::lang::XUnoTunnel            )
 149                         )
 150
 151 DEFINE_XTYPEPROVIDER_6  (   ConstItemContainer                          ,
 152                             ::com::sun::star::lang::XTypeProvider       ,
 153                             ::com::sun::star::container::XIndexAccess   ,
 154                             ::com::sun::star::container::XElementAccess ,
 155                             ::com::sun::star::beans::XFastPropertySet   ,
 156                             ::com::sun::star::beans::XPropertySet       ,
 157                             ::com::sun::star::lang::XUnoTunnel
 158                         )
 159
 160 ConstItemContainer::ConstItemContainer() : ::cppu::OWeakObject()
 161 {
 162 }
 163
 164 ConstItemContainer::ConstItemContainer( const RootItemContainer& rRootItemContainer, sal_Bool bFastCopy )
 165 {
 166     ShareGuard( rRootItemContainer.m_aShareMutex );
 167
 168     // If bFastCopy is set the onwer of the root item container will transfer ownership to us. So
 169     // it is possible to copy only the root part.
 170     m_aUIName = rRootItemContainer.m_aUIName;
 171     if ( bFastCopy )
 172         m_aItemVector = rRootItemContainer.m_aItemVector;
 173     else
 174         copyItemContainer( rRootItemContainer.m_aItemVector );
 175 }
 176
 177 ConstItemContainer::ConstItemContainer( const ItemContainer& rItemContainer )
 178 {
 179     ShareGuard( rItemContainer.m_aShareMutex );
 180     copyItemContainer( rItemContainer.m_aItemVector );
 181 }
 182
 183 ConstItemContainer::ConstItemContainer( const Reference< XIndexAccess >& rSourceContainer, sal_Bool bFastCopy )
 184 {
 185     // We also have to copy the UIName property
 186     try
 187     {
 188         Reference< XPropertySet > xPropSet( rSourceContainer, UNO_QUERY );
 189         if ( xPropSet.is() )
 190         {
 191             rtl::OUString aUIName;
 192             xPropSet->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "UIName" ))) >>= m_aUIName;
 193         }
 194     }
 195     catch ( Exception& )
 196     {
 197     }
 198
 199     if ( rSourceContainer.is() )
 200     {
 201         try
 202         {
 203             sal_Int32 nCount = rSourceContainer->getCount();
 204             m_aItemVector.reserve(nCount);
 205             if ( bFastCopy )
 206             {
 207                 for ( sal_Int32 i = 0; i < nCount; i++ )
 208                 {
 209                     Sequence< PropertyValue > aPropSeq;
 210                     if ( rSourceContainer->getByIndex( i ) >>= aPropSeq )
 211                         m_aItemVector.push_back( aPropSeq );
 212                 }
 213             }
 214             else
 215             {
 216                 for ( sal_Int32 i = 0; i < nCount; i++ )
 217                 {
 218                     Sequence< PropertyValue > aPropSeq;
 219                     if ( rSourceContainer->getByIndex( i ) >>= aPropSeq )
 220                     {
 221                         sal_Int32 nContainerIndex = -1;
 222                         Reference< XIndexAccess > xIndexAccess;
 223                         for ( sal_Int32 j = 0; j < aPropSeq.getLength(); j++ )
 224                         {
 225                             if ( aPropSeq[j].Name.equalsAscii( "ItemDescriptorContainer" ))
 226                             {
 227                                 aPropSeq[j].Value >>= xIndexAccess;
 228                                 nContainerIndex = j;
 229                                 break;
 230                             }
 231                         }
 232
 233                         if ( xIndexAccess.is() && nContainerIndex >= 0 )
 234                             aPropSeq[nContainerIndex].Value <<= deepCopyContainer( xIndexAccess );
 235
 236                         m_aItemVector.push_back( aPropSeq );
 237                     }
 238                 }
 239             }
 240         }
 241         catch ( IndexOutOfBoundsException& )
 242         {
 243         }
 244     }
 245 }
 246
 247 ConstItemContainer::~ConstItemContainer()
 248 {
 249 }
 250
 251 // private
 252 void ConstItemContainer::copyItemContainer( const std::vector< Sequence< PropertyValue > >& rSourceVector )
 253 {
 254     const sal_uInt32 nCount = rSourceVector.size();
 255     for ( sal_uInt32 i = 0; i < nCount; i++ )
 256     {
 257         sal_Int32 nContainerIndex = -1;
 258         Sequence< PropertyValue > aPropSeq( rSourceVector[i] );
 259         Reference< XIndexAccess > xIndexAccess;
 260         for ( sal_Int32 j = 0; j < aPropSeq.getLength(); j++ )
 261         {
 262             if ( aPropSeq[j].Name.equalsAscii( "ItemDescriptorContainer" ))
 263             {
 264                 aPropSeq[j].Value >>= xIndexAccess;
 265                 nContainerIndex = j;
 266                 break;
 267             }
 268         }
 269
 270         if ( xIndexAccess.is() && nContainerIndex >= 0 )
 271             aPropSeq[nContainerIndex].Value <<= deepCopyContainer( xIndexAccess );
 272
 273         m_aItemVector.push_back( aPropSeq );
 274     }
 275 }
 276
 277 Reference< XIndexAccess > ConstItemContainer::deepCopyContainer( const Reference< XIndexAccess >& rSubContainer )
 278 {
 279     Reference< XIndexAccess > xReturn;
 280     if ( rSubContainer.is() )
 281     {
 282         ItemContainer*      pSource = ItemContainer::GetImplementation( rSubContainer );
 283         ConstItemContainer* pSubContainer( 0 );
 284         if ( pSource )
 285             pSubContainer = new ConstItemContainer( *pSource );
 286         else
 287             pSubContainer = new ConstItemContainer( rSubContainer );
 288         xReturn = Reference< XIndexAccess >( static_cast< OWeakObject* >( pSubContainer ), UNO_QUERY );
 289     }
 290
 291     return xReturn;
 292 }
 293
 294 // XUnoTunnel
 295 sal_Int64 ConstItemContainer::getSomething( const ::com::sun::star::uno::Sequence< sal_Int8 >& rIdentifier ) throw(::com::sun::star::uno::RuntimeException)
 296 {
 297     if( ( rIdentifier.getLength() == 16 ) && ( 0 == rtl_compareMemory( ConstItemContainer::GetUnoTunnelId().getConstArray(), rIdentifier.getConstArray(), 16 ) ) )
 298     {
 299         return reinterpret_cast< sal_Int64 >( this );
 300     }
 301     return 0;
 302 }
 303
 304 const Sequence< sal_Int8 >& ConstItemContainer::GetUnoTunnelId() throw()
 305 {
 306     static ::com::sun::star::uno::Sequence< sal_Int8 > * pSeq = NULL;
 307     if( !pSeq )
 308     {
 309         ::osl::Guard< ::osl::Mutex > aGuard( ::osl::Mutex::getGlobalMutex() );
 310         if( !pSeq )
 311         {
 312             static ::com::sun::star::uno::Sequence< sal_Int8 > aSeq( 16 );
 313             rtl_createUuid( (sal_uInt8*)aSeq.getArray(), 0, sal_True );
 314             pSeq = &aSeq;
 315         }
 316     }
 317     return *pSeq;
 318 }
 319
 320 ConstItemContainer* ConstItemContainer::GetImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& rxIFace ) throw()
 321 {
 322     ::com::sun::star::uno::Reference< ::com::sun::star::lang::XUnoTunnel > xUT( rxIFace, ::com::sun::star::uno::UNO_QUERY );
 323     return xUT.is() ? reinterpret_cast< ConstItemContainer* >(sal::static_int_cast< sal_IntPtr >(
 324                           xUT->getSomething( ConstItemContainer::GetUnoTunnelId() ))) : NULL;
 325 }
 326
 327 // XElementAccess
 328 sal_Bool SAL_CALL ConstItemContainer::hasElements()
 329 throw ( RuntimeException )
 330 {
 331     return ( !m_aItemVector.empty() );
 332 }
 333
 334 // XIndexAccess
 335 sal_Int32 SAL_CALL ConstItemContainer::getCount()
 336 throw ( RuntimeException )
 337 {
 338     return m_aItemVector.size();
 339 }
 340
 341 Any SAL_CALL ConstItemContainer::getByIndex( sal_Int32 Index )
 342 throw ( IndexOutOfBoundsException, WrappedTargetException, RuntimeException )
 343 {
 344     if ( sal_Int32( m_aItemVector.size()) > Index )
 345         return makeAny( m_aItemVector[Index] );
 346     else
 347         throw IndexOutOfBoundsException( ::rtl::OUString(), (OWeakObject *)this );
 348 }
 349
 350 // XPropertySet
 351 Reference< XPropertySetInfo > SAL_CALL ConstItemContainer::getPropertySetInfo()
 352 throw (::com::sun::star::uno::RuntimeException)
 353 {
 354     // Optimize this method !
 355     // We initialize a static variable only one time. And we don't must use a mutex at every call!
 356     // For the first call; pInfo is NULL - for the second call pInfo is different from NULL!
 357     static Reference< XPropertySetInfo >* pInfo = NULL;
 358
 359     if( pInfo == NULL )
 360     {
 361         // Ready for multithreading
 362         osl::MutexGuard aGuard( osl::Mutex::getGlobalMutex() ) ;
 363         // Control this pointer again, another instance can be faster then these!
 364         if( pInfo == NULL )
 365         {
 366             // Create structure of propertysetinfo for baseclass "OPropertySetHelper".
 367             // (Use method "getInfoHelper()".)
 368             static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 369             pInfo = &xInfo;
 370         }
 371     }
 372
 373     return (*pInfo);
 374 }
 375
 376 void SAL_CALL ConstItemContainer::setPropertyValue( const ::rtl::OUString&, const Any& )
 377 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 378 {
 379 }
 380
 381 Any SAL_CALL ConstItemContainer::getPropertyValue( const ::rtl::OUString& PropertyName )
 382 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 383 {
 384     if ( PropertyName.equals( PROPNAME_UINAME ))
 385         return makeAny( m_aUIName );
 386
 387     throw UnknownPropertyException();
 388 }
 389
 390 void SAL_CALL ConstItemContainer::addPropertyChangeListener( const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& )
 391 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 392 {
 393 }
 394
 395 void SAL_CALL ConstItemContainer::removePropertyChangeListener( const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& )
 396 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 397 {
 398     // Only read-only properties - do nothing
 399 }
 400
 401 void SAL_CALL ConstItemContainer::addVetoableChangeListener( const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& )
 402 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 403 {
 404     // Only read-only properties - do nothing
 405 }
 406
 407 void SAL_CALL ConstItemContainer::removeVetoableChangeListener( const ::rtl::OUString&, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& )
 408 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 409 {
 410     // Only read-only properties - do nothing
 411 }
 412
 413 // XFastPropertySet
 414 void SAL_CALL ConstItemContainer::setFastPropertyValue( sal_Int32, const ::com::sun::star::uno::Any& )
 415 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 416 {
 417 }
 418
 419 Any SAL_CALL ConstItemContainer::getFastPropertyValue( sal_Int32 nHandle )
 420 throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException)
 421 {
 422     if ( nHandle == PROPHANDLE_UINAME )
 423         return makeAny( m_aUIName );
 424
 425     throw UnknownPropertyException();
 426 }
 427
 428 ::cppu::IPropertyArrayHelper& SAL_CALL ConstItemContainer::getInfoHelper()
 429 {
 430     // Optimize this method !
 431     // We initialize a static variable only one time. And we don't must use a mutex at every call!
 432     // For the first call; pInfoHelper is NULL - for the second call pInfoHelper is different from NULL!
 433     static ::cppu::OPropertyArrayHelper* pInfoHelper = NULL;
 434
 435     if( pInfoHelper == NULL )
 436     {
 437         // Ready for multithreading
 438         osl::MutexGuard aGuard( osl::Mutex::getGlobalMutex() ) ;
 439
 440         // Control this pointer again, another instance can be faster then these!
 441         if( pInfoHelper == NULL )
 442         {
 443             // Define static member to give structure of properties to baseclass "OPropertySetHelper".
 444             // "impl_getStaticPropertyDescriptor" is a non exported and static funtion, who will define a static propertytable.
 445             // "sal_True" say: Table is sorted by name.
 446             static ::cppu::OPropertyArrayHelper aInfoHelper( impl_getStaticPropertyDescriptor(), sal_True );
 447             pInfoHelper = &aInfoHelper;
 448         }
 449     }
 450
 451     return(*pInfoHelper);
 452 }
 453
 454 const com::sun::star::uno::Sequence< com::sun::star::beans::Property > ConstItemContainer::impl_getStaticPropertyDescriptor()
 455 {
 456     // Create a new static property array to initialize sequence!
 457     // Table of all predefined properties of this class. Its used from OPropertySetHelper-class!
 458     // Don't forget to change the defines (see begin of this file), if you add, change or delete a property in this list!!!
 459     // It's necessary for methods of OPropertySetHelper.
 460     // ATTENTION:
 461     //      YOU MUST SORT FOLLOW TABLE BY NAME ALPHABETICAL !!!
 462
 463     static const com::sun::star::beans::Property pProperties[] =
 464     {
 465         com::sun::star::beans::Property( PROPNAME_UINAME, PROPHANDLE_UINAME ,
 466                                          ::getCppuType((const rtl::OUString*)NULL),
 467                                          com::sun::star::beans::PropertyAttribute::TRANSIENT | com::sun::star::beans::PropertyAttribute::READONLY  )
 468     };
 469     // Use it to initialize sequence!
 470     static const com::sun::star::uno::Sequence< com::sun::star::beans::Property > lPropertyDescriptor( pProperties, PROPCOUNT );
 471     // Return static "PropertyDescriptor"
 472     return lPropertyDescriptor;
 473 }
 474
 475 Reference < XPropertySetInfo > ConstItemContainer::createPropertySetInfo(
 476     IPropertyArrayHelper & rProperties ) SAL_THROW( () )
 477 {
 478     return static_cast< XPropertySetInfo * >( new OPropertySetHelperInfo_Impl( rProperties ) );
 479 }
 480
 481 } // namespace framework
 482