toolkit/source/controls/stdtabcontrollermodel.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: stdtabcontrollermodel.cxx,v $
  10  * $Revision: 1.6 $
  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_toolkit.hxx"
  33 #include <com/sun/star/io/XMarkableStream.hpp>
  34
  35 #include <toolkit/controls/stdtabcontrollermodel.hxx>
  36 #include <toolkit/helper/macros.hxx>
  37 #include <toolkit/helper/servicenames.hxx>
  38 #include <toolkit/helper/property.hxx>
  39 #include <cppuhelper/typeprovider.hxx>
  40 #include <rtl/memory.h>
  41 #include <rtl/uuid.h>
  42
  43 #include <tools/debug.hxx>
  44
  45 #define UNOCONTROL_STREAMVERSION        (short)2
  46
  47 //      ----------------------------------------------------
  48 //      class UnoControlModelEntryList
  49 //      ----------------------------------------------------
  50 UnoControlModelEntryList::UnoControlModelEntryList()
  51 {
  52 }
  53
  54 UnoControlModelEntryList::~UnoControlModelEntryList()
  55 {
  56     Reset();
  57 }
  58
  59 void UnoControlModelEntryList::Reset()
  60 {
  61     for ( sal_uInt32 n = Count(); n; )
  62         DestroyEntry( --n );
  63 }
  64
  65 void UnoControlModelEntryList::DestroyEntry( sal_uInt32 nEntry )
  66 {
  67     UnoControlModelEntry* pEntry = GetObject( nEntry );
  68
  69     if ( pEntry->bGroup )
  70         delete pEntry->pGroup;
  71     else
  72         delete pEntry->pxControl;
  73
  74     Remove( nEntry );
  75     delete pEntry;
  76 }
  77
  78 //      ----------------------------------------------------
  79 //      class StdTabControllerModel
  80 //      ----------------------------------------------------
  81 StdTabControllerModel::StdTabControllerModel()
  82 {
  83     mbGroupControl = sal_True;
  84 }
  85
  86 StdTabControllerModel::~StdTabControllerModel()
  87 {
  88 }
  89
  90 sal_uInt32 StdTabControllerModel::ImplGetControlCount( const UnoControlModelEntryList& rList ) const
  91 {
  92     sal_uInt32 nCount = 0;
  93     sal_uInt32 nEntries = rList.Count();
  94     for ( sal_uInt32 n = 0; n < nEntries; n++ )
  95     {
  96         UnoControlModelEntry* pEntry = rList.GetObject( n );
  97         if ( pEntry->bGroup )
  98             nCount += ImplGetControlCount( *pEntry->pGroup );
  99         else
 100             nCount++;
 101     }
 102     return nCount;
 103 }
 104
 105 void StdTabControllerModel::ImplGetControlModels( ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > ** ppRefs, const UnoControlModelEntryList& rList ) const
 106 {
 107     sal_uInt32 nEntries = rList.Count();
 108     for ( sal_uInt32 n = 0; n < nEntries; n++ )
 109     {
 110         UnoControlModelEntry* pEntry = rList.GetObject( n );
 111         if ( pEntry->bGroup )
 112             ImplGetControlModels( ppRefs, *pEntry->pGroup );
 113         else
 114         {
 115             **ppRefs = *pEntry->pxControl;
 116             (*ppRefs)++;
 117         }
 118     }
 119 }
 120
 121 void StdTabControllerModel::ImplSetControlModels( UnoControlModelEntryList& rList, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > >& Controls ) const
 122 {
 123     const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > * pRefs = Controls.getConstArray();
 124     sal_uInt32 nControls = Controls.getLength();
 125     for ( sal_uInt32 n = 0; n < nControls; n++ )
 126     {
 127         UnoControlModelEntry* pNewEntry = new UnoControlModelEntry;
 128         pNewEntry->bGroup = sal_False;
 129         pNewEntry->pxControl = new ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > ;
 130         *pNewEntry->pxControl = pRefs[n];
 131         rList.Insert( pNewEntry, LIST_APPEND );
 132     }
 133 }
 134
 135 sal_uInt32 StdTabControllerModel::ImplGetControlPos( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >  xCtrl, const UnoControlModelEntryList& rList ) const
 136 {
 137     for ( sal_uInt32 n = rList.Count(); n; )
 138     {
 139         UnoControlModelEntry* pEntry = rList.GetObject( --n );
 140         if ( !pEntry->bGroup && ( *pEntry->pxControl == xCtrl ) )
 141             return n;
 142     }
 143     return CONTROLPOS_NOTFOUND;
 144 }
 145
 146 void ImplWriteControls( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream > & OutStream, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > >& rCtrls )
 147 {
 148     ::com::sun::star::uno::Reference< ::com::sun::star::io::XMarkableStream >  xMark( OutStream, ::com::sun::star::uno::UNO_QUERY );
 149     DBG_ASSERT( xMark.is(), "write: no XMarkableStream!" );
 150
 151     sal_uInt32 nStoredControls = 0;
 152     sal_Int32 nDataBeginMark = xMark->createMark();
 153
 154     OutStream->writeLong( 0L ); // DataLen
 155     OutStream->writeLong( 0L ); // nStoredControls
 156
 157     sal_uInt32 nCtrls = rCtrls.getLength();
 158     for ( sal_uInt32 n = 0; n < nCtrls; n++ )
 159     {
 160         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >  xI = rCtrls.getConstArray()[n];
 161         ::com::sun::star::uno::Reference< ::com::sun::star::io::XPersistObject >  xPO( xI, ::com::sun::star::uno::UNO_QUERY );
 162         DBG_ASSERT( xPO.is(), "write: Control doesn't support XPersistObject" );
 163         if ( xPO.is() )
 164         {
 165             OutStream->writeObject( xPO );
 166             nStoredControls++;
 167         }
 168     }
 169     sal_Int32 nDataLen = xMark->offsetToMark( nDataBeginMark );
 170     xMark->jumpToMark( nDataBeginMark );
 171     OutStream->writeLong( nDataLen );
 172     OutStream->writeLong( nStoredControls );
 173     xMark->jumpToFurthest();
 174     xMark->deleteMark(nDataBeginMark);
 175 }
 176
 177 ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > ImplReadControls( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream > & InStream )
 178 {
 179     ::com::sun::star::uno::Reference< ::com::sun::star::io::XMarkableStream >  xMark( InStream, ::com::sun::star::uno::UNO_QUERY );
 180     DBG_ASSERT( xMark.is(), "write: no XMarkableStream!" );
 181
 182     sal_Int32 nDataBeginMark = xMark->createMark();
 183
 184     sal_Int32 nDataLen = InStream->readLong();
 185     sal_uInt32 nCtrls = InStream->readLong();
 186
 187     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > aSeq( nCtrls );
 188     for ( sal_uInt32 n = 0; n < nCtrls; n++ )
 189     {
 190         ::com::sun::star::uno::Reference< ::com::sun::star::io::XPersistObject >  xObj = InStream->readObject();
 191         ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >  xI( xObj, ::com::sun::star::uno::UNO_QUERY );
 192         aSeq.getArray()[n] = xI;
 193     }
 194
 195     // Falls bereits mehr drinsteht als diese Version kennt:
 196     xMark->jumpToMark( nDataBeginMark );
 197     InStream->skipBytes( nDataLen );
 198     xMark->deleteMark(nDataBeginMark);
 199     return aSeq;
 200 }
 201
 202
 203 // ::com::sun::star::uno::XInterface
 204 ::com::sun::star::uno::Any StdTabControllerModel::queryAggregation( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException)
 205 {
 206     ::com::sun::star::uno::Any aRet = ::cppu::queryInterface( rType,
 207                                         SAL_STATIC_CAST( ::com::sun::star::awt::XTabControllerModel*, this ),
 208                                         SAL_STATIC_CAST( ::com::sun::star::lang::XServiceInfo*, this ),
 209                                         SAL_STATIC_CAST( ::com::sun::star::io::XPersistObject*, this ),
 210                                         SAL_STATIC_CAST( ::com::sun::star::lang::XTypeProvider*, this ) );
 211     return (aRet.hasValue() ? aRet : OWeakAggObject::queryAggregation( rType ));
 212 }
 213
 214 // ::com::sun::star::lang::XTypeProvider
 215 IMPL_XTYPEPROVIDER_START( StdTabControllerModel )
 216     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabControllerModel>* ) NULL ),
 217     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::lang::XServiceInfo>* ) NULL ),
 218     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::io::XPersistObject>* ) NULL )
 219 IMPL_XTYPEPROVIDER_END
 220
 221 sal_Bool StdTabControllerModel::getGroupControl(  ) throw(::com::sun::star::uno::RuntimeException)
 222 {
 223     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 224
 225     return mbGroupControl;
 226 }
 227
 228 void StdTabControllerModel::setGroupControl( sal_Bool GroupControl ) throw(::com::sun::star::uno::RuntimeException)
 229 {
 230     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 231
 232     mbGroupControl = GroupControl;
 233 }
 234
 235 void StdTabControllerModel::setControlModels( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > >& Controls ) throw(::com::sun::star::uno::RuntimeException)
 236 {
 237     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 238
 239     maControls.Reset();
 240     ImplSetControlModels( maControls, Controls );
 241 }
 242
 243 ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > StdTabControllerModel::getControlModels(  ) throw(::com::sun::star::uno::RuntimeException)
 244 {
 245     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 246
 247     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > aSeq( ImplGetControlCount( maControls ) );
 248     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > * pRefs = aSeq.getArray();
 249     ImplGetControlModels( &pRefs, maControls );
 250     return aSeq;
 251 }
 252
 253 void StdTabControllerModel::setGroup( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > >& Group, const ::rtl::OUString& GroupName ) throw(::com::sun::star::uno::RuntimeException)
 254 {
 255     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 256
 257     // Die Controls stehen eventuel flach in der Liste und werden jetzt gruppiert.
 258     // Verschachtelte Gruppen sind erstmal nicht moeglich...
 259     // Das erste Element der Gruppe welches auch schon in der flachen Liste
 260     // stand bestimmt die Position der Gruppe.
 261
 262     UnoControlModelEntry* pNewEntry = new UnoControlModelEntry;
 263     pNewEntry->bGroup = sal_True;
 264     pNewEntry->pGroup = new UnoControlModelEntryList;
 265     pNewEntry->pGroup->SetName( GroupName );
 266     ImplSetControlModels( *pNewEntry->pGroup, Group );
 267
 268     sal_Bool bInserted = sal_False;
 269     sal_uInt32 nElements = pNewEntry->pGroup->Count();
 270     for ( sal_uInt32 n = 0; n < nElements; n++ )
 271     {
 272         UnoControlModelEntry* pEntry = pNewEntry->pGroup->GetObject( n );
 273         if ( !pEntry->bGroup )
 274         {
 275             sal_uInt32 nPos = ImplGetControlPos( *pEntry->pxControl, maControls );
 276             // Eigentlich sollten alle Controls vorher in der flachen Liste stehen
 277             DBG_ASSERT( nPos != CONTROLPOS_NOTFOUND, "setGroup - Element not found" );
 278             if ( nPos != CONTROLPOS_NOTFOUND )
 279             {
 280                 maControls.DestroyEntry( nPos );
 281                 if ( !bInserted )
 282                 {
 283                     maControls.Insert( pNewEntry, nPos );
 284                     bInserted = sal_True;
 285                 }
 286             }
 287         }
 288     }
 289     if ( !bInserted )
 290         maControls.Insert( pNewEntry, LIST_APPEND );
 291 }
 292
 293 sal_Int32 StdTabControllerModel::getGroupCount(  ) throw(::com::sun::star::uno::RuntimeException)
 294 {
 295     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 296
 297     // erstmal nur eine Ebene...
 298     // Das Model und die Impl-Methoden arbeiten zwar rekursiv, aber das wird
 299     // erstmal nich nach aussen gegeben.
 300
 301     sal_Int32 nGroups = 0;
 302     sal_uInt32 nEntries = maControls.Count();
 303     for ( sal_uInt32 n = 0; n < nEntries; n++ )
 304     {
 305         UnoControlModelEntry* pEntry = maControls.GetObject( n );
 306         if ( pEntry->bGroup )
 307             nGroups++;
 308     }
 309     return nGroups;
 310 }
 311
 312 void StdTabControllerModel::getGroup( sal_Int32 nGroup, ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > >& rGroup, ::rtl::OUString& rName ) throw(::com::sun::star::uno::RuntimeException)
 313 {
 314     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 315
 316     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > aSeq;
 317     sal_uInt32 nG = 0;
 318     sal_uInt32 nEntries = maControls.Count();
 319     for ( sal_uInt32 n = 0; n < nEntries; n++ )
 320     {
 321         UnoControlModelEntry* pEntry = maControls.GetObject( n );
 322         if ( pEntry->bGroup )
 323         {
 324             if ( nG == (sal_uInt32)nGroup )
 325             {
 326                 sal_uInt32 nCount = ImplGetControlCount( *pEntry->pGroup );
 327                 aSeq = ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > >( nCount );
 328                 ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > * pRefs = aSeq.getArray();
 329                 ImplGetControlModels( &pRefs, *pEntry->pGroup );
 330                 rName = pEntry->pGroup->GetName();
 331                 break;
 332             }
 333             nG++;
 334         }
 335     }
 336     rGroup = aSeq;
 337 }
 338
 339 void StdTabControllerModel::getGroupByName( const ::rtl::OUString& rName, ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > >& rGroup ) throw(::com::sun::star::uno::RuntimeException)
 340 {
 341     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 342
 343     sal_uInt32 nGroup = 0;
 344     sal_uInt32 nEntries = maControls.Count();
 345     for ( sal_uInt32 n = 0; n < nEntries; n++ )
 346     {
 347         UnoControlModelEntry* pEntry = maControls.GetObject( n );
 348         if ( pEntry->bGroup )
 349         {
 350             if ( pEntry->pGroup->GetName() == rName )
 351             {
 352                 ::rtl::OUString Dummy;
 353                 getGroup( nGroup, rGroup, Dummy );
 354                 break;
 355             }
 356             nGroup++;
 357         }
 358     }
 359 }
 360
 361
 362 // ::com::sun::star::io::XPersistObject
 363 ::rtl::OUString StdTabControllerModel::getServiceName(  ) throw(::com::sun::star::uno::RuntimeException)
 364 {
 365     return ::rtl::OUString::createFromAscii( szServiceName_TabControllerModel );
 366 }
 367
 368 void StdTabControllerModel::write( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream >& OutStream ) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException)
 369 {
 370     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 371
 372     ::com::sun::star::uno::Reference< ::com::sun::star::io::XMarkableStream >  xMark( OutStream, ::com::sun::star::uno::UNO_QUERY );
 373     DBG_ASSERT( xMark.is(), "write: no XMarkableStream!" );
 374
 375     OutStream->writeShort( UNOCONTROL_STREAMVERSION );
 376
 377     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > aCtrls = getControlModels();
 378     ImplWriteControls( OutStream, aCtrls );
 379
 380     sal_uInt32 nGroups = getGroupCount();
 381     OutStream->writeLong( nGroups );
 382     for ( sal_uInt32 n = 0; n < nGroups; n++ )
 383     {
 384         ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > aGroupCtrls;
 385         ::rtl::OUString aGroupName;
 386         getGroup( n, aGroupCtrls, aGroupName );
 387         OutStream->writeUTF( aGroupName );
 388         ImplWriteControls( OutStream, aGroupCtrls );
 389     }
 390 }
 391
 392 void StdTabControllerModel::read( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream >& InStream ) throw(::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException)
 393 {
 394     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 395
 396     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > aSeq = ImplReadControls( InStream );
 397     setControlModels( aSeq );
 398
 399     sal_uInt32 nGroups = InStream->readLong();
 400     for ( sal_uInt32 n = 0; n < nGroups; n++ )
 401     {
 402         ::rtl::OUString aGroupName = InStream->readUTF();
 403         ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > > aCtrlSeq = ImplReadControls( InStream );
 404         setGroup( aCtrlSeq, aGroupName );
 405     }
 406 }
 407
 408
 409
 410
 411