binarystreambase.hxx

Go to the documentation of this file.

/* -*- 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;


class OOX_DLLPUBLIC BinaryStreamBase
{
public:
    virtual             ~BinaryStreamBase();

    virtual sal_Int64   size() const = 0;

    virtual sal_Int64   tell() const = 0;

    virtual void        seek( sal_Int64 nPos ) = 0;

    virtual void        close() = 0;

    bool         isSeekable() const { return mbSeekable; }

    bool         isEof() const { return mbEof; }

    sal_Int64           getRemaining() const;

    void         seekToStart() { seek( 0 ); }

    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;          

private:
    const bool          mbSeekable;     
};


class BinaryXSeekableStream : public virtual BinaryStreamBase
{
public:
    virtual             ~BinaryXSeekableStream() override;

    virtual sal_Int64   size() const override;
    virtual sal_Int64   tell() const override;
    virtual void        seek( sal_Int64 nPos ) override;
    virtual void        close() override;

protected:
    explicit            BinaryXSeekableStream(
                            const css::uno::Reference< css::io::XSeekable >& rxSeekable );

private:
    css::uno::Reference< css::io::XSeekable >
                        mxSeekable;     
};


class OOX_DLLPUBLIC SequenceSeekableStream : public virtual BinaryStreamBase
{
public:
    virtual sal_Int64   size() const override;
    virtual sal_Int64   tell() const override;
    virtual void        seek( sal_Int64 nPos ) override;
    virtual void        close() override;

protected:
    explicit            SequenceSeekableStream( const StreamDataSequence& rData );

protected:
    const StreamDataSequence* mpData;   
    sal_Int32           mnPos;          
};


} // namespace oox

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */