/home/maarten/src/libreoffice/core/include/rtl/ref.hxx

Bug Summary

File:	home/maarten/src/libreoffice/core/include/rtl/ref.hxx
Warning:	line 192, column 9 Use of memory after it is freed

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-unknown-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name pagepreviewlayout.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D SW_DLLIMPLEMENTATION -D SWUI_DLL_NAME="libswuilo.so" -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sw/source/core/inc -I /home/maarten/src/libreoffice/core/sw/source/filter/inc -I /home/maarten/src/libreoffice/core/sw/source/uibase/inc -I /home/maarten/src/libreoffice/core/sw/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sw/sdi -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/sw/generated -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/oovbaapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx

/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx

→

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
* 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 .
*/

20#include <pagepreviewlayout.hxx>
21#include <prevwpage.hxx>

23#include <algorithm>
24#include <tools/fract.hxx>
25#include <vcl/window.hxx>
26#include <vcl/settings.hxx>

28#include <rootfrm.hxx>
29#include <pagefrm.hxx>
30#include <viewsh.hxx>
31#include <viewimp.hxx>
32#include <viewopt.hxx>
33#include <swregion.hxx>
34#include <strings.hrc>
35#include <frmtool.hxx>
36#include <sfx2/zoomitem.hxx>
37#include <printdata.hxx>
38#include <paintfrm.hxx>

40#include <IDocumentDeviceAccess.hxx>

42// methods to initialize page preview layout

44SwPagePreviewLayout::SwPagePreviewLayout( SwViewShell& _rParentViewShell,
                                        const SwRootFrame& _rLayoutRootFrame )
  : mrParentViewShell( _rParentViewShell ),
    mrLayoutRootFrame ( _rLayoutRootFrame )
48{
  Clear_();

  mbBookPreview = false;
  mbBookPreviewModeToggled = false;

  mbPrintEmptyPages = mrParentViewShell.getIDocumentDeviceAccess().getPrintData().IsPrintEmptyPages();
55}

57void SwPagePreviewLayout::Clear_()
58{
  mbLayoutInfoValid = mbLayoutSizesValid = mbPaintInfoValid = false;

  maWinSize.setWidth( 0 );
  maWinSize.setHeight( 0 );
  mnCols = mnRows = 0;

  ClearPreviewLayoutSizes();

  mbDoesLayoutRowsFitIntoWindow = false;
  mbDoesLayoutColsFitIntoWindow = false;

  mnPaintPhyStartPageNum = 0;
  mnPaintStartCol = mnPaintStartRow = 0;
  mbNoPageVisible = false;
  maPaintStartPageOffset.setX( 0 );
  maPaintStartPageOffset.setY( 0 );
  maPaintPreviewDocOffset.setX( 0 );
  maPaintPreviewDocOffset.setY( 0 );
  maAdditionalPaintOffset.setX( 0 );
  maAdditionalPaintOffset.setY( 0 );
  maPaintedPreviewDocRect.SetLeft( 0 );
  maPaintedPreviewDocRect.SetTop( 0 );
  maPaintedPreviewDocRect.SetRight( 0 );
  maPaintedPreviewDocRect.SetBottom( 0 );
  mnSelectedPageNum = 0;
  ClearPreviewPageData();

  mbInPaint = false;
  mbNewLayoutDuringPaint = false;
88}

90void SwPagePreviewLayout::ClearPreviewLayoutSizes()
91{
  mnPages = 0;

  maMaxPageSize.setWidth( 0 );
  maMaxPageSize.setHeight( 0 );
  maPreviewDocRect.SetLeft( 0 );
  maPreviewDocRect.SetTop( 0 );
  maPreviewDocRect.SetRight( 0 );
  maPreviewDocRect.SetBottom( 0 );
  mnColWidth = mnRowHeight = 0;
  mnPreviewLayoutWidth = mnPreviewLayoutHeight = 0;
102}

104void SwPagePreviewLayout::ClearPreviewPageData()
105{
  maPreviewPages.clear();
107}

109/** calculate page preview layout sizes

111*/
112void SwPagePreviewLayout::CalcPreviewLayoutSizes()
113{
  vcl::RenderContext* pRenderContext = mrParentViewShell.GetOut();
  // calculate maximal page size; calculate also number of pages

  const SwPageFrame* pPage = static_cast<const SwPageFrame*>(mrLayoutRootFrame.Lower());
  while ( pPage )
  {
      if ( !mbBookPreview && !mbPrintEmptyPages && pPage->IsEmptyPage() )
      {
          pPage = static_cast<const SwPageFrame*>(pPage->GetNext());
          continue;
      }

      ++mnPages;
      pPage->Calc(pRenderContext);
      const Size& rPageSize = pPage->getFrameArea().SSize();
      if ( rPageSize.Width() > maMaxPageSize.Width() )
          maMaxPageSize.setWidth( rPageSize.Width() );
      if ( rPageSize.Height() > maMaxPageSize.Height() )
          maMaxPageSize.setHeight( rPageSize.Height() );
      pPage = static_cast<const SwPageFrame*>(pPage->GetNext());
  }
  // calculate and set column width and row height
  mnColWidth = maMaxPageSize.Width() + gnXFree;
  mnRowHeight = maMaxPageSize.Height() + gnYFree;

  // calculate and set preview layout width and height
  mnPreviewLayoutWidth = mnCols * mnColWidth + gnXFree;
  mnPreviewLayoutHeight = mnRows * mnRowHeight + gnYFree;

  // calculate document rectangle in preview layout
  {
      Size aDocSize;
      // document width
      aDocSize.setWidth( mnPreviewLayoutWidth );

      // document height
      // determine number of rows needed for <nPages> in preview layout
      // use method <GetRowOfPage(..)>.
      const sal_uInt16 nDocRows = GetRowOfPage( mnPages );
      aDocSize.setHeight( nDocRows * maMaxPageSize.Height() +
                          (nDocRows+1) * gnYFree );
      maPreviewDocRect.SetPos( Point( 0, 0 ) );
      maPreviewDocRect.SetSize( aDocSize );
  }
158}

160/** init page preview layout

  initialize the page preview settings for a given layout.

  side effects:
  (1) If parameter <_bCalcScale> is true, mapping mode with calculated
  scaling is set at the output device and the zoom at the view options of
  the given view shell is set with the calculated scaling.
168*/
169void SwPagePreviewLayout::Init( const sal_uInt16 _nCols,
                              const sal_uInt16 _nRows,
                              const Size&      _rPxWinSize
                            )
173{
  // check environment and parameters
  {
      bool bColsRowsValid = (_nCols != 0) && (_nRows != 0);
      OSL_ENSURE( bColsRowsValid, "preview layout parameters not correct - preview layout can *not* be initialized" )do { if (true && (!(bColsRowsValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "177" ": "), "%s", "preview layout parameters not correct - preview layout can *not* be initialized"
); } } while (false);
      if ( !bColsRowsValid )
          return;

      bool bPxWinSizeValid = (_rPxWinSize.Width() >= 0) &&
                             (_rPxWinSize.Height() >= 0);
      OSL_ENSURE( bPxWinSizeValid, "no window size - preview layout can *not* be initialized" )do { if (true && (!(bPxWinSizeValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "183" ": "), "%s", "no window size - preview layout can *not* be initialized"
); } } while (false);
      if ( !bPxWinSizeValid )
          return;
  }

  // environment and parameters ok

  // clear existing preview settings
  Clear_();

  // set layout information columns and rows
  mnCols = _nCols;
  mnRows = _nRows;

  CalcPreviewLayoutSizes();

  // validate layout information
  mbLayoutInfoValid = true;

  // calculate scaling
  MapMode aMapMode( MapUnit::MapTwip );
  Size aWinSize = mrParentViewShell.GetOut()->PixelToLogic( _rPxWinSize, aMapMode );
  Fraction aXScale( aWinSize.Width(), mnPreviewLayoutWidth );
  Fraction aYScale( aWinSize.Height(), mnPreviewLayoutHeight );
  if( aXScale < aYScale )
      aYScale = aXScale;
  {
      // adjust scaling for Drawing layer.
      aYScale *= Fraction( 1000, 1 );
      long nNewNuminator = aYScale.operator long();
      if( nNewNuminator < 1 )
          nNewNuminator = 1;
      aYScale = Fraction( nNewNuminator, 1000 );
      // propagate scaling as zoom percentage to view options for font cache
      ApplyNewZoomAtViewShell( static_cast<sal_uInt8>(nNewNuminator/10) );

      aMapMode.SetScaleY( aYScale );
      aMapMode.SetScaleX( aYScale );
      // set created mapping mode with calculated scaling at output device.
      mrParentViewShell.GetOut()->SetMapMode( aMapMode );
      // update statics for paint.
      ::SwCalcPixStatics( mrParentViewShell.GetOut() );
  }

  // set window size in twips
  maWinSize = mrParentViewShell.GetOut()->PixelToLogic( _rPxWinSize );
  // validate layout sizes
  mbLayoutSizesValid = true;
231}

233/** apply new zoom at given view shell */
234void SwPagePreviewLayout::ApplyNewZoomAtViewShell( sal_uInt8 _aNewZoom )
235{
  SwViewOption aNewViewOptions = *(mrParentViewShell.GetViewOptions());
  if ( aNewViewOptions.GetZoom() != _aNewZoom )
  {
      aNewViewOptions.SetZoom( _aNewZoom );
      //#i19975# - consider zoom type.
      aNewViewOptions.SetZoomType( SvxZoomType::PERCENT );
      mrParentViewShell.ApplyViewOptions( aNewViewOptions );
  }
244}

246/** method to adjust page preview layout to document changes

248*/
249void SwPagePreviewLayout::ReInit()
250{
  // check environment and parameters
  {
      bool bLayoutSettingsValid = mbLayoutInfoValid && mbLayoutSizesValid;
      OSL_ENSURE( bLayoutSettingsValid,do { if (true && (!(bLayoutSettingsValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "255" ": "), "%s", "no valid preview layout info/sizes - no re-init of page preview layout"
); } } while (false)
              "no valid preview layout info/sizes - no re-init of page preview layout")do { if (true && (!(bLayoutSettingsValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "255" ": "), "%s", "no valid preview layout info/sizes - no re-init of page preview layout"
); } } while (false);
      if ( !bLayoutSettingsValid )
          return;
  }

  ClearPreviewLayoutSizes();
  CalcPreviewLayoutSizes();
262}

264// methods to prepare paint of page preview

266/** prepare paint of page preview

  delete parameter _onStartPageVirtNum

  @note _nProposedStartPageNum, _onStartPageNum are absolute
271*/
272bool SwPagePreviewLayout::Prepare( const sal_uInt16 _nProposedStartPageNum,
                                 const Point&      rProposedStartPos,
                                 const Size&      _rPxWinSize,
                                 sal_uInt16&      _onStartPageNum,
                                 tools::Rectangle&       _orDocPreviewPaintRect,
                                 const bool       _bStartWithPageAtFirstCol
                               )
279{
  sal_uInt16 nProposedStartPageNum = ConvertAbsoluteToRelativePageNum( _nProposedStartPageNum );
  // check environment and parameters
  {
      bool bLayoutSettingsValid = mbLayoutInfoValid && mbLayoutSizesValid;
      OSL_ENSURE( bLayoutSettingsValid,do { if (true && (!(bLayoutSettingsValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "285" ": "), "%s", "no valid preview layout info/sizes - no prepare of preview paint"
); } } while (false)
              "no valid preview layout info/sizes - no prepare of preview paint")do { if (true && (!(bLayoutSettingsValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "285" ": "), "%s", "no valid preview layout info/sizes - no prepare of preview paint"
); } } while (false);
      if ( !bLayoutSettingsValid )
          return false;

      bool bStartPageRangeValid = nProposedStartPageNum <= mnPages;
      OSL_ENSURE( bStartPageRangeValid,do { if (true && (!(bStartPageRangeValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "291" ": "), "%s", "proposed start page not existing - no prepare of preview paint"
); } } while (false)
              "proposed start page not existing - no prepare of preview paint")do { if (true && (!(bStartPageRangeValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "291" ": "), "%s", "proposed start page not existing - no prepare of preview paint"
); } } while (false);
      if ( !bStartPageRangeValid )
          return false;

      bool bStartPosRangeValid =
              rProposedStartPos.X() >= 0 && rProposedStartPos.Y() >= 0 &&
              rProposedStartPos.X() <= maPreviewDocRect.Right() &&
              rProposedStartPos.Y() <= maPreviewDocRect.Bottom();
      OSL_ENSURE( bStartPosRangeValid,do { if (true && (!(bStartPosRangeValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "300" ": "), "%s", "proposed start position out of range - no prepare of preview paint"
); } } while (false)
              "proposed start position out of range - no prepare of preview paint")do { if (true && (!(bStartPosRangeValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "300" ": "), "%s", "proposed start position out of range - no prepare of preview paint"
); } } while (false);
      if ( !bStartPosRangeValid )
          return false;

      bool bWinSizeValid = !_rPxWinSize.IsEmpty();
      OSL_ENSURE( bWinSizeValid, "no window size - no prepare of preview paint")do { if (true && (!(bWinSizeValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "305" ": "), "%s", "no window size - no prepare of preview paint"
); } } while (false);
      if ( !bWinSizeValid )
          return false;

      bool bStartInfoValid = _nProposedStartPageNum > 0 ||
                             rProposedStartPos != Point(0,0);
      if ( !bStartInfoValid )
          nProposedStartPageNum = 1;
  }

  // environment and parameter ok

  // update window size at preview setting data
  maWinSize = mrParentViewShell.GetOut()->PixelToLogic( _rPxWinSize );

  mbNoPageVisible = false;
  if ( nProposedStartPageNum > 0 )
  {
      // determine column and row of proposed start page in virtual preview layout
      const sal_uInt16 nColOfProposed = GetColOfPage( nProposedStartPageNum );
      const sal_uInt16 nRowOfProposed = GetRowOfPage( nProposedStartPageNum );
      // determine start page
      if ( _bStartWithPageAtFirstCol )
      {
          // leaving left-top-corner blank is
          // controlled by <mbBookPreview>.
          if ( mbBookPreview &&
               ( nProposedStartPageNum == 1 || nRowOfProposed == 1 )
             )
              mnPaintPhyStartPageNum = 1;
          else
              mnPaintPhyStartPageNum = nProposedStartPageNum - (nColOfProposed-1);
      }
      else
          mnPaintPhyStartPageNum = nProposedStartPageNum;

      mnPaintPhyStartPageNum = ConvertRelativeToAbsolutePageNum( mnPaintPhyStartPageNum );

      // set starting column
      if ( _bStartWithPageAtFirstCol )
          mnPaintStartCol = 1;
      else
          mnPaintStartCol = nColOfProposed;
      // set starting row
      mnPaintStartRow = nRowOfProposed;
      // page offset == (-1,-1), indicating no offset and paint of free space.
      maPaintStartPageOffset.setX( -1 );
      maPaintStartPageOffset.setY( -1 );
      // virtual preview document offset.
      if ( _bStartWithPageAtFirstCol )
          maPaintPreviewDocOffset.setX( 0 );
      else
          maPaintPreviewDocOffset.setX( (nColOfProposed-1) * mnColWidth );
      maPaintPreviewDocOffset.setY( (nRowOfProposed-1) * mnRowHeight );
  }
  else
  {
      // determine column and row of proposed start position.
      // Note: paint starts at point (0,0)
      const sal_uInt16 nColOfProposed =
              static_cast<sal_uInt16>(rProposedStartPos.X() / mnColWidth) + 1;
      const sal_uInt16 nRowOfProposed =
              static_cast<sal_uInt16>(rProposedStartPos.Y() / mnRowHeight) + 1;
      // determine start page == page at proposed start position
      // leaving left-top-corner blank is
      // controlled by <mbBookPreview>.
      if ( mbBookPreview &&
           ( nRowOfProposed == 1 && nColOfProposed == 1 )
         )
          mnPaintPhyStartPageNum = 1;
      else
      {
          // leaving left-top-corner blank is
          // controlled by <mbBookPreview>.
          mnPaintPhyStartPageNum = (nRowOfProposed-1) * mnCols + nColOfProposed;
          if ( mbBookPreview )
              --mnPaintPhyStartPageNum;
          if ( mnPaintPhyStartPageNum > mnPages )
          {
              // no page will be visible, because shown part of document
              // preview is the last row to the right of the last page
              mnPaintPhyStartPageNum = mnPages;
              mbNoPageVisible = true;
          }
      }
      // set starting column and starting row
      mnPaintStartCol = nColOfProposed;
      mnPaintStartRow = nRowOfProposed;
      // page offset
      maPaintStartPageOffset.setX(
              (rProposedStartPos.X() % mnColWidth) - gnXFree );
      maPaintStartPageOffset.setY(
              (rProposedStartPos.Y() % mnRowHeight) - gnYFree );
      // virtual preview document offset.
      maPaintPreviewDocOffset = rProposedStartPos;
  }

  // determine additional paint offset, if preview layout fits into window.
  CalcAdditionalPaintOffset();

  // determine rectangle to be painted from document preview
  CalcDocPreviewPaintRect();
  _orDocPreviewPaintRect = maPaintedPreviewDocRect;

  // shift visible preview document area to the left,
  // if on the right is an area left blank.
  if ( !mbDoesLayoutColsFitIntoWindow &&
       maPaintedPreviewDocRect.GetWidth() < maWinSize.Width() )
  {
      maPaintedPreviewDocRect.Move(
              -(maWinSize.Width() - maPaintedPreviewDocRect.GetWidth()), 0 );
      Prepare( 0, maPaintedPreviewDocRect.TopLeft(),
               _rPxWinSize, _onStartPageNum,
               _orDocPreviewPaintRect, _bStartWithPageAtFirstCol );
  }

  // shift visible preview document area to the top,
  // if on the bottom is an area left blank.
  if ( mbBookPreviewModeToggled &&
       maPaintedPreviewDocRect.Bottom() == maPreviewDocRect.Bottom() &&
       maPaintedPreviewDocRect.GetHeight() < maWinSize.Height() )
  {
      if ( mbDoesLayoutRowsFitIntoWindow )
      {
          if ( maPaintedPreviewDocRect.GetHeight() < mnPreviewLayoutHeight)
          {
              maPaintedPreviewDocRect.Move(
                      0, -(mnPreviewLayoutHeight - maPaintedPreviewDocRect.GetHeight()) );
              Prepare( 0, maPaintedPreviewDocRect.TopLeft(),
                       _rPxWinSize, _onStartPageNum,
                       _orDocPreviewPaintRect, _bStartWithPageAtFirstCol );
          }
      }
      else
      {
          maPaintedPreviewDocRect.Move(
                  0, -(maWinSize.Height() - maPaintedPreviewDocRect.GetHeight()) );
          Prepare( 0, maPaintedPreviewDocRect.TopLeft(),
                   _rPxWinSize, _onStartPageNum,
                   _orDocPreviewPaintRect, _bStartWithPageAtFirstCol );
      }
  }

  // determine preview pages - visible pages with needed data for paint and
  // accessible pages with needed data.
  CalcPreviewPages();

  // OD 07.11.2003 #i22014# - indicate new layout, if print preview is in paint
  if ( mbInPaint )
  {
      mbNewLayoutDuringPaint = true;
  }

  // validate paint data
  mbPaintInfoValid = true;

  // return start page
  _onStartPageNum = mnPaintPhyStartPageNum;

  return true;
465}

467/** calculate additional paint offset

469*/
470void SwPagePreviewLayout::CalcAdditionalPaintOffset()
471{
  if ( mnPreviewLayoutWidth <= maWinSize.Width() &&
       maPaintStartPageOffset.X() <= 0 )
  {
      mbDoesLayoutColsFitIntoWindow = true;
      maAdditionalPaintOffset.setX( (maWinSize.Width() - mnPreviewLayoutWidth) / 2 );
  }
  else
  {
      mbDoesLayoutColsFitIntoWindow = false;
      maAdditionalPaintOffset.setX( 0 );
  }

  if ( mnPreviewLayoutHeight <= maWinSize.Height() &&
       maPaintStartPageOffset.Y() <= 0 )
  {
      mbDoesLayoutRowsFitIntoWindow = true;
      maAdditionalPaintOffset.setY( (maWinSize.Height() - mnPreviewLayoutHeight) / 2 );
  }
  else
  {
      mbDoesLayoutRowsFitIntoWindow = false;
      maAdditionalPaintOffset.setY( 0 );
  }
495}

497/** calculate painted preview document rectangle

499*/
500void SwPagePreviewLayout::CalcDocPreviewPaintRect()
501{
  Point aTopLeftPos = maPaintPreviewDocOffset;
  maPaintedPreviewDocRect.SetPos( aTopLeftPos );

  Size aSize;
  if ( mbDoesLayoutColsFitIntoWindow )
      aSize.setWidth( std::min( mnPreviewLayoutWidth,
                           maPreviewDocRect.GetWidth() - aTopLeftPos.X() ) );
  else
      aSize.setWidth( std::min( maPreviewDocRect.GetWidth() - aTopLeftPos.X(),
                           maWinSize.Width() - maAdditionalPaintOffset.X() ) );
  if ( mbDoesLayoutRowsFitIntoWindow )
      aSize.setHeight( std::min( mnPreviewLayoutHeight,
                            maPreviewDocRect.GetHeight() - aTopLeftPos.Y() ) );
  else
      aSize.setHeight( std::min( maPreviewDocRect.GetHeight() - aTopLeftPos.Y(),
                            maWinSize.Height() - maAdditionalPaintOffset.Y() ) );
  maPaintedPreviewDocRect.SetSize( aSize );
519}

521/** calculate preview pages

523*/
524void SwPagePreviewLayout::CalcPreviewPages()
525{
  vcl::RenderContext* pRenderContext = mrParentViewShell.GetOut();
  ClearPreviewPageData();

  if ( mbNoPageVisible )
      return;

  // determine start page frame
  const SwPageFrame* pStartPage = mrLayoutRootFrame.GetPageByPageNum( mnPaintPhyStartPageNum );

  // calculate initial paint offset
  Point aInitialPaintOffset;
  /// check whether RTL interface or not
  if(!AllSettings::GetLayoutRTL()){
      if ( maPaintStartPageOffset != Point( -1, -1 ) )
          aInitialPaintOffset = Point(0,0) - maPaintStartPageOffset;
      else
          aInitialPaintOffset = Point( gnXFree, gnYFree );
  }
  else {
      if ( maPaintStartPageOffset != Point( -1, -1 ) )
          aInitialPaintOffset = Point(0 + ((SwPagePreviewLayout::mnCols-1)*mnColWidth),0) - maPaintStartPageOffset;
      else
          aInitialPaintOffset = Point( gnXFree + ((SwPagePreviewLayout::mnCols-1)*mnColWidth), gnYFree );
  }
  aInitialPaintOffset += maAdditionalPaintOffset;

  // prepare loop data
  const SwPageFrame* pPage = pStartPage;
  sal_uInt16 nCurrCol = mnPaintStartCol;
  sal_uInt16 nConsideredRows = 0;
  Point aCurrPaintOffset = aInitialPaintOffset;
  // loop on pages to determine preview background rectangles
  while ( pPage &&
          (!mbDoesLayoutRowsFitIntoWindow || nConsideredRows < mnRows) &&
          aCurrPaintOffset.Y() < maWinSize.Height()
        )
  {
      if ( !mbBookPreview && !mbPrintEmptyPages && pPage->IsEmptyPage() )
      {
          pPage = static_cast<const SwPageFrame*>(pPage->GetNext());
          continue;
      }

      pPage->Calc(pRenderContext);

      // consider only pages, which have to be painted.
      if ( nCurrCol < mnPaintStartCol )
      {
          // calculate data of unvisible page needed for accessibility
          std::unique_ptr<PreviewPage> pPreviewPage(new PreviewPage);
          Point aCurrAccOffset = aCurrPaintOffset -
                         Point( (mnPaintStartCol-nCurrCol) * mnColWidth, 0 );
          CalcPreviewDataForPage( *pPage, aCurrAccOffset, pPreviewPage.get() );
          pPreviewPage->bVisible = false;
          maPreviewPages.push_back( std::move(pPreviewPage) );
          // continue with next page and next column
          pPage = static_cast<const SwPageFrame*>(pPage->GetNext());
          ++nCurrCol;
          continue;
      }
      if ( aCurrPaintOffset.X() < maWinSize.Width() )
      {
          // leaving left-top-corner blank is
          // controlled by <mbBookPreview>.
          if ( mbBookPreview && pPage->GetPhyPageNum() == 1 && mnCols != 1 && nCurrCol == 1
             )
          {
              // first page in 2nd column
              // --> continue with increased paint offset and next column
              /// check whether RTL interface or not
              if(!AllSettings::GetLayoutRTL())
                  aCurrPaintOffset.AdjustX(mnColWidth );
              else aCurrPaintOffset.AdjustX( -mnColWidth );
              ++nCurrCol;
              continue;
          }

          // calculate data of visible page
          std::unique_ptr<PreviewPage> pPreviewPage(new PreviewPage);
          CalcPreviewDataForPage( *pPage, aCurrPaintOffset, pPreviewPage.get() );
          pPreviewPage->bVisible = true;
          maPreviewPages.push_back( std::move(pPreviewPage) );
      }
      else
      {
          // calculate data of unvisible page needed for accessibility
          std::unique_ptr<PreviewPage> pPreviewPage(new PreviewPage);
          CalcPreviewDataForPage( *pPage, aCurrPaintOffset, pPreviewPage.get() );
          pPreviewPage->bVisible = false;
          maPreviewPages.push_back( std::move(pPreviewPage) );
      }

      // prepare data for next loop
      pPage = static_cast<const SwPageFrame*>(pPage->GetNext());

      /// check whether RTL interface or not
      if(!AllSettings::GetLayoutRTL())
          aCurrPaintOffset.AdjustX(mnColWidth );
      else aCurrPaintOffset.AdjustX( -mnColWidth );
      ++nCurrCol;
      if ( nCurrCol > mnCols )
      {
          ++nConsideredRows;
          aCurrPaintOffset.setX( aInitialPaintOffset.X() );
          nCurrCol = 1;
          aCurrPaintOffset.AdjustY(mnRowHeight );
      }
  }
634}

636/** determines preview data for a given page and a given preview offset

  OD 13.12.2002 #103492#
639*/
640void SwPagePreviewLayout::CalcPreviewDataForPage( const SwPageFrame& _rPage,
                                                 const Point& _rPreviewOffset,
                                                 PreviewPage* _opPreviewPage )
643{
  // page frame
  _opPreviewPage->pPage = &_rPage;
  // size of page frame
  if ( _rPage.IsEmptyPage() )
  {
      if ( _rPage.GetPhyPageNum() % 2 == 0 )
          _opPreviewPage->aPageSize = _rPage.GetPrev()->getFrameArea().SSize();
      else
          _opPreviewPage->aPageSize = _rPage.GetNext()->getFrameArea().SSize();
  }
  else
      _opPreviewPage->aPageSize = _rPage.getFrameArea().SSize();
  // position of page in preview window
  Point aPreviewWinOffset( _rPreviewOffset );
  if ( _opPreviewPage->aPageSize.Width() < maMaxPageSize.Width() )
      aPreviewWinOffset.AdjustX(( maMaxPageSize.Width() - _opPreviewPage->aPageSize.Width() ) / 2 );
  if ( _opPreviewPage->aPageSize.Height() < maMaxPageSize.Height() )
      aPreviewWinOffset.AdjustY(( maMaxPageSize.Height() - _opPreviewPage->aPageSize.Height() ) / 2 );
  _opPreviewPage->aPreviewWinPos = aPreviewWinOffset;
  // logic position of page and mapping offset for paint
  if ( _rPage.IsEmptyPage() )
  {
      _opPreviewPage->aLogicPos = _opPreviewPage->aPreviewWinPos;
      _opPreviewPage->aMapOffset = Point( 0, 0 );
  }
  else
  {
      _opPreviewPage->aLogicPos = _rPage.getFrameArea().Pos();
      _opPreviewPage->aMapOffset = _opPreviewPage->aPreviewWinPos - _opPreviewPage->aLogicPos;
  }
674}

676/** enable/disable book preview

  OD 2004-03-04 #i18143#
679*/
680bool SwPagePreviewLayout::SetBookPreviewMode( const bool _bEnableBookPreview,
                                            sal_uInt16& _onStartPageNum,
                                            tools::Rectangle&  _orDocPreviewPaintRect )
683{
  if ( mbBookPreview != _bEnableBookPreview)
  {
      mbBookPreview = _bEnableBookPreview;
      // re-initialize page preview layout
      ReInit();
      // re-prepare page preview layout
      {
          mbBookPreviewModeToggled = true;
          Point aProposedStartPos( maPaintPreviewDocOffset );
          // if proposed start position is below virtual preview document
          // bottom, adjust it to the virtual preview document bottom
          if ( aProposedStartPos.Y() > maPreviewDocRect.Bottom() )
          {
              aProposedStartPos.setY( maPreviewDocRect.Bottom() );
          }
          Prepare( 0, aProposedStartPos,
                   mrParentViewShell.GetOut()->LogicToPixel( maWinSize ),
                   _onStartPageNum, _orDocPreviewPaintRect );
          mbBookPreviewModeToggled = false;
      }

      return true;
  }

  return false;
709}

711// methods to determine new data for changing the current shown part of the
712// document preview.

714/** calculate start position for new scale

716*/
717Point SwPagePreviewLayout::GetPreviewStartPosForNewScale(
                        const Fraction& _aNewScale,
                        const Fraction& _aOldScale,
                        const Size&     _aNewWinSize ) const
721{
  Point aNewPaintStartPos = maPaintedPreviewDocRect.TopLeft();
  if ( _aNewScale < _aOldScale )
  {
      // increase paint width by moving start point to left.
      if ( mnPreviewLayoutWidth < _aNewWinSize.Width() )
          aNewPaintStartPos.setX( 0 );
      else if ( maPaintedPreviewDocRect.GetWidth() < _aNewWinSize.Width() )
      {
          aNewPaintStartPos.AdjustX( -(
              (_aNewWinSize.Width() - maPaintedPreviewDocRect.GetWidth()) / 2) );
          if ( aNewPaintStartPos.X() < 0)
              aNewPaintStartPos.setX( 0 );
      }

      if ( !mbDoesLayoutRowsFitIntoWindow )
      {
          // increase paint height by moving start point to top.
          if ( mnPreviewLayoutHeight < _aNewWinSize.Height() )
          {
              aNewPaintStartPos.setY(
                  (mnPaintStartRow - 1) * mnRowHeight );
          }
          else if ( maPaintedPreviewDocRect.GetHeight() < _aNewWinSize.Height() )
          {
              aNewPaintStartPos.AdjustY( -(
                  (_aNewWinSize.Height() - maPaintedPreviewDocRect.GetHeight()) / 2) );
              if ( aNewPaintStartPos.Y() < 0)
                  aNewPaintStartPos.setY( 0 );
          }
      }
  }
  else
  {
      // decrease paint width by moving start point to right
      if ( maPaintedPreviewDocRect.GetWidth() > _aNewWinSize.Width() )
          aNewPaintStartPos.AdjustX(
              (maPaintedPreviewDocRect.GetWidth() - _aNewWinSize.Width()) / 2 );
      // decrease paint height by moving start point to bottom
      if ( maPaintedPreviewDocRect.GetHeight() > _aNewWinSize.Height() )
      {
          aNewPaintStartPos.AdjustY(
              (maPaintedPreviewDocRect.GetHeight() - _aNewWinSize.Height()) / 2 );
          // check, if new y-position is outside document preview
          if ( aNewPaintStartPos.Y() > maPreviewDocRect.Bottom() )
              aNewPaintStartPos.setY(
                      std::max( 0L, maPreviewDocRect.Bottom() - mnPreviewLayoutHeight ) );
      }
  }

  return aNewPaintStartPos;
772}

774/** determines, if page with given page number is visible in preview

  @note _nPageNum is absolute
777*/
778bool SwPagePreviewLayout::IsPageVisible( const sal_uInt16 _nPageNum ) const
779{
  const PreviewPage* pPreviewPage = GetPreviewPageByPageNum( _nPageNum );
  return pPreviewPage && pPreviewPage->bVisible;
782}

784/** calculate data to bring new selected page into view.

  @note IN/OUT parameters are absolute page numbers!!!
787*/
788void SwPagePreviewLayout::CalcStartValuesForSelectedPageMove(
                              const sal_Int16  _nHoriMove,
                              const sal_Int16  _nVertMove,
                              sal_uInt16&      _orNewSelectedPage,
                              sal_uInt16&      _orNewStartPage,
                              Point&           _orNewStartPos ) const
794{
  // determine position of current selected page
  sal_uInt16 nTmpRelSelPageNum = ConvertAbsoluteToRelativePageNum( mnSelectedPageNum );
  sal_uInt16 nNewRelSelectedPageNum = nTmpRelSelPageNum;

  const sal_uInt16 nCurrRow = GetRowOfPage(nTmpRelSelPageNum);

  // determine new selected page number
  {
      if ( _nHoriMove != 0 )
      {
          if ( (nNewRelSelectedPageNum + _nHoriMove) < 1 )
              nNewRelSelectedPageNum = 1;
          else if ( (nNewRelSelectedPageNum + _nHoriMove) > mnPages )
              nNewRelSelectedPageNum = mnPages;
          else
              nNewRelSelectedPageNum = nNewRelSelectedPageNum + _nHoriMove;
      }
      if ( _nVertMove != 0 )
      {
          if ( (nNewRelSelectedPageNum + (_nVertMove * mnCols)) < 1 )
              nNewRelSelectedPageNum = 1;
          else if ( (nNewRelSelectedPageNum + (_nVertMove * mnCols)) > mnPages )
              nNewRelSelectedPageNum = mnPages;
          else
              nNewRelSelectedPageNum += ( _nVertMove * mnCols );
      }
  }

  sal_uInt16 nNewStartPage = mnPaintPhyStartPageNum;
  Point aNewStartPos(0,0);

  const sal_uInt16 nNewAbsSelectedPageNum = ConvertRelativeToAbsolutePageNum( nNewRelSelectedPageNum );
  if ( !IsPageVisible( nNewAbsSelectedPageNum ) )
  {
      if ( _nHoriMove != 0 && _nVertMove != 0 )
      {
          OSL_FAIL( "missing implementation for moving preview selected page horizontal AND vertical")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "831" ": "), "%s", "missing implementation for moving preview selected page horizontal AND vertical"
); } } while (false);
          return;
      }

      // new selected page has to be brought into view considering current
      // visible preview.
      const sal_uInt16 nTotalRows = GetRowOfPage( mnPages );
      if ( (_nHoriMove > 0 || _nVertMove > 0) &&
           mbDoesLayoutRowsFitIntoWindow &&
           mbDoesLayoutColsFitIntoWindow &&
           nCurrRow > nTotalRows - mnRows )
      {
          // new proposed start page = left-top-corner of last possible
          // preview page.
          nNewStartPage = (nTotalRows - mnRows) * mnCols + 1;
          // leaving left-top-corner blank is controlled
          // by <mbBookPreview>.
          if ( mbBookPreview )
          {
              // Note: decrease new proposed start page number by one,
              // because of blank left-top-corner
              --nNewStartPage;
          }
          nNewStartPage = ConvertRelativeToAbsolutePageNum( nNewStartPage );
      }
      else
      {
          // new proposed start page = new selected page.
          nNewStartPage = ConvertRelativeToAbsolutePageNum( nNewRelSelectedPageNum );
      }
  }

  _orNewSelectedPage = nNewAbsSelectedPageNum;
  _orNewStartPage = nNewStartPage;
  _orNewStartPos = aNewStartPos;
866}

868namespace {

870/** checks, if given position is inside a shown document page */
871struct PreviewPosInsidePagePred
872{
  const Point mnPreviewPos;
  explicit PreviewPosInsidePagePred(const Point& rPreviewPos)
      : mnPreviewPos( rPreviewPos )
  {}
  bool operator() ( const std::unique_ptr<PreviewPage> & _pPreviewPage )
  {
      if ( _pPreviewPage->bVisible )
      {
          tools::Rectangle aPreviewPageRect( _pPreviewPage->aPreviewWinPos, _pPreviewPage->aPageSize );
          return aPreviewPageRect.IsInside( mnPreviewPos );
      }
      return false;
  }
886};

888}

890bool SwPagePreviewLayout::IsPreviewPosInDocPreviewPage( const Point&  rPreviewPos,
                                                  Point&       _orDocPos,
                                                  bool&        _obPosInEmptyPage,
                                                  sal_uInt16&  _onPageNum ) const
894{
  // initialize variable parameter values.
  _orDocPos.setX( 0 );
  _orDocPos.setY( 0 );
  _obPosInEmptyPage = false;
  _onPageNum = 0;

  auto aFoundPreviewPageIter =
          std::find_if( maPreviewPages.begin(), maPreviewPages.end(),
                        PreviewPosInsidePagePred( rPreviewPos ) );

  if ( aFoundPreviewPageIter != maPreviewPages.end() )
  {
      // given preview position is inside a document page.
      _onPageNum = (*aFoundPreviewPageIter)->pPage->GetPhyPageNum();
      _obPosInEmptyPage = (*aFoundPreviewPageIter)->pPage->IsEmptyPage();
      if ( !_obPosInEmptyPage )
      {
          // given preview position inside a normal page
          _orDocPos = rPreviewPos -
                      (*aFoundPreviewPageIter)->aPreviewWinPos +
                      (*aFoundPreviewPageIter)->aLogicPos;
          return true;
      }
  }

  return false;
921}

923/** determine window page scroll amount */
924SwTwips SwPagePreviewLayout::GetWinPagesScrollAmount(
                              const sal_Int16 _nWinPagesToScroll ) const
926{
  SwTwips nScrollAmount;
  if ( mbDoesLayoutRowsFitIntoWindow )
  {
      nScrollAmount = (mnPreviewLayoutHeight - gnYFree) * _nWinPagesToScroll;
  }
  else
      nScrollAmount = _nWinPagesToScroll * maPaintedPreviewDocRect.GetHeight();

  // check, if preview layout size values are valid.
  // If not, the checks for an adjustment of the scroll amount aren't useful.
  if ( mbLayoutSizesValid )
  {
      if ( (maPaintedPreviewDocRect.Top() + nScrollAmount) <= 0 )
          nScrollAmount = -maPaintedPreviewDocRect.Top();

      // correct scroll amount
      if ( nScrollAmount > 0 &&
           maPaintedPreviewDocRect.Bottom() == maPreviewDocRect.Bottom()
         )
      {
          nScrollAmount = 0;
      }
      else
      {
          while ( (maPaintedPreviewDocRect.Top() + nScrollAmount + gnYFree) >= maPreviewDocRect.GetHeight() )
          {
              nScrollAmount -= mnRowHeight;
          }
      }
  }

  return nScrollAmount;
959}

961// methods to paint page preview layout

963namespace
964{
965/// Similar to RenderContextGuard, but does not touch the draw view.
966class PreviewRenderContextGuard
967{
  VclPtr<vcl::RenderContext> m_pOriginalValue;
  SwViewShell& m_rShell;

971public:
  PreviewRenderContextGuard(SwViewShell& rShell, vcl::RenderContext* pValue)
      : m_pOriginalValue(rShell.GetOut()),
2
←
Calling constructor for 'VclPtr<OutputDevice>'→
7
←
Returning from constructor for 'VclPtr<OutputDevice>'→
      m_rShell(rShell)
  {
      m_rShell.SetOut(pValue);
8
←
Calling 'SwViewShell::SetOut'→
20
←
Returning; memory was released→
  }

  ~PreviewRenderContextGuard()
  {
      m_rShell.SetOut(m_pOriginalValue);
28
←
Calling 'VclPtr::operator OutputDevice *'→
  }
983};
984}

986/** paint prepared preview

988*/
989bool SwPagePreviewLayout::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rOutRect) const
990{
  PreviewRenderContextGuard aGuard(mrParentViewShell, &rRenderContext);
1
Calling constructor for 'PreviewRenderContextGuard'→
21
←
Returning from constructor for 'PreviewRenderContextGuard'→
  // check environment and parameters
  {
      if (!mrParentViewShell.GetWin() && !mrParentViewShell.GetOut()->GetConnectMetaFile())
22
←
Assuming the condition is false→
      {
          return false;
      }

      OSL_ENSURE(mbPaintInfoValid, "invalid preview settings - no paint of preview")do { if (true && (!(mbPaintInfoValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "999" ": "), "%s", "invalid preview settings - no paint of preview"
); } } while (false);
23
←
Assuming field 'mbPaintInfoValid' is false→
24
←
Taking true branch→
25
←
Loop condition is false.  Exiting loop→
      if (!mbPaintInfoValid25.1
Field 'mbPaintInfoValid' is false
1
Field 'mbPaintInfoValid' is false
1
Field 'mbPaintInfoValid' is false
1
Field 'mbPaintInfoValid' is false
1
Field 'mbPaintInfoValid' is false
)
26
←
Taking true branch→
          return false;
27
←
Calling '~PreviewRenderContextGuard'→
  }

  // OD 17.11.2003 #i22014# - no paint, if <superfluous> flag is set at layout
  if (mrLayoutRootFrame.IsSuperfluous())
  {
      return true;
  }

  // environment and parameter ok

  if (mbInPaint)
  {
      return false;
  }
  mbInPaint = true;

  OutputDevice* pOutputDev = &rRenderContext;

  // prepare paint
  if ( !maPreviewPages.empty() )
  {
      mrParentViewShell.Imp()->m_bFirstPageInvalid = false;
      mrParentViewShell.Imp()->m_pFirstVisiblePage =
              const_cast<SwPageFrame*>(maPreviewPages[0]->pPage);
  }

  // paint preview background
  {
      SwRegionRects aPreviewBackgrdRegion(rOutRect);
      // calculate preview background rectangles
      for ( auto & rpPreviewPage : maPreviewPages )
      {
          if ( rpPreviewPage->bVisible )
          {
              aPreviewBackgrdRegion -=
                      SwRect( rpPreviewPage->aPreviewWinPos, rpPreviewPage->aPageSize );
          }
      }
      // paint preview background rectangles
      mrParentViewShell.PaintDesktop_(aPreviewBackgrdRegion);
  }

  // prepare data for paint of pages
  const tools::Rectangle aPxOutRect( pOutputDev->LogicToPixel(rOutRect) );

  MapMode aMapMode( pOutputDev->GetMapMode() );
  MapMode aSavedMapMode = aMapMode;

  const vcl::Font& rEmptyPgFont = SwPageFrame::GetEmptyPageFont();

  for ( auto & rpPreviewPage : maPreviewPages )
  {
      if ( !rpPreviewPage->bVisible )
          continue;

      tools::Rectangle aPageRect( rpPreviewPage->aLogicPos, rpPreviewPage->aPageSize );
      aMapMode.SetOrigin( rpPreviewPage->aMapOffset );
      pOutputDev->SetMapMode( aMapMode );
      tools::Rectangle aPxPaintRect = pOutputDev->LogicToPixel( aPageRect );
      if ( aPxOutRect.IsOver( aPxPaintRect) )
      {
          const SwPageFrame* pPage = rpPreviewPage->pPage;

          if (pPage->IsEmptyPage())
          {
              const Color aRetouche( mrParentViewShell.Imp()->GetRetoucheColor() );
              if( pOutputDev->GetFillColor() != aRetouche )
                  pOutputDev->SetFillColor( aRetouche );
              pOutputDev->SetLineColor(); // no line color
              // use aligned page rectangle
              {
                  SwRect aTmpPageRect( aPageRect );
                  ::SwAlignRect( aTmpPageRect, &mrParentViewShell, &rRenderContext );
                  aPageRect = aTmpPageRect.SVRect();
              }
              pOutputDev->DrawRect( aPageRect );

              // paint empty page text
              vcl::Font aOldFont( pOutputDev->GetFont() );
              pOutputDev->SetFont( rEmptyPgFont );
              pOutputDev->DrawText( aPageRect, SwResId( STR_EMPTYPAGEreinterpret_cast<char const *>("STR_EMPTYPAGE" "\004" u8"blank page"
) ),
                                  DrawTextFlags::VCenter |
                                  DrawTextFlags::Center |
                                  DrawTextFlags::Clip );
              pOutputDev->SetFont( aOldFont );
              // paint shadow and border for empty page
              // use new method to paint page border and shadow
              SwPageFrame::PaintBorderAndShadow( aPageRect, &mrParentViewShell, true, false, true );
          }
          else
          {
              const bool bIsLeftShadowed = pPage->IsLeftShadowNeeded();
              const bool bIsRightShadowed = pPage->IsRightShadowNeeded();

              mrParentViewShell.maVisArea = aPageRect;
              aPxPaintRect.Intersection( aPxOutRect );
              tools::Rectangle aPaintRect = pOutputDev->PixelToLogic( aPxPaintRect );
              mrParentViewShell.Paint(rRenderContext, aPaintRect);

              // --> OD 2007-08-15 #i80691#
              // paint page border and shadow
              {
                  SwRect aPageBorderRect;
                  SwPageFrame::GetBorderAndShadowBoundRect( SwRect( aPageRect ), &mrParentViewShell, &rRenderContext, aPageBorderRect,
                      bIsLeftShadowed, bIsRightShadowed, true );
                  const vcl::Region aDLRegion(aPageBorderRect.SVRect());
                  mrParentViewShell.DLPrePaint2(aDLRegion);
                  SwPageFrame::PaintBorderAndShadow( aPageRect, &mrParentViewShell, true, false, true );
                  mrParentViewShell.DLPostPaint2(true);
              }
              // <--
          }
          // OD 07.11.2003 #i22014# - stop painting, because new print
          // preview layout is created during paint.
          if ( mbNewLayoutDuringPaint )
          {
              break;
          }

          if (pPage->GetPhyPageNum() == mnSelectedPageNum)
          {
              PaintSelectMarkAtPage(rRenderContext, rpPreviewPage.get());
          }
      }
  }

  // OD 17.11.2003 #i22014# - no update of accessible preview, if a new
  // print preview layout is created during paint.
  if ( !mbNewLayoutDuringPaint )
  {
      // update at accessibility interface
      mrParentViewShell.Imp()->UpdateAccessiblePreview(
                      maPreviewPages,
                      aMapMode.GetScaleX(),
                      mrLayoutRootFrame.GetPageByPageNum( mnSelectedPageNum ),
                      maWinSize );
  }

  pOutputDev->SetMapMode( aSavedMapMode );
  mrParentViewShell.maVisArea.Clear();

  // OD 07.11.2003 #i22014#
  mbInPaint = false;
  mbNewLayoutDuringPaint = false;

  return true;
1148}

1150/** repaint pages on page preview

  OD 18.12.2002 #103492#
1153*/
1154void SwPagePreviewLayout::Repaint( const tools::Rectangle& rInvalidCoreRect ) const
1155{
  // check environment and parameters
  {
      if ( !mrParentViewShell.GetWin() &&
           !mrParentViewShell.GetOut()->GetConnectMetaFile() )
          return;

      OSL_ENSURE( mbPaintInfoValid,do { if (true && (!(mbPaintInfoValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "1163" ": "), "%s", "invalid preview settings - no paint of preview"
); } } while (false)
              "invalid preview settings - no paint of preview" )do { if (true && (!(mbPaintInfoValid))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "1163" ": "), "%s", "invalid preview settings - no paint of preview"
); } } while (false);
      if ( !mbPaintInfoValid )
          return;
  }

  // environment and parameter ok

  // prepare paint
  if ( !maPreviewPages.empty() )
  {
      mrParentViewShell.Imp()->m_bFirstPageInvalid = false;
      mrParentViewShell.Imp()->m_pFirstVisiblePage =
              const_cast<SwPageFrame*>(maPreviewPages[0]->pPage);
  }

  // invalidate visible pages, which overlap the invalid core rectangle
  for ( auto & rpPreviewPage : maPreviewPages )
  {
      if ( !rpPreviewPage->bVisible )
          continue;

      tools::Rectangle aPageRect( rpPreviewPage->aLogicPos, rpPreviewPage->aPageSize );
      if ( rInvalidCoreRect.IsOver( aPageRect ) )
      {
          aPageRect.Intersection(rInvalidCoreRect);
          tools::Rectangle aInvalidPreviewRect = aPageRect;
          aInvalidPreviewRect.SetPos( aInvalidPreviewRect.TopLeft() -
                                    rpPreviewPage->aLogicPos +
                                    rpPreviewPage->aPreviewWinPos );
          mrParentViewShell.GetWin()->Invalidate( aInvalidPreviewRect );
      }
  }
1195}

1197/** paint selection mark at page

  OD 17.12.2002 #103492#
1200*/
1201void SwPagePreviewLayout::PaintSelectMarkAtPage(vcl::RenderContext& rRenderContext,
                                  const PreviewPage* _aSelectedPreviewPage ) const
1203{
  OutputDevice* pOutputDev = &rRenderContext;
  MapMode aMapMode( pOutputDev->GetMapMode() );
  // save mapping mode of output device
  MapMode aSavedMapMode = aMapMode;
  // save fill and line color of output device
  Color aFill( pOutputDev->GetFillColor() );
  Color aLine( pOutputDev->GetLineColor() );

  // determine selection mark color
  Color aSelPgLineColor(117, 114, 106);
  const StyleSettings& rSettings =
      mrParentViewShell.GetWin()->GetSettings().GetStyleSettings();
  if ( rSettings.GetHighContrastMode() )
      aSelPgLineColor = rSettings.GetHighlightTextColor();

  // set needed mapping mode at output device
  aMapMode.SetOrigin( _aSelectedPreviewPage->aMapOffset );
  pOutputDev->SetMapMode( aMapMode );

  // calculate page rectangle in pixel coordinates
  SwRect aPageRect( _aSelectedPreviewPage->aLogicPos,
                       _aSelectedPreviewPage->aPageSize );
  // OD 19.02.2003 #107369# - use aligned page rectangle, as it is used for
  // page border and shadow paint - see <SwPageFrame::PaintBorderAndShadow(..)>
  ::SwAlignRect( aPageRect, &mrParentViewShell, pOutputDev );
  tools::Rectangle aPxPageRect = pOutputDev->LogicToPixel( aPageRect.SVRect() );

  // draw two rectangle
  // OD 19.02.2003 #107369# - adjust position of select mark rectangle
  tools::Rectangle aRect( aPxPageRect.Left(), aPxPageRect.Top(),
                     aPxPageRect.Right(), aPxPageRect.Bottom() );
  aRect = pOutputDev->PixelToLogic( aRect );
  pOutputDev->SetFillColor(); // OD 20.02.2003 #107369# - no fill color
  pOutputDev->SetLineColor( aSelPgLineColor );
  pOutputDev->DrawRect( aRect );
  // OD 19.02.2003 #107369# - adjust position of select mark rectangle
  aRect = tools::Rectangle( aPxPageRect.Left()+1, aPxPageRect.Top()+1,
                     aPxPageRect.Right()-1, aPxPageRect.Bottom()-1 );
  aRect = pOutputDev->PixelToLogic( aRect );
  pOutputDev->DrawRect( aRect );

  // reset fill and line color of output device
  pOutputDev->SetFillColor( aFill );
  pOutputDev->SetLineColor( aLine );

  // reset mapping mode of output device
  pOutputDev->SetMapMode( aSavedMapMode );
1251}

1253/** paint to mark new selected page

  OD 17.12.2002 #103492#
  Perform paint for current selected page in order to unmark it.
  Set new selected page and perform paint to mark this page.

  @note _nSelectedPage, mnSelectedPage are absolute
1260*/
1261void SwPagePreviewLayout::MarkNewSelectedPage( const sal_uInt16 _nSelectedPage )
1262{
  const sal_uInt16 nOldSelectedPageNum = mnSelectedPageNum;
  mnSelectedPageNum = _nSelectedPage;

  // re-paint for current selected page in order to unmark it.
  const PreviewPage* pOldSelectedPreviewPage = GetPreviewPageByPageNum( nOldSelectedPageNum );
  OutputDevice* pOutputDev = mrParentViewShell.GetOut();
  if ( pOldSelectedPreviewPage && pOldSelectedPreviewPage->bVisible )
  {
      // OD 20.02.2003 #107369# - invalidate only areas of selection mark.
      SwRect aPageRect( pOldSelectedPreviewPage->aPreviewWinPos,
                            pOldSelectedPreviewPage->aPageSize );
      ::SwAlignRect( aPageRect, &mrParentViewShell, pOutputDev );
      tools::Rectangle aPxPageRect = pOutputDev->LogicToPixel( aPageRect.SVRect() );
      // invalidate top mark line
      tools::Rectangle aInvalPxRect( aPxPageRect.Left(), aPxPageRect.Top(),
                              aPxPageRect.Right(), aPxPageRect.Top()+1 );
      mrParentViewShell.GetWin()->Invalidate( pOutputDev->PixelToLogic( aInvalPxRect ) );
      // invalidate right mark line
      aInvalPxRect = tools::Rectangle( aPxPageRect.Right()-1, aPxPageRect.Top(),
                                aPxPageRect.Right(), aPxPageRect.Bottom() );
      mrParentViewShell.GetWin()->Invalidate( pOutputDev->PixelToLogic( aInvalPxRect ) );
      // invalidate bottom mark line
      aInvalPxRect = tools::Rectangle( aPxPageRect.Left(), aPxPageRect.Bottom()-1,
                                aPxPageRect.Right(), aPxPageRect.Bottom() );
      mrParentViewShell.GetWin()->Invalidate( pOutputDev->PixelToLogic( aInvalPxRect ) );
      // invalidate left mark line
      aInvalPxRect = tools::Rectangle( aPxPageRect.Left(), aPxPageRect.Top(),
                                aPxPageRect.Left()+1, aPxPageRect.Bottom() );
      mrParentViewShell.GetWin()->Invalidate( pOutputDev->PixelToLogic( aInvalPxRect ) );
  }

  // re-paint for new selected page in order to mark it.
  const PreviewPage* pNewSelectedPreviewPage = GetPreviewPageByPageNum( _nSelectedPage );
  if ( pNewSelectedPreviewPage && pNewSelectedPreviewPage->bVisible )
  {
      const PreviewPage* pSelectedPreviewPage = GetPreviewPageByPageNum(mnSelectedPageNum);
      SwRect aPageRect(pSelectedPreviewPage->aPreviewWinPos, pSelectedPreviewPage->aPageSize);
      ::SwAlignRect(aPageRect, &mrParentViewShell, pOutputDev);
      mrParentViewShell.GetWin()->Invalidate(aPageRect.SVRect());
  }
1303}

1305// helper methods

1307namespace {

1309/** get preview page by physical page number

  OD 17.12.2002 #103492#
1312*/
1313struct EqualsPageNumPred
1314{
  const sal_uInt16 mnPageNum;
  explicit EqualsPageNumPred(const sal_uInt16 _nPageNum)
      : mnPageNum( _nPageNum )
  {}
  bool operator() ( const std::unique_ptr<PreviewPage> & _pPreviewPage )
  {
      return _pPreviewPage->pPage->GetPhyPageNum() == mnPageNum;
  }
1323};

1325}

1327const PreviewPage* SwPagePreviewLayout::GetPreviewPageByPageNum( const sal_uInt16 _nPageNum ) const
1328{
  auto aFoundPreviewPageIter =
          std::find_if( maPreviewPages.begin(), maPreviewPages.end(),
                        EqualsPageNumPred( _nPageNum ) );

  if ( aFoundPreviewPageIter == maPreviewPages.end() )
      return nullptr;

  return aFoundPreviewPageIter->get();
1337}

1339/** determine row the page with the given number is in

  OD 17.01.2003 #103492#

  @note _nPageNum is relative
1344*/
1345sal_uInt16 SwPagePreviewLayout::GetRowOfPage( sal_uInt16 _nPageNum ) const
1346{
  // OD 19.02.2003 #107369# - leaving left-top-corner blank is controlled
  // by <mbBookPreview>.
  if ( mbBookPreview )
  {
      // Note: increase given physical page number by one, because left-top-corner
      //       in the preview layout is left blank.
      ++_nPageNum;
  }

  return _nPageNum / mnCols + ((_nPageNum % mnCols)>0 ? 1 : 0);
1357}

1359/** determine column the page with the given number is in

  OD 17.01.2003 #103492#

  @note _nPageNum is relative
1364*/
1365sal_uInt16 SwPagePreviewLayout::GetColOfPage( sal_uInt16 _nPageNum ) const
1366{
  // OD 19.02.2003 #107369# - leaving left-top-corner blank is controlled
  // by <mbBookPreview>.
  if ( mbBookPreview )
  {
      // Note: increase given physical page number by one, because left-top-corner
      //       in the preview layout is left blank.
      ++_nPageNum;
  }

  const sal_uInt16 nCol = _nPageNum % mnCols;
  return nCol ? nCol : mnCols;
1378}

1380Size SwPagePreviewLayout::GetPreviewDocSize() const
1381{
  OSL_ENSURE( PreviewLayoutValid(), "PagePreviewLayout not valid" )do { if (true && (!(PreviewLayoutValid()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/view/pagepreviewlayout.cxx"
 ":" "1382" ": "), "%s", "PagePreviewLayout not valid"); } } while
 (false);
  return maPreviewDocRect.GetSize();
1384}

1386/** get size of a preview page by its physical page number

  OD 15.01.2003 #103492#
1389*/
1390Size SwPagePreviewLayout::GetPreviewPageSizeByPageNum( sal_uInt16 _nPageNum ) const
1391{
  const PreviewPage* pPreviewPage = GetPreviewPageByPageNum( _nPageNum );
  if ( pPreviewPage )
  {
      return pPreviewPage->aPageSize;
  }
  return Size( 0, 0 );
1398}

1400/** get virtual page number by its physical page number

  OD 21.03.2003 #108282#
1403*/
1404sal_uInt16 SwPagePreviewLayout::GetVirtPageNumByPageNum( sal_uInt16 _nPageNum ) const
1405{
  const PreviewPage* pPreviewPage = GetPreviewPageByPageNum( _nPageNum );
  if ( pPreviewPage )
  {
      return pPreviewPage->pPage->GetVirtPageNum();
  }
  return 0;
1412}

1414/** Convert absolute to relative page numbers (see PrintEmptyPages) */
1415sal_uInt16 SwPagePreviewLayout::ConvertAbsoluteToRelativePageNum( sal_uInt16 _nAbsPageNum ) const
1416{
  if ( mbBookPreview || mbPrintEmptyPages || !_nAbsPageNum )
  {
      return _nAbsPageNum;
  }

  const SwPageFrame* pTmpPage = static_cast<const SwPageFrame*>(mrLayoutRootFrame.Lower());

  sal_uInt16 nRet = 1;

  while ( pTmpPage && pTmpPage->GetPhyPageNum() != _nAbsPageNum )
  {
      if ( !pTmpPage->IsEmptyPage() )
          ++nRet;

      pTmpPage = static_cast<const SwPageFrame*>( pTmpPage->GetNext() );
  }

  return nRet;
1435}

1437/** Convert relative to absolute page numbers (see PrintEmptyPages) */
1438sal_uInt16 SwPagePreviewLayout::ConvertRelativeToAbsolutePageNum( sal_uInt16 _nRelPageNum ) const
1439{
  if ( mbBookPreview || mbPrintEmptyPages || !_nRelPageNum )
  {
      return _nRelPageNum;
  }

  const SwPageFrame* pTmpPage = static_cast<const SwPageFrame*>(mrLayoutRootFrame.Lower());
  const SwPageFrame* pRet = nullptr;

  sal_uInt16 i = 0;
  while( pTmpPage && i != _nRelPageNum )
  {
      if ( !pTmpPage->IsEmptyPage() )
          ++i;

      pRet = pTmpPage;
      pTmpPage = static_cast<const SwPageFrame*>( pTmpPage->GetNext() );
  }

  return pRet->GetPhyPageNum();
1459}

1461/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

←

/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx

→

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
* 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 .
*/

20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX

23#include <sal/config.h>

25#include <rtl/ref.hxx>

27#include <utility>
28#include <type_traits>

30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif

36class VclReferenceBase;

38namespace vcl::detail {

40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }

43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
  int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }

47} // namespace vcl::detail

49/**
* A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
56template <class reference_type>
57class VclPtr
58{
  static_assert(
      vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
          nullptr),
      "template argument type must be derived from VclReferenceBase");

  ::rtl::Reference<reference_type> m_rInnerRef;

66public:
  /** Constructor...
   */
  VclPtr()
      : m_rInnerRef()
  {}

  /** Constructor...
   */
  VclPtr (reference_type * pBody)
      : m_rInnerRef(pBody)
3
←
Calling constructor for 'Reference<OutputDevice>'→
6
←
Returning from constructor for 'Reference<OutputDevice>'→
  {}

  /** Constructor... that doesn't take a ref.
   */
  VclPtr (reference_type * pBody, __sal_NoAcquire)
      : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
  {}

  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.  For the special case of
      up-casting to Reference< XInterface >, see the corresponding conversion
      operator.

      @param rRef another reference
  */
  template< class derived_type >
  VclPtr(
      const VclPtr< derived_type > & rRef,
      typename std::enable_if<
          std::is_base_of<reference_type, derived_type>::value, int>::type
          = 0 )
      : m_rInnerRef( static_cast<reference_type*>(rRef) )
  {
  }

103#if defined(DBG_UTIL) && !defined(_WIN32)
  virtual ~VclPtr()
  {
      assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
      // We can be one of the intermediate counts, but if we are the last
      // VclPtr keeping this object alive, then something forgot to call dispose().
      assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
 "someone forgot to call dispose()") ? void (0) : __assert_fail
 ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
              && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
 "someone forgot to call dispose()") ? void (0) : __assert_fail
 ("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
  }
  VclPtr(VclPtr const &) = default;
  VclPtr(VclPtr &&) = default;
  VclPtr & operator =(VclPtr const &) = default;
  VclPtr & operator =(VclPtr &&) = default;
116#endif

  /**
   * A construction helper for VclPtr. Since VclPtr types are created
   * with a reference-count of one - to help fit into the existing
   * code-flow; this helps us to construct them easily.
   *
   * For more details on the design please see vcl/README.lifecycle
   *
   * @tparam reference_type must be a subclass of vcl::Window
   */
  template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
  {
      return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
  }

  /** Probably most common used: handle->someBodyOp().
   */
  reference_type * operator->() const
  {
      return m_rInnerRef.get();
  }

  /** Get the body. Can be used instead of operator->().
       I.e. handle->someBodyOp() and handle.get()->someBodyOp()
       are the same.
    */
  reference_type * get() const
  {
      return m_rInnerRef.get();
  }

  void set(reference_type *pBody)
  {
      m_rInnerRef.set(pBody);
  }

  void reset(reference_type *pBody)
  {
      m_rInnerRef.set(pBody);
  }

  /** Up-casting copy assignment operator.

      Does not work for up-casts to ambiguous bases.

      @param rRef another reference
  */
  template<typename derived_type>
  typename std::enable_if<
      std::is_base_of<reference_type, derived_type>::value,
      VclPtr &>::type
  operator =(VclPtr<derived_type> const & rRef)
  {
      m_rInnerRef.set(rRef.get());
      return *this;
  }

  VclPtr & operator =(reference_type * pBody)
  {
      m_rInnerRef.set(pBody);
10
←
Calling 'Reference::set'→
18
←
Returning; memory was released→
      return *this;
  }

  operator reference_type * () const
  {
      return m_rInnerRef.get();
29
←
Calling 'Reference::get'→
  }

  explicit operator bool () const
  {
      return m_rInnerRef.get() != nullptr;
  }

  void clear()
  {
      m_rInnerRef.clear();
  }

  void reset()
  {
      m_rInnerRef.clear();
  }

  void disposeAndClear()
  {
      // hold it alive for the lifetime of this method
      ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
      m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
      if (aTmp.get()) {
          aTmp->disposeOnce();
      }
  }

  /** Needed to place VclPtr's into STL collection.
   */
  bool operator< (const VclPtr<reference_type> & handle) const
  {
      return (m_rInnerRef < handle.m_rInnerRef);
  }
216}; // class VclPtr

218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
  return p1.get() == p2.get();
221}

223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
  return p1.get() == p2;
226}

228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
  return p1.get() == p2;
230}

232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
  return p1 == p2.get();
235}

237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
  return p1 == p2.get();
239}

241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
  return !(p1 == p2);
244}

246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
  return !(p1 == p2);
249}

251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
  return !(p1 == p2);
253}

255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
  return !(p1 == p2);
258}

260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
  return !(p1 == p2);
262}

264/**
* A construction helper for a temporary VclPtr. Since VclPtr types
* are created with a reference-count of one - to help fit into
* the existing code-flow; this helps us to construct them easily.
* see also VclPtr::Create and ScopedVclPtr
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
  template<typename... Arg> VclPtrInstance(Arg &&... arg)
      : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
  {
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};

290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
  /** Constructor...
   */
  ScopedVclPtr()
      : VclPtr<reference_type>()
  {}

  /** Constructor
   */
  ScopedVclPtr (reference_type * pBody)
      : VclPtr<reference_type>(pBody)
  {}

  /** Copy constructor...
   */
  ScopedVclPtr (const VclPtr<reference_type> & handle)
      : VclPtr<reference_type>(handle)
  {}

  /**
     Assignment that releases the last reference.
   */
  void disposeAndReset(reference_type *pBody)
  {
      if (pBody != this->get()) {
          VclPtr<reference_type>::disposeAndClear();
          VclPtr<reference_type>::set(pBody);
      }
  }

  /**
     Assignment that releases the last reference.
   */
  ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
  {
      disposeAndReset(pBody);
      return *this;
  }

  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.  For the special case of
      up-casting to Reference< XInterface >, see the corresponding conversion
      operator.

      @param rRef another reference
  */
  template< class derived_type >
  ScopedVclPtr(
      const VclPtr< derived_type > & rRef,
      typename std::enable_if<
          std::is_base_of<reference_type, derived_type>::value, int>::type
          = 0 )
      : VclPtr<reference_type>( rRef )
  {
  }

  /** Up-casting assignment operator.

      Does not work for up-casts to ambiguous bases.

      @param rRef another VclPtr
  */
  template<typename derived_type>
  typename std::enable_if<
      std::is_base_of<reference_type, derived_type>::value,
      ScopedVclPtr &>::type
  operator =(VclPtr<derived_type> const & rRef)
  {
      disposeAndReset(rRef.get());
      return *this;
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;

  ~ScopedVclPtr()
  {
      VclPtr<reference_type>::disposeAndClear();
      assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
  }

378private:
  // Most likely we don't want this default copy-constructor.
  ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
  // And certainly we don't want a default assignment operator.
  ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
  // And disallow reset as that doesn't call disposeAndClear on the original reference
  void reset() = delete;
  void reset(reference_type *pBody) = delete;

387protected:
  ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
      : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
  {}
391};

393/**
* A construction helper for ScopedVclPtr. Since VclPtr types are created
* with a reference-count of one - to help fit into the existing
* code-flow; this helps us to construct them easily.
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
  template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
      : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
  {
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;

421private:
  // Prevent the above perfect forwarding ctor from hijacking (accidental)
  // attempts at ScopedVclPtrInstance copy construction (where the hijacking
  // would typically lead to somewhat obscure error messages); both non-const
  // and const variants are needed here, as the ScopedVclPtr base class has a
  // const--variant copy ctor, so the implicitly declared copy ctor for
  // ScopedVclPtrInstance would also be the const variant, so non-const copy
  // construction attempts would be hijacked by the perfect forwarding ctor;
  // but if we only declared a non-const variant here, the const variant would
  // no longer be implicitly declared (as there would already be an explicitly
  // declared copy ctor), so const copy construction attempts would then be
  // hijacked by the perfect forwarding ctor:
  ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
  ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif

440#endif // INCLUDED_VCL_PTR_HXX

442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

←

/home/maarten/src/libreoffice/core/include/rtl/ref.hxx

→

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
* 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 .
*/

20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX

23#include "sal/config.h"

25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif

32#include "sal/types.h"

34namespace rtl
35{

37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
  /** The <b>reference_type</b> body pointer.
   */
  reference_type * m_pBody;


47public:
  /** Constructor...
   */
  Reference()
      : m_pBody (NULL__null)
  {}


  /** Constructor...
   */
  Reference (reference_type * pBody, __sal_NoAcquire)
      : m_pBody (pBody)
  {
  }

  /** Constructor...
   */
  Reference (reference_type * pBody)
      : m_pBody (pBody)
  {
      if (m_pBody)
4
←
Assuming field 'm_pBody' is non-null→
5
←
Taking true branch→
          m_pBody->acquire();
  }

  /** Copy constructor...
   */
  Reference (const Reference<reference_type> & handle)
      : m_pBody (handle.m_pBody)
  {
      if (m_pBody)
          m_pBody->acquire();
  }

80#ifdef LIBO_INTERNAL_ONLY1
  /** Move constructor...
   */
  Reference (Reference<reference_type> && handle) noexcept
      : m_pBody (handle.m_pBody)
  {
      handle.m_pBody = nullptr;
  }
88#endif

90#if defined LIBO_INTERNAL_ONLY1
  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.

      @param rRef another reference
  */
  template< class derived_type >
  inline Reference(
      const Reference< derived_type > & rRef,
      std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
      : m_pBody (rRef.get())
  {
      if (m_pBody)
          m_pBody->acquire();
  }
106#endif

  /** Destructor...
   */
  ~Reference() COVERITY_NOEXCEPT_FALSE
  {
      if (m_pBody)
          m_pBody->release();
  }

  /** Set...
       Similar to assignment.
   */
  Reference<reference_type> &
  SAL_CALL set (reference_type * pBody)
  {
      if (pBody10.1
'pBody' is non-null
1
'pBody' is non-null
1
'pBody' is non-null
1
'pBody' is non-null
1
'pBody' is non-null
)
11
←
Taking true branch→
          pBody->acquire();
      reference_type * const pOld = m_pBody;
      m_pBody = pBody;
      if (pOld11.1
'pOld' is non-null
1
'pOld' is non-null
1
'pOld' is non-null
1
'pOld' is non-null
1
'pOld' is non-null
)
12
←
Taking true branch→
          pOld->release();
13
←
Calling 'VclReferenceBase::release'→
17
←
Returning; memory was released→
      return *this;
  }

  /** Assignment.
       Unbinds this instance from its body (if bound) and
       bind it to the body represented by the handle.
   */
  Reference<reference_type> &
  SAL_CALL operator= (const Reference<reference_type> & handle)
  {
      return set( handle.m_pBody );
  }

141#ifdef LIBO_INTERNAL_ONLY1
  /** Assignment.
   *   Unbinds this instance from its body (if bound),
   *   bind it to the body represented by the handle, and
   *   set the body represented by the handle to nullptr.
   */
  Reference<reference_type> &
  operator= (Reference<reference_type> && handle)
  {
      // self-movement guts ourself
      if (m_pBody)
          m_pBody->release();
      m_pBody = handle.m_pBody;
      handle.m_pBody = nullptr;
      return *this;
  }
157#endif

  /** Assignment...
   */
  Reference<reference_type> &
  SAL_CALL operator= (reference_type * pBody)
  {
      return set( pBody );
  }

  /** Unbind the body from this handle.
       Note that for a handle representing a large body,
       "handle.clear().set(new body());" _might_
       perform a little bit better than "handle.set(new body());",
       since in the second case two large objects exist in memory
       (the old body and the new body).
   */
  Reference<reference_type> & SAL_CALL clear()
  {
      if (m_pBody)
      {
          reference_type * const pOld = m_pBody;
          m_pBody = NULL__null;
          pOld->release();
      }
      return *this;
  }


  /** Get the body. Can be used instead of operator->().
       I.e. handle->someBodyOp() and handle.get()->someBodyOp()
       are the same.
   */
  reference_type * SAL_CALL get() const
  {
      return m_pBody;
30
←
Use of memory after it is freed
  }


  /** Probably most common used: handle->someBodyOp().
   */
  reference_type * SAL_CALL operator->() const
  {
      assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
 ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__));
      return m_pBody;
  }


  /** Allows (*handle).someBodyOp().
  */
  reference_type & SAL_CALL operator*() const
  {
      assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
 ("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__));
      return *m_pBody;
  }


  /** Returns True if the handle does point to a valid body.
   */
  bool SAL_CALL is() const
  {
      return (m_pBody != NULL__null);
  }

221#if defined LIBO_INTERNAL_ONLY1
  /** Returns True if the handle does point to a valid body.
   */
  explicit operator bool() const
  {
      return is();
  }
228#endif

  /** Returns True if this points to pBody.
   */
  bool SAL_CALL operator== (const reference_type * pBody) const
  {
      return (m_pBody == pBody);
  }


  /** Returns True if handle points to the same body.
   */
  bool
  SAL_CALL operator== (const Reference<reference_type> & handle) const
  {
      return (m_pBody == handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator!= (const Reference<reference_type> & handle) const
  {
      return (m_pBody != handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator< (const Reference<reference_type> & handle) const
  {
      return (m_pBody < handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator> (const Reference<reference_type> & handle) const
  {
      return (m_pBody > handle.m_pBody);
  }
272};

274} // namespace rtl

276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{

280/// @cond INTERNAL
281/**
Make rtl::Reference hashable by default for use in STL containers.

@since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
  std::size_t operator()(::rtl::Reference<T> const & s) const
  { return std::size_t(s.get()); }
291};
292/// @endcond

294}

296#endif

298#endif /* ! INCLUDED_RTL_REF_HXX */

300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

←

/home/maarten/src/libreoffice/core/sw/inc/viewsh.hxx

→

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
* 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 .
*/
19#ifndef INCLUDED_SW_INC_VIEWSH_HXX
20#define INCLUDED_SW_INC_VIEWSH_HXX

22#include "swdllapi.h"
23#include "swtypes.hxx"
24#include "ring.hxx"
25#include "swrect.hxx"
26#include <memory>
27#include <stack>
28#include <vcl/mapmod.hxx>
29#include <vcl/vclptr.hxx>
30#include <vcl/lazydelete.hxx>
31#include <vcl/window.hxx>

33namespace com::sun::star::accessibility { class XAccessible; }
34class SwDoc;
35class IDocumentSettingAccess;
36class IDocumentDeviceAccess;
37class IDocumentMarkAccess;
38class IDocumentDrawModelAccess;
39class IDocumentRedlineAccess;
40class IDocumentLayoutAccess;
41class IDocumentContentOperations;
42class IDocumentStylePoolAccess;
43class IDocumentStatistics;
44class IDocumentUndoRedo;
45class IDocumentListItems;
46class IDocumentOutlineNodes;
47class SfxPrinter;
48class SwRootFrame;
49class SwNodes;
50class SdrView;
51class SfxItemPool;
52class SfxViewShell;
53class SwViewOption;
54class SwViewShellImp;
55class SwPrintData;
56struct ShellResource;
57class SwRegionRects;
58class SvtAccessibilityOptions;
59class SwPagePreviewLayout;
60class SwTextFrame;

62struct SwAccessibilityOptions;
63namespace vcl { class Region; }
64class SwPostItMgr;
65class SdrPaintWindow;
66class SwAccessibleMap;
67enum class Orientation;

69namespace vcl
70{
  typedef OutputDevice RenderContext;
72}

74// Define for flags needed in ctor or layers below.
75// Currently the Preview flag is needed for DrawPage.
76#define VSHELLFLAG_ISPREVIEW(long(0x1))            (long(0x1))
77#define VSHELLFLAG_SHARELAYOUT(long(0x2))          (long(0x2))
78typedef std::shared_ptr<SwRootFrame> SwRootFramePtr;

80typedef struct _xmlTextWriter* xmlTextWriterPtr;

82class SW_DLLPUBLIC__attribute__ ((visibility("default"))) SwViewShell : public sw::Ring<SwViewShell>
83{
  friend void SetOutDev( SwViewShell *pSh, OutputDevice *pOut );
  friend void SetOutDevAndWin( SwViewShell *pSh, OutputDevice *pOut,
                               vcl::Window *pWin, sal_uInt16 nZoom );

  friend class SwViewShellImp;
  friend class SwLayIdle;

  // For setting visible area for page preview paint.
  friend class SwPagePreviewLayout;

  // Set SwVisArea in order to enable clean formatting before printing.
  friend void SetSwVisArea( SwViewShell *pSh, const SwRect & );

  std::unique_ptr<BitmapEx> m_xReplaceBmp; ///< replaced display of still loaded images
  std::unique_ptr<BitmapEx> m_xErrorBmp;   ///< error display of missed images

  static bool mbLstAct;            // true if EndAction of last Shell
                                   // i.e. if the EndActions of the other
                                   // Shells on the document are through.

  Point         maPrtOffset;       // Offset for Printer,
                                   // non-printable margin.
  Size          maBrowseBorder;    // Border for frame documents.
  SwRect        maInvalidRect;

  SfxViewShell *mpSfxViewShell;
  std::unique_ptr<SwViewShellImp>
                mpImp;             // Core-internals of SwViewShell.
                                   // The pointer is never 0.

  VclPtr<vcl::Window>   mpWin;     ///< = 0 during printing or pdf export
  VclPtr<OutputDevice>  mpOut;     ///< Window, Printer, VirtDev, ...

  std::unique_ptr<SwViewOption> mpOpt;
  std::unique_ptr<SwAccessibilityOptions> mpAccOptions;

  bool  mbDocSizeChgd     :1;  // For DocChgNotify(): Announce new DocSize
                                  // at EndAction to DocMDI.
  bool  mbPaintWorks      :1;  // Normal Painting if true,
                                  // remember Paint if false.
  bool  mbPaintInProgress :1;  // Block any double paint.
  bool  mbViewLocked      :1;  // Lock visible range;
                                  // in this case MakeVisible is ineffectual.
  bool  mbInEndAction     :1;  // Avoid problems, cf. viewsh.cxx.
  bool  mbPreview         :1;  // If true it is a Preview-SwViewShell.
  bool  mbFrameView       :1;  // If true it is a  (HTML-)Frame.
  bool  mbEnableSmooth    :1;  // Disable SmoothScroll, e.g. for drag
                                  // of scrollbars.
  bool  mbEndActionByVirDev:1; // Paints from EndAction always via virtual device
                                  // (e.g. when browsing).
  bool      mbShowHeaderSeparator:1; ///< Flag to say that we are showing the header control
  bool      mbShowFooterSeparator:1; ///< Flag to say that we are showing the footer control
  bool      mbHeaderFooterEdit:1;  ///< Flag to say that we are editing header or footer (according to the bShow(Header|Footer)Separator above)

  // boolean, indicating that class in constructor.
  bool mbInConstructor:1;

  SdrPaintWindow*         mpTargetPaintWindow;
  VclPtr<OutputDevice>    mpBufferedOut;

  SwRootFramePtr            mpLayout;

  // Initialization; called by the diverse constructors.
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void Init( const SwViewOption *pNewOpt );

  inline void ResetInvalidRect();



  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void PaintDesktop(vcl::RenderContext& rRenderContext, const SwRect&);  // Collect values for painting of desktop
                                                      // and calling.
  // PaintDesktop split. This pars is also used by PreviewPage.
  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void PaintDesktop_(const SwRegionRects &rRegion);

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) bool CheckInvalidForPaint( const SwRect & );  // Direct Paint or rather
                                                                  // trigger an action.

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void PrepareForPrint( const SwPrintData &rOptions, bool bIsPDFExport = false );

  SAL_DLLPRIVATE__attribute__ ((visibility("hidden"))) void ImplApplyViewOptions( const SwViewOption &rOpt );

165protected:
  static ShellResource*      mpShellRes;      ///< Resources for the Shell.
  static vcl::DeleteOnDeinit< std::shared_ptr<weld::Window> > mpCareDialog;    ///< Avoid this window.

  SwRect                  maVisArea;       ///< The modern version of VisArea.
  tools::Rectangle        maLOKVisibleArea;///< The visible area in the LibreOfficeKit client.
  rtl::Reference<SwDoc>   mxDoc;          ///< The document; never 0.

  sal_uInt16 mnStartAction; ///< != 0 if at least one Action is active.
  sal_uInt16 mnLockPaint;   ///< != 0 if Paint is locked.
  bool      mbSelectAll; ///< Special select all mode: whole document selected, even if doc starts with table.

  /// The virtual device we paint to will end up on the screen.
  bool mbOutputToWindow;

180public:

        SwViewShellImp *Imp() { return mpImp.get(); }
  const SwViewShellImp *Imp() const { return mpImp.get(); }

  const SwNodes& GetNodes() const;

  // After change of printer; by Doc.
  void            InitPrt( OutputDevice *pOutDev );

  // Bracketing of actions belonging together.
  inline void StartAction();
         void ImplStartAction();
  inline void EndAction( const bool bIdleEnd = false );
         void ImplEndAction( const bool bIdleEnd );
  sal_uInt16 ActionCount() const { return mnStartAction; }
  bool ActionPend() const { return mnStartAction != 0; }
  bool IsInEndAction() const { return mbInEndAction; }

  void SetEndActionByVirDev( bool b ) { mbEndActionByVirDev = b; }
  bool IsEndActionByVirDev() const    { return mbEndActionByVirDev; }

  // The ActionCount for all Shells is temporarily set to zero and then
  // restored at the RootFrame via UNO.
  void    SetRestoreActions(sal_uInt16 nSet);
  sal_uInt16  GetRestoreActions() const;

  bool HasInvalidRect() const { return maInvalidRect.HasArea(); }
  void ChgHyphenation() { Reformat(); }
  void ChgNumberDigits();

  bool AddPaintRect( const SwRect &rRect );

  void InvalidateWindows( const SwRect &rRect );

  /// Invalidates complete Layout (ApplyViewOption).
  void Reformat();

  // #i72754# set of Pre/PostPaints with lock counter and initial target OutDev
219protected:
  std::stack<vcl::Region> mPrePostPaintRegions; // acts also as a lock counter (empty == not locked)
  VclPtr<OutputDevice>    mpPrePostOutDev;
  MapMode                 maPrePostMapMode;
223public:
  void PrePaint();
  void DLPrePaint2(const vcl::Region& rRegion);
  void DLPostPaint2(bool bPaintFormLayer);
  const MapMode& getPrePostMapMode() const { return maPrePostMapMode; }

  virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle &rRect);

  /** Paint tile.

      Sets the pOut so that the rRect is always painted over the entire
      pOut, ie. starts in 0,0 and ends in width/height.
  */
  void PaintTile(VirtualDevice &rDevice, int contextWidth, int contextHeight, int tilePosX, int tilePosY, long tileWidth, long tileHeight);

  bool IsPaintInProgress() const { return mbPaintInProgress; }
  bool IsDrawingLayerPaintInProgress() const { return !mPrePostPaintRegions.empty(); }

  // Notification that visible area has been changed.
  // VisArea is reset, after that scrolling takes place.
  // The passed rect is situated on pixel borders
  // in order to avoid pixel errors when scrolling.
  virtual void VisPortChgd( const SwRect & );
  bool SmoothScroll( long lXDiff, long lYDiff, const tools::Rectangle* );//Browser
  void EnableSmooth( bool b ) { mbEnableSmooth = b; }

  const SwRect& VisArea() const;

  /// The visible area in the client (set by setClientVisibleArea).
  const tools::Rectangle & getLOKVisibleArea() const { return maLOKVisibleArea; }
  void setLOKVisibleArea(const tools::Rectangle& rArea) { maLOKVisibleArea = rArea; }

  // If necessary scroll until passed Rect is situated in visible sector.
  void MakeVisible( const SwRect & );

  // At nearest occasion pass new document size to UI.
  void SizeChgNotify();
  void UISizeNotify();            // Passing of current size.

  Point GetPagePos( sal_uInt16 nPageNum ) const;

  sal_uInt16 GetNumPages() const;   // Ask count of current pages from layout.
  bool   IsDummyPage( sal_uInt16 nPageNum ) const;  // An empty page?

  // Invalidate first visible page for all Shells in ring.
  void SetFirstVisPageInvalid();

  SwRootFrame   *GetLayout() const;
  bool         IsNewLayout() const; // Has Layout been loaded or created?

   Size GetDocSize() const;   // Get document size.

  virtual void CalcLayout();  // Force complete formatting of layout.

  sal_uInt16 GetPageCount() const;

  Size GetPageSize( sal_uInt16 nPageNum, bool bSkipEmptyPages ) const;

  SwDoc *GetDoc()  const { return mxDoc.get(); }  //Never 0.

  /** Provides access to the document setting interface
   */
  const IDocumentSettingAccess& getIDocumentSettingAccess() const;
        IDocumentSettingAccess& getIDocumentSettingAccess();

  /** Provides access to the document device interface
   */
  const IDocumentDeviceAccess& getIDocumentDeviceAccess() const;
        IDocumentDeviceAccess& getIDocumentDeviceAccess();

  /** Provides access to the document bookmark interface
   */
  const IDocumentMarkAccess* getIDocumentMarkAccess() const;
        IDocumentMarkAccess* getIDocumentMarkAccess();

  /** Provides access to the document draw model interface
   */
  const IDocumentDrawModelAccess& getIDocumentDrawModelAccess() const;
        IDocumentDrawModelAccess& getIDocumentDrawModelAccess();

  /** Provides access to the document redline interface
   */
  const IDocumentRedlineAccess& getIDocumentRedlineAccess() const;
        IDocumentRedlineAccess& getIDocumentRedlineAccess();

  /** Provides access to the document layout interface
   */
  const IDocumentLayoutAccess& getIDocumentLayoutAccess() const;
        IDocumentLayoutAccess& getIDocumentLayoutAccess();

  /** Provides access to the content operations interface
   */
  IDocumentContentOperations& getIDocumentContentOperations();

  /** Provides access to the document style pool interface
   */
  IDocumentStylePoolAccess& getIDocumentStylePoolAccess();

  /** Provides access to the document statistics interface
   */
  const IDocumentStatistics& getIDocumentStatistics() const;

  /** Provides access to the document undo/redo interface
   */
  IDocumentUndoRedo const& GetIDocumentUndoRedo() const;
  IDocumentUndoRedo      & GetIDocumentUndoRedo();

  const IDocumentListItems* getIDocumentListItemsAccess() const;
  const IDocumentOutlineNodes* getIDocumentOutlineNodesAccess() const;

  // 1. GetRefDev:   Either the printer or the virtual device from the doc
  // 2. GetWin:      Available if we not printing
  // 3. GetOut:      Printer, Window or Virtual device
  vcl::RenderContext& GetRefDev() const;
  vcl::Window* GetWin()    const { return mpWin; }
  vcl::RenderContext* GetOut()     const { return mpOut; }

  void SetWin(vcl::Window* win) { mpWin = win; }
  void SetOut(vcl::RenderContext* pOut) { mpOut = pOut; }
9
←
Calling 'VclPtr::operator='→
19
←
Returning; memory was released→
  static bool IsLstEndAction() { return SwViewShell::mbLstAct; }

  // Change of all page descriptors.
  void   ChgAllPageOrientation( Orientation eOri );
  void   ChgAllPageSize( Size const &rSz );

  // Printing of one page.
  // bIsPDFExport == true is: do PDF Export (no printing!)
  bool PrintOrPDFExport( OutputDevice *pOutDev,
          SwPrintData const& rPrintData,
          sal_Int32 nRenderer, /* offset in vector of pages to print */
          bool bIsPDFExport );

  // Printing of one brochure page.
  void PrintProspect( OutputDevice *pOutDev, const SwPrintData &rPrintData,
          sal_Int32 nRenderer /* offset in vector of page pairs for prospect printing */ );

  // Printing for OLE 2.0.
  static void PrtOle2( SwDoc *pDoc, const SwViewOption *pOpt, const SwPrintData& rOptions,
                       vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect );

  // Fill temporary doc with selected text for Print or PDF export.
  void FillPrtDoc( SwDoc& rPrtDoc, const SfxPrinter* pPrt );

  // Called internally for Shell. Formats pages.
  void CalcPagesForPrint( sal_uInt16 nMax );

  // All about fields.
  void UpdateFields(bool bCloseDB = false);
  bool IsAnyFieldInDoc() const;
  // Update all charts, for that exists any table.
  void UpdateAllCharts();
  bool HasCharts() const;

  // DOCUMENT COMPATIBILITY FLAGS START

  // Add or maximize paragraph spacing?
  void SetParaSpaceMax( bool bNew );

  // Add or maximize paragraph spacing?
  void SetParaSpaceMaxAtPages( bool bNew );

  // Compatible behaviour of tabs.
  void SetTabCompat( bool bNew );

  // Font metric attribute "External Leading" should be considered.
  void SetAddExtLeading( bool bNew );

  // Formatting by virtual device or printer.
  void SetUseVirDev( bool bNew );

  // Adding paragraph and table spacing at bottom
  // of table cells.
  void SetAddParaSpacingToTableCells( bool _bAddParaSpacingToTableCells );

  // Former formatting of text lines with
  // proportional line spacing or not.
  void SetUseFormerLineSpacing( bool _bUseFormerLineSpacing );

  // Former object positioning.
  void SetUseFormerObjectPositioning( bool _bUseFormerObjPos );

  void SetConsiderWrapOnObjPos( bool _bConsiderWrapOnObjPos );

  void SetUseFormerTextWrapping( bool _bUseFormerTextWrapping );

  void SetDoNotJustifyLinesWithManualBreak( bool _bDoNotJustifyLinesWithManualBreak );

  void SetProtectForm( bool _bProtectForm );

  void SetMsWordCompTrailingBlanks( bool _bMsWordCompTrailingBlanks );

  void SetSubtractFlysAnchoredAtFlys(bool bSubtractFlysAnchoredAtFlys);

  void SetEmptyDbFieldHidesPara(bool bEmptyDbFieldHidesPara);

  // DOCUMENT COMPATIBILITY FLAGS END

  // Calls Idle-formatter of Layout.
  void LayoutIdle();

  const SwViewOption *GetViewOptions() const { return mpOpt.get(); }
  virtual void  ApplyViewOptions( const SwViewOption &rOpt );
         void  SetUIOptions( const SwViewOption &rOpt );
  virtual void  SetReadonlyOption(bool bSet);          // Set readonly-bit of ViewOptions.
         void  SetPDFExportOption(bool bSet);         // Set/reset PDF export mode.
         void  SetPrtFormatOption(bool bSet);         // Set PrtFormat-Bit of ViewOptions.
         void  SetReadonlySelectionOption(bool bSet); // Change the selection mode in readonly docs.

  const SwAccessibilityOptions* GetAccessibilityOptions() const { return mpAccOptions.get();}

  static void           SetShellRes( ShellResource* pRes ) { mpShellRes = pRes; }
  static ShellResource* GetShellRes();

  static weld::Window*   CareChildWin(SwViewShell const & rVSh);
  static void           SetCareDialog(const std::shared_ptr<weld::Window>& rNew);
  static weld::Window*  GetCareDialog(SwViewShell const & rVSh)
                        { return (*mpCareDialog.get()) ? mpCareDialog.get()->get() : CareChildWin(rVSh); }

  SfxViewShell   *GetSfxViewShell() const { return mpSfxViewShell; }
  void           SetSfxViewShell(SfxViewShell *pNew) { mpSfxViewShell = pNew; }

  // Selection of  Draw Engine has been changed.
  virtual void DrawSelChanged();

  SwPagePreviewLayout* PagePreviewLayout();

  /** adjust view options for page preview

      Because page preview should show the document as it is printed -
      page preview is print preview -, the view options are adjusted to the
      same as for printing.

      @param _rPrintOptions
      input parameter - constant reference to print options, to which the
      view option will be adjusted.
  */
  void AdjustOptionsForPagePreview( SwPrintData const& rPrintOptions );

  bool IsViewLocked() const { return mbViewLocked; }
  void LockView( bool b )   { mbViewLocked = b;    }

  inline void LockPaint();
         void ImplLockPaint();
  inline void UnlockPaint( bool bVirDev = false );
         void ImplUnlockPaint( bool bVirDev );
         bool IsPaintLocked() const { return mnLockPaint != 0; }

  // Get/set DrawView and PageView.
  bool HasDrawView() const;
  void MakeDrawView();

  // Are we dragging draw shapes around.
  bool HasDrawViewDrag() const;

  // DrawView may be used at UI.
        SdrView *GetDrawView();
  const SdrView *GetDrawView() const { return const_cast<SwViewShell*>(this)->GetDrawView(); }

  // Take care that MarkList is up-to-date in any case (Bug 57153).
  SdrView *GetDrawViewWithValidMarkList();

  // Query attribute pool.
  inline const SfxItemPool& GetAttrPool() const;
               SfxItemPool& GetAttrPool();

  bool IsPreview() const { return mbPreview; }

  bool IsFrameView()  const { return mbFrameView; }

  // Invalidates pages and contents.
  // When bSizeChanged==true, adds/removes
  // headers and footers as necessary.
  void InvalidateLayout(bool bSizeChanged);

  const Size& GetBrowseBorder() const;
  sal_Int32 GetBrowseWidth() const;
  void SetBrowseBorder( const Size& rNew );

  css::uno::Reference< css::accessibility::XAccessible > CreateAccessible();

  css::uno::Reference< css::accessibility::XAccessible >  CreateAccessiblePreview();

  void ShowPreviewSelection( sal_uInt16 nSelPage );
  void InvalidateAccessibleFocus();

  // Apply Accessibility options.
  void ApplyAccessibilityOptions(SvtAccessibilityOptions const & rAccessibilityOptions);

  /** invalidate CONTENT_FLOWS_FROM/_TO relation for paragraphs

      @param _pFromTextFrame
      input parameter - paragraph frame, for which the relation CONTENT_FLOWS_FROM
      has to be invalidated.
      If NULL, no CONTENT_FLOWS_FROM relation has to be invalidated

      @param _pToTextFrame
      input parameter - paragraph frame, for which the relation CONTENT_FLOWS_TO
      has to be invalidated.
      If NULL, no CONTENT_FLOWS_TO relation has to be invalidated
  */
  void InvalidateAccessibleParaFlowRelation( const SwTextFrame* _pFromTextFrame,
                                             const SwTextFrame* _pToTextFrame );

  /** invalidate text selection for paragraphs
  */
  void InvalidateAccessibleParaTextSelection();

  /** invalidate attributes for paragraphs and paragraph's characters

      usage also for changes of the attributes of
      paragraph's characters.

      @param rTextFrame
      input parameter - paragraph frame, whose attributes have changed
  */
  void InvalidateAccessibleParaAttrs( const SwTextFrame& rTextFrame );

  SwAccessibleMap* GetAccessibleMap();

  SwViewShell( SwViewShell&, vcl::Window *pWin, OutputDevice *pOut = nullptr,
              long nFlags = 0 );
  SwViewShell( SwDoc& rDoc, vcl::Window *pWin,
             const SwViewOption *pOpt, OutputDevice *pOut = nullptr,
             long nFlags = 0 );
  virtual ~SwViewShell() override;

  sal_Int32 GetPageNumAndSetOffsetForPDF( OutputDevice& rOut, const SwRect& rRect ) const;

  bool IsInConstructor() const { return mbInConstructor; }

  const BitmapEx& GetReplacementBitmap(bool bIsErrorState);
  void DeleteReplacementBitmaps();

  const SwPostItMgr* GetPostItMgr() const { return const_cast<SwViewShell*>(this)->GetPostItMgr(); }
  SwPostItMgr* GetPostItMgr();

  /// Acts both for headers / footers, depending on the bShow(Header|Footer)Separator flags
  void ToggleHeaderFooterEdit();
  /// Acts both for headers / footers, depending on the bShow(Header|Footer)Separator flags
  bool IsHeaderFooterEdit() const { return mbHeaderFooterEdit; }
  bool IsShowHeaderFooterSeparator( FrameControlType eControl ) { return (eControl == FrameControlType::Header)? mbShowHeaderSeparator: mbShowFooterSeparator; }
  virtual void SetShowHeaderFooterSeparator( FrameControlType eControl, bool bShow );
  bool IsSelectAll() const { return mbSelectAll; }

  void setOutputToWindow(bool bOutputToWindow);
  bool isOutputToWindow() const;

  virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
571};

573// manages global ShellPointer
574class CurrShell
575{
576public:
  SwViewShell *pPrev;
  SwRootFrame *pRoot;

  CurrShell( SwViewShell *pNew );
  ~CurrShell();
582};

584inline void SwViewShell::ResetInvalidRect()
585{
  maInvalidRect.Clear();
587}

589inline void SwViewShell::StartAction()
590{
  if ( !mnStartAction++ )
      ImplStartAction();
593}
594inline void SwViewShell::EndAction( const bool bIdleEnd )
595{
  if( 0 == (mnStartAction - 1) )
      ImplEndAction( bIdleEnd );
  --mnStartAction;
599}

601inline void SwViewShell::LockPaint()
602{
  if ( !mnLockPaint++ )
      ImplLockPaint();
605}
606inline void SwViewShell::UnlockPaint( bool bVirDev )
607{
  if ( 0 == --mnLockPaint )
      ImplUnlockPaint( bVirDev );
610}
611inline const SfxItemPool& SwViewShell::GetAttrPool() const
612{
  return const_cast<SwViewShell*>(this)->GetAttrPool();
614}

616#endif // INCLUDED_SW_INC_VIEWSH_HXX

618/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

←

/home/maarten/src/libreoffice/core/include/vcl/vclreferencebase.hxx

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#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21 
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24 
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27    mutable oslInterlockedCount mnRefCnt;
28 
29    template<typename T> friend class VclPtr;
30 
31public:
32    void acquire() const
33    {
34        osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35    }
36 
37    void release() const
38    {
39        if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
14
←
Assuming the condition is true→
15
←
Taking true branch→
40            delete this;
16
←
Memory is released→
41    }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44    sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47 
48 
49private:
50    VclReferenceBase(const VclReferenceBase&) = delete;
51    VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52 
53    bool                        mbDisposed : 1;
54 
55protected:
56                                VclReferenceBase();
57protected:
58    virtual                     ~VclReferenceBase();
59 
60protected:
61    virtual void                dispose();
62 
63public:
64    void                        disposeOnce();
65    bool                        isDisposed() const { return mbDisposed; }
66 
67};
68#endif