office-gobmx/include/unotools/streamwrap.hxx
Noel Grandin 9ba8b37db5 use utl::TempFile directly in package
so we can
(a) control the lifetime of the temp file properly
and
(b) we don't need to use file URLs which means we stay on the
efficient path on Windows

Change-Id: I2b1eed5f5afc8f89f53bde35ebb44e9922889817
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/136557
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2022-06-28 14:56:46 +02:00

185 lines
6.8 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_UNOTOOLS_STREAMWRAP_HXX
#define INCLUDED_UNOTOOLS_STREAMWRAP_HXX
#include <unotools/unotoolsdllapi.h>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XSeekable.hpp>
#include <com/sun/star/io/XTruncate.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <comphelper/bytereader.hxx>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/implbase1.hxx>
#include <memory>
#include <mutex>
class SvStream;
namespace utl
{
// workaround for incremental linking bugs in MSVC2015
class SAL_DLLPUBLIC_TEMPLATE OInputStreamWrapper_Base : public cppu::WeakImplHelper< css::io::XInputStream, css::lang::XUnoTunnel > {};
/// helper class for wrapping an SvStream into a com.sun.star.io::XInputStream
class UNOTOOLS_DLLPUBLIC OInputStreamWrapper : public OInputStreamWrapper_Base, public comphelper::ByteReader
{
protected:
std::mutex m_aMutex;
SvStream* m_pSvStream;
bool m_bSvStreamOwner : 1;
OInputStreamWrapper()
{ m_pSvStream = nullptr; m_bSvStreamOwner = false; }
void SetStream(SvStream* _pStream, bool bOwner )
{ m_pSvStream = _pStream; m_bSvStreamOwner = bOwner; }
public:
OInputStreamWrapper(SvStream& _rStream);
OInputStreamWrapper(SvStream* pStream, bool bOwner=false);
OInputStreamWrapper(std::unique_ptr<SvStream> pStream);
virtual ~OInputStreamWrapper() override;
// css::io::XInputStream
virtual sal_Int32 SAL_CALL readBytes(css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nBytesToRead) override;
virtual sal_Int32 SAL_CALL readSomeBytes(css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nMaxBytesToRead) override;
virtual void SAL_CALL skipBytes(sal_Int32 nBytesToSkip) override;
virtual sal_Int32 SAL_CALL available() override;
virtual void SAL_CALL closeInput() override;
// css::lang::XUnoTunnel
virtual sal_Int64 SAL_CALL getSomething( const css::uno::Sequence< sal_Int8 >& _rIdentifier ) override;
// utl::ByteReader
virtual sal_Int32 readSomeBytes( sal_Int8* aData, sal_Int32 nMaxBytesToRead ) final override;
protected:
/// throws a NotConnectedException if the object is not connected anymore
void checkConnected() const;
/// throws an exception according to the error flag of m_pSvStream
void checkError() const;
};
//= OSeekableInputStreamWrapper
/** helper class for wrapping an SvStream into a com.sun.star.io::XInputStream
which is seekable (i.e. supports the com.sun.star.io::XSeekable interface).
*/
class UNOTOOLS_DLLPUBLIC OSeekableInputStreamWrapper
: public cppu::ImplInheritanceHelper< OInputStreamWrapper, css::io::XSeekable >
{
protected:
OSeekableInputStreamWrapper() {}
~OSeekableInputStreamWrapper() override;
public:
OSeekableInputStreamWrapper(SvStream& _rStream);
OSeekableInputStreamWrapper(SvStream* _pStream, bool _bOwner = false);
// XSeekable
virtual void SAL_CALL seek( sal_Int64 _nLocation ) override;
virtual sal_Int64 SAL_CALL getPosition( ) override;
virtual sal_Int64 SAL_CALL getLength( ) override;
};
//= OOutputStreamWrapper
class OOutputStreamWrapper : public cppu::WeakImplHelper<css::io::XOutputStream>
{
public:
UNOTOOLS_DLLPUBLIC OOutputStreamWrapper(SvStream& _rStream);
protected:
virtual ~OOutputStreamWrapper() override;
// css::io::XOutputStream
virtual void SAL_CALL writeBytes(const css::uno::Sequence< sal_Int8 >& aData) override;
virtual void SAL_CALL flush() override;
virtual void SAL_CALL closeOutput() override;
/// throws an exception according to the error flag of m_pSvStream
void checkError() const;
// TODO: thread safety!
SvStream& rStream;
};
//= OSeekableOutputStreamWrapper
typedef ::cppu::ImplHelper1 < css::io::XSeekable
> OSeekableOutputStreamWrapper_Base;
/** helper class for wrapping an SvStream into a com.sun.star.io::XOutputStream
which is seekable (i.e. supports the com.sun.star.io::XSeekable interface).
*/
class UNOTOOLS_DLLPUBLIC OSeekableOutputStreamWrapper final
:public OOutputStreamWrapper
,public OSeekableOutputStreamWrapper_Base
{
public:
OSeekableOutputStreamWrapper(SvStream& _rStream);
private:
virtual ~OSeekableOutputStreamWrapper() override;
// disambiguate XInterface
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& _rType ) override;
virtual void SAL_CALL acquire( ) noexcept override
{ OOutputStreamWrapper::acquire(); }
virtual void SAL_CALL release( ) noexcept override
{ OOutputStreamWrapper::release(); }
// XSeekable
virtual void SAL_CALL seek( sal_Int64 _nLocation ) override;
virtual sal_Int64 SAL_CALL getPosition( ) override;
virtual sal_Int64 SAL_CALL getLength( ) override;
};
class UNOTOOLS_DLLPUBLIC OStreamWrapper final
: public cppu::ImplInheritanceHelper<OSeekableInputStreamWrapper,
css::io::XStream,
css::io::XOutputStream,
css::io::XTruncate>
{
~OStreamWrapper() override;
public:
OStreamWrapper(SvStream& _rStream);
OStreamWrapper(std::unique_ptr<SvStream> _rStream);
OStreamWrapper(SvStream* _pStream, bool _bOwner = false);
// css::io::XStream
virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getInputStream( ) override;
virtual css::uno::Reference< css::io::XOutputStream > SAL_CALL getOutputStream( ) override;
// css::io::XOutputStream
virtual void SAL_CALL writeBytes(const css::uno::Sequence< sal_Int8 >& aData) override;
virtual void SAL_CALL flush() override;
virtual void SAL_CALL closeOutput() override;
virtual void SAL_CALL truncate() override;
};
}
// namespace utl
#endif // INCLUDED_UNOTOOLS_STREAMWRAP_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */