svtools/source/config/optionsdlg.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: optionsdlg.cxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svtools.hxx"
  33
  34 #include <svtools/optionsdlg.hxx>
  35 #include <unotools/configmgr.hxx>
  36 #include <unotools/configitem.hxx>
  37 #include <tools/debug.hxx>
  38 #include <com/sun/star/uno/Any.hxx>
  39 #include <com/sun/star/uno/Sequence.hxx>
  40 #include <osl/mutex.hxx>
  41 #include <comphelper/stl_types.hxx>
  42
  43 #include <hash_map>
  44 #include "itemholder1.hxx"
  45
  46 using namespace utl;
  47 using namespace rtl;
  48 using namespace com::sun::star::beans ;
  49 using namespace com::sun::star::uno;
  50
  51 #define CFG_FILENAME            OUString( RTL_CONSTASCII_USTRINGPARAM( "Office.OptionsDialog" ) )
  52 #define ROOT_NODE               OUString( RTL_CONSTASCII_USTRINGPARAM( "OptionsDialogGroups" ) )
  53 #define PAGES_NODE              OUString( RTL_CONSTASCII_USTRINGPARAM( "Pages" ) )
  54 #define OPTIONS_NODE            OUString( RTL_CONSTASCII_USTRINGPARAM( "Options" ) )
  55 #define PROPERTY_HIDE           OUString( RTL_CONSTASCII_USTRINGPARAM( "Hide" ) )
  56
  57 static SvtOptionsDlgOptions_Impl*   pOptions = NULL;
  58 static sal_Int32                    nRefCount = 0;
  59
  60 class SvtOptionsDlgOptions_Impl : public utl::ConfigItem
  61 {
  62 private:
  63     struct OUStringHashCode
  64     {
  65         size_t operator()( const ::rtl::OUString& sString ) const
  66         {
  67             return sString.hashCode();
  68         }
  69     };
  70
  71     typedef std::hash_map< OUString, sal_Bool, OUStringHashCode, ::std::equal_to< OUString > > OptionNodeList;
  72
  73     OUString        m_sPathDelimiter;
  74     OptionNodeList  m_aOptionNodeList;
  75
  76     enum NodeType{ NT_Group, NT_Page, NT_Option };
  77     void            ReadNode( const OUString& _rNode, NodeType _eType );
  78     sal_Bool        IsHidden( const OUString& _rPath ) const;
  79
  80 public:
  81                     SvtOptionsDlgOptions_Impl();
  82
  83     virtual void    Notify( const com::sun::star::uno::Sequence< rtl::OUString >& aPropertyNames );
  84     virtual void    Commit();
  85
  86     static ::osl::Mutex & getInitMutex();
  87
  88     sal_Bool        IsGroupHidden   (   const OUString& _rGroup ) const;
  89     sal_Bool        IsPageHidden    (   const OUString& _rPage,
  90                                         const OUString& _rGroup ) const;
  91     sal_Bool        IsOptionHidden  (   const OUString& _rOption,
  92                                         const OUString& _rPage,
  93                                         const OUString& _rGroup ) const;
  94 };
  95
  96 ::osl::Mutex & SvtOptionsDlgOptions_Impl::getInitMutex()
  97 {
  98     static ::osl::Mutex *pMutex = 0;
  99
 100     if( ! pMutex )
 101     {
 102         ::osl::MutexGuard guard( ::osl::Mutex::getGlobalMutex() );
 103         if( ! pMutex )
 104         {
 105             static ::osl::Mutex mutex;
 106             pMutex = &mutex;
 107         }
 108     }
 109     return *pMutex;
 110 }
 111
 112 // -----------------------------------------------------------------------
 113
 114 SvtOptionsDlgOptions_Impl::SvtOptionsDlgOptions_Impl()
 115     : ConfigItem( OUString( CFG_FILENAME ) ),
 116
 117     m_sPathDelimiter( RTL_CONSTASCII_USTRINGPARAM( "/" ) ),
 118     m_aOptionNodeList( OptionNodeList() )
 119
 120 {
 121     OUString sRootNode( ROOT_NODE );
 122     Sequence< OUString > aNodeSeq = GetNodeNames( sRootNode );
 123     OUString sNode( sRootNode + m_sPathDelimiter );
 124     sal_uInt32 nCount = aNodeSeq.getLength();
 125     for ( sal_uInt32 n = 0; n < nCount; n++ )
 126     {
 127         OUString sSubNode( sNode + aNodeSeq[n] );
 128         ReadNode( sSubNode, NT_Group );
 129     }
 130 }
 131
 132 // -----------------------------------------------------------------------
 133
 134 void SvtOptionsDlgOptions_Impl::Commit()
 135 {
 136     // nothing to commit
 137 }
 138
 139 // -----------------------------------------------------------------------
 140
 141 void SvtOptionsDlgOptions_Impl::Notify( const Sequence< rtl::OUString >& )
 142 {
 143     // nothing to notify
 144 }
 145
 146 void SvtOptionsDlgOptions_Impl::ReadNode( const OUString& _rNode, NodeType _eType )
 147 {
 148     OUString sNode( _rNode + m_sPathDelimiter );
 149     OUString sSet;
 150     sal_Int32 nLen = 0;
 151     switch ( _eType )
 152     {
 153         case NT_Group :
 154         {
 155             sSet = PAGES_NODE;
 156             nLen = 2;
 157             break;
 158         }
 159
 160         case NT_Page :
 161         {
 162             sSet = OPTIONS_NODE;
 163             nLen = 2;
 164             break;
 165         }
 166
 167         case NT_Option :
 168         {
 169             nLen = 1;
 170             break;
 171         }
 172     }
 173
 174     Sequence< OUString > lResult( nLen );
 175     lResult[0] = OUString( sNode + PROPERTY_HIDE );
 176     if ( _eType != NT_Option )
 177         lResult[1] = OUString( sNode + sSet );
 178
 179     Sequence< Any > aValues;
 180     aValues = GetProperties( lResult );
 181     sal_Bool bHide = sal_False;
 182     if ( aValues[0] >>= bHide )
 183         m_aOptionNodeList.insert( OptionNodeList::value_type( sNode, bHide ) );
 184
 185     if ( _eType != NT_Option )
 186     {
 187         OUString sNodes( sNode + sSet );
 188         Sequence< OUString > aNodes = GetNodeNames( sNodes );
 189         if ( aNodes.getLength() > 0 )
 190         {
 191             for ( sal_uInt32 n = 0; n < (sal_uInt32)aNodes.getLength(); ++n )
 192             {
 193                 OUString sSubNodeName( sNodes + m_sPathDelimiter + aNodes[n] );
 194                 ReadNode( sSubNodeName, _eType == NT_Group ? NT_Page : NT_Option );
 195             }
 196         }
 197     }
 198 }
 199
 200 // -----------------------------------------------------------------------
 201
 202 OUString getGroupPath( const OUString& _rGroup )
 203 {
 204     return OUString( ROOT_NODE + OUString('/') + _rGroup + OUString('/') );
 205 }
 206 OUString getPagePath( const OUString& _rPage )
 207 {
 208     return OUString( PAGES_NODE + OUString('/') + _rPage + OUString('/') );
 209 }
 210 OUString getOptionPath( const OUString& _rOption )
 211 {
 212     return OUString( OPTIONS_NODE + OUString('/') + _rOption + OUString('/') );
 213 }
 214
 215 // -----------------------------------------------------------------------
 216
 217 sal_Bool SvtOptionsDlgOptions_Impl::IsHidden( const OUString& _rPath ) const
 218 {
 219     sal_Bool bRet = sal_False;
 220     OptionNodeList::const_iterator pIter = m_aOptionNodeList.find( _rPath );
 221     if ( pIter != m_aOptionNodeList.end() )
 222         bRet = pIter->second;
 223     return bRet;
 224 }
 225
 226 // -----------------------------------------------------------------------
 227
 228 sal_Bool SvtOptionsDlgOptions_Impl::IsGroupHidden( const OUString& _rGroup ) const
 229 {
 230     return IsHidden( getGroupPath( _rGroup ) );
 231 }
 232
 233 // -----------------------------------------------------------------------
 234
 235 sal_Bool SvtOptionsDlgOptions_Impl::IsPageHidden( const OUString& _rPage, const OUString& _rGroup ) const
 236 {
 237     return IsHidden( getGroupPath( _rGroup  ) + getPagePath( _rPage ) );
 238 }
 239
 240 // -----------------------------------------------------------------------
 241
 242 sal_Bool SvtOptionsDlgOptions_Impl::IsOptionHidden(
 243     const OUString& _rOption, const OUString& _rPage, const OUString& _rGroup ) const
 244 {
 245     return IsHidden( getGroupPath( _rGroup  ) + getPagePath( _rPage ) + getOptionPath( _rOption ) );
 246 }
 247
 248 // -----------------------------------------------------------------------
 249
 250 SvtOptionsDialogOptions::SvtOptionsDialogOptions()
 251 {
 252     // Global access, must be guarded (multithreading)
 253     ::osl::MutexGuard aGuard( SvtOptionsDlgOptions_Impl::getInitMutex() );
 254     ++nRefCount;
 255     if ( !pOptions )
 256     {
 257         pOptions = new SvtOptionsDlgOptions_Impl;
 258
 259         ItemHolder1::holdConfigItem( E_OPTIONSDLGOPTIONS );
 260     }
 261     m_pImp = pOptions;
 262 }
 263
 264 // -----------------------------------------------------------------------
 265
 266 SvtOptionsDialogOptions::~SvtOptionsDialogOptions()
 267 {
 268     // Global access, must be guarded (multithreading)
 269     ::osl::MutexGuard aGuard( SvtOptionsDlgOptions_Impl::getInitMutex() );
 270     if ( !--nRefCount )
 271     {
 272         if ( pOptions->IsModified() )
 273             pOptions->Commit();
 274         DELETEZ( pOptions );
 275     }
 276 }
 277
 278 sal_Bool SvtOptionsDialogOptions::IsGroupHidden( const String& _rGroup ) const
 279 {
 280     return m_pImp->IsGroupHidden( _rGroup );
 281 }
 282
 283 sal_Bool SvtOptionsDialogOptions::IsPageHidden( const String& _rPage, const String& _rGroup ) const
 284 {
 285     return m_pImp->IsPageHidden( _rPage, _rGroup );
 286 }
 287
 288 sal_Bool SvtOptionsDialogOptions::IsOptionHidden(
 289     const String& _rOption, const String& _rPage, const String& _rGroup ) const
 290 {
 291     return m_pImp->IsOptionHidden( _rOption, _rPage, _rGroup );
 292 }
 293