sc/source/ui/docshell/servobj.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 <osl/thread.h>
  21 #include <osl/diagnose.h>
  22 #include <sot/exchange.hxx>
  23 #include <sot/formats.hxx>
  24 #include <sfx2/app.hxx>
  25 #include <sfx2/linkmgr.hxx>
  26 #include <servobj.hxx>
  27 #include <docsh.hxx>
  28 #include <impex.hxx>
  29 #include <brdcst.hxx>
  30 #include <rangenam.hxx>
  31 #include <unotools/charclass.hxx>
  32
  33 using namespace formula;
  34
  35 static bool lcl_FillRangeFromName( ScRange& rRange, ScDocShell* pDocSh, const OUString& rName )
  36 {
  37     if (pDocSh)
  38     {
  39         ScDocument& rDoc = pDocSh->GetDocument();
  40         ScRangeName* pNames = rDoc.GetRangeName();
  41         if (pNames)
  42         {
  43             const ScRangeData* pData = pNames->findByUpperName(ScGlobal::getCharClass().uppercase(rName));
  44             if (pData)
  45             {
  46                 if ( pData->IsValidReference( rRange ) )
  47                     return true;
  48             }
  49         }
  50     }
  51     return false;
  52 }
  53
  54 ScServerObjectSvtListenerForwarder::ScServerObjectSvtListenerForwarder(
  55         ScServerObject* pObjP)
  56     : pObj(pObjP)
  57 {
  58 }
  59
  60 ScServerObjectSvtListenerForwarder::~ScServerObjectSvtListenerForwarder()
  61 {
  62     //! do NOT access pObj
  63 }
  64
  65 void ScServerObjectSvtListenerForwarder::Notify( const SfxHint& rHint )
  66 {
  67     pObj->Notify( aBroadcaster, rHint);
  68 }
  69
  70 ScServerObject::ScServerObject( ScDocShell* pShell, const OUString& rItem ) :
  71     aForwarder( this ),
  72     pDocSh( pShell ),
  73     bRefreshListener( false )
  74 {
  75     //  parse item string
  76
  77     if ( lcl_FillRangeFromName( aRange, pDocSh, rItem ) )
  78     {
  79         aItemStr = rItem;               // must be parsed again on ref update
  80     }
  81     else
  82     {
  83         //  parse ref
  84         ScDocument& rDoc = pDocSh->GetDocument();
  85         SCTAB nTab = ScDocShell::GetCurTab();
  86         aRange.aStart.SetTab( nTab );
  87
  88         // For DDE link, we always must parse references using OOO A1 convention.
  89
  90         if ( aRange.Parse( rItem, rDoc, FormulaGrammar::CONV_OOO ) & ScRefFlags::VALID )
  91         {
  92             // area reference
  93         }
  94         else if ( aRange.aStart.Parse( rItem, rDoc, FormulaGrammar::CONV_OOO ) & ScRefFlags::VALID )
  95         {
  96             // cell reference
  97             aRange.aEnd = aRange.aStart;
  98         }
  99         else
 100         {
 101             OSL_FAIL("ScServerObject: invalid item");
 102         }
 103     }
 104
 105     pDocSh->GetDocument().GetLinkManager()->InsertServer( this );
 106     pDocSh->GetDocument().StartListeningArea( aRange, false, &aForwarder );
 107
 108     StartListening(*pDocSh);           // to notice if DocShell gets deleted
 109     StartListening(*SfxGetpApp());     // for SfxHintId::ScAreasChanged
 110 }
 111
 112 ScServerObject::~ScServerObject()
 113 {
 114     Clear();
 115 }
 116
 117 void ScServerObject::Clear()
 118 {
 119     if (pDocSh)
 120     {
 121         ScDocShell* pTemp = pDocSh;
 122         pDocSh = nullptr;
 123
 124         pTemp->GetDocument().EndListeningArea(aRange, false, &aForwarder);
 125         pTemp->GetDocument().GetLinkManager()->RemoveServer( this );
 126         EndListening(*pTemp);
 127         EndListening(*SfxGetpApp());
 128     }
 129 }
 130
 131 void ScServerObject::EndListeningAll()
 132 {
 133     aForwarder.EndListeningAll();
 134     SfxListener::EndListeningAll();
 135 }
 136
 137 bool ScServerObject::GetData(
 138         css::uno::Any & rData /*out param*/,
 139         const OUString & rMimeType, bool /* bSynchron */ )
 140 {
 141     if (!pDocSh)
 142         return false;
 143
 144     // named ranges may have changed -> update aRange
 145     if ( !aItemStr.isEmpty() )
 146     {
 147         ScRange aNew;
 148         if ( lcl_FillRangeFromName( aNew, pDocSh, aItemStr ) && aNew != aRange )
 149         {
 150             aRange = aNew;
 151             bRefreshListener = true;
 152         }
 153     }
 154
 155     if ( bRefreshListener )
 156     {
 157         //  refresh the listeners now (this is called from a timer)
 158
 159         EndListeningAll();
 160         pDocSh->GetDocument().StartListeningArea( aRange, false, &aForwarder );
 161         StartListening(*pDocSh);
 162         StartListening(*SfxGetpApp());
 163         bRefreshListener = false;
 164     }
 165
 166     OUString aDdeTextFmt = pDocSh->GetDdeTextFmt();
 167     ScDocument& rDoc = pDocSh->GetDocument();
 168
 169     SotClipboardFormatId eFormatId = SotExchange::GetFormatIdFromMimeType( rMimeType );
 170     if (SotClipboardFormatId::STRING == eFormatId || SotClipboardFormatId::STRING_TSVC == eFormatId)
 171     {
 172         ScImportExport aObj( rDoc, aRange );
 173         if( aDdeTextFmt[0] == 'F' )
 174             aObj.SetFormulas( true );
 175         if( aDdeTextFmt == "SYLK" || aDdeTextFmt == "FSYLK" )
 176         {
 177             OString aByteData;
 178             if( aObj.ExportByteString( aByteData, osl_getThreadTextEncoding(), SotClipboardFormatId::SYLK ) )
 179             {
 180                 rData <<= css::uno::Sequence< sal_Int8 >(
 181                                         reinterpret_cast<const sal_Int8*>(aByteData.getStr()),
 182                                         aByteData.getLength() + 1 );
 183                 return true;
 184             }
 185             return false;
 186         }
 187         if( aDdeTextFmt == "CSV" || aDdeTextFmt == "FCSV" )
 188             aObj.SetSeparator( ',' );
 189         /* TODO: STRING_TSVC could preserve line breaks with added quotes. */
 190         aObj.SetExportTextOptions( ScExportTextOptions( ScExportTextOptions::ToSpace, ' ', false ) );
 191         return aObj.ExportData( rMimeType, rData );
 192     }
 193
 194     ScImportExport aObj( rDoc, aRange );
 195     aObj.SetExportTextOptions( ScExportTextOptions( ScExportTextOptions::ToSpace, ' ', false ) );
 196     if( aObj.IsRef() )
 197         return aObj.ExportData( rMimeType, rData );
 198     return false;
 199 }
 200
 201 void ScServerObject::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
 202 {
 203     bool bDataChanged = false;
 204
 205     //  DocShell can't be tested via type info, because SfxHintId::Dying comes from the dtor
 206     if ( &rBC == pDocSh )
 207     {
 208         //  from DocShell, only SfxHintId::Dying is interesting
 209         if ( rHint.GetId() == SfxHintId::Dying )
 210         {
 211             pDocSh = nullptr;
 212             EndListening(*SfxGetpApp());
 213             //  don't access DocShell anymore for EndListening etc.
 214         }
 215     }
 216     else if (dynamic_cast<const SfxApplication*>( &rBC) !=  nullptr)
 217     {
 218         if ( !aItemStr.isEmpty() && rHint.GetId() == SfxHintId::ScAreasChanged )
 219         {
 220             //  check if named range was modified
 221             ScRange aNew;
 222             if ( lcl_FillRangeFromName( aNew, pDocSh, aItemStr ) && aNew != aRange )
 223                 bDataChanged = true;
 224         }
 225     }
 226     else
 227     {
 228         //  must be from Area broadcasters
 229
 230         if (rHint.GetId() == SfxHintId::ScDataChanged)
 231             bDataChanged = true;
 232         else if (rHint.GetId() == SfxHintId::ScAreaChanged)  // position of broadcaster changed
 233         {
 234             const ScAreaChangedHint *pChgHint = static_cast<const ScAreaChangedHint*>(&rHint);
 235             const ScRange& aNewRange = pChgHint->GetRange();
 236             if ( aRange != aNewRange )
 237             {
 238                 bRefreshListener = true;
 239                 bDataChanged = true;
 240             }
 241         }
 242         else if (rHint.GetId() == SfxHintId::Dying)
 243         {
 244             //  If the range is being deleted, listening must be restarted
 245             //  after the deletion is complete (done in GetData)
 246             bRefreshListener = true;
 247             bDataChanged = true;
 248         }
 249     }
 250
 251     if ( bDataChanged && HasDataLinks() )
 252         SvLinkSource::NotifyDataChanged();
 253 }
 254
 255 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */