sw/source/ui/vba/vbatables.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 "vbatables.hxx"
  21 #include "vbatable.hxx"
  22 #include "vbarange.hxx"
  23 #include "wordvbahelper.hxx"
  24 #include <com/sun/star/text/XTextTable.hpp>
  25 #include <com/sun/star/text/XTextTablesSupplier.hpp>
  26 #include <com/sun/star/text/XTextDocument.hpp>
  27 #include <com/sun/star/lang/XServiceInfo.hpp>
  28 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  29 #include <com/sun/star/text/XText.hpp>
  30 #include <com/sun/star/table/XCellRange.hpp>
  31 #include <cppuhelper/implbase.hxx>
  32 #include <unotxdoc.hxx>
  33 #include <unocoll.hxx>
  34 #include <unotbl.hxx>
  35 #include <utility>
  36
  37 using namespace ::ooo::vba;
  38 using namespace css;
  39
  40 static uno::Any lcl_createTable( const uno::Reference< XHelperInterface >& xParent,
  41                                  const uno::Reference< uno::XComponentContext >& xContext,
  42                                  const rtl::Reference< SwXTextDocument >& xDocument,
  43                                  const uno::Any& aSource )
  44 {
  45     uno::Reference< text::XTextTable > xTextTable( aSource, uno::UNO_QUERY_THROW );
  46     uno::Reference< word::XTable > xTable( new SwVbaTable( xParent, xContext, xDocument, xTextTable ) );
  47     return uno::Any( xTable );
  48 }
  49
  50 static bool lcl_isInHeaderFooter( const uno::Reference< text::XTextTable >& xTable )
  51 {
  52     uno::Reference< text::XTextContent > xTextContent( xTable, uno::UNO_QUERY_THROW );
  53     uno::Reference< text::XText > xText = xTextContent->getAnchor()->getText();
  54     uno::Reference< lang::XServiceInfo > xServiceInfo( xText, uno::UNO_QUERY );
  55     if ( !xServiceInfo )
  56         return false;
  57     OUString aImplName = xServiceInfo->getImplementationName();
  58     return aImplName == "SwXHeadFootText";
  59 }
  60
  61 namespace {
  62
  63 class TableCollectionHelper : public ::cppu::WeakImplHelper< container::XIndexAccess,
  64                                                              container::XNameAccess >
  65 {
  66     std::vector<rtl::Reference<SwXTextTable>> mxTables;
  67     std::vector<rtl::Reference<SwXTextTable>>::iterator m_cachePos;
  68
  69 public:
  70     explicit TableCollectionHelper( const rtl::Reference< SwXTextDocument >& xDocument )
  71     {
  72         // only count the tables in the body text, not in the header/footer
  73         rtl::Reference< SwXTextTables > xTables = xDocument->getSwTextTables();
  74         sal_Int32 nCount = xTables->getCount();
  75         for( sal_Int32 i = 0; i < nCount; i++ )
  76         {
  77             rtl::Reference< SwXTextTable > xTable = xTables->getTextTableByIndex( i );
  78             if( !lcl_isInHeaderFooter( xTable ) )
  79                 mxTables.push_back( xTable );
  80         }
  81         m_cachePos = mxTables.begin();
  82     }
  83     // XIndexAccess
  84     virtual sal_Int32 SAL_CALL getCount(  ) override
  85     {
  86         return mxTables.size();
  87     }
  88     virtual uno::Any SAL_CALL getByIndex( sal_Int32 Index ) override
  89     {
  90         if ( Index < 0 || Index >= getCount() )
  91             throw lang::IndexOutOfBoundsException();
  92         uno::Reference< text::XTextTable > xTable( mxTables[ Index ] );
  93         return uno::Any( xTable );
  94     }
  95     // XElementAccess
  96     virtual uno::Type SAL_CALL getElementType(  ) override { return  cppu::UnoType<text::XTextTable>::get(); }
  97     virtual sal_Bool SAL_CALL hasElements(  ) override { return getCount() > 0 ; }
  98     // XNameAccess
  99     virtual uno::Any SAL_CALL getByName( const OUString& aName ) override
 100     {
 101         if ( !hasByName(aName) )
 102             throw container::NoSuchElementException();
 103         uno::Reference< text::XTextTable > xTable( *m_cachePos, uno::UNO_SET_THROW );
 104         return uno::Any( xTable );
 105     }
 106     virtual uno::Sequence< OUString > SAL_CALL getElementNames(  ) override
 107     {
 108         uno::Sequence< OUString > sNames( mxTables.size() );
 109         OUString* pString = sNames.getArray();
 110         for ( const auto& rxTable : mxTables )
 111         {
 112             *pString = rxTable->getName();
 113             ++pString;
 114         }
 115         return sNames;
 116     }
 117     virtual sal_Bool SAL_CALL hasByName( const OUString& aName ) override
 118     {
 119         m_cachePos = mxTables.begin();
 120         auto it_end = mxTables.end();
 121         for ( ; m_cachePos != it_end; ++m_cachePos )
 122         {
 123             if ( aName.equalsIgnoreAsciiCase( (*m_cachePos)->getName() ) )
 124                 break;
 125         }
 126         return ( m_cachePos != it_end );
 127     }
 128 };
 129
 130 class TableEnumerationImpl : public ::cppu::WeakImplHelper< css::container::XEnumeration >
 131 {
 132     uno::Reference< XHelperInterface > mxParent;
 133     uno::Reference< uno::XComponentContext > mxContext;
 134     rtl::Reference< SwXTextDocument > mxDocument;
 135     uno::Reference< container::XIndexAccess > mxIndexAccess;
 136     sal_Int32 mnCurIndex;
 137 public:
 138     TableEnumerationImpl( uno::Reference< XHelperInterface > xParent,
 139                           uno::Reference< uno::XComponentContext > xContext,
 140                           rtl::Reference< SwXTextDocument > xDocument,
 141                           uno::Reference< container::XIndexAccess >  xIndexAccess )
 142     : mxParent(std::move( xParent )), mxContext(std::move( xContext )),
 143       mxDocument(std::move( xDocument )), mxIndexAccess(std::move( xIndexAccess )), mnCurIndex(0)
 144     {
 145     }
 146     virtual sal_Bool SAL_CALL hasMoreElements(  ) override
 147     {
 148         return ( mnCurIndex < mxIndexAccess->getCount() );
 149     }
 150     virtual uno::Any SAL_CALL nextElement(  ) override
 151     {
 152         if ( !hasMoreElements() )
 153             throw container::NoSuchElementException();
 154         return lcl_createTable( mxParent, mxContext, mxDocument, mxIndexAccess->getByIndex( mnCurIndex++ ) );
 155     }
 156
 157 };
 158
 159 }
 160
 161 SwVbaTables::SwVbaTables( const uno::Reference< XHelperInterface >& xParent,
 162                           const uno::Reference< uno::XComponentContext > & xContext,
 163                           const rtl::Reference< SwXTextDocument >& xDocument )
 164 : SwVbaTables_BASE( xParent, xContext , uno::Reference< container::XIndexAccess >( new TableCollectionHelper( xDocument ) ) ),
 165   mxDocument( xDocument )
 166 {
 167 }
 168
 169 uno::Reference< word::XTable > SAL_CALL
 170 SwVbaTables::Add( const uno::Reference< word::XRange >& Range, const uno::Any& NumRows, const uno::Any& NumColumns, const uno::Any& /*DefaultTableBehavior*/, const uno::Any& /*AutoFitBehavior*/ )
 171 {
 172     sal_Int32 nCols = 0;
 173     sal_Int32 nRows = 0;
 174     SwVbaRange* pVbaRange = dynamic_cast< SwVbaRange* >( Range.get() );
 175     // Preconditions
 176     if ( !( pVbaRange && ( NumRows >>= nRows ) && ( NumColumns >>= nCols ) ) )
 177         throw uno::RuntimeException(); // #FIXME better exception??
 178     if ( nCols <= 0 || nRows <= 0 )
 179         throw uno::RuntimeException(); // #FIXME better exception??
 180
 181     rtl::Reference< SwXTextDocument > xModel( pVbaRange->getDocument() );
 182     uno::Reference< text::XTextRange > xTextRange = pVbaRange->getXTextRange();
 183
 184     uno::Reference< text::XTextTable > xTable;
 185     xTable.set( xModel->createInstance(u"com.sun.star.text.TextTable"_ustr), uno::UNO_QUERY_THROW );
 186
 187     xTable->initialize( nRows, nCols );
 188     uno::Reference< text::XText > xText = xTextRange->getText();
 189     uno::Reference< text::XTextContent > xContext( xTable, uno::UNO_QUERY_THROW );
 190
 191     xText->insertTextContent( xTextRange, xContext, true );
 192
 193     // move the current cursor to the first table cell
 194     uno::Reference< table::XCellRange > xCellRange( xTable, uno::UNO_QUERY_THROW );
 195     uno::Reference< text::XText> xFirstCellText( xCellRange->getCellByPosition(0, 0), uno::UNO_QUERY_THROW );
 196     word::getXTextViewCursor( mxDocument )->gotoRange( xFirstCellText->getStart(), false );
 197
 198     uno::Reference< word::XTable > xVBATable( new SwVbaTable( mxParent, mxContext,  pVbaRange->getDocument(), xTable ) );
 199     return xVBATable;
 200 }
 201
 202 uno::Reference< container::XEnumeration > SAL_CALL
 203 SwVbaTables::createEnumeration()
 204 {
 205     return new TableEnumerationImpl( mxParent, mxContext, mxDocument, m_xIndexAccess );
 206 }
 207
 208 // ScVbaCollectionBaseImpl
 209 uno::Any
 210 SwVbaTables::createCollectionObject( const uno::Any& aSource )
 211 {
 212     return lcl_createTable( mxParent, mxContext, mxDocument, aSource );
 213 }
 214
 215 // XHelperInterface
 216 OUString
 217 SwVbaTables::getServiceImplName()
 218 {
 219     return u"SwVbaTables"_ustr;
 220 }
 221
 222 // XEnumerationAccess
 223 uno::Type SAL_CALL
 224 SwVbaTables::getElementType()
 225 {
 226     return  cppu::UnoType<word::XTable>::get();
 227 }
 228
 229 uno::Sequence<OUString>
 230 SwVbaTables::getServiceNames()
 231 {
 232     static uno::Sequence< OUString > const aServiceNames
 233     {
 234         u"ooo.vba.word.Tables"_ustr
 235     };
 236     return aServiceNames;
 237 }
 238
 239 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */