#98427# new services for recording

3 files changed, 611 insertions, 0 deletions

diff --git a/framework/source/recording/dispatchrecorder.cxx b/framework/source/recording/dispatchrecorder.cxx
new file mode 100644
index 000000000000..647cd484fae1
--- /dev/null
+++ b/framework/source/recording/dispatchrecorder.cxx
@@ -0,0 +1,266 @@
+
+#ifndef __FRAMEWORK_RECORDING_DISPATCHRECORDER_HXX_
+#include <recording/dispatchrecorder.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_WRITEGUARD_HXX_
+#include <threadhelp/writeguard.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_
+#include <threadhelp/readguard.hxx>
+#endif
+
+#ifndef __FRAMEWORK_SERVICES_H_
+#include <services.h>
+#endif
+
+#ifndef _SV_SVAPP_HXX
+#include <vcl/svapp.hxx>
+#endif
+
+namespace framework{
+
+//*****************************************************************************************************************
+//  XInterface, XTypeProvider, XServiceInfo
+//*****************************************************************************************************************
+DEFINE_XINTERFACE_3(
+    DispatchRecorder,
+    OWeakObject,
+    DIRECT_INTERFACE(css::lang::XTypeProvider),
+    DIRECT_INTERFACE(css::lang::XServiceInfo),
+    DIRECT_INTERFACE(css::frame::XDispatchRecorder))
+
+DEFINE_XTYPEPROVIDER_3(
+    DispatchRecorder,
+    css::lang::XTypeProvider,
+    css::lang::XServiceInfo,
+    css::frame::XDispatchRecorder)
+
+DEFINE_XSERVICEINFO_MULTISERVICE(
+    DispatchRecorder,
+    ::cppu::OWeakObject,
+    SERVICENAME_DISPATCHRECORDER,
+    IMPLEMENTATIONNAME_DISPATCHRECORDER)
+
+DEFINE_INIT_SERVICE(
+    DispatchRecorder,
+    {
+    }
+)
+
+//***********************************************************************
+DispatchRecorder::DispatchRecorder( const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR )
+        : ThreadHelpBase     ( &Application::GetSolarMutex() )
+        , ::cppu::OWeakObject(                               )
+        , m_xSMGR            ( xSMGR                         )
+{
+}
+
+//************************************************************************
+DispatchRecorder::~DispatchRecorder()
+{
+}
+
+//*************************************************************************
+// generate header
+void SAL_CALL DispatchRecorder::startRecording( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException )
+{
+    /* SAFE{ */
+    WriteGuard aWriteLock(m_aLock);
+
+    LOG_ASSERT2(m_aScriptBuffer.getLength()>0, "DispatchRecorder::startRecording()", "start without end called ... append new macro to old one!")
+    m_aScriptBuffer.ensureCapacity(10000);
+
+    m_aScriptBuffer.appendAscii("rem ----------------------------------------------------------------------\n");
+    m_aScriptBuffer.appendAscii("rem define variables\n");
+    m_aScriptBuffer.appendAscii("dim document   as object\n");
+    m_aScriptBuffer.appendAscii("dim dispatcher as object\n");
+    m_aScriptBuffer.appendAscii("dim parser     as object\n");
+    m_aScriptBuffer.appendAscii("dim url        as new com.sun.star.util.URL\n");
+    m_aScriptBuffer.appendAscii("rem ----------------------------------------------------------------------\n");
+    m_aScriptBuffer.appendAscii("rem get access to the document\n");
+    m_aScriptBuffer.appendAscii("document = ThisComponent.CurrentController.Frame\n");
+    m_aScriptBuffer.appendAscii("parser   = createUnoService(\"com.sun.star.util.URLTransformer\")\n\n");
+
+    m_nRecordingID = 1;
+    /* } */
+}
+
+//*************************************************************************
+void SAL_CALL DispatchRecorder::recordDispatch( const css::util::URL& aURL,
+                                                const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException )
+{
+    implts_recordMacro(aURL,lArguments,sal_False);
+}
+
+//*************************************************************************
+void SAL_CALL  DispatchRecorder::recordDispatchAsComment( const css::util::URL& aURL,
+                                                          const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::uno::RuntimeException )
+{
+    implts_recordMacro(aURL,lArguments,sal_True);
+}
+
+//*************************************************************************
+void SAL_CALL DispatchRecorder::endRecording() throw( css::uno::RuntimeException )
+{
+    /* SAFE{ */
+    WriteGuard aWriteLock(m_aLock);
+    m_sScript = m_aScriptBuffer.makeStringAndClear();
+    /* } */
+}
+
+//*************************************************************************
+::rtl::OUString SAL_CALL DispatchRecorder::getRecordedMacro() throw( css::uno::RuntimeException )
+{
+    /* SAFE{ */
+    ReadGuard aReadLock(m_aLock);
+    return m_sScript;
+    /* } */
+}
+
+//*************************************************************************
+void SAL_CALL DispatchRecorder::implts_recordMacro( const css::util::URL& aURL,
+                                                    const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
+                                                          sal_Bool bAsComment )
+{
+    ::rtl::OUStringBuffer aArgumentBuffer(1000);
+    ::rtl::OUStringBuffer aScriptBuffer(1000);
+    ::rtl::OUString       sArrayName;
+
+    aScriptBuffer.appendAscii("rem ----------------------------------------------------------------------\n");
+    aScriptBuffer.appendAscii("rem dispatch\n");
+
+    sal_Int32 nLength = lArguments.getLength();
+    sal_Int32 nValidArgs = 0;
+    for( sal_Int32 i=0; i<nLength; ++i )
+    {
+        if(lArguments[i].Value.hasValue())
+        {
+            // this value is used to name the arrays of aArgumentBuffer
+            if(sArrayName.getLength()<1)
+            {
+                sArrayName = ::rtl::OUString::createFromAscii("args");
+                sArrayName += ::rtl::OUString::valueOf((sal_Int32)m_nRecordingID);
+            }
+
+            ++nValidArgs;
+
+            // add arg().Name
+            if(bAsComment)
+                aArgumentBuffer.appendAscii("rem ");
+            aArgumentBuffer.append     (sArrayName);
+            aArgumentBuffer.appendAscii("(");
+            aArgumentBuffer.append     (i);
+            aArgumentBuffer.appendAscii(").Name = \"");
+            aArgumentBuffer.append     (lArguments[i].Name);
+            aArgumentBuffer.appendAscii("\"\n");
+
+            // add arg().Value
+            if(bAsComment)
+                aArgumentBuffer.appendAscii("rem ");
+            aArgumentBuffer.append     (sArrayName);
+            aArgumentBuffer.appendAscii("(");
+            aArgumentBuffer.append     (i);
+            aArgumentBuffer.appendAscii(").Value = ");
+
+            // if value == bool
+            if (lArguments[i].Value.getValueType() == getBooleanCppuType())
+            {
+                sal_Bool bVal;
+                lArguments[i].Value >>= bVal;
+                if (bVal)
+                    aArgumentBuffer.appendAscii("true");
+                else
+                    aArgumentBuffer.appendAscii("false");
+            }
+            else
+            // if value == sal_Int16
+            if (lArguments[i].Value.getValueType() == getCppuType((sal_Int16*)0))
+            {
+                sal_Int16 nVal;
+                lArguments[i].Value >>= nVal;
+                aArgumentBuffer.append((sal_Int32)nVal);
+            }
+            else
+            // if value == sal_Int32
+            if (lArguments[i].Value.getValueType() == getCppuType((sal_Int32*)0))
+            {
+                sal_Int32 nVal;
+                lArguments[i].Value >>= nVal;
+                aArgumentBuffer.append((sal_Int32)nVal);
+            }
+            else
+            // if value == float
+            if (lArguments[i].Value.getValueType() == getCppuType((float*)0))
+            {
+                float fVal;
+                lArguments[i].Value >>= fVal;
+                aArgumentBuffer.append(fVal);
+            }
+            else
+            // if value == double
+            if (lArguments[i].Value.getValueType() == getCppuType((double*)0))
+            {
+                double fVal;
+                lArguments[i].Value >>= fVal;
+                aArgumentBuffer.append(fVal);
+            }
+            else
+            // if value == string
+            if (lArguments[i].Value.getValueType() == getCppuType((::rtl::OUString*)0))
+            {
+                ::rtl::OUString sVal;
+                lArguments[i].Value >>= sVal;
+                aArgumentBuffer.appendAscii("\"");
+                aArgumentBuffer.append     (sVal);
+                aArgumentBuffer.appendAscii("\"");
+            }
+
+            aArgumentBuffer.appendAscii("\n");
+        }
+    }
+
+    // if aArgumentBuffer exist - pack it into the aScriptBuffer
+    if(nValidArgs>0)
+    {
+        if(bAsComment)
+            aArgumentBuffer.appendAscii("rem ");
+        aScriptBuffer.appendAscii("dim ");
+        aScriptBuffer.append     (sArrayName);
+        aScriptBuffer.appendAscii("(");
+        aScriptBuffer.append     ((sal_Int32)(nValidArgs-1)); // 0 based!
+        aScriptBuffer.appendAscii(") as new com.sun.star.beans.PropertyValue\n");
+        aScriptBuffer.append     (aArgumentBuffer.makeStringAndClear());
+        aScriptBuffer.appendAscii("\n");
+    }
+
+    // add code for parsing urls
+    if(bAsComment)
+        aArgumentBuffer.appendAscii("rem ");
+    aScriptBuffer.appendAscii("url.Complete = \"");
+    aScriptBuffer.append     (aURL.Complete);
+    aScriptBuffer.appendAscii("\"\n");
+    if(bAsComment)
+        aArgumentBuffer.appendAscii("rem ");
+    aScriptBuffer.appendAscii("parser.parseStrict(url)\n");
+
+    // add code for dispatches
+    if(bAsComment)
+        aArgumentBuffer.appendAscii("rem ");
+    aScriptBuffer.appendAscii("disp = document.queryDispatch(url,\"\",0)\n");
+    if(bAsComment)
+        aArgumentBuffer.appendAscii("rem ");
+    if(nValidArgs<1)
+        aScriptBuffer.appendAscii("disp.dispatch(url,noargs())\n");
+    else
+        aScriptBuffer.appendAscii("disp.dispatch(url,args())\n");
+    aScriptBuffer.appendAscii("\n");
+
+    /* SAFE { */
+    m_aScriptBuffer.append(aScriptBuffer.makeStringAndClear());
+    m_nRecordingID++;
+    /* } */
+}
+
+} // namespace framework
diff --git a/framework/source/recording/dispatchrecordersupplier.cxx b/framework/source/recording/dispatchrecordersupplier.cxx
new file mode 100644
index 000000000000..89da0da32ea3
--- /dev/null
+++ b/framework/source/recording/dispatchrecordersupplier.cxx
@@ -0,0 +1,261 @@
+/*************************************************************************
+ *
+ *  $RCSfile: dispatchrecordersupplier.cxx,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: as $ $Date: 2002-04-22 13:49:47 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library 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 for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+//_________________________________________________________________________________________________________________
+// include own things
+
+#ifndef __FRAMEWORK_RECORDING_DISPATCHRECORDERSUPPLIER_HXX_
+#include <recording/dispatchrecordersupplier.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_WRITEGUARD_HXX_
+#include <threadhelp/writeguard.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_
+#include <threadhelp/readguard.hxx>
+#endif
+
+#ifndef __FRAMEWORK_SERVICES_H_
+#include <services.h>
+#endif
+
+//_________________________________________________________________________________________________________________
+// include interfaces
+
+#ifndef _COM_SUN_STAR_FRAME_XRECORDABLEDISPATCH_HPP_
+#include <com/sun/star/frame/XRecordableDispatch.hpp>
+#endif
+
+//_________________________________________________________________________________________________________________
+// include other projects
+
+#ifndef _SV_SVAPP_HXX
+#include <vcl/svapp.hxx>
+#endif
+
+//_________________________________________________________________________________________________________________
+// namespace
+
+namespace framework{
+
+//_________________________________________________________________________________________________________________
+// non exported const
+
+//_________________________________________________________________________________________________________________
+// non exported definitions
+
+//_________________________________________________________________________________________________________________
+// declarations
+
+//*****************************************************************************************************************
+//  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,
+    SERVICENAME_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 informations!
+        */
+    }
+)
+
+//_____________________________________________________________________________
+/**
+    @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_xFactory         ( xFactory                      )
+        , m_xDispatchRecorder( NULL                          )
+{
+}
+
+//_____________________________________________________________________________
+/**
+    @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 informations)
+    @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
+
+    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
diff --git a/framework/source/recording/makefile.mk b/framework/source/recording/makefile.mk
new file mode 100644
index 000000000000..cf6ee77b8f16
--- /dev/null
+++ b/framework/source/recording/makefile.mk
@@ -0,0 +1,84 @@
+#*************************************************************************
+#
+#   $RCSfile: makefile.mk,v $
+#
+#   $Revision: 1.1 $
+#
+#   last change: $Author: as $ $Date: 2002-04-22 13:50:11 $
+#
+#   The Contents of this file are made available subject to the terms of
+#   either of the following licenses
+#
+#          - GNU Lesser General Public License Version 2.1
+#          - Sun Industry Standards Source License Version 1.1
+#
+#   Sun Microsystems Inc., October, 2000
+#
+#   GNU Lesser General Public License Version 2.1
+#   =============================================
+#   Copyright 2000 by Sun Microsystems, Inc.
+#   901 San Antonio Road, Palo Alto, CA 94303, USA
+#
+#   This library is free software; you can redistribute it and/or
+#   modify it under the terms of the GNU Lesser General Public
+#   License version 2.1, as published by the Free Software Foundation.
+#
+#   This library 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 for more details.
+#
+#   You should have received a copy of the GNU Lesser General Public
+#   License along with this library; if not, write to the Free Software
+#   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+#   MA  02111-1307  USA
+#
+#
+#   Sun Industry Standards Source License Version 1.1
+#   =================================================
+#   The contents of this file are subject to the Sun Industry Standards
+#   Source License Version 1.1 (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.openoffice.org/license.html.
+#
+#   Software provided under this License is provided on an "AS IS" basis,
+#   WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+#   WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+#   MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+#   See the License for the specific provisions governing your rights and
+#   obligations concerning the Software.
+#
+#   The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+#
+#   Copyright: 2000 by Sun Microsystems, Inc.
+#
+#   All Rights Reserved.
+#
+#   Contributor(s): _______________________________________
+#
+#
+#
+#*************************************************************************
+
+PRJ=..$/..
+
+PRJNAME=framework
+TARGET=recording
+ENABLE_EXCEPTIONS=TRUE
+NO_BSYMBOLIC=TRUE
+
+# --- Settings -----------------------------------------------------
+
+.INCLUDE :  svpre.mk
+.INCLUDE :  settings.mk
+.INCLUDE :  sv.mk
+
+# --- Files --------------------------------------------------------
+
+SLOFILES =\
+    $(SLO)$/dispatchrecordersupplier.obj\
+    $(SLO)$/dispatchrecorder.obj
+
+# --- Targets ------------------------------------------------------
+
+.INCLUDE :  target.mk