unotools/source/config/cmdoptions.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 <sal/config.h>
  21
  22 #include <sal/log.hxx>
  23 #include <unotools/cmdoptions.hxx>
  24 #include <unotools/configitem.hxx>
  25 #include <tools/debug.hxx>
  26 #include <com/sun/star/uno/Any.hxx>
  27 #include <com/sun/star/uno/Sequence.hxx>
  28 #include <com/sun/star/frame/XFrame.hpp>
  29 #include <cppuhelper/weakref.hxx>
  30 #include <rtl/instance.hxx>
  31
  32 #include "itemholder1.hxx"
  33
  34 #include <algorithm>
  35 #include <unordered_map>
  36
  37 using namespace ::std;
  38 using namespace ::utl;
  39 using namespace ::osl;
  40 using namespace ::com::sun::star::uno;
  41 using namespace ::com::sun::star::beans;
  42
  43 #define ROOTNODE_CMDOPTIONS                             "Office.Commands/Execute"
  44 #define PATHDELIMITER                                   "/"
  45
  46 #define SETNODE_DISABLED                                "Disabled"
  47
  48 #define PROPERTYNAME_CMD                                "Command"
  49
  50 /*-****************************************************************************************************************
  51     @descr  support simple command option structures and operations on it
  52 ****************************************************************************************************************-*/
  53 class SvtCmdOptions
  54 {
  55     public:
  56
  57         // the only way to free memory!
  58         void Clear()
  59         {
  60             m_aCommandHashMap.clear();
  61         }
  62
  63         bool HasEntries() const
  64         {
  65             return ( !m_aCommandHashMap.empty() );
  66         }
  67
  68         bool Lookup( const OUString& aCmd ) const
  69         {
  70             CommandHashMap::const_iterator pEntry = m_aCommandHashMap.find( aCmd );
  71             return ( pEntry != m_aCommandHashMap.end() );
  72         }
  73
  74         void AddCommand( const OUString& aCmd )
  75         {
  76             m_aCommandHashMap.emplace( aCmd, 0 );
  77         }
  78
  79     private:
  80         typedef std::unordered_map<OUString, sal_Int32>
  81             CommandHashMap;
  82
  83         CommandHashMap m_aCommandHashMap;
  84 };
  85
  86 typedef ::std::vector< css::uno::WeakReference< css::frame::XFrame > > SvtFrameVector;
  87
  88 class SvtCommandOptions_Impl : public ConfigItem
  89 {
  90     public:
  91
  92          SvtCommandOptions_Impl();
  93         virtual ~SvtCommandOptions_Impl() override;
  94
  95         /*-****************************************************************************************************
  96             @short      called for notify of configmanager
  97             @descr      This method is called from the ConfigManager before the application ends or from the
  98                          PropertyChangeListener if the sub tree broadcasts changes. You must update your
  99                         internal values.
 100
 101             @seealso    baseclass ConfigItem
 102
 103             @param      "lPropertyNames" is the list of properties which should be updated.
 104         *//*-*****************************************************************************************************/
 105
 106         virtual void Notify( const Sequence< OUString >& lPropertyNames ) override;
 107
 108         /*-****************************************************************************************************
 109             @short      base implementation of public interface for "SvtDynamicMenuOptions"!
 110             @descr      These class is used as static member of "SvtDynamicMenuOptions" ...
 111                         => The code exist only for one time and isn't duplicated for every instance!
 112         *//*-*****************************************************************************************************/
 113
 114         bool                HasEntries  (   SvtCommandOptions::CmdOption    eOption     ) const;
 115         bool                Lookup      (   SvtCommandOptions::CmdOption    eCmdOption, const OUString& ) const;
 116         void EstablishFrameCallback(const css::uno::Reference< css::frame::XFrame >& xFrame);
 117
 118     private:
 119
 120         virtual void ImplCommit() override;
 121
 122         /*-****************************************************************************************************
 123             @short      return list of key names of our configuration management which represent our module tree
 124             @descr      This method returns the current list of key names! We need it to get needed values from our
 125                         configuration management and support dynamical menu item lists!
 126             @param      "nDisabledCount", returns count of menu entries for "new"
 127             @return     A list of configuration key names is returned.
 128         *//*-*****************************************************************************************************/
 129
 130         Sequence< OUString > impl_GetPropertyNames();
 131
 132     private:
 133         SvtCmdOptions  m_aDisabledCommands;
 134         SvtFrameVector m_lFrames;
 135 };
 136
 137 //  constructor
 138
 139 SvtCommandOptions_Impl::SvtCommandOptions_Impl()
 140     // Init baseclasses first
 141     :   ConfigItem( ROOTNODE_CMDOPTIONS )
 142     // Init member then...
 143 {
 144     // Get names and values of all accessible menu entries and fill internal structures.
 145     // See impl_GetPropertyNames() for further information.
 146     Sequence< OUString >    lNames              = impl_GetPropertyNames ();
 147     Sequence< Any >         lValues             = GetProperties         ( lNames         );
 148
 149     // Safe impossible cases.
 150     // We need values from ALL configuration keys.
 151     // Follow assignment use order of values in relation to our list of key names!
 152     DBG_ASSERT( !(lNames.getLength()!=lValues.getLength()), "SvtCommandOptions_Impl::SvtCommandOptions_Impl()\nI miss some values of configuration keys!\n" );
 153
 154     // Copy values from list in right order to our internal member.
 155     // Attention: List for names and values have an internal construction pattern!
 156     sal_Int32   nItem     = 0;
 157     OUString    sCmd;
 158
 159     // Get names/values for disabled commands.
 160     for( nItem=0; nItem < lNames.getLength(); ++nItem )
 161     {
 162         // Currently only one value
 163         lValues[nItem] >>= sCmd;
 164         m_aDisabledCommands.AddCommand( sCmd );
 165     }
 166
 167 /*TODO: Not used in the moment! see Notify() ...
 168     // Enable notification mechanism of our baseclass.
 169     // We need it to get information about changes outside these class on our used configuration keys! */
 170     Sequence<OUString> aNotifySeq { "Disabled" };
 171     EnableNotification( aNotifySeq, true );
 172 }
 173
 174 //  destructor
 175
 176 SvtCommandOptions_Impl::~SvtCommandOptions_Impl()
 177 {
 178     assert(!IsModified()); // should have been committed
 179 }
 180
 181 //  public method
 182
 183 void SvtCommandOptions_Impl::Notify( const Sequence< OUString >& )
 184 {
 185     MutexGuard aGuard( SvtCommandOptions::GetOwnStaticMutex() );
 186
 187     Sequence< OUString >    lNames   = impl_GetPropertyNames ();
 188     Sequence< Any >         lValues  = GetProperties         ( lNames         );
 189
 190     // Safe impossible cases.
 191     // We need values from ALL configuration keys.
 192     // Follow assignment use order of values in relation to our list of key names!
 193     DBG_ASSERT( !(lNames.getLength()!=lValues.getLength()), "SvtCommandOptions_Impl::Notify()\nI miss some values of configuration keys!\n" );
 194
 195     // Copy values from list in right order to our internal member.
 196     // Attention: List for names and values have an internal construction pattern!
 197     sal_Int32   nItem     = 0;
 198     OUString    sCmd;
 199
 200     m_aDisabledCommands.Clear();
 201
 202     // Get names/values for disabled commands.
 203     for( nItem=0; nItem < lNames.getLength(); ++nItem )
 204     {
 205         // Currently only one value
 206         lValues[nItem] >>= sCmd;
 207         m_aDisabledCommands.AddCommand( sCmd );
 208     }
 209
 210     // don't forget to update all existing frames and her might cached dispatch objects!
 211     // But look for already killed frames. We hold weak references instead of hard ones ...
 212     for (SvtFrameVector::iterator pIt  = m_lFrames.begin(); pIt != m_lFrames.end(); )
 213     {
 214         css::uno::Reference< css::frame::XFrame > xFrame(pIt->get(), css::uno::UNO_QUERY);
 215         if (xFrame.is())
 216         {
 217             xFrame->contextChanged();
 218             ++pIt;
 219         }
 220         else
 221             pIt = m_lFrames.erase(pIt);
 222     }
 223 }
 224
 225 //  public method
 226
 227 void SvtCommandOptions_Impl::ImplCommit()
 228 {
 229     SAL_WARN("unotools.config","SvtCommandOptions_Impl::ImplCommit(): Not implemented yet!");
 230 }
 231
 232 //  public method
 233
 234 bool SvtCommandOptions_Impl::HasEntries( SvtCommandOptions::CmdOption eOption ) const
 235 {
 236     if ( eOption == SvtCommandOptions::CMDOPTION_DISABLED )
 237         return m_aDisabledCommands.HasEntries();
 238     else
 239         return false;
 240 }
 241
 242 //  public method
 243
 244 bool SvtCommandOptions_Impl::Lookup( SvtCommandOptions::CmdOption eCmdOption, const OUString& aCommand ) const
 245 {
 246     switch( eCmdOption )
 247     {
 248         case SvtCommandOptions::CMDOPTION_DISABLED:
 249         {
 250             return m_aDisabledCommands.Lookup( aCommand );
 251         }
 252         default:
 253             SAL_WARN( "unotools.config", "SvtCommandOptions_Impl::Lookup() Unknown option type given!" );
 254     }
 255
 256     return false;
 257 }
 258
 259 //  public method
 260
 261 void SvtCommandOptions_Impl::EstablishFrameCallback(const css::uno::Reference< css::frame::XFrame >& xFrame)
 262 {
 263     // check if frame already exists inside list
 264     // ignore double registrations
 265     // every frame must be notified one times only!
 266     css::uno::WeakReference< css::frame::XFrame > xWeak(xFrame);
 267     SvtFrameVector::const_iterator pIt = ::std::find(m_lFrames.begin(), m_lFrames.end(), xWeak);
 268     if (pIt == m_lFrames.end())
 269         m_lFrames.push_back(xWeak);
 270 }
 271
 272 //  private method
 273
 274 Sequence< OUString > SvtCommandOptions_Impl::impl_GetPropertyNames()
 275 {
 276     // First get ALL names of current existing list items in configuration!
 277     Sequence< OUString > lDisabledItems      = GetNodeNames( SETNODE_DISABLED, utl::ConfigNameFormat::LocalPath );
 278
 279     // Expand all keys
 280     std::transform(lDisabledItems.begin(), lDisabledItems.end(), lDisabledItems.begin(),
 281         [](const OUString& rItem) -> OUString {
 282             return SETNODE_DISABLED PATHDELIMITER + rItem + PATHDELIMITER PROPERTYNAME_CMD; });
 283
 284     // Return result.
 285     return lDisabledItems;
 286 }
 287
 288 namespace {
 289
 290 std::weak_ptr<SvtCommandOptions_Impl> g_pCommandOptions;
 291
 292 }
 293
 294 SvtCommandOptions::SvtCommandOptions()
 295 {
 296     // Global access, must be guarded (multithreading!).
 297     MutexGuard aGuard( GetOwnStaticMutex() );
 298
 299     m_pImpl = g_pCommandOptions.lock();
 300     if( !m_pImpl )
 301     {
 302         m_pImpl = std::make_shared<SvtCommandOptions_Impl>();
 303         g_pCommandOptions = m_pImpl;
 304         ItemHolder1::holdConfigItem(EItem::CmdOptions);
 305     }
 306 }
 307
 308 SvtCommandOptions::~SvtCommandOptions()
 309 {
 310     // Global access, must be guarded (multithreading!)
 311     MutexGuard aGuard( GetOwnStaticMutex() );
 312
 313     m_pImpl.reset();
 314 }
 315
 316 //  public method
 317
 318 bool SvtCommandOptions::HasEntries( CmdOption eOption ) const
 319 {
 320     MutexGuard aGuard( GetOwnStaticMutex() );
 321     return m_pImpl->HasEntries( eOption );
 322 }
 323
 324 //  public method
 325
 326 bool SvtCommandOptions::Lookup( CmdOption eCmdOption, const OUString& aCommandURL ) const
 327 {
 328     MutexGuard aGuard( GetOwnStaticMutex() );
 329     return m_pImpl->Lookup( eCmdOption, aCommandURL );
 330 }
 331
 332 //  public method
 333
 334 void SvtCommandOptions::EstablishFrameCallback(const css::uno::Reference< css::frame::XFrame >& xFrame)
 335 {
 336     MutexGuard aGuard( GetOwnStaticMutex() );
 337     m_pImpl->EstablishFrameCallback(xFrame);
 338 }
 339
 340 namespace
 341 {
 342     class theCommandOptionsMutex : public rtl::Static<osl::Mutex, theCommandOptionsMutex>{};
 343 }
 344
 345 //  private method
 346
 347 Mutex& SvtCommandOptions::GetOwnStaticMutex()
 348 {
 349     return theCommandOptionsMutex::get();
 350 }
 351
 352 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */