framework/source/inc/accelerators/acceleratorconfiguration.hxx

   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 #ifndef INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
  21 #define INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
  22
  23 #include <accelerators/istoragelistener.hxx>
  24 #include <accelerators/presethandler.hxx>
  25 #include <accelerators/acceleratorcache.hxx>
  26 #include <accelerators/keymapping.hxx>
  27 #include <macros/xinterface.hxx>
  28 #include <macros/xtypeprovider.hxx>
  29 #include <general.h>
  30 #include <stdtypes.h>
  31
  32 #include <com/sun/star/container/XNameAccess.hpp>
  33 #include <com/sun/star/lang/XTypeProvider.hpp>
  34 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  35 #include <com/sun/star/ui/XAcceleratorConfiguration.hpp>
  36 #include <com/sun/star/ui/XUIConfiguration.hpp>
  37 #include <com/sun/star/ui/XUIConfigurationPersistence.hpp>
  38
  39 #include <com/sun/star/ui/XUIConfigurationStorage.hpp>
  40 #include <com/sun/star/io/XStream.hpp>
  41 #include <com/sun/star/io/XInputStream.hpp>
  42 #include <com/sun/star/io/XOutputStream.hpp>
  43 #include <com/sun/star/util/XChangesListener.hpp>
  44
  45 // TODO use XPresetHandler interface instead if available
  46 #include <com/sun/star/form/XReset.hpp>
  47
  48 #include <cppuhelper/propshlp.hxx>
  49 #include <cppuhelper/implbase2.hxx>
  50 #include <cppuhelper/implbase4.hxx>
  51 #include <salhelper/singletonref.hxx>
  52
  53 // definition
  54
  55 namespace framework
  56 {
  57
  58 const char CFG_ENTRY_PRIMARY[] = "PrimaryKeys";
  59 const char CFG_ENTRY_GLOBAL[] = "Global";
  60 const char CFG_ENTRY_MODULES[] = "Modules";
  61
  62 /**
  63     implements a read/write access to the accelerator configuration.
  64  */
  65 class XMLBasedAcceleratorConfiguration : public    IStorageListener,
  66                                          public    ::cppu::WeakImplHelper2<
  67                                                        css::form::XReset,                    // TODO use XPresetHandler instead if available
  68                                                        css::ui::XAcceleratorConfiguration >  // => css::ui::XUIConfigurationPersistence
  69                                                                                              //    css::ui::XUIConfigurationStorage
  70                                                                                              //    css::ui::XUIConfiguration
  71 {
  72
  73     // member
  74
  75     protected:
  76
  77         /** the global uno service manager.
  78         Must be used to create own needed services. */
  79         css::uno::Reference< css::uno::XComponentContext > m_xContext;
  80
  81         /** used to:
  82         i  ) copy configuration files from the share to the user layer
  83         ii ) provide access to these config files
  84         iii) cache all sub storages on the path from the top to the bottom(!)
  85         iv ) provide commit for changes. */
  86         PresetHandler m_aPresetHandler;
  87
  88         /** contains the cached configuration data */
  89         AcceleratorCache m_aReadCache;
  90
  91         /** used to implement the copy on write pattern! */
  92         AcceleratorCache* m_pWriteCache;
  93
  94         // native interface!
  95
  96     public:
  97
  98         XMLBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext);
  99         virtual ~XMLBasedAcceleratorConfiguration(                                                                    );
 100
 101         // uno interface!
 102
 103     public:
 104
 105         // XAcceleratorConfiguration
 106         virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents()
 107             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 108
 109         virtual OUString SAL_CALL getCommandByKeyEvent(const css::awt::KeyEvent& aKeyEvent)
 110             throw(css::container::NoSuchElementException,
 111             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 112
 113         virtual void SAL_CALL setKeyEvent(const css::awt::KeyEvent& aKeyEvent,
 114             const OUString&    sCommand )
 115             throw(css::lang::IllegalArgumentException,
 116             css::uno::RuntimeException, std::exception         ) SAL_OVERRIDE;
 117
 118         virtual void SAL_CALL removeKeyEvent(const css::awt::KeyEvent& aKeyEvent)
 119             throw(css::container::NoSuchElementException,
 120             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 121
 122         virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand(const OUString& sCommand)
 123             throw(css::lang::IllegalArgumentException   ,
 124             css::container::NoSuchElementException,
 125             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 126
 127         virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList(const css::uno::Sequence< OUString >& lCommandList)
 128             throw (css::lang::IllegalArgumentException, css::container::NoSuchElementException,
 129                    css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 130
 131         virtual void SAL_CALL removeCommandFromAllKeyEvents(const OUString& sCommand)
 132             throw(css::lang::IllegalArgumentException   ,
 133             css::container::NoSuchElementException,
 134             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 135
 136         // XUIConfigurationPersistence
 137         virtual void SAL_CALL reload()
 138             throw(css::uno::Exception       ,
 139             css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 140
 141         virtual void SAL_CALL store()
 142             throw(css::uno::Exception       ,
 143             css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 144
 145         virtual void SAL_CALL storeToStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
 146             throw(css::uno::Exception       ,
 147             css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 148
 149         virtual sal_Bool SAL_CALL isModified()
 150             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 151
 152         virtual sal_Bool SAL_CALL isReadOnly()
 153             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 154
 155         // XUIConfigurationStorage
 156         virtual void SAL_CALL setStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
 157             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 158
 159         virtual sal_Bool SAL_CALL hasStorage()
 160             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 161
 162         // XUIConfiguration
 163         virtual void SAL_CALL addConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
 164             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 165
 166         virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
 167             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 168
 169         // XReset
 170         // TODO use XPresetHandler instead if available
 171         virtual void SAL_CALL reset()
 172             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 173
 174         virtual void SAL_CALL addResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
 175             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 176
 177         virtual void SAL_CALL removeResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
 178             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 179
 180         // IStorageListener
 181         virtual void changesOccurred(const OUString& sPath) SAL_OVERRIDE;
 182
 183         // helper for derived classes
 184
 185     protected:
 186
 187         /** @short  return the current office locale.
 188
 189         @descr  We do not cache this value, because we are not listen
 190         for changes on the configuration layer ...
 191
 192         @return OUString
 193         The current office locale as BCP47 string.
 194         */
 195         OUString impl_ts_getLocale() const;
 196
 197         // helper
 198
 199     private:
 200
 201         /** @short  load a configuration set, using the given stream.
 202
 203         @param  xStream
 204         provides the XML structure as stream.
 205         */
 206         void impl_ts_load(const css::uno::Reference< css::io::XInputStream >& xStream);
 207
 208         /** @short  save a configuration set, using the given stream.
 209
 210         @param  xStream
 211         the XML structure can be written there.
 212         */
 213         void impl_ts_save(const css::uno::Reference< css::io::XOutputStream >& xStream);
 214
 215         /** @short  try to locate and open a sub storage.
 216
 217         @descr  It search at the root storage for the specified
 218         sub storage. If it exists - it will be opened.
 219         By default this method tries to open the storage
 220         for reading. But the calli can request a writeable
 221         storage.
 222
 223         @param  xRooStorage
 224         used to locate the sub storage.
 225
 226         @param  sSubStorage
 227         relativ path of the sub storage.
 228
 229         @param  bOutStream
 230         force open of the sub storage in
 231         write mode - instead of read mode, which
 232         is the default.
 233
 234         @return [XInterface]
 235         will be a css::io::XInpoutStream or a css::io::XOutputStream.
 236         Depends from the parameter bWriteable!
 237         */
 238         css::uno::Reference< css::uno::XInterface > impl_ts_openSubStorage(const css::uno::Reference< css::embed::XStorage >& xRootStorage,
 239             const OUString&                             sSubStorage ,
 240             bool                                        bOutStream  );
 241
 242         /** @short  returns a reference to one of our internal cache members.
 243
 244         @descr  We implement the copy-on-write pattern. Doing so
 245         we know two caches internally. The second one is used
 246         only, if the container was changed.
 247
 248         This method here returns access to one of these
 249         caches - depending on the change state of this
 250         configuration service.
 251
 252         @param  bWriteAccessRequested
 253         if the outside code wish to change the container
 254         it must call this method with "sal_True". So the internal
 255         cache can be prepared for that (means copy-on-write ...).
 256
 257         @return [AcceleratorCache]
 258         c++ reference(!) to one of our internal caches.
 259         */
 260         AcceleratorCache& impl_getCFG(bool bWriteAccessRequested = false);
 261
 262 };
 263
 264 class XCUBasedAcceleratorConfiguration : public  ::cppu::WeakImplHelper4<
 265                                                      css::util::XChangesListener,
 266                                                      css::lang::XComponent,
 267                                                      css::form::XReset,                    // TODO use XPresetHandler instead if available
 268                                                      css::ui::XAcceleratorConfiguration >  // => css::ui::XUIConfigurationPersistence
 269                                                                                            //    css::ui::XUIConfigurationStorage
 270                                                                                            //    css::ui::XUIConfiguration
 271 {
 272
 273     // member
 274
 275     protected:
 276
 277         /** the global uno service manager.
 278         Must be used to create own needed services. */
 279         css::uno::Reference< css::uno::XComponentContext > m_xContext;
 280
 281         css::uno::Reference< css::container::XNameAccess > m_xCfg;
 282         AcceleratorCache m_aPrimaryReadCache;
 283         AcceleratorCache m_aSecondaryReadCache;
 284         AcceleratorCache* m_pPrimaryWriteCache;
 285         AcceleratorCache* m_pSecondaryWriteCache;
 286
 287         OUString m_sGlobalOrModules;
 288         OUString m_sModuleCFG;
 289
 290         ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping;
 291
 292         // native interface!
 293
 294     public:
 295
 296         XCUBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext );
 297         virtual ~XCUBasedAcceleratorConfiguration(                                                           );
 298
 299         // uno interface!
 300
 301     public:
 302
 303         // XAcceleratorConfiguration
 304         virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents()
 305             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 306
 307         virtual OUString SAL_CALL getCommandByKeyEvent(const css::awt::KeyEvent& aKeyEvent)
 308             throw(css::container::NoSuchElementException,
 309             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 310
 311         virtual void SAL_CALL setKeyEvent(const css::awt::KeyEvent& aKeyEvent,
 312             const OUString&    sCommand )
 313             throw (css::lang::IllegalArgumentException, css::container::NoSuchElementException,
 314                    css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 315
 316         virtual void SAL_CALL removeKeyEvent(const css::awt::KeyEvent& aKeyEvent)
 317             throw(css::container::NoSuchElementException,
 318             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 319
 320         virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand(const OUString& sCommand)
 321             throw(css::lang::IllegalArgumentException   ,
 322             css::container::NoSuchElementException,
 323             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 324
 325         virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList(const css::uno::Sequence< OUString >& lCommandList)
 326             throw(css::lang::IllegalArgumentException, css::container::NoSuchElementException,
 327                   css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 328
 329         virtual void SAL_CALL removeCommandFromAllKeyEvents(const OUString& sCommand)
 330             throw(css::lang::IllegalArgumentException   ,
 331             css::container::NoSuchElementException,
 332             css::uno::RuntimeException, std::exception            ) SAL_OVERRIDE;
 333
 334         // XUIConfigurationPersistence
 335         virtual void SAL_CALL reload()
 336             throw(css::uno::Exception       ,
 337             css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 338
 339         virtual void SAL_CALL store()
 340             throw(css::uno::Exception       ,
 341             css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 342
 343         virtual void SAL_CALL storeToStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
 344             throw(css::uno::Exception       ,
 345             css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 346
 347         virtual sal_Bool SAL_CALL isModified()
 348             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 349
 350         virtual sal_Bool SAL_CALL isReadOnly()
 351             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 352
 353         // XUIConfigurationStorage
 354         virtual void SAL_CALL setStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
 355             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 356
 357         virtual sal_Bool SAL_CALL hasStorage()
 358             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 359
 360         // XUIConfiguration
 361         virtual void SAL_CALL addConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
 362             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 363
 364         virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
 365             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 366
 367         // XReset
 368         // TODO use XPresetHandler instead if available
 369         virtual void SAL_CALL reset()
 370             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 371
 372         virtual void SAL_CALL addResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
 373             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 374
 375         virtual void SAL_CALL removeResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
 376             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 377
 378         // css.util.XChangesListener
 379         virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent)
 380             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 381
 382         // css.lang.XEventListener
 383         virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
 384             throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 385
 386         // XComponent
 387         virtual  void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 388         virtual  void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 389         virtual  void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 390
 391         // helper for derived classes
 392
 393     protected:
 394
 395         /** @short  return the current office locale.
 396
 397         @descr  We do not cache this value, because we are not listen
 398         for changes on the configuration layer ...
 399
 400         @return OUString
 401         The current office locale as BCP47 string.
 402         */
 403         OUString impl_ts_getLocale() const;
 404
 405         // helper
 406
 407     private:
 408
 409         void impl_ts_load(bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
 410         void impl_ts_save(bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
 411
 412         void insertKeyToConfiguration(const css::awt::KeyEvent& aKeyEvent, const OUString& sCommand, const bool bPreferred);
 413         void removeKeyFromConfiguration(const css::awt::KeyEvent& aKeyEvent, const bool bPreferred);
 414
 415         void reloadChanged(const OUString& sPrimarySecondary, const OUString& sGlobalModules, const OUString& sModule, const OUString& sKey);
 416         AcceleratorCache& impl_getCFG(bool bPreferred, bool bWriteAccessRequested = false);
 417
 418 };
 419
 420 } // namespace framework
 421
 422 #endif // INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
 423
 424 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */