include/unotools/streamhelper.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_UNOTOOLS_STREAMHELPER_HXX
  21 #define INCLUDED_UNOTOOLS_STREAMHELPER_HXX
  22
  23 #include <unotools/unotoolsdllapi.h>
  24 #include <com/sun/star/io/XInputStream.hpp>
  25 #include <com/sun/star/io/XSeekable.hpp>
  26 #include <osl/mutex.hxx>
  27 #include <cppuhelper/implbase.hxx>
  28 #include <tools/stream.hxx>
  29
  30 namespace utl
  31 {
  32
  33 /**
  34  * The helper implementation for a using input streams based on SvLockBytes.
  35  */
  36 class UNOTOOLS_DLLPUBLIC OInputStreamHelper : public cppu::WeakImplHelper<css::io::XInputStream, css::io::XSeekable>
  37 {
  38     ::osl::Mutex    m_aMutex;
  39     SvLockBytesRef  m_xLockBytes;
  40     sal_uInt64      m_nActPos;
  41     sal_Int32 const       m_nAvailable;   // this is typically the chunk(buffer) size
  42
  43 public:
  44     OInputStreamHelper(const SvLockBytesRef& _xLockBytes,
  45                        sal_uInt32 _nAvailable)
  46         :m_xLockBytes(_xLockBytes)
  47         ,m_nActPos(0)
  48         ,m_nAvailable(_nAvailable){}
  49
  50 // css::io::XInputStream
  51     virtual sal_Int32 SAL_CALL readBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nBytesToRead ) override;
  52     virtual sal_Int32 SAL_CALL readSomeBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nMaxBytesToRead ) override;
  53     virtual void SAL_CALL skipBytes( sal_Int32 nBytesToSkip ) override;
  54     virtual sal_Int32 SAL_CALL available(  ) override;
  55     virtual void SAL_CALL closeInput(  ) override;
  56
  57     virtual void SAL_CALL seek( sal_Int64 location ) override;
  58     virtual sal_Int64 SAL_CALL getPosition(  ) override;
  59     virtual sal_Int64 SAL_CALL getLength(  ) override;
  60 };
  61
  62 }   // namespace utl
  63
  64 #endif // _UNOTOOLS_STREAM_WRAPPER_HXX_
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */