xmluconv.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_XMLOFF_XMLUCONV_HXX
#define INCLUDED_XMLOFF_XMLUCONV_HXX

#include <sal/config.h>
#include <xmloff/dllapi.h>
#include <sal/types.h>

#include <memory>

#include <rtl/ustring.hxx>
#include <rtl/ustrbuf.hxx>
#include <xmloff/xmltoken.hxx>

#include <unotools/saveopt.hxx>

#include <tools/fldunit.hxx>

namespace com::sun::star {
    namespace text { class XNumberingTypeInfo; }
}

namespace basegfx
{
    class B3DVector;
}

namespace com::sun::star::beans { class XPropertySet; }
namespace com::sun::star::beans { struct PropertyValue; }
namespace com::sun::star::drawing { struct Position3D; }
namespace com::sun::star::frame { class XModel; }
namespace com::sun::star::uno { class XComponentContext; }
namespace com::sun::star::uno { template <class E> class Sequence; }
namespace com::sun::star::util { struct Date; }
template <typename EnumT> struct SvXMLEnumMapEntry;
template <typename EnumT> struct SvXMLEnumStringMapEntry;

class XMLOFF_DLLPUBLIC SvXMLTokenEnumerator
{
private:
    std::u16string_view     maTokenString;
    size_t                  mnNextTokenPos;
    sal_Unicode             mcSeparator;

public:
    SvXMLTokenEnumerator( std::u16string_view rString, sal_Unicode cSeparator = u' ' );
    SvXMLTokenEnumerator( OUString&& , sal_Unicode cSeparator = u' ' ) = delete;

    bool getNextToken( std::u16string_view& rToken );
};

class XMLOFF_DLLPUBLIC SvXMLUnitConverter final
{
private:
    SvXMLUnitConverter(const SvXMLUnitConverter&) = delete;
    SvXMLUnitConverter& operator=(const SvXMLUnitConverter&) = delete;

    struct SAL_DLLPRIVATE Impl;
    ::std::unique_ptr<Impl> m_pImpl;

public:
    SvXMLUnitConverter(
        const css::uno::Reference< css::uno::XComponentContext >& xContext,
        sal_Int16 eCoreMeasureUnit /*css::util::MeasureUnit*/,
        sal_Int16 eXMLMeasureUnit /*css::util::MeasureUnit*/,
        SvtSaveOptions::ODFSaneDefaultVersion const nODFVersion);

    ~SvXMLUnitConverter();

    static sal_Int16 GetMeasureUnit(FieldUnit const nFieldUnit);

    void SetCoreMeasureUnit( sal_Int16 const eCoreMeasureUnit /*css::util::MeasureUnit*/);

    void SetXMLMeasureUnit( sal_Int16 const eXMLMeasureUnit /*css::util::MeasureUnit*/);

    sal_Int16 GetXMLMeasureUnit() const;

    SvtSaveOptions::ODFSaneDefaultVersion getSaneDefaultVersion() const;
    void overrideSaneDefaultVersion(SvtSaveOptions::ODFSaneDefaultVersion const);

    const css::uno::Reference< css::text::XNumberingTypeInfo >& getNumTypeInfo() const;

    bool convertMeasureToCore( sal_Int32& rValue,
                         std::u16string_view rString,
                         sal_Int32 nMin = SAL_MIN_INT32,
                         sal_Int32 nMax = SAL_MAX_INT32) const;

    bool convertMeasureToCore( sal_Int32& rValue,
                         std::string_view rString,
                         sal_Int32 nMin = SAL_MIN_INT32,
                         sal_Int32 nMax = SAL_MAX_INT32) const;

    void convertMeasureToXML( OUStringBuffer& rBuffer,
                         sal_Int32 nMeasure ) const;

    OUString convertMeasureToXML( sal_Int32 nMeasure ) const;

    template<typename EnumT>
    static bool convertEnum( EnumT& rEnum,
                             std::u16string_view rValue,
                             const SvXMLEnumMapEntry<EnumT> *pMap )
    {
        sal_uInt16 nTmp;
        bool bRet = convertEnumImpl(nTmp, rValue,
                        reinterpret_cast<const SvXMLEnumMapEntry<sal_uInt16>*>(pMap));
        if (bRet)
            rEnum = static_cast<EnumT>(nTmp);
        return bRet;
    }

    template<typename EnumT>
    static bool convertEnum( EnumT& rEnum,
                             std::string_view rValue,
                             const SvXMLEnumMapEntry<EnumT> *pMap )
    {
        sal_uInt16 nTmp;
        bool bRet = convertEnumImpl(nTmp, rValue,
                        reinterpret_cast<const SvXMLEnumMapEntry<sal_uInt16>*>(pMap));
        if (bRet)
            rEnum = static_cast<EnumT>(nTmp);
        return bRet;
    }

    template<typename EnumT>
    static bool convertEnum( EnumT& rEnum,
                             std::u16string_view rValue,
                             const SvXMLEnumStringMapEntry<EnumT> *pMap )
    {
        sal_uInt16 nTmp;
        bool bRet = convertEnumImpl(nTmp, rValue,
                        reinterpret_cast<const SvXMLEnumStringMapEntry<sal_uInt16>*>(pMap));
        if (bRet)
            rEnum = static_cast<EnumT>(nTmp);
        return bRet;
    }

    template<typename EnumT>
    static bool convertEnum( EnumT& rEnum,
                             std::string_view rValue,
                             const SvXMLEnumStringMapEntry<EnumT> *pMap )
    {
        sal_uInt16 nTmp;
        bool bRet = convertEnumImpl(nTmp, rValue,
                        reinterpret_cast<const SvXMLEnumStringMapEntry<sal_uInt16>*>(pMap));
        if (bRet)
            rEnum = static_cast<EnumT>(nTmp);
        return bRet;
    }

    template<typename EnumT>
    static bool convertEnum( OUStringBuffer& rBuffer,
                             EnumT nValue,
                             const SvXMLEnumMapEntry<EnumT> *pMap,
                             enum ::xmloff::token::XMLTokenEnum eDefault =
                                         ::xmloff::token::XML_TOKEN_INVALID )
    {
        return convertEnumImpl(rBuffer, static_cast<sal_uInt16>(nValue),
                   reinterpret_cast<const SvXMLEnumMapEntry<sal_uInt16>*>(pMap), eDefault);
    }

    void convertDouble(OUStringBuffer& rBuffer,
        double fNumber) const;

    bool convertDouble(double& rValue, std::u16string_view rString) const;

    bool setNullDate (
        const css::uno::Reference <css::frame::XModel>& xModel);

    void convertDateTime( OUStringBuffer& rBuffer,
                                const double& fDateTime,
                                bool const bAddTimeIf0AM = false);

    bool convertDateTime(double& fDateTime,
                         std::u16string_view rString) const;

    bool convertDateTime(double& fDateTime,
                         std::string_view rString) const;


    static void convertDateTime( OUStringBuffer& rBuffer,
                                const double& fDateTime,
                                const css::util::Date& aNullDate,
                                bool bAddTimeIf0AM = false);
    static bool convertDateTime( double& fDateTime,
                                std::u16string_view rString,
                                const css::util::Date& aNullDate);
    static bool convertDateTime( double& fDateTime,
                                std::string_view rString,
                                const css::util::Date& aNullDate);


    static bool convertB3DVector( ::basegfx::B3DVector& rVector,
                              std::u16string_view rValue );

    static bool convertB3DVector( ::basegfx::B3DVector& rVector,
                              std::string_view rValue );

    static void convertB3DVector( OUStringBuffer &rBuffer,
        const ::basegfx::B3DVector& rVector );

    bool convertPosition3D( css::drawing::Position3D& rPosition,
                              std::string_view rValue ) const;

    void convertPosition3D( OUStringBuffer &rBuffer,
                              const css::drawing::Position3D& rVector );


    bool convertNumFormat( sal_Int16& rType,
                           const OUString& rNumFormat,
                           std::u16string_view rNumLetterSync,
                           bool bNumberNone = false ) const;

    void convertNumFormat( OUStringBuffer& rBuffer,
                           sal_Int16 nType ) const;
    static void convertNumLetterSync( OUStringBuffer& rBuffer,
                                  sal_Int16 nType );

    static void convertPropertySet(css::uno::Sequence<css::beans::PropertyValue>& rProps,
                        const css::uno::Reference<css::beans::XPropertySet>& aProperties);
    static void convertPropertySet(css::uno::Reference<css::beans::XPropertySet> const & rProperties,
                        const css::uno::Sequence<css::beans::PropertyValue>& aProps);

    OUString encodeStyleName( const OUString& rName,
                                     bool *pEncoded=nullptr ) const;
    static bool convertHex( sal_uInt32& nVal,
                              std::u16string_view rValue );

    static void convertHex( OUStringBuffer& rBuffer,
                               sal_uInt32 nVal );

private:
    static bool convertEnumImpl( sal_uInt16& rEnum,
                             std::u16string_view rValue,
                             const SvXMLEnumMapEntry<sal_uInt16> *pMap );

    static bool convertEnumImpl( sal_uInt16& rEnum,
                             std::u16string_view rValue,
                             const SvXMLEnumStringMapEntry<sal_uInt16> *pMap );

    static bool convertEnumImpl( sal_uInt16& rEnum,
                             std::string_view rValue,
                             const SvXMLEnumMapEntry<sal_uInt16> *pMap );

    static bool convertEnumImpl( sal_uInt16& rEnum,
                             std::string_view rValue,
                             const SvXMLEnumStringMapEntry<sal_uInt16> *pMap );

    static bool convertEnumImpl( OUStringBuffer& rBuffer,
                             sal_uInt16 nValue,
                             const SvXMLEnumMapEntry<sal_uInt16> *pMap,
                             enum ::xmloff::token::XMLTokenEnum eDefault );
};

#endif // INCLUDED_XMLOFF_XMLUCONV_HXX

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