svtools/source/config/accelcfg.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: accelcfg.cxx,v $
  10  * $Revision: 1.9 $
  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 #ifndef GCC
  34 #endif
  35 #include "rtl/instance.hxx"
  36 #include <com/sun/star/uno/Any.hxx>
  37 #include <com/sun/star/uno/Sequence.hxx>
  38 #include <com/sun/star/io/XActiveDataSource.hpp>
  39 #include <com/sun/star/io/XInputStream.hpp>
  40 #include <com/sun/star/io/XOutputStream.hpp>
  41 #include <com/sun/star/xml/sax/XParser.hpp>
  42 #include <unotools/configmgr.hxx>
  43 #include <unotools/configitem.hxx>
  44 #include <tools/debug.hxx>
  45
  46 #include <osl/mutex.hxx>
  47 #include <tools/string.hxx>
  48 #include <tools/urlobj.hxx>
  49 #include <unotools/streamwrap.hxx>
  50 #include <unotools/ucbstreamhelper.hxx>
  51 #include <comphelper/processfactory.hxx>
  52
  53 #include <svtools/accelcfg.hxx>
  54 #include "xmlaccelcfg.hxx"
  55 #include <svtools/pathoptions.hxx>
  56 #include "itemholder1.hxx"
  57
  58
  59 using namespace utl;
  60 using namespace rtl;
  61 using namespace com::sun::star::uno;
  62 using namespace com::sun::star::io;
  63 using namespace com::sun::star::xml::sax;
  64
  65
  66 static SvtAcceleratorConfig_Impl* pOptions = NULL;
  67 static sal_Int32           nRefCount = 0;
  68
  69 class SvtAcceleratorConfig_Impl
  70 {
  71 public:
  72
  73     SvtAcceleratorItemList aList;
  74     bool                        bModified;
  75
  76                     SvtAcceleratorConfig_Impl()
  77                         : bModified( FALSE )
  78                     {}
  79
  80                     SvtAcceleratorConfig_Impl( Reference< XInputStream >& xInputStream );
  81     bool                        Commit( Reference< XOutputStream >& xOutputStream );
  82 };
  83
  84 // -----------------------------------------------------------------------
  85
  86 SvtAcceleratorConfig_Impl::SvtAcceleratorConfig_Impl( Reference< XInputStream >& rInputStream )
  87         : bModified( false )
  88 {
  89     Reference< XParser > xParser( ::comphelper::getProcessServiceFactory()->createInstance(
  90                                     ::rtl::OUString::createFromAscii( "com.sun.star.xml.sax.Parser" )),
  91                                   UNO_QUERY);
  92
  93     // connect stream to input stream to the parser
  94     InputSource aInputSource;
  95     aInputSource.aInputStream = rInputStream;
  96
  97     // get filter
  98     Reference< XDocumentHandler > xFilter( new OReadAccelatorDocumentHandler( aList ));
  99
 100     // connect parser and filter
 101     xParser->setDocumentHandler( xFilter );
 102     xParser->parseStream( aInputSource );
 103 }
 104
 105 bool SvtAcceleratorConfig_Impl::Commit( Reference< XOutputStream >& rOutputStream )
 106 {
 107     Reference< XDocumentHandler > xWriter;
 108
 109     xWriter = Reference< XDocumentHandler >( ::comphelper::getProcessServiceFactory()->createInstance(
 110             ::rtl::OUString::createFromAscii( "com.sun.star.xml.sax.Writer" )), UNO_QUERY) ;
 111
 112     Reference< ::com::sun::star::io::XActiveDataSource> xDataSource( xWriter , UNO_QUERY );
 113     xDataSource->setOutputStream( rOutputStream );
 114     try
 115     {
 116         OWriteAccelatorDocumentHandler aWriteHandler( aList, xWriter );
 117         aWriteHandler.WriteAcceleratorDocument();
 118         rOutputStream->flush();
 119         return true;
 120     }
 121     catch ( RuntimeException& )
 122     {
 123     }
 124     catch ( SAXException& )
 125     {
 126     }
 127     catch ( ::com::sun::star::io::IOException& )
 128     {
 129     }
 130
 131     return false;
 132 }
 133
 134 namespace
 135 {
 136     class LocalSingleton : public rtl::Static< osl::Mutex, LocalSingleton >
 137     {
 138     };
 139 }
 140
 141 SvtAcceleratorConfiguration::SvtAcceleratorConfiguration()
 142 {
 143     // Global access, must be guarded (multithreading)
 144     ::osl::MutexGuard aGuard( LocalSingleton::get() );
 145     if ( !pOptions )
 146     {
 147         SvStream* pStream = GetDefaultStream( STREAM_STD_READ );
 148         ::utl::OInputStreamWrapper aHelper( *pStream );
 149         com::sun::star::uno::Reference < ::com::sun::star::io::XInputStream > xOut( &aHelper );
 150
 151         try
 152         {
 153             pOptions = new SvtAcceleratorConfig_Impl( xOut );
 154         }
 155         catch ( RuntimeException& )
 156         {
 157             pOptions = new SvtAcceleratorConfig_Impl();
 158         }
 159         catch( SAXException& )
 160         {
 161             pOptions = new SvtAcceleratorConfig_Impl();
 162         }
 163         catch( ::com::sun::star::io::IOException& )
 164         {
 165             pOptions = new SvtAcceleratorConfig_Impl();
 166         }
 167
 168         if (pOptions)
 169             ItemHolder1::holdConfigItem(E_ACCELCFG);
 170
 171         delete pStream;
 172     }
 173
 174     ++nRefCount;
 175     pImp = pOptions;
 176 }
 177
 178 SvtAcceleratorConfiguration* SvtAcceleratorConfiguration::CreateFromStream( SvStream& rStream )
 179 {
 180     SvtAcceleratorConfiguration* pRet = new SvtAcceleratorConfiguration;
 181     ::utl::OInputStreamWrapper aHelper( rStream );
 182     com::sun::star::uno::Reference < ::com::sun::star::io::XInputStream > xOut( &aHelper );
 183     try
 184     {
 185         pRet->pImp = new SvtAcceleratorConfig_Impl( xOut );
 186     }
 187     catch ( RuntimeException& )
 188     {
 189         DELETEZ( pRet );
 190     }
 191     catch( SAXException& )
 192     {
 193         DELETEZ( pRet );
 194     }
 195     catch( ::com::sun::star::io::IOException& )
 196     {
 197         DELETEZ( pRet );
 198     }
 199
 200     return pRet;
 201 }
 202
 203 // -----------------------------------------------------------------------
 204
 205 SvtAcceleratorConfiguration::~SvtAcceleratorConfiguration()
 206 {
 207     if ( pImp == pOptions )
 208     {
 209         // Global access, must be guarded (multithreading)
 210         ::osl::MutexGuard aGuard( LocalSingleton::get() );
 211         if ( !--nRefCount )
 212         {
 213             if ( pImp->bModified )
 214             {
 215                 String aUserConfig = SvtPathOptions().GetUserConfigPath();
 216                 INetURLObject aObj( aUserConfig );
 217                 aObj.insertName( String::CreateFromAscii("GlobalKeyBindings.xml") );
 218                 SvStream* pStream = ::utl::UcbStreamHelper::CreateStream( aObj.GetMainURL( INetURLObject::NO_DECODE ), STREAM_STD_READWRITE|STREAM_TRUNC );
 219                 ::utl::OOutputStreamWrapper aHelper( *pStream );
 220                 com::sun::star::uno::Reference < ::com::sun::star::io::XOutputStream > xOut( &aHelper );
 221                 pImp->Commit( xOut );
 222                 delete pStream;
 223             }
 224
 225             DELETEZ( pOptions );
 226         }
 227     }
 228     else
 229     {
 230         delete pImp;
 231     }
 232 }
 233
 234 ::rtl::OUString SvtAcceleratorConfiguration::GetCommand( const ::com::sun::star::awt::KeyEvent& rKeyEvent )
 235 {
 236     sal_Int16 nCode=rKeyEvent.KeyCode, nModifier=rKeyEvent.Modifiers;
 237     if ( !nCode )
 238         nCode = rKeyEvent.KeyFunc;
 239
 240     std::list< SvtAcceleratorConfigItem>::const_iterator p;
 241     for ( p = pImp->aList.begin(); p != pImp->aList.end(); p++ )
 242         if ( p->nCode == nCode && p->nModifier == nModifier )
 243             return p->aCommand;
 244
 245     return ::rtl::OUString();
 246 }
 247
 248 const SvtAcceleratorItemList& SvtAcceleratorConfiguration::GetItems()
 249 {
 250     return pImp->aList;
 251 }
 252
 253 void SvtAcceleratorConfiguration::SetCommand( const SvtAcceleratorConfigItem& rItem )
 254 {
 255     std::list< SvtAcceleratorConfigItem>::iterator p;
 256     for ( p = pImp->aList.begin(); p != pImp->aList.end(); p++ )
 257         if ( p->nCode == rItem.nCode && p->nModifier == rItem.nModifier )
 258         {
 259             p->aCommand = rItem.aCommand;
 260             return;
 261         }
 262
 263     pImp->aList.push_back( rItem );
 264
 265 }
 266
 267 void SvtAcceleratorConfiguration::SetItems( const SvtAcceleratorItemList& rItems, bool bClear )
 268 {
 269     if ( bClear )
 270     {
 271         pImp->aList = rItems;
 272     }
 273     else
 274     {
 275         std::list< SvtAcceleratorConfigItem>::const_iterator p;
 276         for ( p = rItems.begin(); p != rItems.end(); p++ )
 277             SetCommand( *p );
 278     }
 279 }
 280
 281 String SvtAcceleratorConfiguration::GetStreamName()
 282 {
 283     return String::CreateFromAscii("KeyBindings.xml");
 284 }
 285
 286 SvStream* SvtAcceleratorConfiguration::GetDefaultStream( StreamMode nMode )
 287 {
 288     String aUserConfig = SvtPathOptions().GetUserConfigPath();
 289     INetURLObject aObj( aUserConfig );
 290     aObj.insertName( GetStreamName() );
 291     return ::utl::UcbStreamHelper::CreateStream( aObj.GetMainURL( INetURLObject::NO_DECODE ), nMode );
 292 }