cppuhelper/source/implbase.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 // MARKER(update_precomp.py): autogen include statement, do not remove
  30 #include "precompiled_cppuhelper.hxx"
  31 #include <cppuhelper/implbase.hxx>
  32 #include <cppuhelper/compbase.hxx>
  33 #include <osl/diagnose.h>
  34 #include <rtl/uuid.h>
  35
  36 #include <com/sun/star/lang/XComponent.hpp>
  37 #include "com/sun/star/uno/RuntimeException.hpp"
  38
  39 using namespace ::osl;
  40 using namespace ::rtl;
  41 using namespace ::com::sun::star;
  42 using namespace ::com::sun::star::uno;
  43
  44 namespace cppu
  45 {
  46 //==================================================================================================
  47 Mutex & SAL_CALL getImplHelperInitMutex(void) SAL_THROW( () )
  48 {
  49     static Mutex * s_pMutex = 0;
  50     if (! s_pMutex)
  51     {
  52         MutexGuard aGuard( Mutex::getGlobalMutex() );
  53         if (! s_pMutex)
  54         {
  55             static Mutex s_aMutex;
  56             s_pMutex = & s_aMutex;
  57         }
  58     }
  59     return * s_pMutex;
  60 }
  61
  62 // ClassDataBase
  63 //__________________________________________________________________________________________________
  64 ClassDataBase::ClassDataBase() SAL_THROW( () )
  65     : bOffsetsInit( sal_False )
  66     , nType2Offset( 0 )
  67     , nClassCode( 0 )
  68     , pTypes( 0 )
  69     , pId( 0 )
  70 {
  71 }
  72 //__________________________________________________________________________________________________
  73 ClassDataBase::ClassDataBase( sal_Int32 nClassCode_ ) SAL_THROW( () )
  74     : bOffsetsInit( sal_False )
  75     , nType2Offset( 0 )
  76     , nClassCode( nClassCode_ )
  77     , pTypes( 0 )
  78     , pId( 0 )
  79 {
  80 }
  81 //__________________________________________________________________________________________________
  82 ClassDataBase::~ClassDataBase() SAL_THROW( () )
  83 {
  84     delete pTypes;
  85     delete pId;
  86
  87     for ( sal_Int32 nPos = nType2Offset; nPos--; )
  88     {
  89         typelib_typedescription_release(
  90             (typelib_TypeDescription *)((ClassData *)this)->arType2Offset[nPos].pTD );
  91     }
  92 }
  93
  94 // ClassData
  95 //__________________________________________________________________________________________________
  96 void ClassData::writeTypeOffset( const Type & rType, sal_Int32 nOffset ) SAL_THROW( () )
  97 {
  98     arType2Offset[nType2Offset].nOffset = nOffset;
  99
 100     arType2Offset[nType2Offset].pTD = 0;
 101     typelib_typedescriptionreference_getDescription(
 102         (typelib_TypeDescription **)&arType2Offset[nType2Offset].pTD, rType.getTypeLibType() );
 103
 104     if (arType2Offset[nType2Offset].pTD)
 105         ++nType2Offset;
 106 #if OSL_DEBUG_LEVEL > 1
 107     else
 108     {
 109         OString msg( "### cannot get type description for " );
 110         msg += OUStringToOString( rType.getTypeName(), RTL_TEXTENCODING_ASCII_US );
 111         OSL_ENSURE( sal_False, msg.getStr() );
 112     }
 113 #endif
 114 }
 115 //__________________________________________________________________________________________________
 116 void ClassData::initTypeProvider() SAL_THROW( () )
 117 {
 118     ::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
 119     if (! pTypes)
 120     {
 121         // create id
 122         pId = new Sequence< sal_Int8 >( 16 );
 123         rtl_createUuid( (sal_uInt8 *)pId->getArray(), 0, sal_True );
 124
 125         // collect types
 126         Sequence< Type > * types = new Sequence< Type >(
 127             nType2Offset + 1 + (nClassCode == 4 ? 2 : nClassCode) );
 128         Type * pTypeAr = types->getArray();
 129
 130         // given types
 131         sal_Int32 nPos = nType2Offset;
 132         while (nPos--)
 133             pTypeAr[nPos] = ((typelib_TypeDescription *)arType2Offset[nPos].pTD)->pWeakRef;
 134
 135         // XTypeProvider
 136         pTypeAr[nType2Offset] = ::getCppuType( (const Reference< lang::XTypeProvider > *)0 );
 137
 138         // class code extra types: [[XComponent,] XWeak[, XAggregation]]
 139         switch (nClassCode)
 140         {
 141         case 4:
 142             pTypeAr[nType2Offset +2] = ::getCppuType( (const Reference< lang::XComponent > *)0 );
 143             pTypeAr[nType2Offset +1] = ::getCppuType( (const Reference< XWeak > *)0 );
 144             break;
 145         case 3:
 146             pTypeAr[nType2Offset +3] = ::getCppuType( (const Reference< lang::XComponent > *)0 );
 147         case 2:
 148             pTypeAr[nType2Offset +2] = ::getCppuType( (const Reference< XAggregation > *)0 );
 149         case 1:
 150             pTypeAr[nType2Offset +1] = ::getCppuType( (const Reference< XWeak > *)0 );
 151         }
 152
 153         pTypes = types;
 154     }
 155 }
 156 //__________________________________________________________________________________________________
 157 Sequence< Type > ClassData::getTypes() SAL_THROW( () )
 158 {
 159     if (! pTypes)
 160         initTypeProvider();
 161     return *pTypes;
 162 }
 163 //__________________________________________________________________________________________________
 164 Sequence< sal_Int8 > ClassData::getImplementationId() SAL_THROW( () )
 165 {
 166     if (! pTypes)
 167         initTypeProvider();
 168     return *pId;
 169 }
 170
 171 //--------------------------------------------------------------------------------------------------
 172 static inline sal_Bool td_equals(
 173     typelib_TypeDescription * pTD, typelib_TypeDescriptionReference * pType )
 174     SAL_THROW( () )
 175 {
 176     return (pTD->pWeakRef == pType ||
 177             (pTD->pTypeName->length == pType->pTypeName->length &&
 178              rtl_ustr_compare( pTD->pTypeName->buffer, pType->pTypeName->buffer ) == 0));
 179 }
 180 //__________________________________________________________________________________________________
 181 Any ClassData::query( const Type & rType, lang::XTypeProvider * pBase ) SAL_THROW( () )
 182 {
 183     if (rType == ::getCppuType( (const Reference< XInterface > *)0 ))
 184         return Any( &pBase, ::getCppuType( (const Reference< XInterface > *)0 ) );
 185     for ( sal_Int32 nPos = 0; nPos < nType2Offset; ++nPos )
 186     {
 187         const Type_Offset & rTO = arType2Offset[nPos];
 188         typelib_InterfaceTypeDescription * pTD = rTO.pTD;
 189         while (pTD)
 190         {
 191             if (td_equals( (typelib_TypeDescription *)pTD,
 192                            *(typelib_TypeDescriptionReference **)&rType ))
 193             {
 194                 void * pInterface = (char *)pBase + rTO.nOffset;
 195                 return Any( &pInterface, (typelib_TypeDescription *)pTD );
 196             }
 197             pTD = pTD->pBaseTypeDescription;
 198         }
 199     }
 200     if (rType == ::getCppuType( (const Reference< lang::XTypeProvider > *)0 ))
 201         return Any( &pBase, ::getCppuType( (const Reference< lang::XTypeProvider > *)0 ) );
 202
 203     return Any();
 204 }
 205
 206 //##################################################################################################
 207 //##################################################################################################
 208 //##################################################################################################
 209
 210 // WeakComponentImplHelperBase
 211 //__________________________________________________________________________________________________
 212 WeakComponentImplHelperBase::WeakComponentImplHelperBase( Mutex & rMutex )
 213     SAL_THROW( () )
 214     : rBHelper( rMutex )
 215 {
 216 }
 217 //__________________________________________________________________________________________________
 218 WeakComponentImplHelperBase::~WeakComponentImplHelperBase()
 219     SAL_THROW( () )
 220 {
 221 }
 222 //__________________________________________________________________________________________________
 223 void WeakComponentImplHelperBase::disposing()
 224 {
 225 }
 226 //__________________________________________________________________________________________________
 227 Any WeakComponentImplHelperBase::queryInterface( Type const & rType )
 228     throw (RuntimeException)
 229 {
 230     if (rType == ::getCppuType( (Reference< lang::XComponent > const *)0 ))
 231     {
 232         void * p = static_cast< lang::XComponent * >( this );
 233         return Any( &p, rType );
 234     }
 235     return OWeakObject::queryInterface( rType );
 236 }
 237 //__________________________________________________________________________________________________
 238 void WeakComponentImplHelperBase::acquire()
 239     throw ()
 240 {
 241     OWeakObject::acquire();
 242 }
 243 //__________________________________________________________________________________________________
 244 void WeakComponentImplHelperBase::release()
 245     throw ()
 246 {
 247     if (osl_decrementInterlockedCount( &m_refCount ) == 0) {
 248         // ensure no other references are created, via the weak connection point, from now on
 249         disposeWeakConnectionPoint();
 250         // restore reference count:
 251         osl_incrementInterlockedCount( &m_refCount );
 252         if (! rBHelper.bDisposed) {
 253             try {
 254                 dispose();
 255             }
 256             catch (RuntimeException const& exc) { // don't break throw ()
 257                 OSL_ENSURE(
 258                     false, OUStringToOString(
 259                         exc.Message, RTL_TEXTENCODING_ASCII_US ).getStr() );
 260                 static_cast<void>(exc);
 261             }
 262             OSL_ASSERT( rBHelper.bDisposed );
 263         }
 264         OWeakObject::release();
 265     }
 266 }
 267 //__________________________________________________________________________________________________
 268 void WeakComponentImplHelperBase::dispose()
 269     throw (RuntimeException)
 270 {
 271     ClearableMutexGuard aGuard( rBHelper.rMutex );
 272     if (!rBHelper.bDisposed && !rBHelper.bInDispose)
 273     {
 274         rBHelper.bInDispose = sal_True;
 275         aGuard.clear();
 276         try
 277         {
 278             // side effect: keeping a reference to this
 279             lang::EventObject aEvt( static_cast< OWeakObject * >( this ) );
 280             try
 281             {
 282                 rBHelper.aLC.disposeAndClear( aEvt );
 283                 disposing();
 284             }
 285             catch (...)
 286             {
 287                 MutexGuard aGuard2( rBHelper.rMutex );
 288                 // bDisposed and bInDispose must be set in this order:
 289                 rBHelper.bDisposed = sal_True;
 290                 rBHelper.bInDispose = sal_False;
 291                 throw;
 292             }
 293             MutexGuard aGuard2( rBHelper.rMutex );
 294             // bDisposed and bInDispose must be set in this order:
 295             rBHelper.bDisposed = sal_True;
 296             rBHelper.bInDispose = sal_False;
 297         }
 298         catch (RuntimeException &)
 299         {
 300             throw;
 301         }
 302         catch (Exception & exc)
 303         {
 304             throw RuntimeException(
 305                 OUString( RTL_CONSTASCII_USTRINGPARAM(
 306                               "unexpected UNO exception caught: ") ) +
 307                 exc.Message, Reference< XInterface >() );
 308         }
 309     }
 310 }
 311 //__________________________________________________________________________________________________
 312 void WeakComponentImplHelperBase::addEventListener(
 313     Reference< lang::XEventListener > const & xListener )
 314     throw (RuntimeException)
 315 {
 316     ClearableMutexGuard aGuard( rBHelper.rMutex );
 317     if (rBHelper.bDisposed || rBHelper.bInDispose)
 318     {
 319         aGuard.clear();
 320         lang::EventObject aEvt( static_cast< OWeakObject * >( this ) );
 321         xListener->disposing( aEvt );
 322     }
 323     else
 324     {
 325         rBHelper.addListener( ::getCppuType( &xListener ), xListener );
 326     }
 327 }
 328 //__________________________________________________________________________________________________
 329 void WeakComponentImplHelperBase::removeEventListener(
 330     Reference< lang::XEventListener > const & xListener )
 331     throw (RuntimeException)
 332 {
 333     rBHelper.removeListener( ::getCppuType( &xListener ), xListener );
 334 }
 335
 336 // WeakAggComponentImplHelperBase
 337 //__________________________________________________________________________________________________
 338 WeakAggComponentImplHelperBase::WeakAggComponentImplHelperBase( Mutex & rMutex )
 339     SAL_THROW( () )
 340     : rBHelper( rMutex )
 341 {
 342 }
 343 //__________________________________________________________________________________________________
 344 WeakAggComponentImplHelperBase::~WeakAggComponentImplHelperBase()
 345     SAL_THROW( () )
 346 {
 347 }
 348 //__________________________________________________________________________________________________
 349 void WeakAggComponentImplHelperBase::disposing()
 350 {
 351 }
 352 //__________________________________________________________________________________________________
 353 Any WeakAggComponentImplHelperBase::queryInterface( Type const & rType )
 354     throw (RuntimeException)
 355 {
 356     return OWeakAggObject::queryInterface( rType );
 357 }
 358 //__________________________________________________________________________________________________
 359 Any WeakAggComponentImplHelperBase::queryAggregation( Type const & rType )
 360     throw (RuntimeException)
 361 {
 362     if (rType == ::getCppuType( (Reference< lang::XComponent > const *)0 ))
 363     {
 364         void * p = static_cast< lang::XComponent * >( this );
 365         return Any( &p, rType );
 366     }
 367     return OWeakAggObject::queryAggregation( rType );
 368 }
 369 //__________________________________________________________________________________________________
 370 void WeakAggComponentImplHelperBase::acquire()
 371     throw ()
 372 {
 373     OWeakAggObject::acquire();
 374 }
 375 //__________________________________________________________________________________________________
 376 void WeakAggComponentImplHelperBase::release()
 377     throw ()
 378 {
 379     Reference<XInterface> const xDelegator_(xDelegator);
 380     if (xDelegator_.is()) {
 381         OWeakAggObject::release();
 382     }
 383     else if (osl_decrementInterlockedCount( &m_refCount ) == 0) {
 384         // ensure no other references are created, via the weak connection point, from now on
 385         disposeWeakConnectionPoint();
 386         // restore reference count:
 387         osl_incrementInterlockedCount( &m_refCount );
 388         if (! rBHelper.bDisposed) {
 389             try {
 390                 dispose();
 391             }
 392             catch (RuntimeException const& exc) { // don't break throw ()
 393                 OSL_ENSURE(
 394                     false, OUStringToOString(
 395                         exc.Message, RTL_TEXTENCODING_ASCII_US ).getStr() );
 396                 static_cast<void>(exc);
 397             }
 398             OSL_ASSERT( rBHelper.bDisposed );
 399         }
 400         OWeakAggObject::release();
 401     }
 402 }
 403 //__________________________________________________________________________________________________
 404 void WeakAggComponentImplHelperBase::dispose()
 405     throw (RuntimeException)
 406 {
 407     ClearableMutexGuard aGuard( rBHelper.rMutex );
 408     if (!rBHelper.bDisposed && !rBHelper.bInDispose)
 409     {
 410         rBHelper.bInDispose = sal_True;
 411         aGuard.clear();
 412         try
 413         {
 414             // side effect: keeping a reference to this
 415             lang::EventObject aEvt( static_cast< OWeakObject * >( this ) );
 416             try
 417             {
 418                 rBHelper.aLC.disposeAndClear( aEvt );
 419                 disposing();
 420             }
 421             catch (...)
 422             {
 423                 MutexGuard aGuard2( rBHelper.rMutex );
 424                 // bDisposed and bInDispose must be set in this order:
 425                 rBHelper.bDisposed = sal_True;
 426                 rBHelper.bInDispose = sal_False;
 427                 throw;
 428             }
 429             MutexGuard aGuard2( rBHelper.rMutex );
 430             // bDisposed and bInDispose must be set in this order:
 431             rBHelper.bDisposed = sal_True;
 432             rBHelper.bInDispose = sal_False;
 433         }
 434         catch (RuntimeException &)
 435         {
 436             throw;
 437         }
 438         catch (Exception & exc)
 439         {
 440             throw RuntimeException(
 441                 OUString( RTL_CONSTASCII_USTRINGPARAM(
 442                               "unexpected UNO exception caught: ") ) +
 443                 exc.Message, Reference< XInterface >() );
 444         }
 445     }
 446 }
 447 //__________________________________________________________________________________________________
 448 void WeakAggComponentImplHelperBase::addEventListener(
 449     Reference< lang::XEventListener > const & xListener )
 450     throw (RuntimeException)
 451 {
 452     ClearableMutexGuard aGuard( rBHelper.rMutex );
 453     if (rBHelper.bDisposed || rBHelper.bInDispose)
 454     {
 455         aGuard.clear();
 456         lang::EventObject aEvt( static_cast< OWeakObject * >( this ) );
 457         xListener->disposing( aEvt );
 458     }
 459     else
 460     {
 461         rBHelper.addListener( ::getCppuType( &xListener ), xListener );
 462     }
 463 }
 464 //__________________________________________________________________________________________________
 465 void WeakAggComponentImplHelperBase::removeEventListener(
 466     Reference< lang::XEventListener > const & xListener )
 467     throw (RuntimeException)
 468 {
 469     rBHelper.removeListener( ::getCppuType( &xListener ), xListener );
 470 }
 471
 472 }
 473
 474 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */