Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 447 insertions, 0 deletions

diff --git a/forms/source/helper/formnavigation.cxx b/forms/source/helper/formnavigation.cxx
new file mode 100644
index 000000000..5182b0544
--- /dev/null
+++ b/forms/source/helper/formnavigation.cxx
@@ -0,0 +1,447 @@
+/* -*- 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 <formnavigation.hxx>
+#include <urltransformer.hxx>
+#include <controlfeatureinterception.hxx>
+#include <frm_strings.hxx>
+
+#include <com/sun/star/form/runtime/FormFeature.hpp>
+
+#include <tools/debug.hxx>
+#include <osl/diagnose.h>
+
+
+namespace frm
+{
+
+
+    using namespace ::com::sun::star::uno;
+    using namespace ::com::sun::star::beans;
+    using namespace ::com::sun::star::lang;
+    using namespace ::com::sun::star::util;
+    using namespace ::com::sun::star::frame;
+    namespace FormFeature = ::com::sun::star::form::runtime::FormFeature;
+
+    OFormNavigationHelper::OFormNavigationHelper( const Reference< XComponentContext >& _rxORB )
+        :m_xORB( _rxORB )
+        ,m_nConnectedFeatures( 0 )
+    {
+        m_pFeatureInterception.reset( new ControlFeatureInterception( m_xORB ) );
+    }
+
+
+    OFormNavigationHelper::~OFormNavigationHelper()
+    {
+    }
+
+
+    void OFormNavigationHelper::dispose( )
+    {
+        m_pFeatureInterception->dispose();
+        disconnectDispatchers();
+    }
+
+
+    void OFormNavigationHelper::interceptorsChanged( )
+    {
+        updateDispatches();
+    }
+
+
+    void OFormNavigationHelper::featureStateChanged( sal_Int16 /*_nFeatureId*/, bool /*_bEnabled*/ )
+    {
+        // not interested in
+    }
+
+
+    void OFormNavigationHelper::allFeatureStatesChanged( )
+    {
+        // not interested in
+    }
+
+
+    void SAL_CALL OFormNavigationHelper::registerDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor )
+    {
+        m_pFeatureInterception->registerDispatchProviderInterceptor( _rxInterceptor );
+        interceptorsChanged();
+    }
+
+
+    void SAL_CALL OFormNavigationHelper::releaseDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor )
+    {
+        m_pFeatureInterception->releaseDispatchProviderInterceptor( _rxInterceptor );
+        interceptorsChanged();
+    }
+
+
+    void SAL_CALL OFormNavigationHelper::statusChanged( const FeatureStateEvent& _rState )
+    {
+        for (auto & feature : m_aSupportedFeatures)
+        {
+            if ( feature.second.aURL.Main == _rState.FeatureURL.Main )
+            {
+                if  (  ( feature.second.bCachedState != bool(_rState.IsEnabled) )
+                    || ( feature.second.aCachedAdditionalState != _rState.State )
+                    )
+                {
+                    // change the cached state
+                    feature.second.bCachedState           = _rState.IsEnabled;
+                    feature.second.aCachedAdditionalState = _rState.State;
+                    // tell derivees what happened
+                    featureStateChanged( feature.first, _rState.IsEnabled );
+                }
+                return;
+            }
+        }
+
+        // unreachable
+        OSL_FAIL( "OFormNavigationHelper::statusChanged: huh? An invalid/unknown URL?" );
+    }
+
+
+    void SAL_CALL OFormNavigationHelper::disposing( const EventObject& _rSource )
+    {
+        // was it one of our external dispatchers?
+        if ( !m_nConnectedFeatures )
+            return;
+
+        for (auto & feature : m_aSupportedFeatures)
+        {
+            if ( feature.second.xDispatcher == _rSource.Source )
+            {
+                feature.second.xDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
+                feature.second.xDispatcher = nullptr;
+                feature.second.bCachedState = false;
+                feature.second.aCachedAdditionalState.clear();
+                --m_nConnectedFeatures;
+
+                featureStateChanged( feature.first, false );
+                break;
+            }
+        }
+    }
+
+
+    void OFormNavigationHelper::updateDispatches()
+    {
+        if ( !m_nConnectedFeatures )
+        {   // we don't have any dispatchers yet -> do the initial connect
+            connectDispatchers();
+            return;
+        }
+
+        initializeSupportedFeatures();
+
+        m_nConnectedFeatures = 0;
+
+        Reference< XDispatch >  xNewDispatcher;
+        Reference< XDispatch >  xCurrentDispatcher;
+
+        for (auto & feature : m_aSupportedFeatures)
+        {
+            xNewDispatcher = queryDispatch( feature.second.aURL );
+            xCurrentDispatcher = feature.second.xDispatcher;
+            if ( xNewDispatcher != xCurrentDispatcher )
+            {
+                // the dispatcher for this particular URL changed
+                if ( xCurrentDispatcher.is() )
+                    xCurrentDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
+
+                xCurrentDispatcher = feature.second.xDispatcher = xNewDispatcher;
+
+                if ( xCurrentDispatcher.is() )
+                    xCurrentDispatcher->addStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
+            }
+
+            if ( xCurrentDispatcher.is() )
+                ++m_nConnectedFeatures;
+            else
+                feature.second.bCachedState = false;
+        }
+
+        // notify derivee that (potentially) all features changed their state
+        allFeatureStatesChanged( );
+    }
+
+
+    void OFormNavigationHelper::connectDispatchers()
+    {
+        if ( m_nConnectedFeatures )
+        {   // already connected -> just do an update
+            updateDispatches();
+            return;
+        }
+
+        initializeSupportedFeatures();
+
+        m_nConnectedFeatures = 0;
+
+        for (auto & feature : m_aSupportedFeatures)
+        {
+            feature.second.bCachedState = false;
+            feature.second.aCachedAdditionalState.clear();
+            feature.second.xDispatcher = queryDispatch( feature.second.aURL );
+            if ( feature.second.xDispatcher.is() )
+            {
+                ++m_nConnectedFeatures;
+                feature.second.xDispatcher->addStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
+            }
+        }
+
+        // notify derivee that (potentially) all features changed their state
+        allFeatureStatesChanged( );
+    }
+
+
+    void OFormNavigationHelper::disconnectDispatchers()
+    {
+        if ( m_nConnectedFeatures )
+        {
+            for (auto & feature : m_aSupportedFeatures)
+            {
+                if ( feature.second.xDispatcher.is() )
+                    feature.second.xDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
+
+                feature.second.xDispatcher = nullptr;
+                feature.second.bCachedState = false;
+                feature.second.aCachedAdditionalState.clear();
+            }
+
+            m_nConnectedFeatures = 0;
+        }
+
+        // notify derivee that (potentially) all features changed their state
+        allFeatureStatesChanged( );
+    }
+
+
+    void OFormNavigationHelper::initializeSupportedFeatures( )
+    {
+        if ( !m_aSupportedFeatures.empty() )
+            return;
+
+        // ask the derivee which feature ids it wants us to support
+        ::std::vector< sal_Int16 > aFeatureIds;
+        getSupportedFeatures( aFeatureIds );
+
+        OFormNavigationMapper aUrlMapper( m_xORB );
+
+        for (auto const& feature : aFeatureIds)
+        {
+            FeatureInfo aFeatureInfo;
+
+            bool bKnownId =
+                aUrlMapper.getFeatureURL( feature, aFeatureInfo.aURL );
+            DBG_ASSERT( bKnownId, "OFormNavigationHelper::initializeSupportedFeatures: unknown feature id!" );
+
+            if ( bKnownId )
+                // add to our map
+                m_aSupportedFeatures.emplace( feature, aFeatureInfo );
+        }
+    }
+
+
+    Reference< XDispatch > OFormNavigationHelper::queryDispatch( const URL& _rURL )
+    {
+        return m_pFeatureInterception->queryDispatch( _rURL );
+    }
+
+
+    void OFormNavigationHelper::dispatchWithArgument( sal_Int16 _nFeatureId, const char* _pParamAsciiName,
+        const Any& _rParamValue ) const
+    {
+        FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
+        if ( m_aSupportedFeatures.end() != aInfo )
+        {
+            if ( aInfo->second.xDispatcher.is() )
+            {
+                Sequence< PropertyValue > aArgs( 1 );
+                aArgs[0].Name = OUString::createFromAscii( _pParamAsciiName );
+                aArgs[0].Value = _rParamValue;
+
+                aInfo->second.xDispatcher->dispatch( aInfo->second.aURL, aArgs );
+            }
+        }
+    }
+
+
+    void OFormNavigationHelper::dispatch( sal_Int16 _nFeatureId ) const
+    {
+        FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
+        if ( m_aSupportedFeatures.end() != aInfo )
+        {
+            if ( aInfo->second.xDispatcher.is() )
+            {
+                Sequence< PropertyValue > aEmptyArgs;
+                aInfo->second.xDispatcher->dispatch( aInfo->second.aURL, aEmptyArgs );
+            }
+        }
+    }
+
+
+    bool OFormNavigationHelper::isEnabled( sal_Int16 _nFeatureId ) const
+    {
+        FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
+        if ( m_aSupportedFeatures.end() != aInfo )
+            return aInfo->second.bCachedState;
+
+        return false;
+    }
+
+
+    bool OFormNavigationHelper::getBooleanState( sal_Int16 _nFeatureId ) const
+    {
+        bool bState = false;
+
+        FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
+        if ( m_aSupportedFeatures.end() != aInfo )
+            aInfo->second.aCachedAdditionalState >>= bState;
+
+        return bState;
+    }
+
+
+    OUString OFormNavigationHelper::getStringState( sal_Int16 _nFeatureId ) const
+    {
+        OUString sState;
+
+        FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
+        if ( m_aSupportedFeatures.end() != aInfo )
+            aInfo->second.aCachedAdditionalState >>= sState;
+
+        return sState;
+    }
+
+
+    sal_Int32 OFormNavigationHelper::getIntegerState( sal_Int16 _nFeatureId ) const
+    {
+        sal_Int32 nState = 0;
+
+        FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
+        if ( m_aSupportedFeatures.end() != aInfo )
+            aInfo->second.aCachedAdditionalState >>= nState;
+
+        return nState;
+    }
+
+
+    void OFormNavigationHelper::invalidateSupportedFeaturesSet()
+    {
+        disconnectDispatchers( );
+        // no supported features anymore:
+        FeatureMap aEmpty;
+        m_aSupportedFeatures.swap( aEmpty );
+    }
+
+    OFormNavigationMapper::OFormNavigationMapper( const Reference< XComponentContext >& _rxORB )
+    {
+        m_pUrlTransformer.reset( new UrlTransformer( _rxORB ) );
+    }
+
+
+    OFormNavigationMapper::~OFormNavigationMapper( )
+    {
+    }
+
+
+    bool OFormNavigationMapper::getFeatureURL( sal_Int16 _nFeatureId, URL& /* [out] */ _rURL )
+    {
+        // get the ascii version of the URL
+        const char* pAsciiURL = getFeatureURLAscii( _nFeatureId );
+        if ( pAsciiURL )
+            _rURL = m_pUrlTransformer->getStrictURLFromAscii( pAsciiURL );
+
+        return ( pAsciiURL != nullptr );
+    }
+
+
+    namespace
+    {
+        struct FeatureURL
+        {
+            const sal_Int16 nFormFeature;
+            const char*     pAsciiURL;
+
+            FeatureURL( const sal_Int16 _nFormFeature, const char* _pAsciiURL )
+                :nFormFeature( _nFormFeature )
+                ,pAsciiURL( _pAsciiURL )
+            {
+            }
+        };
+        const FeatureURL* lcl_getFeatureTable()
+        {
+            static const FeatureURL s_aFeatureURLs[] =
+            {
+                FeatureURL( FormFeature::MoveAbsolute,            URL_FORM_POSITION ),
+                FeatureURL( FormFeature::TotalRecords,            URL_FORM_RECORDCOUNT ),
+                FeatureURL( FormFeature::MoveToFirst,             URL_RECORD_FIRST ),
+                FeatureURL( FormFeature::MoveToPrevious,          URL_RECORD_PREV ),
+                FeatureURL( FormFeature::MoveToNext,              URL_RECORD_NEXT ),
+                FeatureURL( FormFeature::MoveToLast,              URL_RECORD_LAST ),
+                FeatureURL( FormFeature::SaveRecordChanges,       URL_RECORD_SAVE ),
+                FeatureURL( FormFeature::UndoRecordChanges,       URL_RECORD_UNDO ),
+                FeatureURL( FormFeature::MoveToInsertRow,         URL_RECORD_NEW ),
+                FeatureURL( FormFeature::DeleteRecord,            URL_RECORD_DELETE ),
+                FeatureURL( FormFeature::ReloadForm,              URL_FORM_REFRESH ),
+                FeatureURL( FormFeature::RefreshCurrentControl,   URL_FORM_REFRESH_CURRENT_CONTROL ),
+                FeatureURL( FormFeature::SortAscending,           URL_FORM_SORT_UP ),
+                FeatureURL( FormFeature::SortDescending,          URL_FORM_SORT_DOWN ),
+                FeatureURL( FormFeature::InteractiveSort,         URL_FORM_SORT ),
+                FeatureURL( FormFeature::AutoFilter,              URL_FORM_AUTO_FILTER ),
+                FeatureURL( FormFeature::InteractiveFilter,       URL_FORM_FILTER ),
+                FeatureURL( FormFeature::ToggleApplyFilter,       URL_FORM_APPLY_FILTER ),
+                FeatureURL( FormFeature::RemoveFilterAndSort,     URL_FORM_REMOVE_FILTER ),
+                FeatureURL( 0, nullptr )
+            };
+            return s_aFeatureURLs;
+        }
+    }
+
+
+    const char* OFormNavigationMapper::getFeatureURLAscii( sal_Int16 _nFeatureId )
+    {
+        const FeatureURL* pFeatures = lcl_getFeatureTable();
+        while ( pFeatures->pAsciiURL )
+        {
+            if ( pFeatures->nFormFeature == _nFeatureId )
+                return pFeatures->pAsciiURL;
+            ++pFeatures;
+        }
+        return nullptr;
+    }
+
+
+    sal_Int16 OFormNavigationMapper::getFeatureId( const OUString& _rCompleteURL )
+    {
+        const FeatureURL* pFeatures = lcl_getFeatureTable();
+        while ( pFeatures->pAsciiURL )
+        {
+            if ( _rCompleteURL.equalsAscii( pFeatures->pAsciiURL ) )
+                return pFeatures->nFormFeature;
+            ++pFeatures;
+        }
+        return -1;
+    }
+
+
+}   // namespace frm
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */