axbinaryreader.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_OLE_AXBINARYREADER_HXX
#define INCLUDED_OOX_OLE_AXBINARYREADER_HXX

#include <cstddef>
#include <utility>
#include <vector>

#include <oox/helper/binaryinputstream.hxx>
#include <oox/helper/binarystreambase.hxx>
#include <oox/helper/refvector.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>

namespace oox::ole { struct AxFontData; }

namespace oox::ole {


class AxAlignedInputStream final : public BinaryInputStream
{
public:
    explicit            AxAlignedInputStream( BinaryInputStream& rInStrm );

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

    virtual sal_Int32   readData( StreamDataSequence& orData, sal_Int32 nBytes, size_t nAtomSize = 1 ) override;
    virtual sal_Int32   readMemory( void* opMem, sal_Int32 nBytes, size_t nAtomSize = 1 ) override;
    virtual void        skip( sal_Int32 nBytes, size_t nAtomSize = 1 ) override;

    void                align( size_t nSize );

    template< typename Type >
    [[nodiscard]]
    Type                readAligned() { align( sizeof( Type ) ); return readValue< Type >(); }
    template< typename Type >
    void                skipAligned() { align( sizeof( Type ) ); skip( sizeof( Type ) ); }

private:
    BinaryInputStream*  mpInStrm;           
    sal_Int64           mnStrmPos;          
    sal_Int64           mnStrmSize;         
};


typedef ::std::pair< sal_Int32, sal_Int32 > AxPairData;

typedef ::std::vector< OUString > AxArrayString;


class AxBinaryPropertyReader
{
public:
    explicit            AxBinaryPropertyReader( BinaryInputStream& rInStrm, bool b64BitPropFlags = false );

    template< typename StreamType, typename DataType >
    void                readIntProperty( DataType& ornValue )
                            { if( startNextProperty() ) ornValue = maInStrm.readAligned< StreamType >(); }
    void                readBoolProperty( bool& orbValue, bool bReverse = false );
    void                readPairProperty( AxPairData& orPairData );
    void                readStringProperty( OUString& orValue );
    void                readArrayStringProperty( std::vector< OUString >& rStrings );
    void                readGuidProperty( OUString& orGuid );
    void                readFontProperty( AxFontData& orFontData );
    void                readPictureProperty( StreamDataSequence& orPicData );

    template< typename StreamType >
    void                skipIntProperty() { if( startNextProperty() ) maInStrm.skipAligned< StreamType >(); }
    void                skipBoolProperty() { (void)startNextProperty(); }
    void                skipStringProperty() { readStringProperty( maDummyString ); }
    void                skipArrayStringProperty() { readArrayStringProperty( maDummyArrayString ); }
    void                skipGuidProperty() { readGuidProperty( maDummyString ); }
    void                skipPictureProperty() { readPictureProperty( maDummyPicData ); }
    void                skipUndefinedProperty() { ensureValid( !startNextProperty() ); }

    bool                finalizeImport();

private:
    bool                ensureValid( bool bCondition = true );
    bool                startNextProperty();

private:
    struct ComplexProperty
    {
        virtual             ~ComplexProperty();
        virtual bool        readProperty( AxAlignedInputStream& rInStrm ) = 0;
    };

    struct PairProperty final : public ComplexProperty
    {
        AxPairData&         mrPairData;

        explicit            PairProperty( AxPairData& rPairData ) :
                                mrPairData( rPairData ) {}
        virtual bool        readProperty( AxAlignedInputStream& rInStrm ) override;
    };

    struct StringProperty final : public ComplexProperty
    {
        OUString&    mrValue;
        sal_uInt32          mnSize;

        explicit            StringProperty( OUString& rValue, sal_uInt32 nSize ) :
                                mrValue( rValue ), mnSize( nSize ) {}
        virtual bool        readProperty( AxAlignedInputStream& rInStrm ) override;
    };

    struct ArrayStringProperty final : public ComplexProperty
    {
        AxArrayString&      mrArray;
        sal_uInt32          mnSize;
        explicit            ArrayStringProperty( AxArrayString& rArray, sal_uInt32 nSize ) :
                                mrArray( rArray ), mnSize( nSize ) {}
        virtual bool        readProperty( AxAlignedInputStream& rInStrm ) override;
    };

    struct GuidProperty final : public ComplexProperty
    {
        OUString&    mrGuid;

        explicit            GuidProperty( OUString& rGuid ) :
                                mrGuid( rGuid ) {}
        virtual bool        readProperty( AxAlignedInputStream& rInStrm ) override;
    };

    struct FontProperty final : public ComplexProperty
    {
        AxFontData&         mrFontData;

        explicit            FontProperty( AxFontData& rFontData ) :
                                mrFontData( rFontData ) {}
        virtual bool        readProperty( AxAlignedInputStream& rInStrm ) override;
    };

    struct PictureProperty final : public ComplexProperty
    {
        StreamDataSequence& mrPicData;

        explicit            PictureProperty( StreamDataSequence& rPicData ) :
                                mrPicData( rPicData ) {}
        virtual bool        readProperty( AxAlignedInputStream& rInStrm ) override;
    };

    typedef RefVector< ComplexProperty > ComplexPropVector;

private:
    AxAlignedInputStream maInStrm;          
    ComplexPropVector   maLargeProps;       
    ComplexPropVector   maStreamProps;      
    StreamDataSequence  maDummyPicData;     
    OUString            maDummyString;      
    AxArrayString       maDummyArrayString; 
    sal_Int64           mnPropFlags;        
    sal_Int64           mnNextProp;         
    sal_Int64           mnPropsEnd;         
    bool                mbValid;            
};


} // namespace oox::ole

#endif

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