framework/source/recording/dispatchrecordersupplier.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <recording/dispatchrecordersupplier.hxx>
  21
  22 #include <com/sun/star/frame/XRecordableDispatch.hpp>
  23
  24 #include <vcl/svapp.hxx>
  25 #include <cppuhelper/supportsservice.hxx>
  26
  27 namespace framework{
  28
  29 // XInterface, XTypeProvider, XServiceInfo
  30
  31 OUString SAL_CALL DispatchRecorderSupplier::getImplementationName()
  32 {
  33     return "com.sun.star.comp.framework.DispatchRecorderSupplier";
  34 }
  35
  36 sal_Bool SAL_CALL DispatchRecorderSupplier::supportsService( const OUString& sServiceName )
  37 {
  38     return cppu::supportsService(this, sServiceName);
  39 }
  40
  41 css::uno::Sequence< OUString > SAL_CALL DispatchRecorderSupplier::getSupportedServiceNames()
  42 {
  43     return { "com.sun.star.frame.DispatchRecorderSupplier" };
  44 }
  45
  46
  47 DispatchRecorderSupplier::DispatchRecorderSupplier()
  48 {
  49 }
  50
  51 /**
  52     @short  standard destructor
  53     @descr  We are a helper and not a real service. So we don't provide
  54             dispose() functionality. This supplier dies by ref count mechanism
  55             and should release all internal used ones too.
  56  */
  57 DispatchRecorderSupplier::~DispatchRecorderSupplier()
  58 {
  59     m_xDispatchRecorder = nullptr;
  60 }
  61
  62 /**
  63     @short      set a new dispatch recorder on this supplier
  64     @descr      Because there can exist more than one recorder implementations
  65                 (to generate java/basic/... scripts from recorded data) it must
  66                 be possible to set it on a supplier.
  67
  68     @see        getDispatchRecorder()
  69
  70     @param      xRecorder
  71                 the new recorder to set it
  72                 <br><NULL/> isn't recommended, because recording without a
  73                 valid recorder can't work. But it's not checked here. So user
  74                 of this supplier can decide that without changing this
  75                 implementation.
  76
  77     @change     09.04.2002 by Andreas Schluens
  78  */
  79 void SAL_CALL DispatchRecorderSupplier::setDispatchRecorder( const css::uno::Reference< css::frame::XDispatchRecorder >& xRecorder )
  80 {
  81     SolarMutexGuard g;
  82     m_xDispatchRecorder=xRecorder;
  83 }
  84
  85 /**
  86     @short      provides access to the dispatch recorder of this supplier
  87     @descr      Such recorder can be used outside to record dispatches.
  88                 But normally he is used internally only. Of course he must used
  89                 from outside to get the recorded data e.g. for saving it as a
  90                 script.
  91
  92     @see        setDispatchRecorder()
  93
  94     @return     the internal used dispatch recorder
  95                 <br>May it can be <NULL/> if no one was set before.
  96
  97     @change     09.04.2002 by Andreas Schluens
  98  */
  99 css::uno::Reference< css::frame::XDispatchRecorder > SAL_CALL DispatchRecorderSupplier::getDispatchRecorder()
 100 {
 101     SolarMutexGuard g;
 102     return m_xDispatchRecorder;
 103 }
 104
 105 /**
 106     @short      execute a dispatch request and record it
 107     @descr      If given dispatch object provides right recording interface it
 108                 will be used. If it's not supported it record the pure dispatch
 109                 parameters only. There is no code neither the possibility to
 110                 check if recording is enabled or not.
 111
 112     @param      aURL            the command URL
 113     @param      lArguments      optional arguments (see com.sun.star.document.MediaDescriptor for further information)
 114     @param      xDispatcher     the original dispatch object which should be recorded
 115
 116     @change     09.04.2002 by Andreas Schluens
 117  */
 118 void SAL_CALL DispatchRecorderSupplier::dispatchAndRecord( const css::util::URL&                                  aURL        ,
 119                                                            const css::uno::Sequence< css::beans::PropertyValue >& lArguments  ,
 120                                                            const css::uno::Reference< css::frame::XDispatch >&    xDispatcher )
 121 {
 122     SolarMutexClearableGuard aReadLock;
 123     css::uno::Reference< css::frame::XDispatchRecorder > xRecorder = m_xDispatchRecorder;
 124     aReadLock.clear();
 125
 126     // clear unspecific situations
 127     if (!xDispatcher.is())
 128         throw css::uno::RuntimeException("specification violation: dispatcher is NULL", static_cast< ::cppu::OWeakObject* >(this));
 129
 130     if (!xRecorder.is())
 131         throw css::uno::RuntimeException("specification violation: no valid dispatch recorder available", static_cast< ::cppu::OWeakObject* >(this));
 132
 133     // check, if given dispatch supports record functionality by itself ...
 134     // or must be wrapped.
 135     css::uno::Reference< css::frame::XRecordableDispatch > xRecordable(
 136         xDispatcher,
 137         css::uno::UNO_QUERY);
 138
 139     if (xRecordable.is())
 140         xRecordable->dispatchAndRecord(aURL,lArguments,xRecorder);
 141     else
 142     {
 143         // There is no reason to wait for information about success
 144         // of this request. Because status information of a dispatch
 145         // are not guaranteed. So we execute it and record used
 146         // parameters only.
 147         xDispatcher->dispatch(aURL,lArguments);
 148         xRecorder->recordDispatch(aURL,lArguments);
 149     }
 150 }
 151
 152 }   // namespace framework
 153
 154 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 155 framework_DispatchRecorderSupplier_get_implementation(
 156     css::uno::XComponentContext* , css::uno::Sequence<css::uno::Any> const& )
 157 {
 158     return cppu::acquire(new framework::DispatchRecorderSupplier());
 159 }
 160
 161 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */