oleprops.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_SFX2_SOURCE_DOC_OLEPROPS_HXX
#define INCLUDED_SFX2_SOURCE_DOC_OLEPROPS_HXX
 
#include <map>
#include <memory>
#include <string_view>
 
#include <osl/thread.h>
#include <rtl/ustring.hxx>
#include <sot/storage.hxx>
 
#include <com/sun/star/util/DateTime.hpp>
#include <com/sun/star/util/Date.hpp>
 
 
//namespace {
 
 
// property type IDs
const sal_Int32 PROPTYPE_INT16          = 2;
const sal_Int32 PROPTYPE_INT32          = 3;
const sal_Int32 PROPTYPE_FLOAT          = 4;
const sal_Int32 PROPTYPE_DOUBLE         = 5;
const sal_Int32 PROPTYPE_DATE           = 7;
const sal_Int32 PROPTYPE_STRING         = 8;
const sal_Int32 PROPTYPE_STATUS         = 10;
const sal_Int32 PROPTYPE_BOOL           = 11;
const sal_Int32 PROPTYPE_VARIANT        = 12;
const sal_Int32 PROPTYPE_INT8           = 16;
const sal_Int32 PROPTYPE_UINT8          = 17;
const sal_Int32 PROPTYPE_UINT16         = 18;
const sal_Int32 PROPTYPE_UINT32         = 19;
const sal_Int32 PROPTYPE_INT64          = 20;
const sal_Int32 PROPTYPE_UINT64         = 21;
const sal_Int32 PROPTYPE_STRING8        = 30;
const sal_Int32 PROPTYPE_STRING16       = 31;
const sal_Int32 PROPTYPE_FILETIME       = 64;
const sal_Int32 PROPTYPE_BLOB           = 65;
const sal_Int32 PROPTYPE_CLIPFMT        = 71;
 
// static property IDs
const sal_Int32 PROPID_DICTIONARY       = 0;
const sal_Int32 PROPID_CODEPAGE         = 1;
const sal_Int32 PROPID_FIRSTCUSTOM      = 2;
 
// property IDs for GlobalDocPropertySet
const sal_Int32 PROPID_TITLE            = 2;
const sal_Int32 PROPID_SUBJECT          = 3;
const sal_Int32 PROPID_AUTHOR           = 4;
const sal_Int32 PROPID_KEYWORDS         = 5;
const sal_Int32 PROPID_COMMENTS         = 6;
const sal_Int32 PROPID_TEMPLATE         = 7;
const sal_Int32 PROPID_LASTAUTHOR       = 8;
const sal_Int32 PROPID_REVNUMBER        = 9;
const sal_Int32 PROPID_EDITTIME         = 10;
const sal_Int32 PROPID_LASTPRINTED      = 11;
const sal_Int32 PROPID_CREATED          = 12;
const sal_Int32 PROPID_LASTSAVED        = 13;
const sal_Int32 PROPID_THUMBNAIL        = 17;
 
// some Builtin properties
const sal_Int32 PROPID_CATEGORY         = 0x2;
const sal_Int32 PROPID_COMPANY          = 0xf;
const sal_Int32 PROPID_MANAGER          = 0xe;
// predefined codepages
const sal_uInt16 CODEPAGE_UNKNOWN       = 0;
const sal_uInt16 CODEPAGE_UNICODE       = 1200;
const sal_uInt16 CODEPAGE_UTF8          = 65001;
 
// predefined clipboard format IDs
const sal_Int32 CLIPFMT_WIN             = -1;
 
// predefined clipboard data format IDs
const sal_Int32 CLIPDATAFMT_DIB         = 8;
 
 
class SfxOleTextEncoding
{
public:
    explicit     SfxOleTextEncoding() :
                            mxTextEnc( std::make_shared<rtl_TextEncoding>( osl_getThreadTextEncoding() ) ) {}
    explicit     SfxOleTextEncoding( rtl_TextEncoding eTextEnc ) :
                            mxTextEnc( std::make_shared<rtl_TextEncoding>( eTextEnc ) ) {}
 
    rtl_TextEncoding GetTextEncoding() const { return *mxTextEnc; }
    void         SetTextEncoding( rtl_TextEncoding eTextEnc ) { *mxTextEnc = eTextEnc; }
 
    bool         IsUnicode() const { return GetTextEncoding() == RTL_TEXTENCODING_UCS2; }
    void         SetUnicode() { SetTextEncoding( RTL_TEXTENCODING_UCS2 ); }
 
    sal_uInt16          GetCodePage() const;
    void                SetCodePage( sal_uInt16 nCodePage );
 
private:
    std::shared_ptr< rtl_TextEncoding > mxTextEnc;
};
 
 
class SfxOleStringHelper : public SfxOleTextEncoding
{
public:
    explicit     SfxOleStringHelper( const SfxOleTextEncoding& rTextEnc ) :
                            SfxOleTextEncoding( rTextEnc ) {}
    explicit     SfxOleStringHelper( rtl_TextEncoding eTextEnc ) :
                            SfxOleTextEncoding( eTextEnc ) {}
 
    OUString            LoadString8( SvStream& rStrm ) const;
    void                SaveString8( SvStream& rStrm, std::u16string_view rValue ) const;
 
    static OUString     LoadString16( SvStream& rStrm );
    static void         SaveString16( SvStream& rStrm, std::u16string_view rValue );
 
private:
    OUString            ImplLoadString8( SvStream& rStrm ) const;
    static OUString     ImplLoadString16( SvStream& rStrm );
    void                ImplSaveString8( SvStream& rStrm, std::u16string_view rValue ) const;
    static void         ImplSaveString16( SvStream& rStrm, std::u16string_view rValue );
};
 
 
class SfxOleObjectBase
{
public:
    explicit     SfxOleObjectBase() : mnErrCode( ERRCODE_NONE ) {}
    virtual             ~SfxOleObjectBase();
 
    ErrCode const &     GetError() const { return mnErrCode; }
 
    ErrCode const &     Load( SvStream& rStrm );
    ErrCode const &     Save( SvStream& rStrm );
 
protected:
    void         SetError( ErrCode nErrCode ) { if( mnErrCode == ERRCODE_NONE ) mnErrCode = nErrCode; }
    void                LoadObject( SvStream& rStrm, SfxOleObjectBase& rObj );
    void                SaveObject( SvStream& rStrm, SfxOleObjectBase& rObj );
 
private:
    virtual void        ImplLoad( SvStream& rStrm ) = 0;
    virtual void        ImplSave( SvStream& rStrm ) = 0;
 
private:
    ErrCode             mnErrCode;      
};
 
 
class SfxOlePropertyBase : public SfxOleObjectBase
{
public:
    explicit     SfxOlePropertyBase( sal_Int32 nPropId, sal_Int32 nPropType ) :
                            mnPropId( nPropId ), mnPropType( nPropType ) {}
 
    sal_Int32    GetPropId() const { return mnPropId; }
    sal_Int32    GetPropType() const { return mnPropType; }
 
protected:
    void         SetPropType( sal_Int32 nPropType ) { mnPropType = nPropType; }
 
private:
    sal_Int32           mnPropId;
    sal_Int32           mnPropType;
};
 
typedef std::shared_ptr< SfxOlePropertyBase > SfxOlePropertyRef;
 
 
class SfxOleCodePageProperty : public SfxOlePropertyBase, public SfxOleTextEncoding
{
public:
    explicit            SfxOleCodePageProperty();
 
private:
    virtual void        ImplLoad( SvStream& rStrm ) override;
    virtual void        ImplSave( SvStream& rStrm ) override;
};
 
 
class SfxOleDictionaryProperty : public SfxOlePropertyBase, public SfxOleStringHelper
{
public:
    explicit            SfxOleDictionaryProperty( const SfxOleTextEncoding& rTextEnc );
 
    bool         HasPropertyNames() const { return !maPropNameMap.empty(); }
    void         SetNameCount( sal_Int32 nNameCount ) { SetPropType( nNameCount ); }
 
    OUString            GetPropertyName( sal_Int32 nPropId ) const;
    void                SetPropertyName( sal_Int32 nPropId, const OUString& rPropName );
 
private:
    virtual void        ImplLoad( SvStream& rStrm ) override;
    virtual void        ImplSave( SvStream& rStrm ) override;
 
private:
    typedef ::std::map< sal_Int32, OUString > SfxOlePropNameMap;
    SfxOlePropNameMap   maPropNameMap;
};
 
 
class SfxOleSection : public SfxOleObjectBase
{
private:
    typedef ::std::map< sal_Int32, SfxOlePropertyRef > SfxOlePropMap;
 
public:
    explicit            SfxOleSection( bool bSupportsDict );
 
    SfxOlePropertyRef   GetProperty( sal_Int32 nPropId ) const;
    bool                GetInt32Value( sal_Int32& rnValue, sal_Int32 nPropId ) const;
    bool                GetDoubleValue( double& rfValue, sal_Int32 nPropId ) const;
    bool                GetBoolValue( bool& rbValue, sal_Int32 nPropId ) const;
    bool                GetStringValue( OUString& rValue, sal_Int32 nPropId ) const;
    bool                GetFileTimeValue( css::util::DateTime& rValue, sal_Int32 nPropId ) const;
    bool                GetDateValue( css::util::Date& rValue, sal_Int32 nPropId ) const;
 
    void                SetProperty( const SfxOlePropertyRef& xProp );
    void                SetInt32Value( sal_Int32 nPropId, sal_Int32 nValue );
    void                SetDoubleValue( sal_Int32 nPropId, double fValue );
    void                SetBoolValue( sal_Int32 nPropId, bool bValue );
    bool                SetStringValue( sal_Int32 nPropId, const OUString& rValue );
    void                SetFileTimeValue( sal_Int32 nPropId, const css::util::DateTime& rValue );
    void                SetDateValue( sal_Int32 nPropId, const css::util::Date& rValue );
    void                SetThumbnailValue( sal_Int32 nPropId,
                            const css::uno::Sequence<sal_Int8> & i_rData);
    void                SetBlobValue( sal_Int32 nPropId,
                            const css::uno::Sequence<sal_Int8> & i_rData);
 
    css::uno::Any GetAnyValue( sal_Int32 nPropId ) const;
    bool                SetAnyValue( sal_Int32 nPropId, const css::uno::Any& rValue );
 
    OUString            GetPropertyName( sal_Int32 nPropId ) const;
    void                SetPropertyName( sal_Int32 nPropId, const OUString& rPropName );
 
    void                GetPropertyIds( ::std::vector< sal_Int32 >& rPropIds ) const;
    sal_Int32           GetFreePropertyId() const;
 
private:
    virtual void        ImplLoad( SvStream& rStrm ) override;
    virtual void        ImplSave( SvStream& rStrm ) override;
 
    bool                SeekToPropertyPos( SvStream& rStrm, sal_uInt32 nPropPos ) const;
    void                LoadProperty( SvStream& rStrm, sal_Int32 nPropId );
    void                SaveProperty( SvStream& rStrm, SfxOlePropertyBase& rProp, sal_uInt64 & rnPropPosPos );
 
private:
    SfxOlePropMap       maPropMap;              
    SfxOleCodePageProperty maCodePageProp;      
    SfxOleDictionaryProperty maDictProp;        
    sal_uInt64          mnStartPos;             
    bool                mbSupportsDict;         
};
 
typedef std::shared_ptr< SfxOleSection > SfxOleSectionRef;
 
 
enum SfxOleSectionType
{
    SECTION_GLOBAL,         
    SECTION_BUILTIN,        
    SECTION_CUSTOM          
};
 
 
class SfxOlePropertySet : public SfxOleObjectBase
{
public:
    explicit     SfxOlePropertySet() {}
 
    ErrCode const &     LoadPropertySet( SotStorage* pStrg, const OUString& rStrmName );
    ErrCode const &     SavePropertySet( SotStorage* pStrg, const OUString& rStrmName );
 
    SfxOleSectionRef    GetSection( SfxOleSectionType eSection ) const;
    SfxOleSectionRef    GetSection( const SvGlobalName& rSectionGuid ) const;
 
    SfxOleSection&      AddSection( SfxOleSectionType eSection );
    SfxOleSection&      AddSection( const SvGlobalName& rSectionGuid );
 
private:
    virtual void        ImplLoad( SvStream& rStrm ) override;
    virtual void        ImplSave( SvStream& rStrm ) override;
 
    static const SvGlobalName& GetSectionGuid( SfxOleSectionType eSection );
 
private:
    typedef ::std::map< SvGlobalName, SfxOleSectionRef > SfxOleSectionMap;
    SfxOleSectionMap    maSectionMap;
};
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */