include/unotools/compatibility.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 #ifndef INCLUDED_UNOTOOLS_COMPATIBILITY_HXX
  20 #define INCLUDED_UNOTOOLS_COMPATIBILITY_HXX
  21
  22 #include <com/sun/star/uno/Any.hxx>
  23 #include <unotools/options.hxx>
  24 #include <unotools/unotoolsdllapi.h>
  25 #include <rtl/ustring.hxx>
  26 #include <memory>
  27 #include <vector>
  28
  29 namespace osl { class Mutex; }
  30
  31 /*-************************************************************************************************************
  32     @descr  Struct to hold information about one compatibility entry
  33 *//*-*************************************************************************************************************/
  34 class SvtCompatibilityEntry
  35 {
  36     public:
  37         /*-************************************************************************************************************
  38             @descr          The method SvtCompatibilityOptions::GetList() returns a list of property values.
  39                             Use follow enum class to separate values by names.
  40                             Sync it with sPropertyName in SvtCompatibilityEntry::getName()
  41         *//*-*************************************************************************************************************/
  42         enum class Index
  43         {
  44             /* Should be in the start. Do not remove it. */
  45             Name,
  46             Module,
  47
  48             /* Editable list of compatibility options. */
  49             AddSpacing,
  50             AddSpacingAtPages,
  51             UseOurTabStops,
  52             NoExtLeading,
  53             UseLineSpacing,
  54             AddTableSpacing,
  55             UseObjectPositioning,
  56             UseOurTextWrapping,
  57             ConsiderWrappingStyle,
  58             ExpandWordSpace,
  59             ProtectForm,
  60             MsWordTrailingBlanks,
  61             SubtractFlysAnchoredAtFlys,
  62             EmptyDbFieldHidesPara,
  63
  64             /// special entry: optcomp.cxx converts the other values to
  65             /// integers but not this one because it doesn't have its own
  66             /// checkbox, so keep it at the end!
  67             AddTableLineSpacing,
  68
  69             /* Should be at the end. Do not remove it. */
  70             INVALID
  71         };
  72
  73         SvtCompatibilityEntry();
  74
  75         static OUString getName( const Index rIdx );
  76
  77         static constexpr OUStringLiteral USER_ENTRY_NAME = u"_user";
  78         static constexpr OUStringLiteral DEFAULT_ENTRY_NAME = u"_default";
  79
  80         static size_t getElementCount()
  81         {
  82             return static_cast<size_t>(Index::INVALID);
  83         }
  84
  85         css::uno::Any getValue( const Index rIdx ) const
  86         {
  87             if ( static_cast<size_t>(rIdx) < getElementCount() )
  88             {
  89                 return m_aPropertyValue[ static_cast<int>(rIdx) ];
  90             } else
  91             {
  92                 /* Wrong index. */
  93                 assert( false );
  94                 return css::uno::Any();
  95             }
  96         }
  97
  98         template<typename T>
  99         T getValue( const Index rIdx ) const
 100         {
 101             T aValue = T();
 102
 103             if ( static_cast<size_t>(rIdx) < getElementCount() )
 104             {
 105                 m_aPropertyValue[ static_cast<int>(rIdx) ] >>= aValue;
 106             } else
 107             {
 108                 /* Wrong index. */
 109                 assert( false );
 110             }
 111
 112             return aValue;
 113         }
 114
 115         void setValue( const Index rIdx, css::uno::Any const & rValue )
 116         {
 117             if ( static_cast<size_t>(rIdx) < getElementCount() )
 118             {
 119                 m_aPropertyValue[ static_cast<int>(rIdx) ] = rValue;
 120             } else
 121             {
 122                 /* Wrong index. */
 123                 assert( false );
 124             }
 125         }
 126
 127         template<typename T>
 128         void setValue( const Index rIdx, T rValue )
 129         {
 130             setValue(rIdx, css::uno::Any(rValue));
 131         }
 132
 133     private:
 134         std::vector<css::uno::Any> m_aPropertyValue;
 135 };
 136
 137 /*-************************************************************************************************************
 138     @short          forward declaration to our private date container implementation
 139     @descr          We use these class as internal member to support small memory requirements.
 140                     You can create the container if it is necessary. The class which use these mechanism
 141                     is faster and smaller then a complete implementation!
 142 *//*-*************************************************************************************************************/
 143 class SvtCompatibilityOptions_Impl;
 144
 145 /*-************************************************************************************************************
 146     @short          collect information about dynamic menus
 147     @descr          Make it possible to configure dynamic menu structures of menus like "new" or "wizard".
 148     @devstatus      ready to use
 149 *//*-*************************************************************************************************************/
 150 class UNOTOOLS_DLLPUBLIC SvtCompatibilityOptions final : public utl::detail::Options
 151 {
 152     public:
 153         SvtCompatibilityOptions();
 154         virtual ~SvtCompatibilityOptions() override;
 155
 156         /*-****************************************************************************************************
 157             @short      append a new item
 158             @descr
 159
 160             @seealso    method Clear()
 161
 162             @param      "aItem"             SvtCompatibilityEntry
 163         *//*-*****************************************************************************************************/
 164         void AppendItem( const SvtCompatibilityEntry& aItem );
 165
 166         /*-****************************************************************************************************
 167             @short      clear complete specified list
 168             @descr      Call this methods to clear the whole list.
 169         *//*-*****************************************************************************************************/
 170         void Clear();
 171
 172         void SetDefault( SvtCompatibilityEntry::Index rIdx, bool rValue );
 173         bool GetDefault( SvtCompatibilityEntry::Index rIdx ) const;
 174
 175         /*-****************************************************************************************************
 176             @short      return complete specified list
 177             @descr      Call it to get all entries of compatibility options.
 178                         We return a list of all nodes with its names and properties.
 179             @return     A list of compatibility options is returned.
 180
 181             @onerror    We return an empty list.
 182         *//*-*****************************************************************************************************/
 183         std::vector< SvtCompatibilityEntry > GetList() const;
 184
 185     private:
 186         std::shared_ptr<SvtCompatibilityOptions_Impl> m_pImpl;
 187
 188         /*-****************************************************************************************************
 189             @short      return a reference to a static mutex
 190             @descr      These class is partially threadsafe (for de-/initialization only).
 191                         All access methods aren't safe!
 192                         We create a static mutex only for one ime and use at different times.
 193             @return     A reference to a static mutex member.
 194         *//*-*****************************************************************************************************/
 195         UNOTOOLS_DLLPRIVATE static osl::Mutex& GetOwnStaticMutex();
 196 };
 197
 198 #endif // INCLUDED_UNOTOOLS_COMPATIBILITY_HXX
 199
 200 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */