include/oox/ole/vbainputstream.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_OOX_OLE_VBAINPUTSTREAM_HXX
  21 #define INCLUDED_OOX_OLE_VBAINPUTSTREAM_HXX
  22
  23 #include <cstddef>
  24 #include <vector>
  25
  26 #include <oox/helper/binaryinputstream.hxx>
  27 #include <oox/helper/binarystreambase.hxx>
  28 #include <sal/types.h>
  29
  30 namespace oox {
  31 namespace ole {
  32
  33
  34 /** A non-seekable input stream that implements run-length decompression. */
  35 class VbaInputStream : public BinaryInputStream
  36 {
  37 public:
  38     explicit            VbaInputStream( BinaryInputStream& rInStrm );
  39
  40     /** Returns -1, stream size is not determinable. */
  41     virtual sal_Int64   size() const override;
  42     /** Returns -1, stream position is not tracked. */
  43     virtual sal_Int64   tell() const override;
  44     /** Does nothing, stream is not seekable. */
  45     virtual void        seek( sal_Int64 nPos ) override;
  46     /** Closes the input stream but not the wrapped stream. */
  47     virtual void        close() override;
  48
  49     /** Reads nBytes bytes to the passed sequence.
  50         @return  Number of bytes really read. */
  51     virtual sal_Int32   readData( StreamDataSequence& orData, sal_Int32 nBytes, size_t nAtomSize = 1 ) override;
  52     /** Reads nBytes bytes to the (existing) buffer opMem.
  53         @return  Number of bytes really read. */
  54     virtual sal_Int32   readMemory( void* opMem, sal_Int32 nBytes, size_t nAtomSize = 1 ) override;
  55     /** Seeks the stream forward by the passed number of bytes. */
  56     virtual void        skip( sal_Int32 nBytes, size_t nAtomSize = 1 ) override;
  57
  58 private:
  59     /** If no data left in chunk buffer, reads the next chunk from stream. */
  60     bool                updateChunk();
  61
  62 private:
  63     typedef ::std::vector< sal_uInt8 > ChunkBuffer;
  64
  65     BinaryInputStream*  mpInStrm;
  66     ChunkBuffer         maChunk;
  67     size_t              mnChunkPos;
  68 };
  69
  70
  71 } // namespace ole
  72 } // namespace oox
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */