| /************************************************************** | |
| * | |
| * 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 | |
| * | |
| * Unless required by applicable law or agreed to in writing, | |
| * software distributed under the License is distributed on an | |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| * KIND, either express or implied. See the License for the | |
| * specific language governing permissions and limitations | |
| * under the License. | |
| * | |
| *************************************************************/ | |
| // MARKER(update_precomp.py): autogen include statement, do not remove | |
| #include "precompiled_framework.hxx" | |
| //_______________________________________________ | |
| // my own includes | |
| #include <services/dispatchhelper.hxx> | |
| #include <threadhelp/readguard.hxx> | |
| #include <threadhelp/writeguard.hxx> | |
| #include <services.h> | |
| //_______________________________________________ | |
| // interface includes | |
| #include <com/sun/star/util/XURLTransformer.hpp> | |
| #include <com/sun/star/frame/XNotifyingDispatch.hpp> | |
| //_______________________________________________ | |
| // includes of other projects | |
| //_______________________________________________ | |
| // namespace | |
| namespace framework{ | |
| //_______________________________________________ | |
| // non exported const | |
| //_______________________________________________ | |
| // non exported definitions | |
| //_______________________________________________ | |
| // declarations | |
| //_______________________________________________ | |
| // XInterface, XTypeProvider, XServiceInfo | |
| DEFINE_XSERVICEINFO_MULTISERVICE(DispatchHelper , | |
| ::cppu::OWeakObject , | |
| SERVICENAME_DISPATCHHELPER , | |
| IMPLEMENTATIONNAME_DISPATCHHELPER) | |
| DEFINE_INIT_SERVICE( DispatchHelper, {} ) | |
| //_______________________________________________ | |
| /** ctor. | |
| @param xSMGR the global uno service manager, which can be used to create own needed services. | |
| */ | |
| DispatchHelper::DispatchHelper( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR ) | |
| : ThreadHelpBase( ) | |
| // Init member | |
| , m_xSMGR (xSMGR) | |
| { | |
| } | |
| //_______________________________________________ | |
| /** dtor. | |
| */ | |
| DispatchHelper::~DispatchHelper() | |
| { | |
| } | |
| //_______________________________________________ | |
| /** capsulate all steps of a dispatch request and provide so an easy way for dispatches. | |
| @param xDispatchProvider | |
| identifies the object, which provides may be valid dispatch objects for this execute. | |
| @param sURL | |
| describes the requested feature. | |
| @param sTargetFrameName | |
| points to the frame, which must be used (or may be created) for this dispatch. | |
| @param nSearchFlags | |
| in case the <var>sTargetFrameName</var> isn't unique, these flags regulate further searches. | |
| @param lArguments | |
| optional arguments for this request. | |
| @return An Any which capsulate a possible result of the internal wrapped dispatch. | |
| */ | |
| css::uno::Any SAL_CALL DispatchHelper::executeDispatch( | |
| const css::uno::Reference< css::frame::XDispatchProvider >& xDispatchProvider , | |
| const ::rtl::OUString& sURL , | |
| const ::rtl::OUString& sTargetFrameName , | |
| sal_Int32 nSearchFlags , | |
| const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) | |
| { | |
| css::uno::Reference< css::uno::XInterface > xTHIS(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY); | |
| // check for valid parameters | |
| if ( | |
| (!xDispatchProvider.is()) || | |
| (sURL.getLength()<1 ) | |
| ) | |
| { | |
| return css::uno::Any(); | |
| } | |
| // parse given URL | |
| /* SAFE { */ | |
| ReadGuard aReadLock(m_aLock); | |
| css::uno::Reference< css::util::XURLTransformer > xParser(m_xSMGR->createInstance(SERVICENAME_URLTRANSFORMER), css::uno::UNO_QUERY); | |
| aReadLock.unlock(); | |
| /* } SAFE */ | |
| css::util::URL aURL; | |
| aURL.Complete = sURL; | |
| xParser->parseStrict(aURL); | |
| // search dispatcher | |
| css::uno::Reference< css::frame::XDispatch > xDispatch = xDispatchProvider->queryDispatch(aURL, sTargetFrameName, nSearchFlags); | |
| css::uno::Reference< css::frame::XNotifyingDispatch > xNotifyDispatch (xDispatch, css::uno::UNO_QUERY); | |
| // make sure that synchronous execution is used (if possible) | |
| css::uno::Sequence< css::beans::PropertyValue > aArguments( lArguments ); | |
| sal_Int32 nLength = lArguments.getLength(); | |
| aArguments.realloc( nLength + 1 ); | |
| aArguments[ nLength ].Name = ::rtl::OUString::createFromAscii("SynchronMode"); | |
| aArguments[ nLength ].Value <<= (sal_Bool) sal_True; | |
| css::uno::Any aResult; | |
| if (xNotifyDispatch.is()) | |
| { | |
| // dispatch it with guaranteed notification | |
| // Here we can hope for a result ... instead of the normal dispatch. | |
| css::uno::Reference< css::frame::XDispatchResultListener > xListener(xTHIS, css::uno::UNO_QUERY); | |
| /* SAFE { */ | |
| WriteGuard aWriteLock(m_aLock); | |
| m_xBroadcaster = css::uno::Reference< css::uno::XInterface >(xNotifyDispatch, css::uno::UNO_QUERY); | |
| m_aResult = css::uno::Any(); | |
| m_aBlock.reset(); | |
| aWriteLock.unlock(); | |
| /* } SAFE */ | |
| // dispatch it and wait for a notification | |
| // TODO/MBA: waiting in main thread?! | |
| xNotifyDispatch->dispatchWithNotification(aURL, aArguments, xListener); | |
| //m_aBlock.wait(); | |
| aResult = m_aResult; | |
| } | |
| else | |
| if (xDispatch.is()) | |
| { | |
| // dispatch it without any chance to get a result | |
| xDispatch->dispatch( aURL, aArguments ); | |
| } | |
| return aResult; | |
| } | |
| //_______________________________________________ | |
| /** callback for started dispatch with guaranteed notifications. | |
| We must save the result, so the method executeDispatch() can return it. | |
| Further we must release the broadcaster (otherwise it can't die) | |
| and unblock the waiting executeDispatch() request. | |
| @param aResult | |
| describes the result of the dispatch operation | |
| */ | |
| void SAL_CALL DispatchHelper::dispatchFinished( const css::frame::DispatchResultEvent& aResult ) | |
| { | |
| /* SAFE { */ | |
| WriteGuard aWriteLock(m_aLock); | |
| m_aResult <<= aResult; | |
| m_aBlock.set(); | |
| m_xBroadcaster.clear(); | |
| /* } SAFE */ | |
| } | |
| //_______________________________________________ | |
| /** we have to release our broadcaster reference. | |
| @param aEvent | |
| describe the source of this event and MUST be our save broadcaster! | |
| */ | |
| void SAL_CALL DispatchHelper::disposing( const css::lang::EventObject& ) | |
| { | |
| /* SAFE { */ | |
| WriteGuard aWriteLock(m_aLock); | |
| m_aResult.clear(); | |
| m_aBlock.set(); | |
| m_xBroadcaster.clear(); | |
| /* } SAFE */ | |
| } | |
| } |