include/xmloff/xmluconv.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_XMLOFF_XMLUCONV_HXX
  21 #define INCLUDED_XMLOFF_XMLUCONV_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <sal/types.h>
  26
  27 #include <memory>
  28
  29 #include <rtl/ustring.hxx>
  30 #include <rtl/ustrbuf.hxx>
  31 #include <xmloff/xmltoken.hxx>
  32
  33 #include <unotools/saveopt.hxx>
  34
  35 #include <tools/fldunit.hxx>
  36
  37 namespace com::sun::star {
  38     namespace text { class XNumberingTypeInfo; }
  39 }
  40
  41 namespace basegfx
  42 {
  43     class B3DVector;
  44 }
  45
  46 namespace com::sun::star::beans { class XPropertySet; }
  47 namespace com::sun::star::beans { struct PropertyValue; }
  48 namespace com::sun::star::drawing { struct Position3D; }
  49 namespace com::sun::star::frame { class XModel; }
  50 namespace com::sun::star::uno { class XComponentContext; }
  51 namespace com::sun::star::uno { template <class E> class Sequence; }
  52 namespace com::sun::star::util { struct Date; }
  53 template <typename EnumT> struct SvXMLEnumMapEntry;
  54 template <typename EnumT> struct SvXMLEnumStringMapEntry;
  55
  56 class XMLOFF_DLLPUBLIC SvXMLTokenEnumerator
  57 {
  58 private:
  59     const OUString&  maTokenString;
  60     sal_Int32               mnNextTokenPos;
  61     sal_Unicode             mcSeparator;
  62
  63 public:
  64     SvXMLTokenEnumerator( const OUString& rString, sal_Unicode cSeparator = u' ' );
  65
  66     bool getNextToken( OUString& rToken );
  67 };
  68
  69 /** the SvXMLTypeConverter converts values of various types from
  70     their internal representation to the textual form used in xml
  71     and back.
  72     Most of the methods are static but the SvXMLTypeConverter can
  73     also store default units for both numerical and textual measures.
  74
  75     @attention:
  76         a lot of the methods here have been moved to <sax/tools/converter.hxx>!
  77 */
  78
  79 class XMLOFF_DLLPUBLIC SvXMLUnitConverter final
  80 {
  81 private:
  82     SvXMLUnitConverter(const SvXMLUnitConverter&) = delete;
  83     SvXMLUnitConverter& operator=(const SvXMLUnitConverter&) = delete;
  84
  85     struct SAL_DLLPRIVATE Impl;
  86     ::std::unique_ptr<Impl> m_pImpl;
  87
  88 public:
  89     /** constructs a SvXMLUnitConverter. The core measure unit is the
  90         default unit for numerical measures, the XML measure unit is
  91         the default unit for textual measures */
  92     SvXMLUnitConverter(
  93         const css::uno::Reference< css::uno::XComponentContext >& xContext,
  94         sal_Int16 eCoreMeasureUnit /*css::util::MeasureUnit*/,
  95         sal_Int16 eXMLMeasureUnit /*css::util::MeasureUnit*/,
  96         SvtSaveOptions::ODFSaneDefaultVersion const nODFVersion);
  97
  98     ~SvXMLUnitConverter();
  99
 100     static sal_Int16 GetMeasureUnit(FieldUnit const nFieldUnit);
 101
 102     /** sets the default unit for numerical measures */
 103     void SetCoreMeasureUnit( sal_Int16 const eCoreMeasureUnit /*css::util::MeasureUnit*/);
 104
 105     /** sets the default unit for textual measures */
 106     void SetXMLMeasureUnit( sal_Int16 const eXMLMeasureUnit /*css::util::MeasureUnit*/);
 107
 108     /** gets the default unit for textual measures */
 109     sal_Int16 GetXMLMeasureUnit() const;
 110
 111     /// ODF version, only when exporting
 112     SvtSaveOptions::ODFSaneDefaultVersion getSaneDefaultVersion() const;
 113     void overrideSaneDefaultVersion(SvtSaveOptions::ODFSaneDefaultVersion const);
 114
 115     /** gets XNumberingTypeInfo */
 116     const css::uno::Reference< css::text::XNumberingTypeInfo >& getNumTypeInfo() const;
 117
 118     /** convert string to measure with meCoreMeasureUnit,
 119         using optional min and max values*/
 120     bool convertMeasureToCore( sal_Int32& rValue,
 121                          const OUString& rString,
 122                          sal_Int32 nMin = SAL_MIN_INT32,
 123                          sal_Int32 nMax = SAL_MAX_INT32) const;
 124
 125     /** convert measure to string: from meCoreMeasureUnit to meXMLMeasureUnit */
 126     void convertMeasureToXML( OUStringBuffer& rBuffer,
 127                          sal_Int32 nMeasure ) const;
 128
 129     /** convert measure to string: from meCoreMeasureUnit to meXMLMeasureUnit */
 130     OUString convertMeasureToXML( sal_Int32 nMeasure ) const;
 131
 132     /** convert string to enum using given enum map, if the enum is
 133         not found in the map, this method will return false */
 134     template<typename EnumT>
 135     static bool convertEnum( EnumT& rEnum,
 136                              const OUString& rValue,
 137                              const SvXMLEnumMapEntry<EnumT> *pMap )
 138     {
 139         sal_uInt16 nTmp;
 140         bool bRet = convertEnumImpl(nTmp, rValue,
 141                         reinterpret_cast<const SvXMLEnumMapEntry<sal_uInt16>*>(pMap));
 142         if (bRet)
 143             rEnum = static_cast<EnumT>(nTmp);
 144         return bRet;
 145     }
 146
 147     /** convert string to enum using given token map, if the enum is
 148         not found in the map, this method will return false */
 149     template<typename EnumT>
 150     static bool convertEnum( EnumT& rEnum,
 151                              const OUString& rValue,
 152                              const SvXMLEnumStringMapEntry<EnumT> *pMap )
 153     {
 154         sal_uInt16 nTmp;
 155         bool bRet = convertEnumImpl(nTmp, rValue,
 156                         reinterpret_cast<const SvXMLEnumStringMapEntry<sal_uInt16>*>(pMap));
 157         if (bRet)
 158             rEnum = static_cast<EnumT>(nTmp);
 159         return bRet;
 160     }
 161
 162     /** convert enum to string using given enum map with an optional
 163         default token. If the enum is not found in the map,
 164         this method will either use the given default or return
 165         false if not default is set */
 166     template<typename EnumT>
 167     static bool convertEnum( OUStringBuffer& rBuffer,
 168                              EnumT nValue,
 169                              const SvXMLEnumMapEntry<EnumT> *pMap,
 170                              enum ::xmloff::token::XMLTokenEnum eDefault =
 171                                          ::xmloff::token::XML_TOKEN_INVALID )
 172     {
 173         return convertEnumImpl(rBuffer, static_cast<sal_uInt16>(nValue),
 174                    reinterpret_cast<const SvXMLEnumMapEntry<sal_uInt16>*>(pMap), eDefault);
 175     }
 176
 177     /** convert double number to string (using ::rtl::math) and DO
 178         convert to export MapUnit using meCoreMeasureUnit/meXMLMeasureUnit */
 179     void convertDouble(OUStringBuffer& rBuffer,
 180         double fNumber) const;
 181
 182     /** convert string to double number (using ::rtl::math) and DO convert. */
 183     bool convertDouble(double& rValue, const OUString& rString) const;
 184
 185     /** get the Null Date of the XModel and set it to the UnitConverter */
 186     bool setNullDate (
 187         const css::uno::Reference <css::frame::XModel>& xModel);
 188
 189     /** convert double to ISO Date Time String */
 190     void convertDateTime( OUStringBuffer& rBuffer,
 191                                 const double& fDateTime,
 192                                 bool const bAddTimeIf0AM = false);
 193
 194     /** convert ISO Date Time String to double */
 195     bool convertDateTime(double& fDateTime,
 196                          const OUString& rString);
 197
 198     /// these 2 functions use tools Date, so they're not yet moved to sax
 199
 200     /** convert double to ISO Date Time String */
 201     static void convertDateTime( OUStringBuffer& rBuffer,
 202                                 const double& fDateTime,
 203                                 const css::util::Date& aNullDate,
 204                                 bool bAddTimeIf0AM = false);
 205     /** convert ISO Date Time String to double */
 206     static bool convertDateTime( double& fDateTime,
 207                                 const OUString& rString,
 208                                 const css::util::Date& aNullDate);
 209
 210
 211     /** convert string to ::basegfx::B3DVector */
 212     static bool convertB3DVector( ::basegfx::B3DVector& rVector,
 213                               const OUString& rValue );
 214
 215     /** convert B3DVector to string */
 216     static void convertB3DVector( OUStringBuffer &rBuffer,
 217         const ::basegfx::B3DVector& rVector );
 218
 219     /** convert string to Position3D */
 220     bool convertPosition3D( css::drawing::Position3D& rPosition,
 221                               const OUString& rValue );
 222
 223     /** convert Position3D to string */
 224     void convertPosition3D( OUStringBuffer &rBuffer,
 225                               const css::drawing::Position3D& rVector );
 226
 227
 228     /** convert num-format and num-letter-sync values to NumberingType */
 229     bool convertNumFormat( sal_Int16& rType,
 230                            const OUString& rNumFormat,
 231                            const OUString& rNumLetterSync,
 232                            bool bNumberNone = false ) const;
 233
 234     /** convert NumberingType to num-format and num-letter-sync values */
 235     void convertNumFormat( OUStringBuffer& rBuffer,
 236                            sal_Int16 nType ) const;
 237     static void convertNumLetterSync( OUStringBuffer& rBuffer,
 238                                   sal_Int16 nType );
 239
 240     static void convertPropertySet(css::uno::Sequence<css::beans::PropertyValue>& rProps,
 241                         const css::uno::Reference<css::beans::XPropertySet>& aProperties);
 242     static void convertPropertySet(css::uno::Reference<css::beans::XPropertySet> const & rProperties,
 243                         const css::uno::Sequence<css::beans::PropertyValue>& aProps);
 244
 245     OUString encodeStyleName( const OUString& rName,
 246                                      bool *pEncoded=nullptr ) const;
 247     /** convert string (hex) to number (sal_uInt32) */
 248     static bool convertHex( sal_uInt32& nVal,
 249                               const OUString& rValue );
 250
 251     /** convert number (sal_uInt32) to string (hex) */
 252     static void convertHex( OUStringBuffer& rBuffer,
 253                                sal_uInt32 nVal );
 254
 255 private:
 256     static bool convertEnumImpl( sal_uInt16& rEnum,
 257                              const OUString& rValue,
 258                              const SvXMLEnumMapEntry<sal_uInt16> *pMap );
 259
 260     static bool convertEnumImpl( sal_uInt16& rEnum,
 261                              const OUString& rValue,
 262                              const SvXMLEnumStringMapEntry<sal_uInt16> *pMap );
 263
 264     static bool convertEnumImpl( OUStringBuffer& rBuffer,
 265                              sal_uInt16 nValue,
 266                              const SvXMLEnumMapEntry<sal_uInt16> *pMap,
 267                              enum ::xmloff::token::XMLTokenEnum eDefault );
 268 };
 269
 270 #endif // INCLUDED_XMLOFF_XMLUCONV_HXX
 271
 272 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */