tools/source/stream/cachestr.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: cachestr.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_tools.hxx"
  33
  34 #include <tools/debug.hxx>
  35 #include <tools/stream.hxx>
  36 #include <tools/cachestr.hxx>
  37 #include <tools/tempfile.hxx>
  38
  39 /*************************************************************************
  40 |*
  41 |*    SvCacheStream::SvCacheStream()
  42 |*
  43 |*    Beschreibung      STREAM.SDW
  44 |*    Ersterstellung    OV 27.09.94
  45 |*    Letzte Aenderung  OV 27.09.94
  46 |*
  47 *************************************************************************/
  48
  49 SvCacheStream::SvCacheStream( ULONG nMaxMemSize )
  50 {
  51     if( !nMaxMemSize )
  52         nMaxMemSize = 20480;
  53     SvStream::bIsWritable = TRUE;
  54     nMaxSize            = nMaxMemSize;
  55     bPersistent         = FALSE;
  56     pSwapStream         = 0;
  57     pCurrentStream      = new SvMemoryStream( nMaxMemSize );
  58     pTempFile       = 0;
  59 }
  60
  61 /*************************************************************************
  62 |*
  63 |*    SvCacheStream::SvCacheStream()
  64 |*
  65 |*    Beschreibung      STREAM.SDW
  66 |*    Ersterstellung    OV 27.09.94
  67 |*    Letzte Aenderung  OV 27.09.94
  68 |*
  69 *************************************************************************/
  70
  71 SvCacheStream::SvCacheStream( const String &rFileName,
  72                               ULONG nExpectedSize,
  73                               ULONG nMaxMemSize )
  74 {
  75     if( !nMaxMemSize )
  76         nMaxMemSize = 20480;
  77
  78     if( nExpectedSize > nMaxMemSize )
  79         nExpectedSize = nMaxMemSize; // oder gleich in File schreiben
  80     else if( !nExpectedSize )
  81         nExpectedSize = 4096;
  82
  83     SvStream::bIsWritable = TRUE;
  84     nMaxSize            = nMaxMemSize;
  85     bPersistent         = TRUE;
  86     aFileName           = rFileName;
  87     pSwapStream         = 0;
  88     pCurrentStream      = new SvMemoryStream( nExpectedSize );
  89     pTempFile       = 0;
  90 }
  91
  92 /*************************************************************************
  93 |*
  94 |*    SvCacheStream::~SvCacheStream()
  95 |*
  96 |*    Beschreibung      STREAM.SDW
  97 |*    Ersterstellung    OV 27.09.94
  98 |*    Letzte Aenderung  OV 27.09.94
  99 |*
 100 *************************************************************************/
 101
 102 SvCacheStream::~SvCacheStream()
 103 {
 104        if( pCurrentStream != pSwapStream )
 105         delete pSwapStream;
 106     delete pCurrentStream;
 107
 108     if( pSwapStream && !bPersistent && pTempFile )
 109     {
 110         // temporaeres File loeschen
 111         pTempFile->EnableKillingFile( TRUE );
 112     }
 113
 114     delete pTempFile;
 115 }
 116
 117 /*************************************************************************
 118 |*
 119 |*    SvCacheStream::SwapOut()
 120 |*
 121 |*    Beschreibung      STREAM.SDW
 122 |*    Ersterstellung    OV 27.09.94
 123 |*    Letzte Aenderung  OV 27.09.94
 124 |*
 125 *************************************************************************/
 126
 127 void SvCacheStream::SwapOut()
 128 {
 129     if( pCurrentStream != pSwapStream )
 130     {
 131         if( !pSwapStream && !aFileName.Len() )
 132         {
 133             if (aFilenameLinkHdl.IsSet())
 134             {
 135                 // pSwapStream wird zum Schutz gegen Reentranz genutzt
 136                 pSwapStream = pCurrentStream;
 137                 Link aLink( aFilenameLinkHdl );
 138                 aFilenameLinkHdl = Link();
 139                 aLink.Call(this);
 140                 // pSwapStream nur zuruecksetzen, wenn nicht ueber
 141                 // SetSwapStream geaendert
 142                 if( pSwapStream == pCurrentStream ) pSwapStream = 0;
 143             }
 144             else
 145             {
 146                 pTempFile = new TempFile;
 147                 aFileName = pTempFile->GetName();
 148             }
 149         }
 150
 151         ULONG nPos = pCurrentStream->Tell();
 152         pCurrentStream->Seek( 0 );
 153         if( !pSwapStream )
 154             pSwapStream = new SvFileStream( aFileName, STREAM_READWRITE | STREAM_TRUNC );
 155         *pSwapStream << *pCurrentStream;
 156         pSwapStream->Flush();
 157         delete pCurrentStream;
 158         pCurrentStream = pSwapStream;
 159         pCurrentStream->Seek( nPos );
 160     }
 161 }
 162
 163 /*************************************************************************
 164 |*
 165 |*    SvCacheStream::GetData()
 166 |*
 167 |*    Beschreibung      STREAM.SDW
 168 |*    Ersterstellung    OV 27.09.94
 169 |*    Letzte Aenderung  OV 27.09.94
 170 |*
 171 *************************************************************************/
 172
 173 ULONG SvCacheStream::GetData( void* pData, ULONG nSize )
 174 {
 175     return pCurrentStream->Read( pData, nSize );
 176 }
 177
 178 /*************************************************************************
 179 |*
 180 |*    SvCacheStream::PutData()
 181 |*
 182 |*    Beschreibung      STREAM.SDW
 183 |*    Ersterstellung    OV 27.09.94
 184 |*    Letzte Aenderung  OV 27.09.94
 185 |*
 186 *************************************************************************/
 187
 188 ULONG SvCacheStream::PutData( const void* pData, ULONG nSize )
 189 {
 190     // lieber unnoetig auslagern als unnoetig umkopieren
 191     if( pCurrentStream != pSwapStream
 192         && pCurrentStream->Tell() + nSize > nMaxSize )
 193         SwapOut();
 194     return pCurrentStream->Write( pData, nSize );
 195 }
 196
 197 /*************************************************************************
 198 |*
 199 |*    SvCacheStream::SeekPos()
 200 |*
 201 |*    Beschreibung      STREAM.SDW
 202 |*    Ersterstellung    OV 27.09.94
 203 |*    Letzte Aenderung  OV 27.09.94
 204 |*
 205 *************************************************************************/
 206
 207 ULONG SvCacheStream::SeekPos( ULONG nPos )
 208 {
 209     return pCurrentStream->Seek( nPos );
 210 }
 211
 212 /*************************************************************************
 213 |*
 214 |*    SvCacheStream::FlushData()
 215 |*
 216 |*    Beschreibung      STREAM.SDW
 217 |*    Ersterstellung    OV 27.09.94
 218 |*    Letzte Aenderung  OV 27.09.94
 219 |*
 220 *************************************************************************/
 221
 222 void SvCacheStream::FlushData()
 223 {
 224     pCurrentStream->Flush();
 225     if( pCurrentStream != pSwapStream
 226         && ((SvMemoryStream*)pCurrentStream)->GetSize() > nMaxSize )
 227         SwapOut();
 228 }
 229
 230 /*************************************************************************
 231 |*
 232 |*    SvCacheStream::GetStr()
 233 |*
 234 |*    Beschreibung      STREAM.SDW
 235 |*    Ersterstellung    OV 27.09.94
 236 |*    Letzte Aenderung  OV 27.09.94
 237 |*
 238 *************************************************************************/
 239
 240 const void* SvCacheStream::GetBuffer()
 241 {
 242     Flush();
 243     if( pCurrentStream != pSwapStream )
 244         return ((SvMemoryStream*)pCurrentStream)->GetData();
 245     else
 246         return 0;
 247 }
 248
 249 /*************************************************************************
 250 |*
 251 |*    SvCacheStream::SetSize()
 252 |*
 253 |*    Beschreibung      STREAM.SDW
 254 |*    Ersterstellung    OV 27.09.94
 255 |*    Letzte Aenderung  OV 27.09.94
 256 |*
 257 *************************************************************************/
 258
 259 void SvCacheStream::SetSize( ULONG nSize )
 260 {
 261     pCurrentStream->SetStreamSize( nSize );
 262 }
 263
 264 /*************************************************************************
 265 |*
 266 |*    SvCacheStream::GetSize()
 267 |*
 268 |*    Beschreibung      STREAM.SDW
 269 |*    Ersterstellung    OV 27.09.94
 270 |*    Letzte Aenderung  OV 27.09.94
 271 |*
 272 *************************************************************************/
 273
 274 ULONG SvCacheStream::GetSize()
 275 {
 276     // ACHTUNG: SvMemoryStream::GetSize() gibt Groesse
 277     // des allozierten Buffers zurueck
 278     Flush();
 279     ULONG nTemp = Tell();
 280     ULONG nLength = Seek( STREAM_SEEK_TO_END );
 281     Seek( nTemp );
 282     return nLength;
 283 }
 284
 285 void    SvCacheStream::SetFilenameHdl( const Link& rLink)
 286 {
 287     aFilenameLinkHdl = rLink;
 288 }
 289
 290 const Link& SvCacheStream::GetFilenameHdl() const
 291 {
 292     return aFilenameLinkHdl;
 293 }