Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 399 insertions, 0 deletions

diff --git a/sc/source/ui/vba/excelvbahelper.cxx b/sc/source/ui/vba/excelvbahelper.cxx
new file mode 100644
index 000000000..317b06454
--- /dev/null
+++ b/sc/source/ui/vba/excelvbahelper.cxx
@@ -0,0 +1,399 @@
+/* -*- 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 "excelvbahelper.hxx"
+
+#include <basic/basmgr.hxx>
+#include <comphelper/processfactory.hxx>
+#include <vbahelper/vbahelper.hxx>
+#include <com/sun/star/frame/XModel.hpp>
+#include <com/sun/star/sheet/XSheetCellRange.hpp>
+#include <com/sun/star/sheet/GlobalSheetSettings.hpp>
+#include <com/sun/star/sheet/XUnnamedDatabaseRanges.hpp>
+#include <com/sun/star/sheet/XSpreadsheet.hpp>
+#include <com/sun/star/sheet/XDatabaseRange.hpp>
+
+#include <document.hxx>
+#include <docuno.hxx>
+#include <tabvwsh.hxx>
+#include <transobj.hxx>
+#include <cellsuno.hxx>
+#include <gridwin.hxx>
+
+#include <com/sun/star/script/vba/VBAEventId.hpp>
+#include <com/sun/star/script/vba/XVBACompatibility.hpp>
+#include <com/sun/star/script/vba/XVBAEventProcessor.hpp>
+#include <com/sun/star/script/vba/XVBAModuleInfo.hpp>
+#include <com/sun/star/script/ModuleInfo.hpp>
+#include <com/sun/star/script/ModuleType.hpp>
+
+using namespace ::com::sun::star;
+using namespace ::ooo::vba;
+
+namespace ooo::vba::excel {
+
+uno::Reference< sheet::XUnnamedDatabaseRanges >
+GetUnnamedDataBaseRanges( const ScDocShell* pShell )
+{
+    uno::Reference< frame::XModel > xModel;
+    if ( pShell )
+        xModel.set( pShell->GetModel(), uno::UNO_SET_THROW );
+    uno::Reference< beans::XPropertySet > xModelProps( xModel, uno::UNO_QUERY_THROW );
+    uno::Reference< sheet::XUnnamedDatabaseRanges > xUnnamedDBRanges( xModelProps->getPropertyValue("UnnamedDatabaseRanges"), uno::UNO_QUERY_THROW );
+    return xUnnamedDBRanges;
+}
+
+// returns the XDatabaseRange for the autofilter on sheet (nSheet)
+// also populates sName with the name of range
+uno::Reference< sheet::XDatabaseRange >
+GetAutoFiltRange( const ScDocShell* pShell, sal_Int16 nSheet )
+{
+    uno::Reference< sheet::XUnnamedDatabaseRanges > xUnnamedDBRanges( GetUnnamedDataBaseRanges( pShell ), uno::UNO_SET_THROW );
+    uno::Reference< sheet::XDatabaseRange > xDataBaseRange;
+    if (xUnnamedDBRanges->hasByTable( nSheet ) )
+    {
+        uno::Reference< sheet::XDatabaseRange > xDBRange( xUnnamedDBRanges->getByTable( nSheet ) , uno::UNO_QUERY_THROW );
+        bool bHasAuto = false;
+        uno::Reference< beans::XPropertySet > xProps( xDBRange, uno::UNO_QUERY_THROW );
+        xProps->getPropertyValue("AutoFilter") >>= bHasAuto;
+        if ( bHasAuto )
+        {
+            xDataBaseRange=xDBRange;
+        }
+    }
+    return xDataBaseRange;
+}
+
+ScDocShell* GetDocShellFromRange( const uno::Reference< uno::XInterface >& xRange )
+{
+    ScCellRangesBase* pScCellRangesBase = comphelper::getFromUnoTunnel<ScCellRangesBase>( xRange );
+    if ( !pScCellRangesBase )
+    {
+        throw uno::RuntimeException("Failed to access underlying doc shell uno range object" );
+    }
+    return pScCellRangesBase->GetDocShell();
+}
+
+uno::Reference< XHelperInterface >
+getUnoSheetModuleObj( const uno::Reference< table::XCellRange >& xRange )
+{
+    uno::Reference< sheet::XSheetCellRange > xSheetRange( xRange, uno::UNO_QUERY_THROW );
+    uno::Reference< sheet::XSpreadsheet > xSheet( xSheetRange->getSpreadsheet(), uno::UNO_SET_THROW );
+    return getUnoSheetModuleObj( xSheet );
+}
+
+void implSetZoom( const uno::Reference< frame::XModel >& xModel, sal_Int16 nZoom, std::vector< SCTAB >& nTabs )
+{
+    ScTabViewShell* pViewSh = excel::getBestViewShell( xModel );
+    Fraction aFract( nZoom, 100 );
+    pViewSh->GetViewData().SetZoom( aFract, aFract, nTabs );
+    pViewSh->RefreshZoom();
+}
+
+namespace {
+
+class PasteCellsWarningReseter
+{
+private:
+    bool bInitialWarningState;
+    /// @throws uno::RuntimeException
+    static uno::Reference< sheet::XGlobalSheetSettings > const & getGlobalSheetSettings()
+    {
+        static uno::Reference< sheet::XGlobalSheetSettings > xProps = sheet::GlobalSheetSettings::create( comphelper::getProcessComponentContext() );
+        return xProps;
+    }
+
+    /// @throws uno::RuntimeException
+    static bool getReplaceCellsWarning()
+    {
+        return getGlobalSheetSettings()->getReplaceCellsWarning();
+    }
+
+    /// @throws uno::RuntimeException
+    static void setReplaceCellsWarning( bool bState )
+    {
+        getGlobalSheetSettings()->setReplaceCellsWarning( bState );
+    }
+public:
+    /// @throws uno::RuntimeException
+    PasteCellsWarningReseter()
+    {
+        bInitialWarningState = getReplaceCellsWarning();
+        if ( bInitialWarningState )
+            setReplaceCellsWarning( false );
+    }
+    ~PasteCellsWarningReseter()
+    {
+        if ( bInitialWarningState )
+        {
+            // don't allow dtor to throw
+            try
+            {
+                setReplaceCellsWarning( true );
+            }
+            catch ( uno::Exception& /*e*/ ){}
+        }
+    }
+};
+
+}
+
+void
+implnPaste( const uno::Reference< frame::XModel>& xModel )
+{
+    PasteCellsWarningReseter resetWarningBox;
+    ScTabViewShell* pViewShell = getBestViewShell( xModel );
+    if ( pViewShell )
+    {
+        pViewShell->PasteFromSystem();
+        pViewShell->CellContentChanged();
+    }
+}
+
+void
+implnCopy( const uno::Reference< frame::XModel>& xModel )
+{
+    ScTabViewShell* pViewShell = getBestViewShell( xModel );
+    ScDocShell* pDocShell = getDocShell( xModel );
+    if ( !(pViewShell && pDocShell) )
+        return;
+
+    pViewShell->CopyToClip(nullptr,false,false,true);
+
+    // mark the copied transfer object so it is used in ScVbaRange::Insert
+    uno::Reference<datatransfer::XTransferable2> xTransferable(ScTabViewShell::GetClipData(pViewShell->GetViewData().GetActiveWin()));
+    ScTransferObj* pClipObj = ScTransferObj::GetOwnClipboard(xTransferable);
+    if (pClipObj)
+    {
+        pClipObj->SetUseInApi( true );
+        pDocShell->SetClipData(xTransferable);
+    }
+}
+
+void
+implnCut( const uno::Reference< frame::XModel>& xModel )
+{
+    ScTabViewShell* pViewShell =  getBestViewShell( xModel );
+    ScDocShell* pDocShell = getDocShell( xModel );
+    if ( !(pViewShell && pDocShell) )
+        return;
+
+    pViewShell->CutToClip();
+
+    // mark the copied transfer object so it is used in ScVbaRange::Insert
+    uno::Reference<datatransfer::XTransferable2> xTransferable(ScTabViewShell::GetClipData(pViewShell->GetViewData().GetActiveWin()));
+    ScTransferObj* pClipObj = ScTransferObj::GetOwnClipboard(xTransferable);
+    if (pClipObj)
+    {
+        pClipObj->SetUseInApi( true );
+        pDocShell->SetClipData(xTransferable);
+    }
+}
+
+void implnPasteSpecial( const uno::Reference< frame::XModel>& xModel, InsertDeleteFlags nFlags, ScPasteFunc nFunction, bool bSkipEmpty, bool bTranspose)
+{
+    PasteCellsWarningReseter resetWarningBox;
+
+    ScTabViewShell* pTabViewShell = getBestViewShell(xModel);
+    if (!pTabViewShell)
+        return;
+
+    ScDocShell* pDocShell = getDocShell(xModel);
+    if (!pDocShell)
+        return;
+
+    ScViewData& rView = pTabViewShell->GetViewData();
+    vcl::Window* pWin = rView.GetActiveWin();
+    if (!pWin)
+        return;
+
+    const ScTransferObj* pOwnClip = ScTransferObj::GetOwnClipboard(ScTabViewShell::GetClipData(pWin));
+    if (pOwnClip)
+    {
+        pTabViewShell->PasteFromClip(nFlags, pOwnClip->GetDocument(),
+            nFunction, bSkipEmpty, bTranspose, false,
+            INS_NONE, InsertDeleteFlags::NONE, true);
+
+        pTabViewShell->CellContentChanged();
+    }
+}
+
+ScDocShell*
+getDocShell( const css::uno::Reference< css::frame::XModel>& xModel )
+{
+    uno::Reference< uno::XInterface > xIf( xModel, uno::UNO_QUERY_THROW );
+    ScModelObj* pModel = dynamic_cast< ScModelObj* >( xIf.get() );
+    ScDocShell* pDocShell = nullptr;
+    if ( pModel )
+        pDocShell = static_cast<ScDocShell*>(pModel->GetEmbeddedObject());
+    return pDocShell;
+
+}
+
+ScTabViewShell*
+getBestViewShell( const css::uno::Reference< css::frame::XModel>& xModel )
+{
+    ScDocShell* pDocShell = getDocShell( xModel );
+    if ( pDocShell )
+        return pDocShell->GetBestViewShell();
+    return nullptr;
+}
+
+ScTabViewShell*
+getCurrentBestViewShell(  const uno::Reference< uno::XComponentContext >& xContext )
+{
+    uno::Reference< frame::XModel > xModel = getCurrentExcelDoc( xContext );
+    return getBestViewShell( xModel );
+}
+
+SfxViewFrame*
+getViewFrame( const uno::Reference< frame::XModel >& xModel )
+{
+    ScTabViewShell* pViewShell = getBestViewShell( xModel );
+    if ( pViewShell )
+        return pViewShell->GetViewFrame();
+    return nullptr;
+}
+
+uno::Reference< XHelperInterface >
+getUnoSheetModuleObj( const uno::Reference< sheet::XSpreadsheet >& xSheet )
+{
+    uno::Reference< beans::XPropertySet > xProps( xSheet, uno::UNO_QUERY_THROW );
+    OUString sCodeName;
+    xProps->getPropertyValue("CodeName") >>= sCodeName;
+    // #TODO #FIXME ideally we should 'throw' here if we don't get a valid parent, but... it is possible
+    // to create a module ( and use 'Option VBASupport 1' ) for a calc document, in this scenario there
+    // are *NO* special document module objects ( of course being able to switch between vba/non vba mode at
+    // the document in the future could fix this, especially IF the switching of the vba mode takes care to
+    // create the special document module objects if they don't exist.
+    return getUnoDocModule( sCodeName, GetDocShellFromRange( xSheet ) );
+}
+
+uno::Reference< XHelperInterface >
+getUnoSheetModuleObj( const uno::Reference< sheet::XSheetCellRangeContainer >& xRanges )
+{
+    uno::Reference< container::XEnumerationAccess > xEnumAccess( xRanges, uno::UNO_QUERY_THROW );
+    uno::Reference< container::XEnumeration > xEnum = xEnumAccess->createEnumeration();
+    uno::Reference< table::XCellRange > xRange( xEnum->nextElement(), uno::UNO_QUERY_THROW );
+    return getUnoSheetModuleObj( xRange );
+}
+
+uno::Reference< XHelperInterface >
+getUnoSheetModuleObj( const uno::Reference< table::XCell >& xCell )
+{
+    uno::Reference< sheet::XSheetCellRange > xSheetRange( xCell, uno::UNO_QUERY_THROW );
+    uno::Reference< sheet::XSpreadsheet > xSheet( xSheetRange->getSpreadsheet(), uno::UNO_SET_THROW );
+    return getUnoSheetModuleObj( xSheet );
+}
+
+uno::Reference< XHelperInterface >
+getUnoSheetModuleObj( const uno::Reference< frame::XModel >& xModel, SCTAB nTab )
+{
+    uno::Reference< sheet::XSpreadsheetDocument > xDoc( xModel, uno::UNO_QUERY_THROW );
+    uno::Reference< container::XIndexAccess > xSheets( xDoc->getSheets(), uno::UNO_QUERY_THROW );
+    uno::Reference< sheet::XSpreadsheet > xSheet( xSheets->getByIndex( nTab ), uno::UNO_QUERY_THROW );
+    return getUnoSheetModuleObj( xSheet );
+}
+
+void setUpDocumentModules( const uno::Reference< sheet::XSpreadsheetDocument >& xDoc )
+{
+    uno::Reference< frame::XModel > xModel( xDoc, uno::UNO_QUERY );
+    ScDocShell* pShell = excel::getDocShell( xModel );
+    if ( !pShell )
+        return;
+
+    OUString aPrjName( "Standard" );
+    pShell->GetBasicManager()->SetName( aPrjName );
+
+    /*  Set library container to VBA compatibility mode. This will create
+        the VBA Globals object and store it in the Basic manager of the
+        document. */
+    uno::Reference<script::XLibraryContainer> xLibContainer = pShell->GetBasicContainer();
+    uno::Reference<script::vba::XVBACompatibility> xVBACompat( xLibContainer, uno::UNO_QUERY_THROW );
+    xVBACompat->setVBACompatibilityMode( true );
+
+    if( xLibContainer.is() )
+    {
+        if( !xLibContainer->hasByName( aPrjName ) )
+            xLibContainer->createLibrary( aPrjName );
+        uno::Any aLibAny = xLibContainer->getByName( aPrjName );
+        uno::Reference< container::XNameContainer > xLib;
+        aLibAny >>= xLib;
+        if( xLib.is()  )
+        {
+            uno::Reference< script::vba::XVBAModuleInfo > xVBAModuleInfo( xLib, uno::UNO_QUERY_THROW );
+            uno::Reference< lang::XMultiServiceFactory> xSF( pShell->GetModel(), uno::UNO_QUERY_THROW);
+            uno::Reference< container::XNameAccess > xVBACodeNamedObjectAccess( xSF->createInstance("ooo.vba.VBAObjectModuleObjectProvider"), uno::UNO_QUERY_THROW );
+            // set up the module info for the workbook and sheets in the newly created
+            // spreadsheet
+            ScDocument& rDoc = pShell->GetDocument();
+            OUString sCodeName = rDoc.GetCodeName();
+            if ( sCodeName.isEmpty() )
+            {
+                sCodeName = "ThisWorkbook";
+                rDoc.SetCodeName( sCodeName );
+            }
+
+            std::vector< OUString > sDocModuleNames { sCodeName };
+
+            for ( SCTAB index = 0; index < rDoc.GetTableCount(); index++)
+            {
+                OUString aName;
+                rDoc.GetCodeName( index, aName );
+                sDocModuleNames.push_back( aName );
+            }
+
+            for ( const auto& rName : sDocModuleNames )
+            {
+                script::ModuleInfo sModuleInfo;
+
+                uno::Any aName= xVBACodeNamedObjectAccess->getByName( rName );
+                sModuleInfo.ModuleObject.set( aName, uno::UNO_QUERY );
+                sModuleInfo.ModuleType = script::ModuleType::DOCUMENT;
+                xVBAModuleInfo->insertModuleInfo( rName, sModuleInfo );
+                if( xLib->hasByName( rName ) )
+                    xLib->replaceByName( rName, uno::Any( OUString( "Option VBASupport 1\n") ) );
+                else
+                    xLib->insertByName( rName, uno::Any( OUString( "Option VBASupport 1\n" ) ) );
+            }
+        }
+    }
+
+    /*  Trigger the Workbook_Open event, event processor will register
+        itself as listener for specific events. */
+    try
+    {
+        uno::Reference< script::vba::XVBAEventProcessor > xVbaEvents( pShell->GetDocument().GetVbaEventProcessor(), uno::UNO_SET_THROW );
+        uno::Sequence< uno::Any > aArgs;
+        xVbaEvents->processVbaEvent( script::vba::VBAEventId::WORKBOOK_OPEN, aArgs );
+    }
+    catch( uno::Exception& )
+    {
+    }
+}
+
+SfxItemSet*
+ScVbaCellRangeAccess::GetDataSet( ScCellRangesBase* pRangeObj )
+{
+    return pRangeObj ? pRangeObj->GetCurrentDataSet( true ) : nullptr;
+}
+
+} // namespace ooo::vba::excel
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */