194 lines
7.8 KiB
C++
194 lines
7.8 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 <recording/dispatchrecordersupplier.hxx>
|
|
#include <threadhelp/writeguard.hxx>
|
|
#include <threadhelp/readguard.hxx>
|
|
#include <services.h>
|
|
|
|
#include <com/sun/star/frame/XRecordableDispatch.hpp>
|
|
|
|
#include <vcl/svapp.hxx>
|
|
|
|
namespace framework{
|
|
|
|
//*****************************************************************************************************************
|
|
// XInterface, XTypeProvider
|
|
//*****************************************************************************************************************
|
|
DEFINE_XINTERFACE_3(
|
|
DispatchRecorderSupplier,
|
|
OWeakObject,
|
|
DIRECT_INTERFACE(css::lang::XTypeProvider),
|
|
DIRECT_INTERFACE(css::lang::XServiceInfo),
|
|
DIRECT_INTERFACE(css::frame::XDispatchRecorderSupplier))
|
|
|
|
DEFINE_XTYPEPROVIDER_3(
|
|
DispatchRecorderSupplier,
|
|
css::lang::XTypeProvider,
|
|
css::lang::XServiceInfo,
|
|
css::frame::XDispatchRecorderSupplier)
|
|
|
|
DEFINE_XSERVICEINFO_MULTISERVICE(
|
|
DispatchRecorderSupplier,
|
|
::cppu::OWeakObject,
|
|
"com.sun.star.frame.DispatchRecorderSupplier",
|
|
IMPLEMENTATIONNAME_DISPATCHRECORDERSUPPLIER)
|
|
|
|
DEFINE_INIT_SERVICE(
|
|
DispatchRecorderSupplier,
|
|
{
|
|
/*Attention
|
|
I think we don't need any mutex or lock here ... because we are called by our own static method impl_createInstance()
|
|
to create a new instance of this class by our own supported service factory.
|
|
see macro DEFINE_XSERVICEINFO_MULTISERVICE and "impl_initService()" for further information!
|
|
*/
|
|
}
|
|
)
|
|
|
|
//_____________________________________________________________________________
|
|
/**
|
|
@short standard constructor to create instance
|
|
@descr Because an instance will be initialized by her interface methods
|
|
it's not neccessary to do anything here.
|
|
*/
|
|
DispatchRecorderSupplier::DispatchRecorderSupplier( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory )
|
|
// init baseclasses first!
|
|
// Attention: Don't change order of initialization!
|
|
: ThreadHelpBase ( &Application::GetSolarMutex() )
|
|
, ::cppu::OWeakObject( )
|
|
// init member
|
|
, m_xDispatchRecorder( NULL )
|
|
, m_xFactory ( xFactory )
|
|
{
|
|
}
|
|
|
|
//_____________________________________________________________________________
|
|
/**
|
|
@short standard destructor
|
|
@descr We are a helper and not a real service. So we doesn't provide
|
|
dispose() functionality. This supplier dies by ref count mechanism
|
|
and should release all internal used ones too.
|
|
*/
|
|
DispatchRecorderSupplier::~DispatchRecorderSupplier()
|
|
{
|
|
m_xFactory = NULL;
|
|
m_xDispatchRecorder = NULL;
|
|
}
|
|
|
|
//_____________________________________________________________________________
|
|
/**
|
|
@short set a new dispatch recorder on this supplier
|
|
@descr Because there can exist more then one recorder implementations
|
|
(to generate java/basic/... scripts from recorded data) it must
|
|
be possible to set it on a supplier.
|
|
|
|
@see getDispatchRecorder()
|
|
|
|
@param xRecorder
|
|
the new recorder to set it
|
|
<br><NULL/> isn't recommended, because recording without a
|
|
valid recorder can't work. But it's not checked here. So user
|
|
of this supplier can decide that without changing this
|
|
implementation.
|
|
|
|
@change 09.04.2002 by Andreas Schluens
|
|
*/
|
|
void SAL_CALL DispatchRecorderSupplier::setDispatchRecorder( const css::uno::Reference< css::frame::XDispatchRecorder >& xRecorder ) throw (css::uno::RuntimeException)
|
|
{
|
|
// SAFE =>
|
|
WriteGuard aWriteLock(m_aLock);
|
|
m_xDispatchRecorder=xRecorder;
|
|
// => SAFE
|
|
}
|
|
//_____________________________________________________________________________
|
|
/**
|
|
@short provides access to the dispatch recorder of this supplier
|
|
@descr Such recorder can be used outside to record dispatches.
|
|
But normaly he is used internaly only. Of course he must used
|
|
from outside to get the recorded data e.g. for saving it as a
|
|
script.
|
|
|
|
@see setDispatchRecorder()
|
|
|
|
@return the internal used dispatch recorder
|
|
<br>May it can be <NULL/> if no one was set before.
|
|
|
|
@change 09.04.2002 by Andreas Schluens
|
|
*/
|
|
css::uno::Reference< css::frame::XDispatchRecorder > SAL_CALL DispatchRecorderSupplier::getDispatchRecorder() throw (css::uno::RuntimeException)
|
|
{
|
|
// SAFE =>
|
|
ReadGuard aReadLock(m_aLock);
|
|
return m_xDispatchRecorder;
|
|
// => SAFE
|
|
}
|
|
|
|
//_____________________________________________________________________________
|
|
/**
|
|
@short execute a dispatch request and record it
|
|
@descr If given dispatch object provides right recording interface it
|
|
will be used. If it's not supported it record the pure dispatch
|
|
parameters only. There is no code neither the possibility to
|
|
check if recording is enabled or not.
|
|
|
|
@param aURL the command URL
|
|
@param lArguments optional arguments (see com.sun.star.document.MediaDescriptor for further information)
|
|
@param xDispatcher the original dispatch object which should be recorded
|
|
|
|
@change 09.04.2002 by Andreas Schluens
|
|
*/
|
|
void SAL_CALL DispatchRecorderSupplier::dispatchAndRecord( const css::util::URL& aURL ,
|
|
const css::uno::Sequence< css::beans::PropertyValue >& lArguments ,
|
|
const css::uno::Reference< css::frame::XDispatch >& xDispatcher ) throw (css::uno::RuntimeException)
|
|
{
|
|
// SAFE =>
|
|
ReadGuard aReadLock(m_aLock);
|
|
css::uno::Reference< css::frame::XDispatchRecorder > xRecorder = m_xDispatchRecorder;
|
|
aReadLock.unlock();
|
|
// => SAFE
|
|
|
|
// clear unspecific situations
|
|
if (!xDispatcher.is())
|
|
throw css::uno::RuntimeException(DECLARE_ASCII("specification violation: dispatcher is NULL"), static_cast< ::cppu::OWeakObject* >(this));
|
|
|
|
if (!xRecorder.is())
|
|
throw css::uno::RuntimeException(DECLARE_ASCII("specification violation: no valid dispatch recorder available"), static_cast< ::cppu::OWeakObject* >(this));
|
|
|
|
// check, if given dispatch supports record functionality by itself ...
|
|
// or must be wrapped.
|
|
css::uno::Reference< css::frame::XRecordableDispatch > xRecordable(
|
|
xDispatcher,
|
|
css::uno::UNO_QUERY);
|
|
|
|
if (xRecordable.is())
|
|
xRecordable->dispatchAndRecord(aURL,lArguments,xRecorder);
|
|
else
|
|
{
|
|
// There is no reason to wait for information about success
|
|
// of this request. Because status information of a dispatch
|
|
// are not guaranteed. So we execute it and record used
|
|
// parameters only.
|
|
xDispatcher->dispatch(aURL,lArguments);
|
|
xRecorder->recordDispatch(aURL,lArguments);
|
|
}
|
|
}
|
|
|
|
} // namespace framework
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|