propertyexport.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 .
 */
 
#pragma once
 
#include <sal/config.h>
 
#include <set>
 
#include "formattributes.hxx"
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <xmloff/xmltoken.hxx>
#include <xmloff/xmlexp.hxx>
#include "callbacks.hxx"
#include "strings.hxx"
 
enum class BoolAttrFlags {
    DefaultFalse          = 0x00,
    DefaultTrue           = 0x01,
    DefaultVoid           = 0x02,
    InverseSemantics      = 0x04,
};
namespace o3tl {
    template<> struct typed_flags<BoolAttrFlags> : is_typed_flags<BoolAttrFlags, 0x07> {};
}
 
namespace xmloff
{
 
    // if sal_True, indicates that the semantic of the property referred by <arg>_pPropertyName</arg>
    // is inverse to the semantic of the XML attribute.<br/>
    // I.e. if the property value is <TRUE/>, <FALSE/> has to be written and vice versa.
    // <p>Be careful with <arg>_bDefault</arg> and <arg>_bInverseSemantics</arg>: if <arg>_bInverseSemantics</arg>
    // is <TRUE/>, the current property value is inverted <em>before</em> comparing it to the default.</p>
 
    class IFormsExportContext;
    //= OPropertyExport
    class OPropertyExport
    {
    private:
        std::set<OUString>      m_aRemainingProps;
            // see examinePersistence
 
        void exportRelativeTargetLocation(const OUString& _sPropertyName, CCAFlags _nProperty,bool _bAddType);
 
    protected:
        IFormsExportContext&    m_rContext;
 
        const css::uno::Reference< css::beans::XPropertySet >
                                m_xProps;
        const css::uno::Reference< css::beans::XPropertySetInfo >
                                m_xPropertyInfo;
        const css::uno::Reference< css::beans::XPropertyState >
                                m_xPropertyState;
 
        // caching
        OUString     m_sValueTrue;
        OUString     m_sValueFalse;
 
    public:
        OPropertyExport(IFormsExportContext& _rContext,
            const css::uno::Reference< css::beans::XPropertySet >& _rxProps);
 
    protected:
        void examinePersistence();
 
        template< typename T > void exportRemainingPropertiesSequence(
            css::uno::Any const & value,
            token::XMLTokenEnum eValueAttName);
 
        void exportRemainingProperties();
 
        void exportedProperty(const OUString& _rPropertyName)
            { m_aRemainingProps.erase(_rPropertyName); }
 
        void exportStringPropertyAttribute(
            const sal_uInt16 _nNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _rPropertyName
        );
 
        void exportBooleanPropertyAttribute(
            const sal_uInt16 _nNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _rPropertyName,
            const BoolAttrFlags _nBooleanAttributeFlags);
 
        void exportInt16PropertyAttribute(
            const sal_uInt16 _nNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _rPropertyName,
            const sal_Int16 _nDefault,
            const bool force = false);
 
        void exportInt32PropertyAttribute(
            const sal_uInt16 _nNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _rPropertyName,
            const sal_Int32 _nDefault);
 
        template<typename EnumT>
        void exportEnumPropertyAttribute(
            const sal_uInt16 _nNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _rPropertyName,
            const SvXMLEnumMapEntry<EnumT>* _pValueMap,
            const EnumT _nDefault,
            const bool _bVoidDefault = false)
        {
            exportEnumPropertyAttributeImpl(_nNamespaceKey, _pAttributeName, _rPropertyName,
                            reinterpret_cast<const SvXMLEnumMapEntry<sal_uInt16>*>(_pValueMap),
                            static_cast<sal_Int16>(_nDefault), _bVoidDefault);
        }
        void exportEnumPropertyAttributeImpl(
            const sal_uInt16 _nNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _rPropertyName,
            const SvXMLEnumMapEntry<sal_uInt16>* _pValueMap,
            const sal_uInt16 _nDefault,
            const bool _bVoidDefault);
 
        // some very special methods for some very special attribute/property pairs
 
        void exportTargetFrameAttribute();
 
        void exportTargetLocationAttribute(bool _bAddType) { exportRelativeTargetLocation(PROPERTY_TARGETURL,CCAFlags::TargetLocation,_bAddType); }
 
        void exportImageDataAttribute() { exportRelativeTargetLocation(PROPERTY_GRAPHIC, CCAFlags::ImageData, false); }
 
        void flagStyleProperties();
 
        void exportGenericPropertyAttribute(
            const sal_uInt16 _nAttributeNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _pPropertyName);
 
        void exportStringSequenceAttribute(
            const sal_uInt16 _nAttributeNamespaceKey,
            const OUString& _pAttributeName,
            const OUString& _rPropertyName);
 
        bool shouldExportProperty( const OUString& i_propertyName ) const;
 
        OUString implConvertAny(
            const css::uno::Any& _rValue);
 
        static ::xmloff::token::XMLTokenEnum implGetPropertyXMLType(const css::uno::Type& _rType);
 
#ifdef DBG_UTIL
                void AddAttribute( sal_uInt16 _nPrefix, const OUString& _rName, const OUString& _rValue );
                void AddAttribute(sal_uInt16 _nPrefix, ::xmloff::token::XMLTokenEnum _eName, const OUString& _rValue);
                void AddAttribute(sal_uInt16 _nPrefix, ::xmloff::token::XMLTokenEnum _eName, ::xmloff::token::XMLTokenEnum _eValue );
#else
        //  in the product version, inline this, so it does not cost us extra time calling into our method
        void AddAttribute( sal_uInt16 _nPrefix, const OUString& _rName, const OUString& _rValue )
            { m_rContext.getGlobalContext().AddAttribute( _nPrefix, _rName, _rValue ); }
        void AddAttribute(sal_uInt16 _nPrefix, ::xmloff::token::XMLTokenEnum _eName, const OUString& _rValue)
            { m_rContext.getGlobalContext().AddAttribute(_nPrefix, _eName, _rValue); }
        void AddAttribute(sal_uInt16 _nPrefix, ::xmloff::token::XMLTokenEnum _eName, ::xmloff::token::XMLTokenEnum _eValue )
            { m_rContext.getGlobalContext().AddAttribute(_nPrefix, _eName, _eValue); }
#endif
 
#ifdef DBG_UTIL
    protected:
        void dbg_implCheckProperty(
            const OUString& _rPropertyName,
            const css::uno::Type* _pType);
 
//      void dbg_implCheckProperty(
//          const char* _rPropertyName,
//          const css::uno::Type* _pType)
//      {
//          dbg_implCheckProperty(OUString::createFromAscii(_rPropertyName), _pType);
//      }
#endif
    };
 
    //= helper
#ifdef DBG_UTIL
    #define DBG_CHECK_PROPERTY(name, type)  \
        dbg_implCheckProperty(name, &cppu::UnoType<type>::get())
 
    #define DBG_CHECK_PROPERTY_NO_TYPE(name)    \
        dbg_implCheckProperty(name, nullptr)
 
    #define DBG_CHECK_PROPERTY_ASCII_NO_TYPE( name ) \
        dbg_implCheckProperty( OUString::createFromAscii( name ), nullptr )
#else
    #define DBG_CHECK_PROPERTY(name, type)
    #define DBG_CHECK_PROPERTY_NO_TYPE(name)
    #define DBG_CHECK_PROPERTY_ASCII_NO_TYPE( name )
#endif
 
}   // namespace xmloff
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */