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 <cppuhelper/implbase.hxx>
  27 #include <tools/stream.hxx>
  28 #include <mutex>
  29 #include <utility>
  30
  31 namespace utl
  32 {
  33
  34 /**
  35  * The helper implementation for a using input streams based on SvLockBytes.
  36  */
  37 class UNOTOOLS_DLLPUBLIC OInputStreamHelper final : public cppu::WeakImplHelper<css::io::XInputStream, css::io::XSeekable>
  38 {
  39     std::mutex      m_aMutex;
  40     SvLockBytesRef  m_xLockBytes;
  41     sal_uInt64      m_nActPos;
  42     sal_Int32       m_nAvailable;   // this is typically the chunk(buffer) size
  43
  44 public:
  45     OInputStreamHelper(SvLockBytesRef _xLockBytes,
  46                        sal_uInt32 _nAvailable)
  47         :m_xLockBytes(std::move(_xLockBytes))
  48         ,m_nActPos(0)
  49         ,m_nAvailable(_nAvailable){}
  50
  51 // css::io::XInputStream
  52     virtual sal_Int32 SAL_CALL readBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nBytesToRead ) override;
  53     virtual sal_Int32 SAL_CALL readSomeBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nMaxBytesToRead ) override;
  54     virtual void SAL_CALL skipBytes( sal_Int32 nBytesToSkip ) override;
  55     virtual sal_Int32 SAL_CALL available(  ) override;
  56     virtual void SAL_CALL closeInput(  ) override;
  57
  58     virtual void SAL_CALL seek( sal_Int64 location ) override;
  59     virtual sal_Int64 SAL_CALL getPosition(  ) override;
  60     virtual sal_Int64 SAL_CALL getLength(  ) override;
  61
  62     // workaround for Ubuntu 18.04 / Fedora 31 (Coverity VM) build with std::mutex; must not be inline!
  63     virtual void SAL_CALL acquire() SAL_NOEXCEPT override;
  64 };
  65
  66 }   // namespace utl
  67
  68 #endif // _UNOTOOLS_STREAM_WRAPPER_HXX_
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */