svtools/source/config/helpopt.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
  21 #include <svtools/helpopt.hxx>
  22 #include <unotools/configmgr.hxx>
  23 #include <unotools/configitem.hxx>
  24 #include <tools/debug.hxx>
  25 #include <com/sun/star/uno/Any.hxx>
  26 #include <com/sun/star/uno/Sequence.hxx>
  27 #include <vcl/help.hxx>
  28 #include <osl/mutex.hxx>
  29 #include <comphelper/stl_types.hxx>
  30
  31 #include "itemholder2.hxx"
  32
  33 using namespace utl;
  34 using namespace com::sun::star::uno;
  35 using namespace com::sun::star;
  36
  37
  38 static SvtHelpOptions_Impl* pOptions = NULL;
  39 static sal_Int32           nRefCount = 0;
  40
  41 #define EXTENDEDHELP        0
  42 #define HELPTIPS            1
  43 #define LOCALE              2
  44 #define SYSTEM              3
  45 #define STYLESHEET          4
  46
  47 class SvtHelpOptions_Impl : public utl::ConfigItem
  48 {
  49     sal_Bool        bExtendedHelp;
  50     sal_Bool        bHelpTips;
  51     sal_Bool        bWelcomeScreen;
  52     OUString        aLocale;
  53     OUString        aSystem;
  54     OUString        sHelpStyleSheet;
  55
  56     DECLARE_STL_USTRINGACCESS_MAP( sal_Int32, MapString2Int );
  57     MapString2Int   aURLIgnoreCounters;
  58     ::osl::Mutex    aIgnoreCounterSafety;
  59
  60     Sequence< OUString > GetPropertyNames();
  61
  62 public:
  63                     SvtHelpOptions_Impl();
  64
  65     virtual void    Notify( const com::sun::star::uno::Sequence< OUString >& aPropertyNames );
  66     void            Load( const ::com::sun::star::uno::Sequence< OUString>& aPropertyNames);
  67     virtual void    Commit();
  68
  69     void            SetExtendedHelp( sal_Bool b )           { bExtendedHelp= b; SetModified(); }
  70     sal_Bool        IsExtendedHelp() const                  { return bExtendedHelp; }
  71     void            SetHelpTips( sal_Bool b )               { bHelpTips = b; SetModified(); }
  72     sal_Bool        IsHelpTips() const                      { return bHelpTips; }
  73
  74     void            SetWelcomeScreen( sal_Bool b )          { bWelcomeScreen = b; SetModified(); }
  75     sal_Bool        IsWelcomeScreen() const                 { return bWelcomeScreen; }
  76     OUString        GetLocale() const                       { return aLocale; }
  77     OUString        GetSystem() const                       { return aSystem; }
  78
  79     const OUString& GetHelpStyleSheet()const{return sHelpStyleSheet;}
  80     void            SetHelpStyleSheet(const OUString& rStyleSheet){sHelpStyleSheet = rStyleSheet; SetModified();}
  81
  82     static ::osl::Mutex & getInitMutex();
  83 };
  84
  85 Sequence< OUString > SvtHelpOptions_Impl::GetPropertyNames()
  86 {
  87     static const char* aPropNames[] =
  88     {
  89         "ExtendedTip",
  90         "Tip",
  91         "Locale",
  92         "System",
  93         "HelpStyleSheet"
  94     };
  95
  96     const int nCount = sizeof( aPropNames ) / sizeof( const char* );
  97     Sequence< OUString > aNames( nCount );
  98     OUString* pNames = aNames.getArray();
  99     for ( int i = 0; i < nCount; i++ )
 100         pNames[i] = OUString::createFromAscii( aPropNames[i] );
 101
 102     return aNames;
 103 }
 104
 105 ::osl::Mutex & SvtHelpOptions_Impl::getInitMutex()
 106 {
 107     static ::osl::Mutex *pMutex = 0;
 108
 109     if( ! pMutex )
 110     {
 111         ::osl::MutexGuard guard( ::osl::Mutex::getGlobalMutex() );
 112         if( ! pMutex )
 113         {
 114             static ::osl::Mutex mutex;
 115             pMutex = &mutex;
 116         }
 117     }
 118     return *pMutex;
 119 }
 120
 121
 122 // -----------------------------------------------------------------------
 123
 124 SvtHelpOptions_Impl::SvtHelpOptions_Impl()
 125     : ConfigItem( OUString( "Office.Common/Help" ) )
 126     , bExtendedHelp( sal_False )
 127     , bHelpTips( sal_True )
 128     , bWelcomeScreen( sal_False )
 129 {
 130     Sequence< OUString > aNames = GetPropertyNames();
 131     Load( aNames );
 132     EnableNotification( aNames );
 133 }
 134
 135 // -----------------------------------------------------------------------
 136 static int lcl_MapPropertyName( const OUString rCompare,
 137                 const uno::Sequence< OUString>& aInternalPropertyNames)
 138 {
 139     for(int nProp = 0; nProp < aInternalPropertyNames.getLength(); ++nProp)
 140     {
 141         if( aInternalPropertyNames[nProp] == rCompare )
 142             return nProp;
 143     }
 144     return -1;
 145 }
 146
 147 void  SvtHelpOptions_Impl::Load(const uno::Sequence< OUString>& rPropertyNames)
 148 {
 149     const uno::Sequence< OUString> aInternalPropertyNames( GetPropertyNames());
 150     Sequence< Any > aValues = GetProperties( rPropertyNames );
 151     const Any* pValues = aValues.getConstArray();
 152     DBG_ASSERT( aValues.getLength() == rPropertyNames.getLength(), "GetProperties failed" );
 153     if ( aValues.getLength() == rPropertyNames.getLength() )
 154     {
 155         for ( int nProp = 0; nProp < rPropertyNames.getLength(); nProp++ )
 156         {
 157 #if OSL_DEBUG_LEVEL > 1
 158             DBG_ASSERT( pValues[nProp].hasValue(), "property value missing" );
 159 #endif
 160             if ( pValues[nProp].hasValue() )
 161             {
 162                 sal_Bool bTmp = sal_Bool();
 163                 OUString aTmpStr;
 164                 sal_Int32 nTmpInt = 0;
 165                 if ( pValues[nProp] >>= bTmp )
 166                 {
 167                     switch ( lcl_MapPropertyName(rPropertyNames[nProp], aInternalPropertyNames) )
 168                     {
 169                         case EXTENDEDHELP :
 170                             bExtendedHelp = bTmp;
 171                             break;
 172                         case HELPTIPS :
 173                             bHelpTips = bTmp;
 174                             break;
 175                         default:
 176                             SAL_WARN( "svtools.config", "Wrong Member!" );
 177                             break;
 178                     }
 179                 }
 180                 else if ( pValues[nProp] >>= aTmpStr )
 181                 {
 182                     switch ( nProp )
 183                     {
 184                         case LOCALE:
 185                             aLocale = aTmpStr;
 186                             break;
 187
 188                         case SYSTEM:
 189                             aSystem = aTmpStr;
 190                             break;
 191                         case STYLESHEET :
 192                             sHelpStyleSheet = aTmpStr;
 193                         break;
 194                         default:
 195                             SAL_WARN( "svtools.config", "Wrong Member!" );
 196                             break;
 197                     }
 198                 }
 199                 else if ( pValues[nProp] >>= nTmpInt )
 200                 {
 201                     SAL_WARN( "svtools.config", "Wrong Member!" );
 202                 }
 203                 else
 204                 {
 205                     SAL_WARN( "svtools.config", "Wrong Type!" );
 206                 }
 207             }
 208         }
 209         if ( IsHelpTips() != Help::IsQuickHelpEnabled() )
 210             IsHelpTips() ? Help::EnableQuickHelp() : Help::DisableQuickHelp();
 211         if ( IsExtendedHelp() != Help::IsBalloonHelpEnabled() )
 212             IsExtendedHelp() ? Help::EnableBalloonHelp() : Help::DisableBalloonHelp();
 213     }
 214 }
 215
 216 // -----------------------------------------------------------------------
 217
 218 void SvtHelpOptions_Impl::Commit()
 219 {
 220     Sequence< OUString > aNames = GetPropertyNames();
 221     Sequence< Any > aValues( aNames.getLength() );
 222     Any* pValues = aValues.getArray();
 223     for ( int nProp = 0; nProp < aNames.getLength(); nProp++ )
 224     {
 225         switch ( nProp )
 226         {
 227             case EXTENDEDHELP :
 228                 pValues[nProp] <<= bExtendedHelp;
 229                 break;
 230
 231             case HELPTIPS :
 232                 pValues[nProp] <<= bHelpTips;
 233                 break;
 234
 235             case LOCALE:
 236                 pValues[nProp] <<= OUString(aLocale);
 237                 break;
 238
 239             case SYSTEM:
 240                 pValues[nProp] <<= OUString(aSystem);
 241                 break;
 242             case STYLESHEET :
 243                 pValues[nProp] <<= OUString(sHelpStyleSheet);
 244             break;
 245
 246         }
 247     }
 248
 249     PutProperties( aNames, aValues );
 250 }
 251
 252 // -----------------------------------------------------------------------
 253
 254 void SvtHelpOptions_Impl::Notify( const Sequence<OUString>& aPropertyNames )
 255 {
 256     Load( aPropertyNames );
 257 }
 258
 259 SvtHelpOptions::SvtHelpOptions()
 260 {
 261     // Global access, must be guarded (multithreading)
 262     ::osl::MutexGuard aGuard( SvtHelpOptions_Impl::getInitMutex() );
 263     ++nRefCount;
 264     if ( !pOptions )
 265     {
 266         pOptions = new SvtHelpOptions_Impl;
 267
 268         svtools::ItemHolder2::holdConfigItem(E_HELPOPTIONS);
 269     }
 270     pImp = pOptions;
 271 }
 272
 273 // -----------------------------------------------------------------------
 274
 275 SvtHelpOptions::~SvtHelpOptions()
 276 {
 277     // Global access, must be guarded (multithreading)
 278     ::osl::MutexGuard aGuard( SvtHelpOptions_Impl::getInitMutex() );
 279     if ( !--nRefCount )
 280     {
 281         if ( pOptions->IsModified() )
 282             pOptions->Commit();
 283         DELETEZ( pOptions );
 284     }
 285 }
 286
 287 void SvtHelpOptions::SetExtendedHelp( sal_Bool b )
 288 {
 289     pImp->SetExtendedHelp( b );
 290 }
 291
 292 sal_Bool SvtHelpOptions::IsExtendedHelp() const
 293 {
 294     return pImp->IsExtendedHelp();
 295 }
 296
 297 void SvtHelpOptions::SetHelpTips( sal_Bool b )
 298 {
 299     pImp->SetHelpTips( b );
 300 }
 301
 302 sal_Bool SvtHelpOptions::IsHelpTips() const
 303 {
 304     return pImp->IsHelpTips();
 305 }
 306
 307 // -----------------------------------------------------------------------
 308
 309 void SvtHelpOptions::SetWelcomeScreen( sal_Bool b )
 310 {
 311     pImp->SetWelcomeScreen( b );
 312 }
 313
 314 sal_Bool SvtHelpOptions::IsWelcomeScreen() const
 315 {
 316     return pImp->IsWelcomeScreen();
 317 }
 318
 319 OUString SvtHelpOptions::GetSystem() const
 320 {
 321     return pImp->GetSystem();
 322 }
 323
 324 const OUString&   SvtHelpOptions::GetHelpStyleSheet()const
 325 {
 326     return pImp->GetHelpStyleSheet();
 327 }
 328
 329 void  SvtHelpOptions::SetHelpStyleSheet(const OUString& rStyleSheet)
 330 {
 331     pImp->SetHelpStyleSheet(rStyleSheet);
 332 }
 333
 334 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */