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