unotools/source/config/optionsdlg.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 <unotools/optionsdlg.hxx>
  21 #include <unotools/configitem.hxx>
  22 #include <com/sun/star/uno/Any.hxx>
  23 #include <com/sun/star/uno/Sequence.hxx>
  24 #include <osl/mutex.hxx>
  25
  26 #include "itemholder1.hxx"
  27
  28 #include <unordered_map>
  29
  30 using namespace utl;
  31 using namespace com::sun::star::beans;
  32 using namespace com::sun::star::uno;
  33
  34 #define CFG_FILENAME            "Office.OptionsDialog"
  35 #define ROOT_NODE               "OptionsDialogGroups"
  36 #define PAGES_NODE              "Pages"
  37 #define OPTIONS_NODE            "Options"
  38
  39 static SvtOptionsDlgOptions_Impl*   pOptions = nullptr;
  40 static sal_Int32                    nRefCount = 0;
  41
  42 class SvtOptionsDlgOptions_Impl : public utl::ConfigItem
  43 {
  44 private:
  45     typedef std::unordered_map< OUString, bool > OptionNodeList;
  46
  47     static constexpr OUStringLiteral g_sPathDelimiter = "/";
  48     OptionNodeList  m_aOptionNodeList;
  49
  50     enum NodeType{ NT_Group, NT_Page, NT_Option };
  51     void            ReadNode( const OUString& _rNode, NodeType _eType );
  52     bool        IsHidden( const OUString& _rPath ) const;
  53
  54     virtual void    ImplCommit() override;
  55
  56 public:
  57                     SvtOptionsDlgOptions_Impl();
  58
  59     virtual void    Notify( const css::uno::Sequence< OUString >& aPropertyNames ) override;
  60
  61     static ::osl::Mutex & getInitMutex();
  62
  63     bool        IsGroupHidden   (   const OUString& _rGroup ) const;
  64     bool        IsPageHidden    (   const OUString& _rPage,
  65                                         const OUString& _rGroup ) const;
  66     bool        IsOptionHidden  (   const OUString& _rOption,
  67                                         const OUString& _rPage,
  68                                         const OUString& _rGroup ) const;
  69 };
  70
  71 namespace
  72 {
  73     class theOptionsDlgOptions_ImplMutex : public rtl::Static<osl::Mutex, theOptionsDlgOptions_ImplMutex>{};
  74 }
  75
  76 ::osl::Mutex & SvtOptionsDlgOptions_Impl::getInitMutex()
  77 {
  78     return theOptionsDlgOptions_ImplMutex::get();
  79 }
  80
  81 SvtOptionsDlgOptions_Impl::SvtOptionsDlgOptions_Impl()
  82     : ConfigItem( CFG_FILENAME ),
  83     m_aOptionNodeList( OptionNodeList() )
  84 {
  85     OUString sRootNode( ROOT_NODE );
  86     const Sequence< OUString > aNodeSeq = GetNodeNames( sRootNode );
  87     OUString sNode( sRootNode + g_sPathDelimiter );
  88     for ( const auto& rNode : aNodeSeq )
  89     {
  90         OUString sSubNode( sNode + rNode );
  91         ReadNode( sSubNode, NT_Group );
  92     }
  93 }
  94
  95 void SvtOptionsDlgOptions_Impl::ImplCommit()
  96 {
  97     // nothing to commit
  98 }
  99
 100 void SvtOptionsDlgOptions_Impl::Notify( const Sequence< OUString >& )
 101 {
 102     // nothing to notify
 103 }
 104
 105 void SvtOptionsDlgOptions_Impl::ReadNode( const OUString& _rNode, NodeType _eType )
 106 {
 107     OUString sNode( _rNode + g_sPathDelimiter );
 108     OUString sSet;
 109     sal_Int32 nLen = 0;
 110     switch ( _eType )
 111     {
 112         case NT_Group :
 113         {
 114             sSet = PAGES_NODE;
 115             nLen = 2;
 116             break;
 117         }
 118
 119         case NT_Page :
 120         {
 121             sSet = OPTIONS_NODE;
 122             nLen = 2;
 123             break;
 124         }
 125
 126         case NT_Option :
 127         {
 128             nLen = 1;
 129             break;
 130         }
 131     }
 132
 133     Sequence< OUString > lResult( nLen );
 134     lResult[0] = sNode + "Hide";
 135     if ( _eType != NT_Option )
 136         lResult[1] = sNode + sSet;
 137
 138     Sequence< Any > aValues = GetProperties( lResult );
 139     bool bHide = false;
 140     if ( aValues[0] >>= bHide )
 141         m_aOptionNodeList.emplace( sNode, bHide );
 142
 143     if ( _eType != NT_Option )
 144     {
 145         OUString sNodes( sNode + sSet );
 146         const Sequence< OUString > aNodes = GetNodeNames( sNodes );
 147         for ( const auto& rNode : aNodes )
 148         {
 149             OUString sSubNodeName( sNodes + g_sPathDelimiter + rNode );
 150             ReadNode( sSubNodeName, _eType == NT_Group ? NT_Page : NT_Option );
 151         }
 152     }
 153 }
 154
 155 static OUString getGroupPath( const OUString& _rGroup )
 156 {
 157     return OUString( ROOT_NODE "/" + _rGroup + "/" );
 158 }
 159 static OUString getPagePath( const OUString& _rPage )
 160 {
 161     return OUString( PAGES_NODE "/" + _rPage + "/" );
 162 }
 163 static OUString getOptionPath( const OUString& _rOption )
 164 {
 165     return OUString( OPTIONS_NODE "/" + _rOption + "/" );
 166 }
 167
 168 bool SvtOptionsDlgOptions_Impl::IsHidden( const OUString& _rPath ) const
 169 {
 170     bool bRet = false;
 171     OptionNodeList::const_iterator pIter = m_aOptionNodeList.find( _rPath );
 172     if ( pIter != m_aOptionNodeList.end() )
 173         bRet = pIter->second;
 174     return bRet;
 175 }
 176
 177 bool SvtOptionsDlgOptions_Impl::IsGroupHidden( const OUString& _rGroup ) const
 178 {
 179     return IsHidden( getGroupPath( _rGroup ) );
 180 }
 181
 182 bool SvtOptionsDlgOptions_Impl::IsPageHidden( const OUString& _rPage, const OUString& _rGroup ) const
 183 {
 184     return IsHidden( getGroupPath( _rGroup  ) + getPagePath( _rPage ) );
 185 }
 186
 187 bool SvtOptionsDlgOptions_Impl::IsOptionHidden(
 188     const OUString& _rOption, const OUString& _rPage, const OUString& _rGroup ) const
 189 {
 190     return IsHidden( getGroupPath( _rGroup  ) + getPagePath( _rPage ) + getOptionPath( _rOption ) );
 191 }
 192
 193 SvtOptionsDialogOptions::SvtOptionsDialogOptions()
 194 {
 195     // Global access, must be guarded (multithreading)
 196     ::osl::MutexGuard aGuard( SvtOptionsDlgOptions_Impl::getInitMutex() );
 197     ++nRefCount;
 198     if ( !pOptions )
 199     {
 200         pOptions = new SvtOptionsDlgOptions_Impl;
 201
 202         ItemHolder1::holdConfigItem( EItem::OptionsDialogOptions );
 203     }
 204     m_pImp = pOptions;
 205 }
 206
 207 SvtOptionsDialogOptions::~SvtOptionsDialogOptions()
 208 {
 209     // Global access, must be guarded (multithreading)
 210     ::osl::MutexGuard aGuard( SvtOptionsDlgOptions_Impl::getInitMutex() );
 211     if ( !--nRefCount )
 212     {
 213         if ( pOptions->IsModified() )
 214             pOptions->Commit();
 215         delete pOptions;
 216         pOptions = nullptr;
 217     }
 218 }
 219
 220 bool SvtOptionsDialogOptions::IsGroupHidden( const OUString& _rGroup ) const
 221 {
 222     return m_pImp->IsGroupHidden( _rGroup );
 223 }
 224
 225 bool SvtOptionsDialogOptions::IsPageHidden( const OUString& _rPage, const OUString& _rGroup ) const
 226 {
 227     return m_pImp->IsPageHidden( _rPage, _rGroup );
 228 }
 229
 230 bool SvtOptionsDialogOptions::IsOptionHidden(
 231     const OUString& _rOption, const OUString& _rPage, const OUString& _rGroup ) const
 232 {
 233     return m_pImp->IsOptionHidden( _rOption, _rPage, _rGroup );
 234 }
 235
 236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */