Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 179 insertions, 0 deletions

diff --git a/include/oox/helper/binarystreambase.hxx b/include/oox/helper/binarystreambase.hxx
new file mode 100644
index 0000000000..8e93d14586
--- /dev/null
+++ b/include/oox/helper/binarystreambase.hxx
@@ -0,0 +1,179 @@
+/* -*- 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_OOX_HELPER_BINARYSTREAMBASE_HXX
+#define INCLUDED_OOX_HELPER_BINARYSTREAMBASE_HXX
+
+#include <com/sun/star/uno/Reference.hxx>
+#include <com/sun/star/uno/Sequence.hxx>
+#include <oox/dllapi.h>
+#include <sal/types.h>
+
+namespace com::sun::star {
+    namespace io { class XSeekable; }
+}
+
+namespace oox {
+
+typedef css::uno::Sequence< sal_Int8 > StreamDataSequence;
+
+
+/** Base class for binary stream classes.
+ */
+class OOX_DLLPUBLIC BinaryStreamBase
+{
+public:
+    virtual             ~BinaryStreamBase();
+
+    /** Implementations return the size of the stream, if possible.
+
+        This function may be implemented for some types of unseekable streams,
+        and MUST be implemented for all seekable streams.
+
+        @return
+            The size of the stream in bytes, or -1, if not implemented.
+     */
+    virtual sal_Int64   size() const = 0;
+
+    /** Implementations return the current stream position, if possible.
+
+        This function may be implemented for some types of unseekable streams,
+        and MUST be implemented for all seekable streams.
+
+        @return
+            The current position in the stream, or -1, if not implemented.
+     */
+    virtual sal_Int64   tell() const = 0;
+
+    /** Implementations seek the stream to the passed position, if
+        the stream is seekable.
+     */
+    virtual void        seek( sal_Int64 nPos ) = 0;
+
+    /** Implementations close the stream.
+     */
+    virtual void        close() = 0;
+
+    /** Returns true, if the implementation supports the seek() operation.
+
+        Implementations may still implement size() and tell() even if the
+        stream is not seekable.
+     */
+    bool         isSeekable() const { return mbSeekable; }
+
+    /** Returns true, if the stream position is invalid (EOF). This flag turns
+        true *after* the first attempt to seek/read beyond the stream end.
+     */
+    bool         isEof() const { return mbEof; }
+
+    /** Returns the size of the remaining data available in the stream, if
+        stream supports size() and tell(), otherwise -1.
+     */
+    sal_Int64           getRemaining() const;
+
+    /** Seeks the stream to the beginning, if stream is seekable.
+     */
+    void         seekToStart() { seek( 0 ); }
+
+    /** Seeks the stream forward to a position that is a multiple of the passed
+        block size, if stream is seekable.
+
+        @param nBlockSize
+            The size of the data blocks the streams needs to be aligned to.
+
+        @param nAnchorPos
+            Position in the stream the data blocks are aligned to.
+     */
+    void                alignToBlock( sal_Int32 nBlockSize, sal_Int64 nAnchorPos );
+
+protected:
+    explicit            BinaryStreamBase( bool bSeekable ) : mbEof( false ), mbSeekable( bSeekable ) {}
+
+private:
+                        BinaryStreamBase( const BinaryStreamBase& ) = delete;
+    BinaryStreamBase&   operator=( const BinaryStreamBase& ) = delete;
+
+protected:
+    bool                mbEof;          ///< End of stream flag.
+
+private:
+    const bool          mbSeekable;     ///< True = implementation supports seeking.
+};
+
+
+/** Base class for binary input and output streams wrapping a UNO stream,
+    seekable via the com.sun.star.io.XSeekable interface.
+ */
+class BinaryXSeekableStream : public virtual BinaryStreamBase
+{
+public:
+    virtual             ~BinaryXSeekableStream() override;
+
+    /** Returns the size of the stream, if wrapped stream is seekable, otherwise -1. */
+    virtual sal_Int64   size() const override;
+    /** Returns the current stream position, if wrapped stream is seekable, otherwise -1. */
+    virtual sal_Int64   tell() const override;
+    /** Seeks the stream to the passed position, if wrapped stream is seekable. */
+    virtual void        seek( sal_Int64 nPos ) override;
+    /** Releases the reference to the UNO XSeekable interface. */
+    virtual void        close() override;
+
+protected:
+    explicit            BinaryXSeekableStream(
+                            const css::uno::Reference< css::io::XSeekable >& rxSeekable );
+
+private:
+    css::uno::Reference< css::io::XSeekable >
+                        mxSeekable;     ///< Stream seeking interface.
+};
+
+
+/** Base class for binary input and output streams wrapping a
+    StreamDataSequence, which is always seekable.
+
+    The wrapped data sequence MUST live at least as long as this stream
+    wrapper. The data sequence MUST NOT be changed from outside as long as this
+    stream wrapper is used to modify it.
+ */
+class OOX_DLLPUBLIC SequenceSeekableStream : public virtual BinaryStreamBase
+{
+public:
+    /** Returns the size of the wrapped data sequence. */
+    virtual sal_Int64   size() const override;
+    /** Returns the current stream position. */
+    virtual sal_Int64   tell() const override;
+    /** Seeks the stream to the passed position. */
+    virtual void        seek( sal_Int64 nPos ) override;
+    /** Releases the reference to the data sequence. */
+    virtual void        close() override;
+
+protected:
+    explicit            SequenceSeekableStream( const StreamDataSequence& rData );
+
+protected:
+    const StreamDataSequence* mpData;   ///< Wrapped data sequence.
+    sal_Int32           mnPos;          ///< Current position in the sequence.
+};
+
+
+} // namespace oox
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */