framework/source/helper/oframes.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 <helper/oframes.hxx>
  21
  22 #include <threadhelp/resetableguard.hxx>
  23
  24 #include <com/sun/star/frame/XDesktop.hpp>
  25 #include <com/sun/star/frame/FrameSearchFlag.hpp>
  26
  27 #include <vcl/svapp.hxx>
  28
  29 namespace framework{
  30
  31 using namespace ::com::sun::star::container     ;
  32 using namespace ::com::sun::star::frame         ;
  33 using namespace ::com::sun::star::lang          ;
  34 using namespace ::com::sun::star::uno           ;
  35 using namespace ::cppu                          ;
  36 using namespace ::osl                           ;
  37 using namespace ::std                           ;
  38
  39
  40 //*****************************************************************************************************************
  41 //  constructor
  42 //*****************************************************************************************************************
  43 OFrames::OFrames(   const   css::uno::Reference< XMultiServiceFactory >&    xFactory        ,
  44                     const   css::uno::Reference< XFrame >&              xOwner          ,
  45                             FrameContainer*                     pFrameContainer )
  46         //  Init baseclasses first
  47         :   ThreadHelpBase              ( &Application::GetSolarMutex() )
  48         // Init member
  49         ,   m_xFactory                  ( xFactory                      )
  50         ,   m_xOwner                    ( xOwner                        )
  51         ,   m_pFrameContainer           ( pFrameContainer               )
  52         ,   m_bRecursiveSearchProtection( sal_False                     )
  53 {
  54     // Safe impossible cases
  55     // Method is not defined for ALL incoming parameters!
  56     LOG_ASSERT( impldbg_checkParameter_OFramesCtor( xFactory, xOwner, pFrameContainer ), "OFrames::OFrames()\nInvalid parameter detected!\n" )
  57 }
  58
  59 //*****************************************************************************************************************
  60 //  (proteced!) destructor
  61 //*****************************************************************************************************************
  62 OFrames::~OFrames()
  63 {
  64     // Reset instance, free memory ....
  65     impl_resetObject();
  66 }
  67
  68 //*****************************************************************************************************************
  69 //  XFrames
  70 //*****************************************************************************************************************
  71 void SAL_CALL OFrames::append( const css::uno::Reference< XFrame >& xFrame ) throw( RuntimeException )
  72 {
  73     // Ready for multithreading
  74     ResetableGuard aGuard( m_aLock );
  75
  76     // Safe impossible cases
  77     // Method is not defined for ALL incoming parameters!
  78     LOG_ASSERT( impldbg_checkParameter_append( xFrame ), "OFrames::append()\nInvalid parameter detected!\n" )
  79
  80     // Do the follow only, if owner instance valid!
  81     // Lock owner for follow operations - make a "hard reference"!
  82     css::uno::Reference< XFramesSupplier > xOwner( m_xOwner.get(), UNO_QUERY );
  83     if ( xOwner.is() == sal_True )
  84     {
  85         // Append frame to the end of the container ...
  86         m_pFrameContainer->append( xFrame );
  87         // Set owner of this instance as parent of the new frame in container!
  88         xFrame->setCreator( xOwner );
  89     }
  90     // Else; Do nothing! Ouer owner is dead.
  91     LOG_ASSERT( !(xOwner.is()==sal_False), "OFrames::append()\nOuer owner is dead - you can't append any frames ...!\n" )
  92 }
  93
  94 //*****************************************************************************************************************
  95 //  XFrames
  96 //*****************************************************************************************************************
  97 void SAL_CALL OFrames::remove( const css::uno::Reference< XFrame >& xFrame ) throw( RuntimeException )
  98 {
  99     // Ready for multithreading
 100     ResetableGuard aGuard( m_aLock );
 101
 102     // Safe impossible cases
 103     // Method is not defined for ALL incoming parameters!
 104     LOG_ASSERT( impldbg_checkParameter_remove( xFrame ), "OFrames::remove()\nInvalid parameter detected!\n" )
 105
 106     // Do the follow only, if owner instance valid!
 107     // Lock owner for follow operations - make a "hard reference"!
 108     css::uno::Reference< XFramesSupplier > xOwner( m_xOwner.get(), UNO_QUERY );
 109     if ( xOwner.is() == sal_True )
 110     {
 111         // Search frame and remove it from container ...
 112         m_pFrameContainer->remove( xFrame );
 113         // Don't reset owner-property of removed frame!
 114         // This must do the caller of this method himself.
 115         // See documentation of interface XFrames for further information.
 116     }
 117     // Else; Do nothing! Ouer owner is dead.
 118     LOG_ASSERT( !(xOwner.is()==sal_False), "OFrames::remove()\nOuer owner is dead - you can't remove any frames ...!\n" )
 119 }
 120
 121 //*****************************************************************************************************************
 122 //  XFrames
 123 //*****************************************************************************************************************
 124 Sequence< css::uno::Reference< XFrame > > SAL_CALL OFrames::queryFrames( sal_Int32 nSearchFlags ) throw( RuntimeException )
 125 {
 126     // Ready for multithreading
 127     ResetableGuard aGuard( m_aLock );
 128
 129     // Safe impossible cases
 130     // Method is not defined for ALL incoming parameters!
 131     LOG_ASSERT( impldbg_checkParameter_queryFrames( nSearchFlags ), "OFrames::queryFrames()\nInvalid parameter detected!\n" )
 132
 133     // Set default return value. (empty sequence)
 134     Sequence< css::uno::Reference< XFrame > > seqFrames;
 135
 136     // Do the follow only, if owner instance valid.
 137     // Lock owner for follow operations - make a "hard reference"!
 138     css::uno::Reference< XFrame > xOwner( m_xOwner.get(), UNO_QUERY );
 139     if ( xOwner.is() == sal_True )
 140     {
 141         // Work only, if search was not started here ...!
 142         if( m_bRecursiveSearchProtection == sal_False )
 143         {
 144             // This class is a helper for services, which must implement XFrames.
 145             // His parent and children are MY parent and children to.
 146             // All searchflags are supported by this implementation!
 147             // If some flags should not be supported - don't call me with this flags!!!
 148
 149             //_____________________________________________________________________________________________________________
 150             // Search with AUTO-flag is not supported yet!
 151             // We think about right implementation.
 152             LOG_ASSERT( !(nSearchFlags & FrameSearchFlag::AUTO), "OFrames::queryFrames()\nSearch with AUTO-flag is not supported yet!\nWe think about right implementation.\n" )
 153             // If searched for tasks ...
 154             // Its not supported yet.
 155             LOG_ASSERT( !(nSearchFlags & FrameSearchFlag::AUTO), "OFrames::queryFrames()\nSearch for tasks not supported yet!\n" )
 156
 157             //_____________________________________________________________________________________________________________
 158             // Search for ALL and GLOBAL is superflous!
 159             // We support all necessary flags, from which these two flags are derived.
 160             //      ALL     = PARENT + SELF  + CHILDREN + SIBLINGS
 161             //      GLOBAL  = ALL    + TASKS
 162
 163             //_____________________________________________________________________________________________________________
 164             // Add parent to list ... if any exist!
 165             if( nSearchFlags & FrameSearchFlag::PARENT )
 166             {
 167                 css::uno::Reference< XFrame > xParent( xOwner->getCreator(), UNO_QUERY );
 168                 if( xParent.is() == sal_True )
 169                 {
 170                     Sequence< css::uno::Reference< XFrame > > seqParent( 1 );
 171                     seqParent[0] = xParent;
 172                     impl_appendSequence( seqFrames, seqParent );
 173                 }
 174             }
 175
 176             //_____________________________________________________________________________________________________________
 177             // Add owner to list if SELF is searched.
 178             if( nSearchFlags & FrameSearchFlag::SELF )
 179             {
 180                 Sequence< css::uno::Reference< XFrame > > seqSelf( 1 );
 181                 seqSelf[0] = xOwner;
 182                 impl_appendSequence( seqFrames, seqSelf );
 183             }
 184
 185             //_____________________________________________________________________________________________________________
 186             // Add SIBLINGS to list.
 187             if( nSearchFlags & FrameSearchFlag::SIBLINGS )
 188             {
 189                 // Else; start a new search.
 190                 // Protect this instance against recursive calls from parents.
 191                 m_bRecursiveSearchProtection = sal_True;
 192                 // Ask parent of my owner for frames and append results to return list.
 193                 css::uno::Reference< XFramesSupplier > xParent( xOwner->getCreator(), UNO_QUERY );
 194                 // If a parent exist ...
 195                 if ( xParent.is() == sal_True )
 196                 {
 197                     // ... ask him for right frames.
 198                     impl_appendSequence( seqFrames, xParent->getFrames()->queryFrames( nSearchFlags ) );
 199                 }
 200                 // We have all searched information.
 201                 // Reset protection-mode.
 202                 m_bRecursiveSearchProtection = sal_False;
 203             }
 204
 205             //_____________________________________________________________________________________________________________
 206             // If searched for children, step over all elements in container and collect the information.
 207             if ( nSearchFlags & FrameSearchFlag::CHILDREN )
 208             {
 209                 // Don't search for parents, siblings and self at children!
 210                 // These things are supported by this instance himself.
 211                 sal_Int32 nChildSearchFlags = FrameSearchFlag::SELF | FrameSearchFlag::CHILDREN;
 212                 // Step over all items of container and ask children for frames.
 213                 sal_uInt32 nCount = m_pFrameContainer->getCount();
 214                 for ( sal_uInt32 nIndex=0; nIndex<nCount; ++nIndex )
 215                 {
 216                     // We don't must control this conversion.
 217                     // We have done this at append()!
 218                     css::uno::Reference< XFramesSupplier > xItem( (*m_pFrameContainer)[nIndex], UNO_QUERY );
 219                     impl_appendSequence( seqFrames, xItem->getFrames()->queryFrames( nChildSearchFlags ) );
 220                 }
 221             }
 222         }
 223     }
 224     // Else; Do nothing! Ouer owner is dead.
 225     LOG_ASSERT( !(xOwner.is()==sal_False), "OFrames::queryFrames()\nOuer owner is dead - you can't query for frames ...!\n" )
 226
 227     // Resturn result of this operation.
 228     return seqFrames;
 229 }
 230
 231 //*****************************************************************************************************************
 232 //  XIndexAccess
 233 //*****************************************************************************************************************
 234 sal_Int32 SAL_CALL OFrames::getCount() throw( RuntimeException )
 235 {
 236     // Ready for multithreading
 237     ResetableGuard aGuard( m_aLock );
 238
 239     // Set default return value.
 240     sal_Int32 nCount = 0;
 241
 242     // Do the follow only, if owner instance valid.
 243     // Lock owner for follow operations - make a "hard reference"!
 244     css::uno::Reference< XFrame > xOwner( m_xOwner.get(), UNO_QUERY );
 245     if ( xOwner.is() == sal_True )
 246     {
 247         // Set CURRENT size of container for return.
 248         nCount = m_pFrameContainer->getCount();
 249     }
 250
 251     // Return result.
 252     return nCount;
 253 }
 254
 255 //*****************************************************************************************************************
 256 //  XIndexAccess
 257 //*****************************************************************************************************************
 258 Any SAL_CALL OFrames::getByIndex( sal_Int32 nIndex ) throw( IndexOutOfBoundsException   ,
 259                                                             WrappedTargetException      ,
 260                                                             RuntimeException            )
 261 {
 262     // Ready for multithreading
 263     ResetableGuard aGuard( m_aLock );
 264
 265       sal_uInt32 nCount = m_pFrameContainer->getCount();
 266       if ( nIndex < 0 || ( sal::static_int_cast< sal_uInt32 >( nIndex ) >= nCount ))
 267           throw IndexOutOfBoundsException( OUString("OFrames::getByIndex - Index out of bounds"),
 268                                            (OWeakObject *)this );
 269
 270     // Set default return value.
 271     Any aReturnValue;
 272
 273     // Do the follow only, if owner instance valid.
 274     // Lock owner for follow operations - make a "hard reference"!
 275     css::uno::Reference< XFrame > xOwner( m_xOwner.get(), UNO_QUERY );
 276     if ( xOwner.is() == sal_True )
 277     {
 278         // Get element form container.
 279         // (If index not valid, FrameContainer return NULL!)
 280             aReturnValue <<= (*m_pFrameContainer)[nIndex];
 281     }
 282
 283     // Return result of this operation.
 284     return aReturnValue;
 285 }
 286
 287 //*****************************************************************************************************************
 288 //  XElementAccess
 289 //*****************************************************************************************************************
 290 Type SAL_CALL OFrames::getElementType() throw( RuntimeException )
 291 {
 292     // This "container" support XFrame-interfaces only!
 293     return ::getCppuType( (const css::uno::Reference< XFrame >*)NULL );
 294 }
 295
 296 //*****************************************************************************************************************
 297 //  XElementAccess
 298 //*****************************************************************************************************************
 299 sal_Bool SAL_CALL OFrames::hasElements() throw( RuntimeException )
 300 {
 301     // Ready for multithreading
 302     ResetableGuard aGuard( m_aLock );
 303
 304     // Set default return value.
 305     sal_Bool bHasElements = sal_False;
 306     // Do the follow only, if owner instance valid.
 307     // Lock owner for follow operations - make a "hard reference"!
 308     css::uno::Reference< XFrame > xOwner( m_xOwner.get(), UNO_QUERY );
 309     if ( xOwner.is() == sal_True )
 310     {
 311         // If some elements exist ...
 312         if ( m_pFrameContainer->getCount() > 0 )
 313         {
 314             // ... change this state value!
 315             bHasElements = sal_True;
 316         }
 317     }
 318     // Return result of this operation.
 319     return bHasElements;
 320 }
 321
 322 //*****************************************************************************************************************
 323 //  proteced method
 324 //*****************************************************************************************************************
 325 void OFrames::impl_resetObject()
 326 {
 327     // Attention:
 328     // Write this for multiple calls - NOT AT THE SAME TIME - but for more then one call again)!
 329     // It exist two ways to call this method. From destructor and from disposing().
 330     // I can't say, which one is the first. Normaly the disposing-call - but other way ....
 331
 332     // This instance can't work if the weakreference to owner is invalid!
 333     // Destroy this to reset this object.
 334     m_xOwner = WeakReference< XFrame >();
 335     // Reset pointer to shared container to!
 336     m_pFrameContainer = NULL;
 337 }
 338
 339 //*****************************************************************************************************************
 340 //  private method
 341 //*****************************************************************************************************************
 342 void OFrames::impl_appendSequence(          Sequence< css::uno::Reference< XFrame > >&  seqDestination  ,
 343                                      const  Sequence< css::uno::Reference< XFrame > >&  seqSource       )
 344 {
 345     // Get some information about the sequences.
 346     sal_Int32                       nSourceCount        = seqSource.getLength();
 347     sal_Int32                       nDestinationCount   = seqDestination.getLength();
 348     const css::uno::Reference< XFrame >*        pSourceAccess       = seqSource.getConstArray();
 349     css::uno::Reference< XFrame >*          pDestinationAccess  = seqDestination.getArray();
 350
 351     // Get memory for result list.
 352     Sequence< css::uno::Reference< XFrame > >   seqResult           ( nSourceCount + nDestinationCount );
 353     css::uno::Reference< XFrame >*          pResultAccess       = seqResult.getArray();
 354     sal_Int32                       nResultPosition     = 0;
 355
 356     // Copy all items from first sequence.
 357     for ( sal_Int32 nSourcePosition=0; nSourcePosition<nSourceCount; ++nSourcePosition )
 358     {
 359         pResultAccess[nResultPosition] = pSourceAccess[nSourcePosition];
 360         ++nResultPosition;
 361     }
 362
 363     // Don't manipulate nResultPosition between these two loops!
 364     // Its the current position in the result list.
 365
 366     // Copy all items from second sequence.
 367     for ( sal_Int32 nDestinationPosition=0; nDestinationPosition<nDestinationCount; ++nDestinationPosition )
 368     {
 369         pResultAccess[nResultPosition] = pDestinationAccess[nDestinationPosition];
 370         ++nResultPosition;
 371     }
 372
 373     // Return result of this operation.
 374     seqDestination.realloc( 0 );
 375     seqDestination = seqResult;
 376 }
 377
 378 //_________________________________________________________________________________________________________________
 379 //  debug methods
 380 //_________________________________________________________________________________________________________________
 381
 382 /*-----------------------------------------------------------------------------------------------------------------
 383     The follow methods checks the parameter for other functions. If a parameter or his value is non valid,
 384     we return "sal_False". (else sal_True) This mechanism is used to throw an ASSERT!
 385
 386     ATTENTION
 387
 388         If you miss a test for one of this parameters, contact the autor or add it himself !(?)
 389         But ... look for right testing! See using of this methods!
 390 -----------------------------------------------------------------------------------------------------------------*/
 391
 392 #ifdef ENABLE_ASSERTIONS
 393
 394 //*****************************************************************************************************************
 395 // An instance of this class can only work with valid initialization.
 396 // We share the mutex with ouer owner class, need a valid factory to instanciate new services and
 397 // use the access to ouer owner for some operations.
 398 sal_Bool OFrames::impldbg_checkParameter_OFramesCtor(   const   css::uno::Reference< XMultiServiceFactory >&    xFactory        ,
 399                                                         const   css::uno::Reference< XFrame >&              xOwner          ,
 400                                                                 FrameContainer*                     pFrameContainer )
 401 {
 402     // Set default return value.
 403     sal_Bool bOK = sal_True;
 404     // Check parameter.
 405     if  (
 406             ( &xFactory         ==  NULL        )   ||
 407             ( &xOwner           ==  NULL        )   ||
 408             ( xFactory.is()     ==  sal_False   )   ||
 409             ( xOwner.is()       ==  sal_False   )   ||
 410             ( pFrameContainer   ==  NULL        )
 411         )
 412     {
 413         bOK = sal_False ;
 414     }
 415     // Return result of check.
 416     return bOK ;
 417 }
 418
 419 //*****************************************************************************************************************
 420 // Its only allowed to add valid references to container.
 421 // AND - alle frames must support XFrames-interface!
 422 sal_Bool OFrames::impldbg_checkParameter_append( const css::uno::Reference< XFrame >& xFrame )
 423 {
 424     // Set default return value.
 425     sal_Bool bOK = sal_True;
 426     // Check parameter.
 427     if  (
 428             ( &xFrame       ==  NULL        )   ||
 429             ( xFrame.is()   ==  sal_False   )
 430         )
 431     {
 432         bOK = sal_False ;
 433     }
 434     // Return result of check.
 435     return bOK ;
 436 }
 437
 438 //*****************************************************************************************************************
 439 // Its only allowed to add valid references to container...
 440 // ... => You can only delete valid references!
 441 sal_Bool OFrames::impldbg_checkParameter_remove( const css::uno::Reference< XFrame >& xFrame )
 442 {
 443     // Set default return value.
 444     sal_Bool bOK = sal_True;
 445     // Check parameter.
 446     if  (
 447             ( &xFrame       ==  NULL        )   ||
 448             ( xFrame.is()   ==  sal_False   )
 449         )
 450     {
 451         bOK = sal_False ;
 452     }
 453     // Return result of check.
 454     return bOK ;
 455 }
 456
 457 //*****************************************************************************************************************
 458 // A search for frames must initiate with right flags.
 459 // Some one are superflous and not supported yet. But here we control only the range of incoming parameter!
 460 sal_Bool OFrames::impldbg_checkParameter_queryFrames( sal_Int32 nSearchFlags )
 461 {
 462     // Set default return value.
 463     sal_Bool bOK = sal_True;
 464     // Check parameter.
 465     if  (
 466             (    nSearchFlags != FrameSearchFlag::AUTO        ) &&
 467             ( !( nSearchFlags &  FrameSearchFlag::PARENT    ) ) &&
 468             ( !( nSearchFlags &  FrameSearchFlag::SELF      ) ) &&
 469             ( !( nSearchFlags &  FrameSearchFlag::CHILDREN  ) ) &&
 470             ( !( nSearchFlags &  FrameSearchFlag::CREATE    ) ) &&
 471             ( !( nSearchFlags &  FrameSearchFlag::SIBLINGS  ) ) &&
 472             ( !( nSearchFlags &  FrameSearchFlag::TASKS     ) ) &&
 473             ( !( nSearchFlags &  FrameSearchFlag::ALL       ) ) &&
 474             ( !( nSearchFlags &  FrameSearchFlag::GLOBAL    ) )
 475         )
 476     {
 477         bOK = sal_False ;
 478     }
 479     // Return result of check.
 480     return bOK ;
 481 }
 482
 483 #endif  //  #ifdef ENABLE_ASSERTIONS
 484
 485 }       //  namespace framework
 486
 487 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */