ucb/source/ucp/file/filstr.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 #pragma once
  20
  21 #include <rtl/ustring.hxx>
  22 #include <com/sun/star/io/XSeekable.hpp>
  23 #include <com/sun/star/io/XTruncate.hpp>
  24 #include <com/sun/star/io/XInputStream.hpp>
  25 #include <com/sun/star/io/XOutputStream.hpp>
  26 #include <com/sun/star/io/XStream.hpp>
  27 #include <com/sun/star/io/XAsyncOutputMonitor.hpp>
  28 #include <com/sun/star/lang/XUnoTunnel.hpp>
  29 #include <comphelper/bytereader.hxx>
  30 #include <cppuhelper/implbase.hxx>
  31 #include <mutex>
  32
  33 #include "filrec.hxx"
  34
  35 namespace fileaccess {
  36
  37     // forward:
  38     class TaskManager;
  39
  40 class XStream_impl :  public cppu::WeakImplHelper<
  41     css::io::XStream,
  42     css::io::XSeekable,
  43     css::io::XInputStream,
  44     css::io::XOutputStream,
  45     css::io::XTruncate,
  46     css::io::XAsyncOutputMonitor >,
  47     public comphelper::ByteReader
  48     {
  49
  50     public:
  51
  52         XStream_impl( const OUString& aUncPath, bool bLock );
  53
  54         /**
  55          *  Returns an error code as given by filerror.hxx
  56          */
  57
  58         sal_Int32 CtorSuccess() const { return m_nErrorCode;}
  59         sal_Int32 getMinorError() const { return m_nMinorErrorCode;}
  60
  61         virtual ~XStream_impl() override;
  62
  63         // XStream
  64
  65         virtual css::uno::Reference< css::io::XInputStream > SAL_CALL
  66         getInputStream() override;
  67
  68         virtual css::uno::Reference< css::io::XOutputStream > SAL_CALL
  69         getOutputStream() override;
  70
  71
  72         // XTruncate
  73
  74         virtual void SAL_CALL truncate() override;
  75
  76
  77         // XInputStream
  78
  79         sal_Int32 SAL_CALL
  80         readBytes(
  81             css::uno::Sequence< sal_Int8 >& aData,
  82             sal_Int32 nBytesToRead ) override;
  83
  84         sal_Int32 SAL_CALL
  85         readSomeBytes(
  86             css::uno::Sequence< sal_Int8 >& aData,
  87             sal_Int32 nMaxBytesToRead ) override;
  88
  89
  90         void SAL_CALL
  91         skipBytes( sal_Int32 nBytesToSkip ) override;
  92
  93         sal_Int32 SAL_CALL
  94         available() override;
  95
  96         void SAL_CALL
  97         closeInput() override;
  98
  99         // XSeekable
 100
 101         void SAL_CALL
 102         seek( sal_Int64 location ) override;
 103
 104         sal_Int64 SAL_CALL
 105         getPosition() override;
 106
 107         sal_Int64 SAL_CALL
 108         getLength() override;
 109
 110
 111         // XOutputStream
 112
 113         void SAL_CALL
 114         writeBytes( const css::uno::Sequence< sal_Int8 >& aData ) override;
 115
 116
 117         void SAL_CALL
 118         flush() override;
 119
 120
 121         void SAL_CALL
 122         closeOutput() override;
 123
 124         virtual void SAL_CALL waitForCompletion() override;
 125
 126         // utl::ByteReader
 127         virtual sal_Int32
 128         readSomeBytes(
 129             sal_Int8* aData,
 130             sal_Int32 nMaxBytesToRead ) override;
 131
 132     private:
 133
 134         std::mutex   m_aMutex;
 135         bool         m_bInputStreamCalled,m_bOutputStreamCalled;
 136         bool         m_nIsOpen;
 137
 138         ReconnectingFile    m_aFile;
 139
 140         sal_Int32                                          m_nErrorCode;
 141         sal_Int32                                          m_nMinorErrorCode;
 142
 143         // Implementation methods
 144
 145         /// @throws css::io::NotConnectedException
 146         /// @throws css::io::IOException
 147         /// @throws css::uno::RuntimeException
 148         void
 149         closeStream();
 150
 151     };
 152
 153 }  // end namespace XStream_impl
 154
 155 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */