sw/source/core/doc/DocumentDeviceManager.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 <DocumentDeviceManager.hxx>
  21
  22 #include <memory>
  23 #include <utility>
  24
  25 #include <doc.hxx>
  26 #include <DocumentSettingManager.hxx>
  27 #include <IDocumentDrawModelAccess.hxx>
  28 #include <IDocumentState.hxx>
  29 #include <IDocumentLayoutAccess.hxx>
  30 #include <osl/diagnose.h>
  31 #include <sfx2/printer.hxx>
  32 #include <vcl/virdev.hxx>
  33 #include <vcl/outdev.hxx>
  34 #include <vcl/jobset.hxx>
  35 #include <printdata.hxx>
  36 #include <vcl/mapmod.hxx>
  37 #include <svl/itemset.hxx>
  38 #include <cfgitems.hxx>
  39 #include <cmdid.h>
  40 #include <drawdoc.hxx>
  41 #include <wdocsh.hxx>
  42 #include <prtopt.hxx>
  43 #include <viewsh.hxx>
  44 #include <rootfrm.hxx>
  45 #include <viewopt.hxx>
  46 #include <swwait.hxx>
  47 #include <fntcache.hxx>
  48
  49 class SwDocShell;
  50 class SwWait;
  51
  52 namespace sw {
  53
  54 DocumentDeviceManager::DocumentDeviceManager( SwDoc& i_rSwdoc ) : m_rDoc( i_rSwdoc ), mpPrt(nullptr), mpVirDev(nullptr) {}
  55
  56 SfxPrinter* DocumentDeviceManager::getPrinter(/*[in]*/ bool bCreate ) const
  57 {
  58     SfxPrinter* pRet = nullptr;
  59     if ( !bCreate || mpPrt )
  60         pRet = mpPrt;
  61     else
  62         pRet = &CreatePrinter_();
  63
  64     return pRet;
  65 }
  66
  67 void DocumentDeviceManager::setPrinter(/*[in]*/ SfxPrinter *pP,/*[in]*/ bool bDeleteOld,/*[in]*/ bool bCallPrtDataChanged )
  68 {
  69     assert ( !pP || !pP->isDisposed() );
  70     if ( pP != mpPrt )
  71     {
  72         if ( bDeleteOld )
  73             mpPrt.disposeAndClear();
  74         mpPrt = pP;
  75
  76         // our printer should always use TWIP. Don't rely on this being set in SwViewShell::InitPrt, there
  77         // are situations where this isn't called. #i108712#
  78         if ( mpPrt )
  79         {
  80             MapMode aMapMode( mpPrt->GetMapMode() );
  81             aMapMode.SetMapUnit( MapUnit::MapTwip );
  82             mpPrt->SetMapMode( aMapMode );
  83         }
  84
  85         if ( m_rDoc.getIDocumentDrawModelAccess().GetDrawModel() && !m_rDoc.GetDocumentSettingManager().get( DocumentSettingId::USE_VIRTUAL_DEVICE ) )
  86             m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetRefDevice( mpPrt );
  87     }
  88
  89     if ( bCallPrtDataChanged &&
  90          // #i41075# Do not call PrtDataChanged() if we do not
  91          // use the printer for formatting:
  92          !m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::USE_VIRTUAL_DEVICE) )
  93         PrtDataChanged();
  94 }
  95
  96 VirtualDevice* DocumentDeviceManager::getVirtualDevice(/*[in]*/ bool bCreate ) const
  97 {
  98     VirtualDevice* pRet = nullptr;
  99     if ( !bCreate || mpVirDev )
 100         pRet = mpVirDev;
 101     else
 102         pRet = &CreateVirtualDevice_();
 103
 104     assert ( !pRet || !pRet->isDisposed() );
 105
 106     return pRet;
 107 }
 108
 109 void DocumentDeviceManager::setVirtualDevice(/*[in]*/ VirtualDevice* pVd )
 110 {
 111     assert ( !pVd->isDisposed() );
 112
 113     if ( mpVirDev.get() != pVd )
 114     {
 115         mpVirDev.disposeAndClear();
 116         mpVirDev = pVd;
 117
 118         if ( m_rDoc.getIDocumentDrawModelAccess().GetDrawModel() && m_rDoc.GetDocumentSettingManager().get( DocumentSettingId::USE_VIRTUAL_DEVICE ) )
 119             m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetRefDevice( mpVirDev );
 120     }
 121 }
 122
 123 OutputDevice* DocumentDeviceManager::getReferenceDevice(/*[in]*/ bool bCreate ) const
 124 {
 125     OutputDevice* pRet = nullptr;
 126     if ( !m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::USE_VIRTUAL_DEVICE) )
 127     {
 128         pRet = getPrinter( bCreate );
 129
 130         if ( bCreate && !mpPrt->IsValid() )
 131         {
 132             pRet = getVirtualDevice( true );
 133         }
 134     }
 135     else
 136     {
 137         pRet = getVirtualDevice( bCreate );
 138     }
 139
 140     assert ( !pRet || !pRet->isDisposed() );
 141
 142     return pRet;
 143 }
 144
 145 void DocumentDeviceManager::setReferenceDeviceType(/*[in]*/ bool bNewVirtual, /*[in]*/ bool bNewHiRes )
 146 {
 147     if ( m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::USE_VIRTUAL_DEVICE) == bNewVirtual &&
 148          m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::USE_HIRES_VIRTUAL_DEVICE) == bNewHiRes )
 149         return;
 150
 151     if ( bNewVirtual )
 152     {
 153         VirtualDevice* pMyVirDev = getVirtualDevice( true );
 154         if ( !bNewHiRes )
 155             pMyVirDev->SetReferenceDevice( VirtualDevice::RefDevMode::Dpi600 );
 156         else
 157             pMyVirDev->SetReferenceDevice( VirtualDevice::RefDevMode::MSO1 );
 158
 159         if( m_rDoc.getIDocumentDrawModelAccess().GetDrawModel() )
 160             m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetRefDevice( pMyVirDev );
 161     }
 162     else
 163     {
 164         // #i41075#
 165         // We have to take care that a printer exists before calling
 166         // PrtDataChanged() in order to prevent that PrtDataChanged()
 167         // triggers this funny situation:
 168         // getReferenceDevice()->getPrinter()->CreatePrinter_()
 169         // ->setPrinter()-> PrtDataChanged()
 170         SfxPrinter* pPrinter = getPrinter( true );
 171         if( m_rDoc.getIDocumentDrawModelAccess().GetDrawModel() )
 172             m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetRefDevice( pPrinter );
 173     }
 174
 175     m_rDoc.GetDocumentSettingManager().set(DocumentSettingId::USE_VIRTUAL_DEVICE, bNewVirtual );
 176     m_rDoc.GetDocumentSettingManager().set(DocumentSettingId::USE_HIRES_VIRTUAL_DEVICE, bNewHiRes );
 177     PrtDataChanged();
 178     m_rDoc.getIDocumentState().SetModified();
 179 }
 180
 181 const JobSetup* DocumentDeviceManager::getJobsetup() const
 182 {
 183     return mpPrt ? &mpPrt->GetJobSetup() : nullptr;
 184 }
 185
 186 void DocumentDeviceManager::setJobsetup(/*[in]*/ const JobSetup &rJobSetup )
 187 {
 188     bool bCheckPageDescs = !mpPrt;
 189     bool bDataChanged = false;
 190
 191     if ( mpPrt )
 192     {
 193         if ( mpPrt->GetName() == rJobSetup.GetPrinterName() )
 194         {
 195             if ( mpPrt->GetJobSetup() != rJobSetup )
 196             {
 197                 mpPrt->SetJobSetup( rJobSetup );
 198                 bDataChanged = true;
 199             }
 200         }
 201         else
 202             mpPrt.disposeAndClear();
 203     }
 204
 205     if( !mpPrt )
 206     {
 207         //The ItemSet is deleted by Sfx!
 208         auto pSet = std::make_unique<SfxItemSet>(SfxItemSet::makeFixedSfxItemSet<
 209                         SID_PRINTER_NOTFOUND_WARN, SID_PRINTER_NOTFOUND_WARN,
 210                         SID_PRINTER_CHANGESTODOC, SID_PRINTER_CHANGESTODOC,
 211                         SID_HTML_MODE, SID_HTML_MODE,
 212                         FN_PARAM_ADDPRINTER, FN_PARAM_ADDPRINTER>(m_rDoc.GetAttrPool()));
 213         VclPtr<SfxPrinter> p = VclPtr<SfxPrinter>::Create( std::move(pSet), rJobSetup );
 214         if ( bCheckPageDescs )
 215             setPrinter( p, true, true );
 216         else
 217         {
 218             mpPrt = std::move(p);
 219             bDataChanged = true;
 220         }
 221     }
 222     if ( bDataChanged && !m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::USE_VIRTUAL_DEVICE) )
 223         PrtDataChanged();
 224 }
 225
 226 const SwPrintData & DocumentDeviceManager::getPrintData() const
 227 {
 228     if(!mpPrtData)
 229     {
 230         DocumentDeviceManager * pThis = const_cast< DocumentDeviceManager * >(this);
 231         pThis->mpPrtData.reset(new SwPrintData);
 232
 233         // SwPrintData should be initialized from the configuration,
 234         // the respective config item is implemented by SwPrintOptions which
 235         // is also derived from SwPrintData
 236         const SwDocShell *pDocSh = m_rDoc.GetDocShell();
 237         OSL_ENSURE( pDocSh, "pDocSh is 0, can't determine if this is a WebDoc or not" );
 238         bool bWeb = dynamic_cast< const SwWebDocShell * >(pDocSh) !=  nullptr;
 239         *pThis->mpPrtData = SwPrintOptions(bWeb);
 240     }
 241     assert(mpPrtData && "this will always be set by now");
 242     return *mpPrtData;
 243 }
 244
 245 void DocumentDeviceManager::setPrintData(/*[in]*/ const SwPrintData& rPrtData )
 246 {
 247     if(!mpPrtData)
 248         mpPrtData.reset(new SwPrintData);
 249     *mpPrtData = rPrtData;
 250 }
 251
 252 DocumentDeviceManager::~DocumentDeviceManager()
 253 {
 254     mpPrtData.reset();
 255     mpVirDev.disposeAndClear();
 256     mpPrt.disposeAndClear();
 257 }
 258
 259 VirtualDevice& DocumentDeviceManager::CreateVirtualDevice_() const
 260 {
 261 #ifdef IOS
 262     VclPtr<VirtualDevice> pNewVir = VclPtr<VirtualDevice>::Create(DeviceFormat::GRAYSCALE);
 263 #else
 264     VclPtr<VirtualDevice> pNewVir = VclPtr<VirtualDevice>::Create(DeviceFormat::WITHOUT_ALPHA);
 265 #endif
 266
 267     pNewVir->SetReferenceDevice( VirtualDevice::RefDevMode::MSO1 );
 268
 269     // #i60945# External leading compatibility for unix systems.
 270     if ( m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::UNIX_FORCE_ZERO_EXT_LEADING ) )
 271         pNewVir->Compat_ZeroExtleadBug();
 272
 273     MapMode aMapMode( pNewVir->GetMapMode() );
 274     aMapMode.SetMapUnit( MapUnit::MapTwip );
 275     pNewVir->SetMapMode( aMapMode );
 276
 277     const_cast<DocumentDeviceManager*>(this)->setVirtualDevice( pNewVir );
 278     return *mpVirDev;
 279 }
 280
 281 SfxPrinter& DocumentDeviceManager::CreatePrinter_() const
 282 {
 283     OSL_ENSURE( ! mpPrt, "Do not call CreatePrinter_(), call getPrinter() instead" );
 284
 285     // We create a default SfxPrinter.
 286     // The ItemSet is deleted by Sfx!
 287     auto pSet = std::make_unique<SfxItemSet>(SfxItemSet::makeFixedSfxItemSet<
 288                     SID_PRINTER_NOTFOUND_WARN, SID_PRINTER_NOTFOUND_WARN,
 289                     SID_PRINTER_CHANGESTODOC, SID_PRINTER_CHANGESTODOC,
 290                     SID_HTML_MODE, SID_HTML_MODE,
 291                     FN_PARAM_ADDPRINTER, FN_PARAM_ADDPRINTER>(m_rDoc.GetAttrPool()));
 292     VclPtr<SfxPrinter> pNewPrt = VclPtr<SfxPrinter>::Create( std::move(pSet) );
 293
 294     // assign PrintData to newly created printer
 295     const SwPrintData& rPrtData = getPrintData();
 296     SwAddPrinterItem aAddPrinterItem(rPrtData);
 297     SfxItemSet aOptions(pNewPrt->GetOptions());
 298     aOptions.Put(aAddPrinterItem);
 299     pNewPrt->SetOptions(aOptions);
 300
 301     const_cast<DocumentDeviceManager*>(this)->setPrinter( pNewPrt, true, true );
 302     return *mpPrt;
 303 }
 304
 305 void DocumentDeviceManager::PrtDataChanged()
 306 {
 307 // If you change this, also modify InJobSetup in Sw3io if appropriate.
 308
 309     // #i41075#
 310     OSL_ENSURE( m_rDoc.getIDocumentSettingAccess().get(DocumentSettingId::USE_VIRTUAL_DEVICE) ||
 311             nullptr != getPrinter( false ), "PrtDataChanged will be called recursively!" );
 312     SwRootFrame* pTmpRoot = m_rDoc.getIDocumentLayoutAccess().GetCurrentLayout();
 313     std::optional<SwWait> oWait;
 314     bool bEndAction = false;
 315
 316     if( m_rDoc.GetDocShell() )
 317         m_rDoc.GetDocShell()->UpdateFontList();
 318
 319     bool bDraw = true;
 320     if ( pTmpRoot )
 321     {
 322         SwViewShell *pSh = m_rDoc.getIDocumentLayoutAccess().GetCurrentViewShell();
 323         if( pSh &&
 324             (!pSh->GetViewOptions()->getBrowseMode() ||
 325              pSh->GetViewOptions()->IsPrtFormat()) )
 326         {
 327             if ( m_rDoc.GetDocShell() )
 328                 oWait.emplace( *m_rDoc.GetDocShell(), true );
 329
 330             pTmpRoot->StartAllAction();
 331             bEndAction = true;
 332
 333             bDraw = false;
 334             if( m_rDoc.getIDocumentDrawModelAccess().GetDrawModel() )
 335             {
 336                 m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetAddExtLeading( m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::ADD_EXT_LEADING) );
 337                 m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetRefDevice( getReferenceDevice( false ) );
 338             }
 339
 340             pFntCache->Flush();
 341
 342             for(SwRootFrame* aLayout : m_rDoc.GetAllLayouts())
 343                 aLayout->InvalidateAllContent(SwInvalidateFlags::Size);
 344
 345             for(SwViewShell& rShell : pSh->GetRingContainer())
 346                 rShell.InitPrt(getPrinter(false));
 347         }
 348     }
 349     if ( bDraw && m_rDoc.getIDocumentDrawModelAccess().GetDrawModel() )
 350     {
 351         const bool bTmpAddExtLeading = m_rDoc.GetDocumentSettingManager().get(DocumentSettingId::ADD_EXT_LEADING);
 352         if ( bTmpAddExtLeading != m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->IsAddExtLeading() )
 353             m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetAddExtLeading( bTmpAddExtLeading );
 354
 355         OutputDevice* pOutDev = getReferenceDevice( false );
 356         if ( pOutDev != m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->GetRefDevice() )
 357             m_rDoc.getIDocumentDrawModelAccess().GetDrawModel()->SetRefDevice( pOutDev );
 358     }
 359
 360     m_rDoc.PrtOLENotify( true );
 361
 362     if ( bEndAction )
 363         pTmpRoot->EndAllAction();
 364 }
 365
 366 }
 367
 368 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */