svtools/source/config/miscopt.cxx

   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 #include <svtools/miscopt.hxx>
  21 #include <unotools/configitem.hxx>
  22 #include <tools/debug.hxx>
  23 #include <com/sun/star/uno/Any.hxx>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include <comphelper/sequence.hxx>
  26 #include <tools/link.hxx>
  27 #include <osl/diagnose.h>
  28
  29 #include "itemholder2.hxx"
  30
  31 #include <svtools/imgdef.hxx>
  32 #include <vcl/svapp.hxx>
  33 #include <vcl/settings.hxx>
  34 #include <officecfg/Office/Common.hxx>
  35
  36 #include <mutex>
  37 #include <vector>
  38
  39 using namespace ::utl                   ;
  40 using namespace ::com::sun::star::uno   ;
  41 using namespace ::com::sun::star;
  42
  43 constexpr OUStringLiteral ROOTNODE_MISC = u"Office.Common/Misc";
  44
  45 // PROPERTYHANDLE defines must be sequential from zero for Commit/Load
  46 constexpr OUString PROPERTYNAME_SYMBOLSET = u"SymbolSet"_ustr;
  47 constexpr OUString PROPERTYNAME_ICONTHEME = u"SymbolStyle"_ustr;
  48 #define PROPERTYHANDLE_SYMBOLSTYLE              1
  49 constexpr OUString PROPERTYNAME_SIDEBARICONSIZE = u"SidebarIconSize"_ustr;
  50 constexpr OUString PROPERTYNAME_NOTEBOOKBARICONSIZE = u"NotebookbarIconSize"_ustr;
  51
  52 static std::mutex & GetInitMutex()
  53 {
  54     static std::mutex theSvtMiscOptionsMutex;
  55     return theSvtMiscOptionsMutex;
  56 }
  57
  58
  59 class SvtMiscOptions_Impl : public ConfigItem
  60 {
  61 private:
  62     ::std::vector<Link<LinkParamNone*,void>> aList;
  63     bool        m_bIsSymbolsStyleRO;
  64     bool        m_bIconThemeWasSetAutomatically;
  65
  66         virtual void ImplCommit() override;
  67
  68 public:
  69
  70          SvtMiscOptions_Impl();
  71         virtual ~SvtMiscOptions_Impl() override;
  72
  73         /*-****************************************************************************************************
  74             @short      called for notify of configmanager
  75             @descr      This method is called from the ConfigManager before the application ends or from the
  76                         PropertyChangeListener if the sub tree broadcasts changes. You must update your
  77                         internal values.
  78
  79             @seealso    baseclass ConfigItem
  80
  81             @param      "seqPropertyNames" is the list of properties which should be updated.
  82         *//*-*****************************************************************************************************/
  83
  84         virtual void Notify( const Sequence< OUString >& seqPropertyNames ) override;
  85
  86         /** loads required data from the configuration. It's called in the constructor to
  87          read all entries and form ::Notify to re-read changed settings
  88
  89          */
  90         void Load( const Sequence< OUString >& rPropertyNames );
  91
  92         //  public interface
  93
  94         static OUString GetIconTheme();
  95
  96         enum class SetModifiedFlag { SET, DONT_SET };
  97
  98         /** Set the icon theme
  99          *
 100          * @param theme
 101          * The name of the icon theme to use.
 102          *
 103          * @param setModified
 104          * Whether to call SetModified() and CallListeners().
 105          *
 106          * @internal
 107          * The @p setModified flag was introduced because the unittests fail if we call SetModified()
 108          * during initialization in the constructor.
 109          */
 110         void
 111         SetIconTheme(const OUString &theme, SetModifiedFlag setModified );
 112
 113         bool IconThemeWasSetAutomatically() const
 114         {return m_bIconThemeWasSetAutomatically;}
 115
 116         void AddListenerLink( const Link<LinkParamNone*,void>& rLink );
 117         void RemoveListenerLink( const Link<LinkParamNone*,void>& rLink );
 118         void CallListeners();
 119
 120
 121     //  private methods
 122
 123
 124 private:
 125
 126         /*-****************************************************************************************************
 127             @short      return list of key names of our configuration management which represent our module tree
 128             @descr      These methods return a static const list of key names. We need it to get needed values from our
 129                         configuration management.
 130             @return     A list of needed configuration keys is returned.
 131         *//*-*****************************************************************************************************/
 132
 133         static Sequence< OUString > GetPropertyNames();
 134 };
 135
 136
 137 //  constructor
 138
 139 SvtMiscOptions_Impl::SvtMiscOptions_Impl()
 140     // Init baseclasses first
 141     : ConfigItem( ROOTNODE_MISC )
 142
 143     , m_bIsSymbolsStyleRO( false )
 144     , m_bIconThemeWasSetAutomatically( false )
 145 {
 146     // Use our static list of configuration keys to get his values.
 147     Sequence< OUString >    seqNames    = GetPropertyNames  (           );
 148     Load( seqNames );
 149     Sequence< Any >         seqValues   = GetProperties     ( seqNames  );
 150     Sequence< sal_Bool >    seqRO       = GetReadOnlyStates ( seqNames  );
 151
 152     // Safe impossible cases.
 153     // We need values from ALL configuration keys.
 154     // Follow assignment use order of values in relation to our list of key names!
 155     DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtMiscOptions_Impl::SvtMiscOptions_Impl()\nI miss some values of configuration keys!\n" );
 156
 157     // Copy values from list in right order to our internal member.
 158     sal_Int32 nPropertyCount = seqValues.getLength();
 159     for( sal_Int32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
 160     {
 161         if (!seqValues[nProperty].hasValue())
 162             continue;
 163         switch( nProperty )
 164         {
 165             case PROPERTYHANDLE_SYMBOLSTYLE :
 166             {
 167                 OUString aIconTheme;
 168                 if (seqValues[nProperty] >>= aIconTheme)
 169                     SetIconTheme(aIconTheme, SetModifiedFlag::DONT_SET);
 170                 else
 171                     OSL_FAIL("Wrong type of \"Misc\\SymbolStyle\"!" );
 172
 173                 m_bIsSymbolsStyleRO = seqRO[nProperty];
 174                 break;
 175             }
 176
 177         }
 178     }
 179
 180     // Enable notification mechanism of our baseclass.
 181     // We need it to get information about changes outside these class on our used configuration keys!
 182     EnableNotification( seqNames );
 183 }
 184
 185
 186 //  destructor
 187
 188 SvtMiscOptions_Impl::~SvtMiscOptions_Impl()
 189 {
 190     assert(!IsModified()); // should have been committed
 191 }
 192
 193 void SvtMiscOptions_Impl::Load( const Sequence< OUString >& rPropertyNames )
 194 {
 195     const uno::Sequence< OUString> aInternalPropertyNames( GetPropertyNames());
 196     Sequence< Any > seqValues = GetProperties( rPropertyNames  );
 197
 198     // Safe impossible cases.
 199     // We need values from ALL configuration keys.
 200     // Follow assignment use order of values in relation to our list of key names!
 201     DBG_ASSERT( !(rPropertyNames.getLength()!=seqValues.getLength()), "SvtSecurityOptions_Impl::SvtSecurityOptions_Impl()\nI miss some values of configuration keys!\n" );
 202
 203     // Copy values from list in right order to our internal member.
 204     sal_Int32 nPropertyCount = seqValues.getLength();
 205     for( sal_Int32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
 206     {
 207         if (!seqValues[nProperty].hasValue())
 208             continue;
 209         switch( comphelper::findValue(aInternalPropertyNames, rPropertyNames[nProperty]) )
 210         {
 211             case PROPERTYHANDLE_SYMBOLSTYLE         :   {
 212                                                             OUString aIconTheme;
 213                                                             if (seqValues[nProperty] >>= aIconTheme)
 214                                                                 SetIconTheme(aIconTheme, SetModifiedFlag::DONT_SET);
 215                                                             else
 216                                                                 OSL_FAIL("Wrong type of \"Misc\\SymbolStyle\"!" );
 217                                                         }
 218                                                     break;
 219         }
 220     }
 221 }
 222
 223 void SvtMiscOptions_Impl::AddListenerLink( const Link<LinkParamNone*,void>& rLink )
 224 {
 225     aList.push_back( rLink );
 226 }
 227
 228 void SvtMiscOptions_Impl::RemoveListenerLink( const Link<LinkParamNone*,void>& rLink )
 229 {
 230     std::erase(aList, rLink);
 231 }
 232
 233 void SvtMiscOptions_Impl::CallListeners()
 234 {
 235     for (auto const& elem : aList)
 236         elem.Call( nullptr );
 237 }
 238
 239 OUString SvtMiscOptions_Impl::GetIconTheme()
 240 {
 241     return Application::GetSettings().GetStyleSettings().DetermineIconTheme();
 242 }
 243
 244 void
 245 SvtMiscOptions_Impl::SetIconTheme(const OUString &rName, SetModifiedFlag setModified)
 246 {
 247     OUString aTheme(rName);
 248     if (aTheme.isEmpty() || aTheme == "auto")
 249     {
 250         aTheme = Application::GetSettings().GetStyleSettings().GetAutomaticallyChosenIconTheme();
 251         m_bIconThemeWasSetAutomatically = true;
 252     }
 253     else
 254         m_bIconThemeWasSetAutomatically = false;
 255
 256     AllSettings aAllSettings = Application::GetSettings();
 257     StyleSettings aStyleSettings = aAllSettings.GetStyleSettings();
 258     aStyleSettings.SetIconTheme(aTheme);
 259
 260     aAllSettings.SetStyleSettings(aStyleSettings);
 261     Application::MergeSystemSettings( aAllSettings );
 262     Application::SetSettings(aAllSettings);
 263
 264     if (setModified == SetModifiedFlag::SET) {
 265         SetModified();
 266     }
 267     CallListeners();
 268 }
 269
 270
 271 //  public method
 272
 273 void SvtMiscOptions_Impl::Notify( const Sequence< OUString >& rPropertyNames )
 274 {
 275     Load( rPropertyNames );
 276     CallListeners();
 277 }
 278
 279
 280 //  public method
 281
 282 void SvtMiscOptions_Impl::ImplCommit()
 283 {
 284     if ( !m_bIsSymbolsStyleRO )
 285     {
 286         // Get names of supported properties, create a list for values and copy current values to it.
 287         Sequence< OUString > seqNames { PROPERTYNAME_ICONTHEME };
 288         sal_Int32               nCount      = seqNames.getLength();
 289         Sequence< Any >         seqValues   ( nCount );
 290         auto seqValuesRange = asNonConstRange(seqValues);
 291         OUString value;
 292         if (m_bIconThemeWasSetAutomatically) {
 293             value = "auto";
 294         }
 295         else {
 296             value = GetIconTheme();
 297         }
 298         seqValuesRange[0] <<= value;
 299         // Set properties in configuration.
 300         PutProperties( seqNames, seqValues );
 301     }
 302 }
 303
 304
 305 //  private method
 306
 307 Sequence< OUString > SvtMiscOptions_Impl::GetPropertyNames()
 308 {
 309     return Sequence<OUString>
 310     {
 311         PROPERTYNAME_SYMBOLSET,
 312         PROPERTYNAME_ICONTHEME,
 313         // SidebarIconSize and NotebookbarIconSize so
 314         // notifications for their changes are also broadcast
 315         // from SvtMiscOptions
 316         PROPERTYNAME_SIDEBARICONSIZE,
 317         PROPERTYNAME_NOTEBOOKBARICONSIZE
 318     };
 319 }
 320
 321 namespace {
 322
 323 std::weak_ptr<SvtMiscOptions_Impl> g_pMiscOptions;
 324
 325 }
 326
 327 SvtMiscOptions::SvtMiscOptions()
 328 {
 329     // Global access, must be guarded (multithreading!).
 330     std::unique_lock aGuard( GetInitMutex() );
 331
 332     m_pImpl = g_pMiscOptions.lock();
 333     if( !m_pImpl )
 334     {
 335         m_pImpl = std::make_shared<SvtMiscOptions_Impl>();
 336         g_pMiscOptions = m_pImpl;
 337         aGuard.unlock(); // because holdConfigItem will call this constructor
 338         svtools::ItemHolder2::holdConfigItem(EItem::MiscOptions);
 339     }
 340 }
 341
 342 SvtMiscOptions::~SvtMiscOptions()
 343 {
 344     // Global access, must be guarded (multithreading!)
 345     std::unique_lock aGuard( GetInitMutex() );
 346
 347     m_pImpl.reset();
 348 }
 349
 350
 351 sal_Int16 SvtMiscOptions::GetSymbolsSize()
 352 {
 353     return officecfg::Office::Common::Misc::SymbolSet::get();
 354 }
 355
 356 void SvtMiscOptions::SetSymbolsSize( sal_Int16 nSet )
 357 {
 358     if (!officecfg::Office::Common::Misc::SymbolSet::isReadOnly())
 359     {
 360         std::shared_ptr<comphelper::ConfigurationChanges> batch(comphelper::ConfigurationChanges::create());
 361         officecfg::Office::Common::Misc::SymbolSet::set(nSet, batch);
 362         batch->commit();
 363         m_pImpl->CallListeners();
 364     }
 365 }
 366
 367 sal_Int16 SvtMiscOptions::GetCurrentSymbolsSize()
 368 {
 369     sal_Int16 eOptSymbolsSize = GetSymbolsSize();
 370
 371     if ( eOptSymbolsSize == SFX_SYMBOLS_SIZE_AUTO )
 372     {
 373         // Use system settings, we have to retrieve the toolbar icon size from the
 374         // Application class
 375         ToolbarIconSize nStyleIconSize = Application::GetSettings().GetStyleSettings().GetToolbarIconSize();
 376         if (nStyleIconSize == ToolbarIconSize::Size32)
 377             eOptSymbolsSize = SFX_SYMBOLS_SIZE_32;
 378         else if (nStyleIconSize == ToolbarIconSize::Large)
 379             eOptSymbolsSize = SFX_SYMBOLS_SIZE_LARGE;
 380         else
 381             eOptSymbolsSize = SFX_SYMBOLS_SIZE_SMALL;
 382     }
 383
 384     return eOptSymbolsSize;
 385 }
 386
 387 bool SvtMiscOptions::AreCurrentSymbolsLarge()
 388 {
 389     return ( GetCurrentSymbolsSize() == SFX_SYMBOLS_SIZE_LARGE || GetCurrentSymbolsSize() == SFX_SYMBOLS_SIZE_32);
 390 }
 391
 392 OUString SvtMiscOptions::GetIconTheme()
 393 {
 394     return SvtMiscOptions_Impl::GetIconTheme();
 395 }
 396
 397 void SvtMiscOptions::SetIconTheme(const OUString& iconTheme)
 398 {
 399     m_pImpl->SetIconTheme(iconTheme, SvtMiscOptions_Impl::SetModifiedFlag::SET);
 400 }
 401
 402 void SvtMiscOptions::AddListenerLink( const Link<LinkParamNone*,void>& rLink )
 403 {
 404     m_pImpl->AddListenerLink( rLink );
 405 }
 406
 407 void SvtMiscOptions::RemoveListenerLink( const Link<LinkParamNone*,void>& rLink )
 408 {
 409     m_pImpl->RemoveListenerLink( rLink );
 410 }
 411
 412 bool
 413 SvtMiscOptions::IconThemeWasSetAutomatically() const
 414 {
 415     return m_pImpl->IconThemeWasSetAutomatically();
 416 }
 417
 418 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */