6ff2d84ade
rtl/string.hxx and rtl/ustring.hxx both unnecessarily #include <sal/log.hxx>
(and don't make use of it themselves), but many other files happen to depend on
it. Cleaned up some, but something like
grep -FwL sal/log.hxx $(git grep -Elw \
'SAL_INFO|SAL_INFO_IF|SAL_WARN|SAL_WARN_IF') -- \*.cxx)
shows lots more files that potentially need fixing before the include can be
removed from rtl/string.hxx and rtl/ustring.hxx.
Change-Id: Ibf033363e83d37851776f392dc0b077381cd8b90
376 lines
13 KiB
C++
376 lines
13 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#include <sal/config.h>
|
|
|
|
#include <sal/log.hxx>
|
|
#include <unotools/cmdoptions.hxx>
|
|
#include <unotools/configmgr.hxx>
|
|
#include <unotools/configitem.hxx>
|
|
#include <tools/debug.hxx>
|
|
#include <com/sun/star/uno/Any.hxx>
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
#include <cppuhelper/weakref.hxx>
|
|
#include <rtl/ustrbuf.hxx>
|
|
#include <rtl/instance.hxx>
|
|
#include <osl/diagnose.h>
|
|
|
|
#include "itemholder1.hxx"
|
|
|
|
#include <algorithm>
|
|
#include <unordered_map>
|
|
|
|
using namespace ::std;
|
|
using namespace ::utl;
|
|
using namespace ::osl;
|
|
using namespace ::com::sun::star::uno;
|
|
using namespace ::com::sun::star::beans;
|
|
|
|
#define ROOTNODE_CMDOPTIONS OUString("Office.Commands/Execute")
|
|
#define PATHDELIMITER OUString("/")
|
|
|
|
#define SETNODE_DISABLED OUString("Disabled")
|
|
|
|
#define PROPERTYNAME_CMD OUString("Command")
|
|
|
|
/*-****************************************************************************************************************
|
|
@descr support simple command option structures and operations on it
|
|
****************************************************************************************************************-*/
|
|
class SvtCmdOptions
|
|
{
|
|
public:
|
|
|
|
// the only way to free memory!
|
|
void Clear()
|
|
{
|
|
m_aCommandHashMap.clear();
|
|
}
|
|
|
|
bool HasEntries() const
|
|
{
|
|
return ( !m_aCommandHashMap.empty() );
|
|
}
|
|
|
|
bool Lookup( const OUString& aCmd ) const
|
|
{
|
|
CommandHashMap::const_iterator pEntry = m_aCommandHashMap.find( aCmd );
|
|
return ( pEntry != m_aCommandHashMap.end() );
|
|
}
|
|
|
|
void AddCommand( const OUString& aCmd )
|
|
{
|
|
m_aCommandHashMap.insert( CommandHashMap::value_type( aCmd, 0 ) );
|
|
}
|
|
|
|
private:
|
|
typedef std::unordered_map<OUString, sal_Int32, OUStringHash>
|
|
CommandHashMap;
|
|
|
|
CommandHashMap m_aCommandHashMap;
|
|
};
|
|
|
|
typedef ::std::vector< ::com::sun::star::uno::WeakReference< ::com::sun::star::frame::XFrame > > SvtFrameVector;
|
|
|
|
class SvtCommandOptions_Impl : public ConfigItem
|
|
{
|
|
public:
|
|
|
|
SvtCommandOptions_Impl();
|
|
virtual ~SvtCommandOptions_Impl();
|
|
|
|
/*-****************************************************************************************************
|
|
@short called for notify of configmanager
|
|
@descr These method is called from the ConfigManager before application ends or from the
|
|
PropertyChangeListener if the sub tree broadcasts changes. You must update your
|
|
internal values.
|
|
|
|
@seealso baseclass ConfigItem
|
|
|
|
@param "lPropertyNames" is the list of properties which should be updated.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual void Notify( const Sequence< OUString >& lPropertyNames ) SAL_OVERRIDE;
|
|
|
|
/*-****************************************************************************************************
|
|
@short base implementation of public interface for "SvtDynamicMenuOptions"!
|
|
@descr These class is used as static member of "SvtDynamicMenuOptions" ...
|
|
=> The code exist only for one time and isn't duplicated for every instance!
|
|
*//*-*****************************************************************************************************/
|
|
|
|
bool HasEntries ( SvtCommandOptions::CmdOption eOption ) const;
|
|
bool Lookup ( SvtCommandOptions::CmdOption eCmdOption, const OUString& ) const;
|
|
void EstablisFrameCallback(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame);
|
|
|
|
private:
|
|
|
|
virtual void ImplCommit() SAL_OVERRIDE;
|
|
|
|
/*-****************************************************************************************************
|
|
@short return list of key names of our configuration management which represent oue module tree
|
|
@descr These methods return the current list of key names! We need it to get needed values from our
|
|
configuration management and support dynamical menu item lists!
|
|
@param "nDisabledCount" , returns count of menu entries for "new"
|
|
@return A list of configuration key names is returned.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
Sequence< OUString > impl_GetPropertyNames();
|
|
|
|
private:
|
|
SvtCmdOptions m_aDisabledCommands;
|
|
SvtFrameVector m_lFrames;
|
|
};
|
|
|
|
// constructor
|
|
|
|
SvtCommandOptions_Impl::SvtCommandOptions_Impl()
|
|
// Init baseclasses first
|
|
: ConfigItem( ROOTNODE_CMDOPTIONS )
|
|
// Init member then...
|
|
{
|
|
// Get names and values of all accessible menu entries and fill internal structures.
|
|
// See impl_GetPropertyNames() for further information.
|
|
Sequence< OUString > lNames = impl_GetPropertyNames ();
|
|
Sequence< Any > lValues = GetProperties ( lNames );
|
|
|
|
// Safe impossible cases.
|
|
// We need values from ALL configuration keys.
|
|
// Follow assignment use order of values in relation to our list of key names!
|
|
DBG_ASSERT( !(lNames.getLength()!=lValues.getLength()), "SvtCommandOptions_Impl::SvtCommandOptions_Impl()\nI miss some values of configuration keys!\n" );
|
|
|
|
// Copy values from list in right order to our internal member.
|
|
// Attention: List for names and values have an internal construction pattern!
|
|
sal_Int32 nItem = 0;
|
|
OUString sCmd;
|
|
|
|
// Get names/values for disabled commands.
|
|
for( nItem=0; nItem < lNames.getLength(); ++nItem )
|
|
{
|
|
// Currently only one value
|
|
lValues[nItem] >>= sCmd;
|
|
m_aDisabledCommands.AddCommand( sCmd );
|
|
}
|
|
|
|
/*TODO: Not used in the moment! see Notify() ...
|
|
// Enable notification mechanism of our baseclass.
|
|
// We need it to get information about changes outside these class on our used configuration keys! */
|
|
Sequence< OUString > aNotifySeq( 1 );
|
|
aNotifySeq[0] = "Disabled";
|
|
EnableNotification( aNotifySeq, true );
|
|
}
|
|
|
|
// destructor
|
|
|
|
SvtCommandOptions_Impl::~SvtCommandOptions_Impl()
|
|
{
|
|
assert(!IsModified()); // should have been committed
|
|
}
|
|
|
|
// public method
|
|
|
|
void SvtCommandOptions_Impl::Notify( const Sequence< OUString >& )
|
|
{
|
|
MutexGuard aGuard( SvtCommandOptions::GetOwnStaticMutex() );
|
|
|
|
Sequence< OUString > lNames = impl_GetPropertyNames ();
|
|
Sequence< Any > lValues = GetProperties ( lNames );
|
|
|
|
// Safe impossible cases.
|
|
// We need values from ALL configuration keys.
|
|
// Follow assignment use order of values in relation to our list of key names!
|
|
DBG_ASSERT( !(lNames.getLength()!=lValues.getLength()), "SvtCommandOptions_Impl::Notify()\nI miss some values of configuration keys!\n" );
|
|
|
|
// Copy values from list in right order to our internal member.
|
|
// Attention: List for names and values have an internal construction pattern!
|
|
sal_Int32 nItem = 0;
|
|
OUString sCmd;
|
|
|
|
m_aDisabledCommands.Clear();
|
|
|
|
// Get names/values for disabled commands.
|
|
for( nItem=0; nItem < lNames.getLength(); ++nItem )
|
|
{
|
|
// Currently only one value
|
|
lValues[nItem] >>= sCmd;
|
|
m_aDisabledCommands.AddCommand( sCmd );
|
|
}
|
|
|
|
// dont forget to update all existing frames and her might cached dispatch objects!
|
|
// But look for already killed frames. We hold weak references instead of hard ones ...
|
|
for (SvtFrameVector::const_iterator pIt = m_lFrames.begin();
|
|
pIt != m_lFrames.end();
|
|
++pIt )
|
|
{
|
|
::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame > xFrame(pIt->get(), ::com::sun::star::uno::UNO_QUERY);
|
|
if (xFrame.is())
|
|
xFrame->contextChanged();
|
|
}
|
|
}
|
|
|
|
// public method
|
|
|
|
void SvtCommandOptions_Impl::ImplCommit()
|
|
{
|
|
SAL_WARN("unotools.config","SvtCommandOptions_Impl::ImplCommit(): Not implemented yet!");
|
|
}
|
|
|
|
// public method
|
|
|
|
bool SvtCommandOptions_Impl::HasEntries( SvtCommandOptions::CmdOption eOption ) const
|
|
{
|
|
if ( eOption == SvtCommandOptions::CMDOPTION_DISABLED )
|
|
return m_aDisabledCommands.HasEntries();
|
|
else
|
|
return false;
|
|
}
|
|
|
|
// public method
|
|
|
|
bool SvtCommandOptions_Impl::Lookup( SvtCommandOptions::CmdOption eCmdOption, const OUString& aCommand ) const
|
|
{
|
|
switch( eCmdOption )
|
|
{
|
|
case SvtCommandOptions::CMDOPTION_DISABLED:
|
|
{
|
|
return m_aDisabledCommands.Lookup( aCommand );
|
|
}
|
|
default:
|
|
DBG_ASSERT( false, "SvtCommandOptions_Impl::Lookup()\nUnknown option type given!\n" );
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
// public method
|
|
|
|
void SvtCommandOptions_Impl::EstablisFrameCallback(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame)
|
|
{
|
|
// check if frame already exists inside list
|
|
// ignore double registrations
|
|
// every frame must be notified one times only!
|
|
::com::sun::star::uno::WeakReference< ::com::sun::star::frame::XFrame > xWeak(xFrame);
|
|
SvtFrameVector::const_iterator pIt = ::std::find(m_lFrames.begin(), m_lFrames.end(), xWeak);
|
|
if (pIt == m_lFrames.end())
|
|
m_lFrames.push_back(xWeak);
|
|
}
|
|
|
|
// private method
|
|
|
|
Sequence< OUString > SvtCommandOptions_Impl::impl_GetPropertyNames()
|
|
{
|
|
// First get ALL names of current existing list items in configuration!
|
|
Sequence< OUString > lDisabledItems = GetNodeNames( SETNODE_DISABLED, utl::CONFIG_NAME_LOCAL_PATH );
|
|
|
|
OUString aSetNode( SETNODE_DISABLED );
|
|
aSetNode += PATHDELIMITER;
|
|
|
|
OUString aCommandKey( PATHDELIMITER );
|
|
aCommandKey += PROPERTYNAME_CMD;
|
|
|
|
// Expand all keys
|
|
for (sal_Int32 i=0; i<lDisabledItems.getLength(); ++i )
|
|
{
|
|
OUStringBuffer aBuffer( 32 );
|
|
aBuffer.append( aSetNode );
|
|
aBuffer.append( lDisabledItems[i] );
|
|
aBuffer.append( aCommandKey );
|
|
lDisabledItems[i] = aBuffer.makeStringAndClear();
|
|
}
|
|
|
|
// Return result.
|
|
return lDisabledItems;
|
|
}
|
|
|
|
// initialize static member
|
|
// DON'T DO IT IN YOUR HEADER!
|
|
// see definition for further information
|
|
|
|
SvtCommandOptions_Impl* SvtCommandOptions::m_pDataContainer = NULL;
|
|
sal_Int32 SvtCommandOptions::m_nRefCount = 0;
|
|
|
|
// constructor
|
|
|
|
SvtCommandOptions::SvtCommandOptions()
|
|
{
|
|
// Global access, must be guarded (multithreading!).
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
// Increase our refcount ...
|
|
++m_nRefCount;
|
|
// ... and initialize our data container only if it not already exist!
|
|
if( m_pDataContainer == NULL )
|
|
{
|
|
m_pDataContainer = new SvtCommandOptions_Impl;
|
|
ItemHolder1::holdConfigItem(E_CMDOPTIONS);
|
|
}
|
|
}
|
|
|
|
// destructor
|
|
|
|
SvtCommandOptions::~SvtCommandOptions()
|
|
{
|
|
// Global access, must be guarded (multithreading!)
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
// Decrease our refcount.
|
|
--m_nRefCount;
|
|
// If last instance was deleted ...
|
|
// we must destroy our static data container!
|
|
if( m_nRefCount <= 0 )
|
|
{
|
|
delete m_pDataContainer;
|
|
m_pDataContainer = NULL;
|
|
}
|
|
}
|
|
|
|
// public method
|
|
|
|
bool SvtCommandOptions::HasEntries( CmdOption eOption ) const
|
|
{
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
return m_pDataContainer->HasEntries( eOption );
|
|
}
|
|
|
|
// public method
|
|
|
|
bool SvtCommandOptions::Lookup( CmdOption eCmdOption, const OUString& aCommandURL ) const
|
|
{
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
return m_pDataContainer->Lookup( eCmdOption, aCommandURL );
|
|
}
|
|
|
|
// public method
|
|
|
|
void SvtCommandOptions::EstablisFrameCallback(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& xFrame)
|
|
{
|
|
MutexGuard aGuard( GetOwnStaticMutex() );
|
|
m_pDataContainer->EstablisFrameCallback(xFrame);
|
|
}
|
|
|
|
namespace
|
|
{
|
|
class theCommandOptionsMutex : public rtl::Static<osl::Mutex, theCommandOptionsMutex>{};
|
|
}
|
|
|
|
// private method
|
|
|
|
Mutex& SvtCommandOptions::GetOwnStaticMutex()
|
|
{
|
|
return theCommandOptionsMutex::get();
|
|
}
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|