include/tools/zcodec.hxx

   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 #ifndef INCLUDED_TOOLS_ZCODEC_HXX
  21 #define INCLUDED_TOOLS_ZCODEC_HXX
  22
  23 #include <tools/toolsdllapi.h>
  24 #include <tools/long.hxx>
  25
  26 #define ZCODEC_NO_COMPRESSION       0
  27 #define ZCODEC_DEFAULT_COMPRESSION  6
  28
  29 class SvStream;
  30
  31 // The overall client call protocol is one of:
  32 // * BeginCompression, Compress, EndCompression
  33 // * BeginCompression, Decompress, EndCompression
  34 // * BeginCompression, Write*, EndCompression
  35 // * BeginCompression, Read*, EndCompression
  36 // * BeginCompression, ReadAsynchron*, EndCompression
  37 class SAL_WARN_UNUSED TOOLS_DLLPUBLIC ZCodec
  38 {
  39     enum State { STATE_INIT, STATE_DECOMPRESS, STATE_COMPRESS };
  40     State           meState;
  41     bool            mbStatus;
  42     bool            mbFinish;
  43     sal_uInt8*      mpInBuf;
  44     size_t          mnInBufSize;
  45     size_t          mnInToRead;
  46     SvStream*       mpOStm;
  47     sal_uInt8*      mpOutBuf;
  48     size_t          mnOutBufSize;
  49
  50     int             mnCompressLevel;
  51     bool            mbGzLib;
  52     void*           mpsC_Stream;
  53
  54     void            InitCompress();
  55     void            InitDecompress(SvStream & inStream);
  56     void            ImplWriteBack();
  57
  58 public:
  59                     ZCodec( size_t nInBufSize = 32768, size_t nOutBufSize = 32768 );
  60                     ~ZCodec();
  61
  62     void            BeginCompression( int nCompressLevel = ZCODEC_DEFAULT_COMPRESSION, bool gzLib = false );
  63     tools::Long            EndCompression();
  64
  65     void            Compress( SvStream& rIStm, SvStream& rOStm );
  66     tools::Long            Decompress( SvStream& rIStm, SvStream& rOStm );
  67     bool            AttemptDecompression( SvStream& rIStm, SvStream& rOStm );
  68
  69     void            Write( SvStream& rOStm, const sal_uInt8* pData, sal_uInt32 nSize );
  70     tools::Long            Read( SvStream& rIStm, sal_uInt8* pData, sal_uInt32 nSize );
  71     tools::Long            ReadAsynchron( SvStream& rIStm, sal_uInt8* pData, sal_uInt32 nSize );
  72
  73     void            SetBreak( size_t );
  74     size_t          GetBreak() const;
  75 };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */