sc/source/filter/ftools/fprogressbar.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: fprogressbar.cxx,v $
  10  * $Revision: 1.10.32.2 $
  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_sc.hxx"
  33 #include "fprogressbar.hxx"
  34 #include "global.hxx"
  35 #include "progress.hxx"
  36
  37 // ============================================================================
  38
  39 ScfProgressBar::ScfProgressSegment::ScfProgressSegment( sal_Size nSize ) :
  40     mxProgress( 0 ),
  41     mnSize( nSize ),
  42     mnPos( 0 )
  43 {
  44 }
  45
  46 ScfProgressBar::ScfProgressSegment::~ScfProgressSegment()
  47 {
  48 }
  49
  50 // ============================================================================
  51
  52 ScfProgressBar::ScfProgressBar( SfxObjectShell* pDocShell, const String& rText ) :
  53     maText( rText )
  54 {
  55     Init( pDocShell );
  56 }
  57
  58 ScfProgressBar::ScfProgressBar( SfxObjectShell* pDocShell, USHORT nResId ) :
  59     maText( ScGlobal::GetRscString( nResId ) )
  60 {
  61     Init( pDocShell );
  62 }
  63
  64 ScfProgressBar::ScfProgressBar( ScfProgressBar& rParProgress, ScfProgressSegment* pParSegment )
  65 {
  66     Init( rParProgress.mpDocShell );
  67     mpParentProgress = &rParProgress;
  68     mpParentSegment = pParSegment;
  69 }
  70
  71 ScfProgressBar::~ScfProgressBar()
  72 {
  73 }
  74
  75 void ScfProgressBar::Init( SfxObjectShell* pDocShell )
  76 {
  77     mpDocShell = pDocShell;
  78     mpParentProgress = 0;
  79     mpParentSegment = mpCurrSegment = 0;
  80     mnTotalSize = mnTotalPos = mnUnitSize = mnNextUnitPos = 0;
  81     mnSysProgressScale = 1;     // used to workaround the ULONG_MAX/100 limit
  82     mbInProgress = false;
  83 }
  84
  85 ScfProgressBar::ScfProgressSegment* ScfProgressBar::GetSegment( sal_Int32 nSegment ) const
  86 {
  87     if( nSegment < 0 )
  88         return 0;
  89     DBG_ASSERT( maSegments.GetObject( nSegment ), "ScfProgressBar::GetSegment - invalid segment index" );
  90     return maSegments.GetObject( nSegment );
  91 }
  92
  93 void ScfProgressBar::SetCurrSegment( ScfProgressSegment* pSegment )
  94 {
  95     if( mpCurrSegment != pSegment )
  96     {
  97         mpCurrSegment = pSegment;
  98
  99         if( mpParentProgress && mpParentSegment )
 100         {
 101             mpParentProgress->SetCurrSegment( mpParentSegment );
 102         }
 103         else if( !mxSysProgress.get() && (mnTotalSize > 0) )
 104         {
 105             // System progress has an internal limit of ULONG_MAX/100.
 106             mnSysProgressScale = 1;
 107             ULONG nSysTotalSize = static_cast< ULONG >( mnTotalSize );
 108             while( nSysTotalSize >= ULONG_MAX / 100 )
 109             {
 110                 nSysTotalSize /= 2;
 111                 mnSysProgressScale *= 2;
 112             }
 113             mxSysProgress.reset( new ScProgress( mpDocShell, maText, nSysTotalSize ) );
 114         }
 115
 116         if( !mbInProgress && mpCurrSegment && (mnTotalSize > 0) )
 117         {
 118             mnUnitSize = mnTotalSize / 256 + 1;   // at most 256 calls of system progress
 119             mnNextUnitPos = 0;
 120             mbInProgress = true;
 121         }
 122     }
 123 }
 124
 125 void ScfProgressBar::IncreaseProgressBar( sal_Size nDelta )
 126 {
 127     sal_Size nNewPos = mnTotalPos + nDelta;
 128
 129     // call back to parent progress bar
 130     if( mpParentProgress && mpParentSegment )
 131     {
 132         // calculate new position of parent progress bar
 133         sal_Size nParentPos = static_cast< sal_Size >(
 134             static_cast< double >( nNewPos ) * mpParentSegment->mnSize / mnTotalSize );
 135         mpParentProgress->ProgressAbs( nParentPos );
 136     }
 137     // modify system progress bar
 138     else if( mxSysProgress.get() )
 139     {
 140         if( nNewPos >= mnNextUnitPos )
 141         {
 142             mnNextUnitPos = nNewPos + mnUnitSize;
 143             mxSysProgress->SetState( static_cast< ULONG >( nNewPos / mnSysProgressScale ) );
 144         }
 145     }
 146     else
 147     {
 148         DBG_ERRORFILE( "ScfProgressBar::IncreaseProgressBar - no progress bar found" );
 149     }
 150
 151     mnTotalPos = nNewPos;
 152 }
 153
 154 sal_Int32 ScfProgressBar::AddSegment( sal_Size nSize )
 155 {
 156     DBG_ASSERT( !mbInProgress, "ScfProgressBar::AddSegment - already in progress mode" );
 157     if( nSize == 0 )
 158         return SCF_INV_SEGMENT;
 159
 160     maSegments.Append( new ScfProgressSegment( nSize ) );
 161     mnTotalSize += nSize;
 162     return static_cast< sal_Int32 >( maSegments.Count() - 1 );
 163 }
 164
 165 ScfProgressBar& ScfProgressBar::GetSegmentProgressBar( sal_Int32 nSegment )
 166 {
 167     ScfProgressSegment* pSegment = GetSegment( nSegment );
 168     DBG_ASSERT( !pSegment || (pSegment->mnPos == 0), "ScfProgressBar::GetSegmentProgressBar - segment already started" );
 169     if( pSegment && (pSegment->mnPos == 0) )
 170     {
 171         if( !pSegment->mxProgress.get() )
 172             pSegment->mxProgress.reset( new ScfProgressBar( *this, pSegment ) );
 173         return *pSegment->mxProgress;
 174     }
 175     return *this;
 176 }
 177
 178 bool ScfProgressBar::IsFull() const
 179 {
 180     DBG_ASSERT( mbInProgress && mpCurrSegment, "ScfProgressBar::IsFull - no segment started" );
 181     return mpCurrSegment && (mpCurrSegment->mnPos >= mpCurrSegment->mnSize);
 182 }
 183
 184 void ScfProgressBar::ActivateSegment( sal_Int32 nSegment )
 185 {
 186     DBG_ASSERT( mnTotalSize > 0, "ScfProgressBar::ActivateSegment - progress range is zero" );
 187     if( mnTotalSize > 0 )
 188         SetCurrSegment( GetSegment( nSegment ) );
 189 }
 190
 191 void ScfProgressBar::ProgressAbs( sal_Size nPos )
 192 {
 193     DBG_ASSERT( mbInProgress && mpCurrSegment, "ScfProgressBar::ProgressAbs - no segment started" );
 194     if( mpCurrSegment )
 195     {
 196         DBG_ASSERT( mpCurrSegment->mnPos <= nPos, "ScfProgressBar::ProgressAbs - delta pos < 0" );
 197         DBG_ASSERT( nPos <= mpCurrSegment->mnSize, "ScfProgressBar::ProgressAbs - segment overflow" );
 198         if( (mpCurrSegment->mnPos < nPos) && (nPos <= mpCurrSegment->mnSize) )
 199         {
 200             IncreaseProgressBar( nPos - mpCurrSegment->mnPos );
 201             mpCurrSegment->mnPos = nPos;
 202         }
 203     }
 204 }
 205
 206 void ScfProgressBar::Progress( sal_Size nDelta )
 207 {
 208     ProgressAbs( mpCurrSegment ? (mpCurrSegment->mnPos + nDelta) : 0 );
 209 }
 210
 211 // ============================================================================
 212
 213 ScfSimpleProgressBar::ScfSimpleProgressBar( sal_Size nSize, SfxObjectShell* pDocShell, const String& rText ) :
 214     maProgress( pDocShell, rText )
 215 {
 216     Init( nSize );
 217 }
 218
 219 ScfSimpleProgressBar::ScfSimpleProgressBar( sal_Size nSize, SfxObjectShell* pDocShell, USHORT nResId ) :
 220     maProgress( pDocShell, nResId )
 221 {
 222     Init( nSize );
 223 }
 224
 225 void ScfSimpleProgressBar::Init( sal_Size nSize )
 226 {
 227     sal_Int32 nSegment = maProgress.AddSegment( nSize );
 228     if( nSegment >= 0 )
 229         maProgress.ActivateSegment( nSegment );
 230 }
 231
 232 // ============================================================================
 233
 234 //UNUSED2008-05  ScfStreamProgressBar::ScfStreamProgressBar( SvStream& rStrm, SfxObjectShell* pDocShell, const String& rText ) :
 235 //UNUSED2008-05      mrStrm( rStrm )
 236 //UNUSED2008-05  {
 237 //UNUSED2008-05      Init( pDocShell, rText );
 238 //UNUSED2008-05  }
 239
 240 ScfStreamProgressBar::ScfStreamProgressBar( SvStream& rStrm, SfxObjectShell* pDocShell, USHORT nResId ) :
 241     mrStrm( rStrm )
 242 {
 243     Init( pDocShell, ScGlobal::GetRscString( nResId ) );
 244 }
 245
 246 void ScfStreamProgressBar::Progress()
 247 {
 248     mxProgress->ProgressAbs( mrStrm.Tell() );
 249 }
 250
 251 void ScfStreamProgressBar::Init( SfxObjectShell* pDocShell, const String& rText )
 252 {
 253     sal_Size nPos = mrStrm.Tell();
 254     mrStrm.Seek( STREAM_SEEK_TO_END );
 255     sal_Size nSize = mrStrm.Tell();
 256     mrStrm.Seek( nPos );
 257
 258     mxProgress.reset( new ScfSimpleProgressBar( nSize, pDocShell, rText ) );
 259     Progress();
 260 }
 261
 262 // ============================================================================
 263