diff options
Diffstat (limited to 'svx/source/form/formcontrolling.cxx')
-rw-r--r-- | svx/source/form/formcontrolling.cxx | 604 |
1 files changed, 604 insertions, 0 deletions
diff --git a/svx/source/form/formcontrolling.cxx b/svx/source/form/formcontrolling.cxx new file mode 100644 index 000000000000..a1f2059f3dfb --- /dev/null +++ b/svx/source/form/formcontrolling.cxx @@ -0,0 +1,604 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +// MARKER(update_precomp.py): autogen include statement, do not remove +#include "precompiled_svx.hxx" + +#include "formcontrolling.hxx" +#include "fmurl.hxx" +#include "svx/svxids.hrc" +#include "fmprop.hrc" +#include "svx/fmtools.hxx" + +/** === begin UNO includes === **/ +#include <com/sun/star/form/runtime/FormOperations.hpp> +#include <com/sun/star/form/runtime/FormFeature.hpp> +#include <com/sun/star/beans/XPropertySet.hpp> +#include <com/sun/star/sdb/XSQLErrorBroadcaster.hpp> +/** === end UNO includes === **/ + +#include <tools/diagnose_ex.h> +#include <comphelper/anytostring.hxx> +#include <cppuhelper/exc_hlp.hxx> +#include <osl/diagnose.h> + +#include <functional> +#include <algorithm> + +//........................................................................ +namespace svx +{ +//........................................................................ + + /** === begin UNO using === **/ + using ::com::sun::star::uno::Reference; + using ::com::sun::star::lang::XMultiServiceFactory; + using ::com::sun::star::form::runtime::XFormController; + using ::com::sun::star::form::XForm; + using ::com::sun::star::form::runtime::FormOperations; + using ::com::sun::star::uno::Exception; + using ::com::sun::star::sdbc::XRowSet; + using ::com::sun::star::form::runtime::FeatureState; + using ::com::sun::star::uno::Any; + using ::com::sun::star::uno::Sequence; + using ::com::sun::star::beans::NamedValue; + using ::com::sun::star::uno::RuntimeException; + using ::com::sun::star::beans::XPropertySet; + using ::com::sun::star::uno::UNO_QUERY_THROW; + using ::com::sun::star::sdbc::SQLException; + using ::com::sun::star::sdb::XSQLErrorBroadcaster; + using ::com::sun::star::sdb::SQLErrorEvent; + using ::com::sun::star::lang::EventObject; + /** === end UNO using === **/ + namespace FormFeature = ::com::sun::star::form::runtime::FormFeature; + + //==================================================================== + //= FeatureSlotTranslation + //==================================================================== + namespace + { + struct FeatureDescription + { + ::rtl::OUString sURL; // the URL + sal_Int32 nSlotId; // the SFX-compatible slot ID + sal_Int16 nFormFeature; // the css.form.runtime.FormFeature ID + }; + typedef ::std::vector< FeatureDescription > FeatureDescriptions; + + //................................................................ + const FeatureDescriptions& getFeatureDescriptions() + { + static FeatureDescriptions s_aFeatureDescriptions; + if ( s_aFeatureDescriptions.empty() ) + { + ::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() ); + if ( s_aFeatureDescriptions.empty() ) + { + FeatureDescription aDescriptions[] = { + { FMURL_FORM_POSITION, SID_FM_RECORD_ABSOLUTE, FormFeature::MoveAbsolute }, + { FMURL_FORM_RECORDCOUNT, SID_FM_RECORD_TOTAL, FormFeature::TotalRecords }, + { FMURL_RECORD_MOVEFIRST, SID_FM_RECORD_FIRST, FormFeature::MoveToFirst }, + { FMURL_RECORD_MOVEPREV, SID_FM_RECORD_PREV, FormFeature::MoveToPrevious }, + { FMURL_RECORD_MOVENEXT, SID_FM_RECORD_NEXT, FormFeature::MoveToNext }, + { FMURL_RECORD_MOVELAST, SID_FM_RECORD_LAST, FormFeature::MoveToLast }, + { FMURL_RECORD_MOVETONEW, SID_FM_RECORD_NEW, FormFeature::MoveToInsertRow }, + { FMURL_RECORD_SAVE, SID_FM_RECORD_SAVE, FormFeature::SaveRecordChanges }, + { FMURL_RECORD_DELETE, SID_FM_RECORD_DELETE, FormFeature::DeleteRecord }, + { FMURL_FORM_REFRESH, SID_FM_REFRESH, FormFeature::ReloadForm }, + { FMURL_FORM_REFRESH_CURRENT_CONTROL, + SID_FM_REFRESH_FORM_CONTROL,FormFeature::RefreshCurrentControl }, + { FMURL_RECORD_UNDO, SID_FM_RECORD_UNDO, FormFeature::UndoRecordChanges }, + { FMURL_FORM_SORT_UP, SID_FM_SORTUP, FormFeature::SortAscending }, + { FMURL_FORM_SORT_DOWN, SID_FM_SORTDOWN, FormFeature::SortDescending }, + { FMURL_FORM_SORT, SID_FM_ORDERCRIT, FormFeature::InteractiveSort }, + { FMURL_FORM_AUTO_FILTER, SID_FM_AUTOFILTER, FormFeature::AutoFilter }, + { FMURL_FORM_FILTER, SID_FM_FILTERCRIT, FormFeature::InteractiveFilter }, + { FMURL_FORM_APPLY_FILTER, SID_FM_FORM_FILTERED, FormFeature::ToggleApplyFilter }, + { FMURL_FORM_REMOVE_FILTER, SID_FM_REMOVE_FILTER_SORT, FormFeature::RemoveFilterAndSort } + }; + for ( size_t i=0; i<sizeof(aDescriptions)/sizeof(aDescriptions[0]); ++i ) + s_aFeatureDescriptions.push_back( aDescriptions[i] ); + } + }; + return s_aFeatureDescriptions; + } + } + + //-------------------------------------------------------------------- + namespace + { + //................................................................ + struct MatchFeatureDescriptionByURL : public ::std::unary_function< FeatureDescription, bool > + { + const ::rtl::OUString& m_rURL; + MatchFeatureDescriptionByURL( const ::rtl::OUString& _rURL ) :m_rURL( _rURL ) { } + + bool operator()( const FeatureDescription& _compare ) + { + return m_rURL == _compare.sURL; + } + }; + + //................................................................ + struct MatchFeatureDescriptionBySlotId : public ::std::unary_function< FeatureDescription, bool > + { + sal_Int32 m_nSlotId; + MatchFeatureDescriptionBySlotId( sal_Int32 _nSlotId ) :m_nSlotId( _nSlotId ) { } + + bool operator()( const FeatureDescription& _compare ) + { + return m_nSlotId == _compare.nSlotId; + } + }; + + //................................................................ + struct MatchFeatureDescriptionByFormFeature : public ::std::unary_function< FeatureDescription, bool > + { + sal_Int32 m_nFormFeature; + MatchFeatureDescriptionByFormFeature( sal_Int32 _nFormFeature ) :m_nFormFeature( _nFormFeature ) { } + + bool operator()( const FeatureDescription& _compare ) + { + return m_nFormFeature == _compare.nFormFeature; + } + }; + + //................................................................ + struct FormFeatureToSlotId : public ::std::unary_function< sal_Int16, sal_Int32 > + { + sal_Int32 operator()( sal_Int16 _FormFeature ) + { + return FeatureSlotTranslation::getSlotIdForFormFeature( _FormFeature ); + } + }; + } + + //-------------------------------------------------------------------- + sal_Int32 FeatureSlotTranslation::getControllerFeatureSlotIdForURL( const ::rtl::OUString& _rMainURL ) + { + const FeatureDescriptions& rDescriptions( getFeatureDescriptions() ); + FeatureDescriptions::const_iterator pos = ::std::find_if( rDescriptions.begin(), rDescriptions.end(), MatchFeatureDescriptionByURL( _rMainURL ) ); + return ( pos != rDescriptions.end() ) ? pos->nSlotId : -1; + } + + //-------------------------------------------------------------------- + ::rtl::OUString FeatureSlotTranslation::getControllerFeatureURLForSlotId( sal_Int32 _nSlotId ) + { + const FeatureDescriptions& rDescriptions( getFeatureDescriptions() ); + FeatureDescriptions::const_iterator pos = ::std::find_if( rDescriptions.begin(), rDescriptions.end(), MatchFeatureDescriptionBySlotId( _nSlotId ) ); + OSL_ENSURE( pos != rDescriptions.end(), "FeatureSlotTranslation::getControllerFeatureURLForSlotId: not found!" ); + return ( pos != rDescriptions.end() ) ? pos->sURL : ::rtl::OUString(); + } + + //-------------------------------------------------------------------- + sal_Bool FeatureSlotTranslation::isFeatureURL( const ::rtl::OUString& _rMainURL ) + { + return ( _rMainURL.indexOf( FMURL_FORMSLOTS_PREFIX ) == 0 ); + } + + //-------------------------------------------------------------------- + sal_Int16 FeatureSlotTranslation::getFormFeatureForSlotId( sal_Int32 _nSlotId ) + { + const FeatureDescriptions& rDescriptions( getFeatureDescriptions() ); + FeatureDescriptions::const_iterator pos = ::std::find_if( rDescriptions.begin(), rDescriptions.end(), MatchFeatureDescriptionBySlotId( _nSlotId ) ); + OSL_ENSURE( pos != rDescriptions.end(), "FeatureSlotTranslation::getFormFeatureForSlotId: not found!" ); + return ( pos != rDescriptions.end() ) ? pos->nFormFeature : -1; + } + + //-------------------------------------------------------------------- + sal_Int32 FeatureSlotTranslation::getSlotIdForFormFeature( sal_Int16 _nFormFeature ) + { + const FeatureDescriptions& rDescriptions( getFeatureDescriptions() ); + FeatureDescriptions::const_iterator pos = ::std::find_if( rDescriptions.begin(), rDescriptions.end(), MatchFeatureDescriptionByFormFeature( _nFormFeature ) ); + OSL_ENSURE( pos != rDescriptions.end(), "FeatureSlotTranslation::getSlotIdForFormFeature: not found!" ); + return ( pos != rDescriptions.end() ) ? pos->nSlotId : -1; + } + + //==================================================================== + //= ControllerFeatures + //==================================================================== + //-------------------------------------------------------------------- + ControllerFeatures::ControllerFeatures( const Reference< XMultiServiceFactory >& _rxORB, IControllerFeatureInvalidation* _pInvalidationCallback ) + :m_aContext( _rxORB ) + ,m_pInvalidationCallback( _pInvalidationCallback ) + ,m_pImpl( NULL ) + { + } + + //-------------------------------------------------------------------- + ControllerFeatures::ControllerFeatures( const Reference< XMultiServiceFactory >& _rxORB, + const Reference< XFormController >& _rxController, IControllerFeatureInvalidation* _pInvalidationCallback ) + :m_aContext( _rxORB ) + ,m_pInvalidationCallback( _pInvalidationCallback ) + ,m_pImpl( NULL ) + { + assign( _rxController ); + } + + //-------------------------------------------------------------------- + ControllerFeatures::ControllerFeatures( const Reference< XMultiServiceFactory >& _rxORB, + const Reference< XForm >& _rxForm, IControllerFeatureInvalidation* _pInvalidationCallback ) + :m_aContext( _rxORB ) + ,m_pInvalidationCallback( _pInvalidationCallback ) + ,m_pImpl( NULL ) + { + assign( _rxForm ); + } + + //-------------------------------------------------------------------- + void ControllerFeatures::assign( const Reference< XFormController >& _rxController ) + { + dispose(); + m_pImpl = new FormControllerHelper( m_aContext, _rxController, m_pInvalidationCallback ); + m_pImpl->acquire(); + } + + //-------------------------------------------------------------------- + void ControllerFeatures::assign( const Reference< XForm >& _rxForm ) + { + dispose(); + m_pImpl = new FormControllerHelper( m_aContext, _rxForm, m_pInvalidationCallback ); + m_pImpl->acquire(); + } + + //-------------------------------------------------------------------- + ControllerFeatures::~ControllerFeatures() + { + dispose(); + } + + //-------------------------------------------------------------------- + void ControllerFeatures::dispose() + { + if ( m_pImpl ) + { + m_pImpl->dispose(); + m_pImpl->release(); + m_pImpl = NULL; + } + } + + //==================================================================== + //= FormControllerHelper + //==================================================================== + //-------------------------------------------------------------------- + FormControllerHelper::FormControllerHelper( const ::comphelper::ComponentContext& _rContext, + const Reference< XFormController >& _rxController, IControllerFeatureInvalidation* _pInvalidationCallback ) + :m_aContext( _rContext ) + ,m_pInvalidationCallback( _pInvalidationCallback ) + { + osl_incrementInterlockedCount( &m_refCount ); + try + { + m_xFormOperations = FormOperations::createWithFormController( m_aContext.getUNOContext(), _rxController ); + if ( m_xFormOperations.is() ) + m_xFormOperations->setFeatureInvalidation( this ); + + // to prevent the controller from displaying any error messages which happen while we operate on it, + // we add ourself as XSQLErrorListener. By contract, a FormController displays errors if and only if + // no SQLErrorListeners are registered. + Reference< XSQLErrorBroadcaster > xErrorBroadcast( _rxController, UNO_QUERY_THROW ); + xErrorBroadcast->addSQLErrorListener( this ); + } + catch( const Exception& ) + { + DBG_UNHANDLED_EXCEPTION(); + } + osl_decrementInterlockedCount( &m_refCount ); + } + + //-------------------------------------------------------------------- + FormControllerHelper::FormControllerHelper( const ::comphelper::ComponentContext& _rContext, + const Reference< XForm >& _rxForm, IControllerFeatureInvalidation* _pInvalidationCallback ) + :m_aContext( _rContext ) + ,m_pInvalidationCallback( _pInvalidationCallback ) + { + osl_incrementInterlockedCount( &m_refCount ); + try + { + m_xFormOperations = FormOperations::createWithForm( m_aContext.getUNOContext(), _rxForm ); + if ( m_xFormOperations.is() ) + m_xFormOperations->setFeatureInvalidation( this ); + } + catch( const Exception& ) + { + DBG_UNHANDLED_EXCEPTION(); + } + osl_decrementInterlockedCount( &m_refCount ); + } + + //-------------------------------------------------------------------- + FormControllerHelper::~FormControllerHelper( ) + { + try + { + acquire(); + dispose(); + } + catch( const Exception& ) + { + DBG_UNHANDLED_EXCEPTION(); + } + } + + //-------------------------------------------------------------------- + void FormControllerHelper::dispose() + { + if ( m_xFormOperations.is() ) + m_xFormOperations->dispose(); + m_xFormOperations.clear(); + } + + //-------------------------------------------------------------------- + sal_Bool FormControllerHelper::isEnabled( sal_Int32 _nSlotId ) const + { + if ( !m_xFormOperations.is() ) + return sal_False; + return m_xFormOperations->isEnabled( FeatureSlotTranslation::getFormFeatureForSlotId( _nSlotId ) ); + } + + //-------------------------------------------------------------------- + Reference< XRowSet > FormControllerHelper::getCursor() const + { + Reference< XRowSet > xCursor; + if ( m_xFormOperations.is() ) + xCursor = m_xFormOperations->getCursor(); + return xCursor; + } + + //-------------------------------------------------------------------- + void FormControllerHelper::getState( sal_Int32 _nSlotId, FeatureState& _rState ) const + { + if ( m_xFormOperations.is() ) + _rState = m_xFormOperations->getState( FeatureSlotTranslation::getFormFeatureForSlotId( _nSlotId ) ); + } + + //-------------------------------------------------------------------- + sal_Bool FormControllerHelper::commitCurrentControl( ) const + { + return impl_operateForm_nothrow( COMMIT_CONTROL ); + } + + //-------------------------------------------------------------------- + sal_Bool FormControllerHelper::commitCurrentRecord() const + { + return impl_operateForm_nothrow( COMMIT_RECORD ); + } + + //-------------------------------------------------------------------- + bool FormControllerHelper::moveRight( ) const + { + return impl_operateForm_nothrow( FormFeature::MoveToNext ); + } + + //-------------------------------------------------------------------- + bool FormControllerHelper::moveLeft( ) const + { + return impl_operateForm_nothrow( FormFeature::MoveToPrevious ); + } + + //-------------------------------------------------------------------- + void FormControllerHelper::execute( sal_Int32 _nSlotId, const ::rtl::OUString& _rParamName, const Any& _rParamValue ) const + { + Sequence< NamedValue > aArguments(1); + aArguments[0].Name = _rParamName; + aArguments[0].Value = _rParamValue; + + impl_operateForm_nothrow( EXECUTE_ARGS, FeatureSlotTranslation::getFormFeatureForSlotId( _nSlotId ), aArguments ); + } + + //-------------------------------------------------------------------- + bool FormControllerHelper::impl_operateForm_nothrow( const FormOperation _eWhat, const sal_Int16 _nFeature, + const Sequence< NamedValue >& _rArguments ) const + { + if ( !m_xFormOperations.is() ) + return false; + + Any aError; + bool bSuccess = false; + const_cast< FormControllerHelper* >( this )->m_aOperationError.clear(); + try + { + switch ( _eWhat ) + { + case COMMIT_CONTROL: + bSuccess = m_xFormOperations->commitCurrentControl(); + break; + + case COMMIT_RECORD: + { + sal_Bool bDummy( sal_False ); + bSuccess = m_xFormOperations->commitCurrentRecord( bDummy ); + } + break; + + case EXECUTE: + m_xFormOperations->execute( _nFeature ); + bSuccess = true; + break; + + case EXECUTE_ARGS: + m_xFormOperations->executeWithArguments( _nFeature, _rArguments ); + bSuccess = true; + break; + } + } + catch ( const SQLException& ) + { + aError = ::cppu::getCaughtException(); + } + catch( const Exception& ) + { + SQLException aFallbackError; + aFallbackError.Message = ::comphelper::anyToString( ::cppu::getCaughtException() ); + aError <<= aFallbackError; + } + + if ( bSuccess ) + return true; + + // display the error. Prefer the one reported in errorOccured over the one caught. + if ( m_aOperationError.hasValue() ) + displayException( m_aOperationError ); + else if ( aError.hasValue() ) + displayException( aError ); + else + OSL_ENSURE( false, "FormControllerHelper::impl_operateForm_nothrow: no success, but no error?" ); + + return false; + } + + //-------------------------------------------------------------------- + void FormControllerHelper::execute( sal_Int32 _nSlotId ) const + { + impl_operateForm_nothrow( EXECUTE, FeatureSlotTranslation::getFormFeatureForSlotId( _nSlotId ), + Sequence< NamedValue >() ); + } + + //-------------------------------------------------------------------- + void SAL_CALL FormControllerHelper::invalidateFeatures( const Sequence< ::sal_Int16 >& _Features ) throw (RuntimeException) + { + if ( !m_pInvalidationCallback ) + // nobody's interested in ... + return; + + ::std::vector< sal_Int32 > aFeatures( _Features.getLength() ); + ::std::transform( + _Features.getConstArray(), + _Features.getConstArray() + _Features.getLength(), + aFeatures.begin(), + FormFeatureToSlotId() + ); + + m_pInvalidationCallback->invalidateFeatures( aFeatures ); + } + + //-------------------------------------------------------------------- + void SAL_CALL FormControllerHelper::invalidateAllFeatures() throw (RuntimeException) + { + if ( !m_pInvalidationCallback ) + // nobody's interested in ... + return; + + // actually, it's a little bit more than the supported features, + // but on the medium term, we are to support everything listed + // here + ::std::vector< sal_Int32 > aSupportedFeatures; + sal_Int32 pSupportedFeatures[] = + { + SID_FM_RECORD_FIRST, + SID_FM_RECORD_NEXT, + SID_FM_RECORD_PREV, + SID_FM_RECORD_LAST, + SID_FM_RECORD_NEW, + SID_FM_RECORD_DELETE, + SID_FM_RECORD_ABSOLUTE, + SID_FM_RECORD_TOTAL, + SID_FM_RECORD_SAVE, + SID_FM_RECORD_UNDO, + SID_FM_REMOVE_FILTER_SORT, + SID_FM_SORTUP, + SID_FM_SORTDOWN, + SID_FM_ORDERCRIT, + SID_FM_AUTOFILTER, + SID_FM_FILTERCRIT, + SID_FM_FORM_FILTERED, + SID_FM_REFRESH, + SID_FM_REFRESH_FORM_CONTROL, + SID_FM_SEARCH, + SID_FM_FILTER_START, + SID_FM_VIEW_AS_GRID + }; + sal_Int32 nFeatureCount = sizeof( pSupportedFeatures ) / sizeof( pSupportedFeatures[ 0 ] ); + aSupportedFeatures.resize( nFeatureCount ); + ::std::copy( pSupportedFeatures, pSupportedFeatures + nFeatureCount, aSupportedFeatures.begin() ); + + m_pInvalidationCallback->invalidateFeatures( aSupportedFeatures ); + } + + //-------------------------------------------------------------------- + void SAL_CALL FormControllerHelper::errorOccured( const SQLErrorEvent& _Event ) throw (RuntimeException) + { + OSL_ENSURE( !m_aOperationError.hasValue(), "FormControllerHelper::errorOccured: two errors during one operation?" ); + m_aOperationError = _Event.Reason; + } + + //-------------------------------------------------------------------- + void SAL_CALL FormControllerHelper::disposing( const EventObject& /*_Source*/ ) throw (RuntimeException) + { + // not interested in + } + + //-------------------------------------------------------------------- + sal_Bool FormControllerHelper::isInsertionRow() const + { + sal_Bool bIs = sal_False; + if ( m_xFormOperations.is() ) + bIs = m_xFormOperations->isInsertionRow(); + return bIs; + } + + //-------------------------------------------------------------------- + sal_Bool FormControllerHelper::isModifiedRow() const + { + sal_Bool bIs = sal_False; + if ( m_xFormOperations.is() ) + bIs = m_xFormOperations->isModifiedRow(); + return bIs; + } + //-------------------------------------------------------------------- + bool FormControllerHelper::canDoFormFilter() const + { + if ( !m_xFormOperations.is() ) + return false; + + bool bCanDo = false; + try + { + Reference< XPropertySet > xCursorProperties( m_xFormOperations->getCursor(), UNO_QUERY_THROW ); + + bool bEscapeProcessing( false ); + OSL_VERIFY( xCursorProperties->getPropertyValue( FM_PROP_ESCAPE_PROCESSING ) >>= bEscapeProcessing ); + + ::rtl::OUString sActiveCommand; + OSL_VERIFY( xCursorProperties->getPropertyValue( FM_PROP_ACTIVECOMMAND ) >>= sActiveCommand ); + + bool bInsertOnlyForm( false ); + OSL_VERIFY( xCursorProperties->getPropertyValue( FM_PROP_INSERTONLY ) >>= bInsertOnlyForm ); + + bCanDo = bEscapeProcessing && ( sActiveCommand.getLength() > 0 ) && !bInsertOnlyForm; + } + catch( const Exception& ) + { + DBG_UNHANDLED_EXCEPTION(); + } + return bCanDo; + } + +//........................................................................ +} // namespace svx +//........................................................................ |