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
  25 #define ZCODEC_NO_COMPRESSION       0
  26 #define ZCODEC_DEFAULT_COMPRESSION  6
  27
  28 class SvStream;
  29
  30 // The overall client call protocol is one of:
  31 // * BeginCompression, Compress, EndCompression
  32 // * BeginCompression, Decompress, EndCompression
  33 // * BeginCompression, Write*, EndCompression
  34 // * BeginCompression, Read*, EndCompression
  35 // * BeginCompression, ReadAsynchron*, EndCompression
  36 class TOOLS_DLLPUBLIC ZCodec
  37 {
  38     enum State { STATE_INIT, STATE_DECOMPRESS, STATE_COMPRESS };
  39     State           meState;
  40     bool            mbStatus;
  41     bool            mbFinish;
  42     sal_uInt8*      mpInBuf;
  43     sal_uIntPtr     mnInBufSize;
  44     sal_uIntPtr     mnInToRead;
  45     SvStream*       mpOStm;
  46     sal_uInt8*      mpOutBuf;
  47     sal_uIntPtr     mnOutBufSize;
  48
  49     sal_uIntPtr     mnCRC;
  50     int             mnCompressLevel;
  51     bool            mbUpdateCrc;
  52     bool            mbGzLib;
  53     void*           mpsC_Stream;
  54
  55     void            InitCompress();
  56     void            InitDecompress(SvStream & inStream);
  57     void            ImplWriteBack();
  58
  59     void            UpdateCRC( sal_uInt8* pSource, long nDatSize );
  60
  61 public:
  62                     ZCodec( sal_uIntPtr nInBuf = 0x8000UL, sal_uIntPtr nOutBuf = 0x8000UL );
  63                     ~ZCodec();
  64
  65     void            BeginCompression( int nCompressLevel = ZCODEC_DEFAULT_COMPRESSION, bool updateCrc = false, bool gzLib = false );
  66     long            EndCompression();
  67
  68     long            Compress( SvStream& rIStm, SvStream& rOStm );
  69     long            Decompress( SvStream& rIStm, SvStream& rOStm );
  70     bool            AttemptDecompression( SvStream& rIStm, SvStream& rOStm, bool updateCrc = false, bool gzLib = false );
  71
  72     long            Write( SvStream& rOStm, const sal_uInt8* pData, sal_uIntPtr nSize );
  73     long            Read( SvStream& rIStm, sal_uInt8* pData, sal_uIntPtr nSize );
  74     long            ReadAsynchron( SvStream& rIStm, sal_uInt8* pData, sal_uIntPtr nSize );
  75
  76     void            SetBreak( sal_uIntPtr );
  77     sal_uIntPtr     GetBreak();
  78     void            SetCRC( sal_uIntPtr nCurrentCRC );
  79     sal_uIntPtr     GetCRC() { return mnCRC;}
  80 };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */