/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx

Bug Summary

File:	home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx
Warning:	line 2290, column 47 Called C++ object pointer is null

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 ftnfrm.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/layout/ftnfrm.cxx

/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.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 <txtftn.hxx>
21#include <fmtftn.hxx>
22#include <ftnidx.hxx>
23#include <pagefrm.hxx>
24#include <colfrm.hxx>
25#include <rootfrm.hxx>
26#include <frmtool.hxx>
27#include <ftnfrm.hxx>
28#include <txtfrm.hxx>
29#include <tabfrm.hxx>
30#include <pagedesc.hxx>
31#include <ftninfo.hxx>
32#include <sectfrm.hxx>
33#include <objectformatter.hxx>
34#include <viewopt.hxx>
35#include <calbck.hxx>
36#include <ndindex.hxx>
37#include <pam.hxx>
38#include <ndtxt.hxx>
39#include <sal/log.hxx>
40#include <IDocumentSettingAccess.hxx>

42#define ENDNOTE0x80000000 0x80000000

44/// Search the position of an attribute in the FootnoteArray at the document,
45/// because all footnotes are located there, ordered by their index.
46static sal_uLong lcl_FindFootnotePos( const SwDoc *pDoc, const SwTextFootnote *pAttr )
47{
  const SwFootnoteIdxs &rFootnoteIdxs = pDoc->GetFootnoteIdxs();

  SwTextFootnote* pBla = const_cast<SwTextFootnote*>(pAttr);
  SwFootnoteIdxs::const_iterator it = rFootnoteIdxs.find( pBla );
  if ( it != rFootnoteIdxs.end() )
  {
      sal_uLong nRet = it - rFootnoteIdxs.begin();
      if( pAttr->GetFootnote().IsEndNote() )
          return nRet + ENDNOTE0x80000000;
      return nRet;
  }
  OSL_ENSURE( !pDoc, "FootnotePos not found." )do { if (true && (!(!pDoc))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "59" ": "), "%s", "FootnotePos not found."); } } while (
false);
  return 0;
61}

63bool SwFootnoteFrame::operator<( const SwTextFootnote* pTextFootnote ) const
64{
  const SwDoc* pDoc = GetFormat()->GetDoc();
  OSL_ENSURE( pDoc, "SwFootnoteFrame: Missing doc!" )do { if (true && (!(pDoc))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "66" ": "), "%s", "SwFootnoteFrame: Missing doc!"); } } while
 (false);
  return lcl_FindFootnotePos( pDoc, GetAttr() ) <
         lcl_FindFootnotePos( pDoc, pTextFootnote );
69}

71/*
*
*  bool lcl_NextFootnoteBoss( SwFootnoteBossFrame* pBoss, SwPageFrame* pPage)
*  sets pBoss on the next SwFootnoteBossFrame, which can either be a column
*  or a page (without columns). If the page changes meanwhile,
*  pPage contains the new page and this function returns true.
*
*/

80static bool lcl_NextFootnoteBoss( SwFootnoteBossFrame* &rpBoss, SwPageFrame* &rpPage,
  bool bDontLeave )
82{
  if( rpBoss->IsColumnFrame() )
  {
      if( rpBoss->GetNext() )
      {
          rpBoss = static_cast<SwFootnoteBossFrame*>(rpBoss->GetNext()); //next column
          return false;
      }
      if( rpBoss->IsInSct() )
      {
          SwSectionFrame* pSct = rpBoss->FindSctFrame()->GetFollow();
          if( pSct )
          {
              OSL_ENSURE( pSct->Lower() && pSct->Lower()->IsColumnFrame(),do { if (true && (!(pSct->Lower() && pSct->
Lower()->IsColumnFrame()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "96" ": "), "%s", "Where's the column?"); } } while (false
)
                      "Where's the column?" )do { if (true && (!(pSct->Lower() && pSct->
Lower()->IsColumnFrame()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "96" ": "), "%s", "Where's the column?"); } } while (false
);
              rpBoss = static_cast<SwColumnFrame*>(pSct->Lower());
              SwPageFrame* pOld = rpPage;
              rpPage = pSct->FindPageFrame();
              return pOld != rpPage;
          }
          else if( bDontLeave )
          {
              rpPage = nullptr;
              rpBoss = nullptr;
              return false;
          }
      }
  }
  rpPage = static_cast<SwPageFrame*>(rpPage->GetNext()); // next page
  rpBoss = rpPage;
  if( rpPage )
  {
      SwLayoutFrame* pBody = rpPage->FindBodyCont();
      if( pBody && pBody->Lower() && pBody->Lower()->IsColumnFrame() )
          rpBoss = static_cast<SwFootnoteBossFrame*>(pBody->Lower()); // first column
  }
  return true;
119}

121/// @returns column number if pBoss is a column, otherwise 0.
122static sal_uInt16 lcl_ColumnNum( const SwFrame* pBoss )
123{
  sal_uInt16 nRet = 0;
  if( !pBoss->IsColumnFrame() )
      return 0;
  const SwFrame* pCol;
  if( pBoss->IsInSct() )
  {
      pCol = pBoss->GetUpper()->FindColFrame();
      if( pBoss->GetNext() || pBoss->GetPrev() )
      {
          while( pBoss )
          {
              ++nRet;                     // Section columns
              pBoss = pBoss->GetPrev();
          }
      }
  }
  else
      pCol = pBoss;
  while( pCol )
  {
      nRet += 256;                    // Page columns
      pCol = pCol->GetPrev();
  }
  return nRet;
148}

150SwFootnoteContFrame::SwFootnoteContFrame( SwFrameFormat *pFormat, SwFrame* pSib ):
  SwLayoutFrame( pFormat, pSib )
152{
  mnFrameType = SwFrameType::FtnCont;
154}

156SwFootnoteFrame* SwFootnoteContFrame::AddChained(bool bAppend, SwFrame* pThis, bool bDefaultFormat)
157{
  SwFootnoteFrame *pOld = pThis->FindFootnoteFrame();
  SwFrameFormat *pFormat = pOld->GetFormat();
  if (bDefaultFormat)
      pFormat = pFormat->GetDoc()->GetDfltFrameFormat();

  SwFootnoteFrame *pNew = new SwFootnoteFrame(pFormat, pOld, pOld->GetRef(), pOld->GetAttr());

  if (bAppend)
  {
      if (pOld->GetFollow())
      {
          pNew->SetFollow(pOld->GetFollow());
          pOld->GetFollow()->SetMaster(pNew);
      }
      pOld->SetFollow(pNew);
      pNew->SetMaster(pOld);
  }
  else
  {
      if (pOld->GetMaster())
      {
          pNew->SetMaster(pOld->GetMaster());
          pOld->GetMaster()->SetFollow(pNew);
      }
      pNew->SetFollow(pOld);
      pOld->SetMaster(pNew);
  }

  return pNew;
187}

189// lcl_Undersize(..) walks over a SwFrame and its contents
190// and returns the sum of all requested TextFrame magnifications.

192static long lcl_Undersize( const SwFrame* pFrame )
193{
  long nRet = 0;
  SwRectFnSet aRectFnSet(pFrame);
  if( pFrame->IsTextFrame() )
  {
      if( static_cast<const SwTextFrame*>(pFrame)->IsUndersized() )
      {
          // Does this TextFrame would like to be a little bit bigger?
          nRet = static_cast<const SwTextFrame*>(pFrame)->GetParHeight() -
                  aRectFnSet.GetHeight(pFrame->getFramePrintArea());
          if( nRet < 0 )
              nRet = 0;
      }
  }
  else if( pFrame->IsLayoutFrame() )
  {
      const SwFrame* pNxt = static_cast<const SwLayoutFrame*>(pFrame)->Lower();
      while( pNxt )
      {
          nRet += lcl_Undersize( pNxt );
          pNxt = pNxt->GetNext();
      }
  }
  return nRet;
217}

219namespace sw {

221SwTwips FootnoteSeparatorHeight(SwPageFootnoteInfo const& rInf)
222{
  return rInf.GetTopDist() + rInf.GetBottomDist() + rInf.GetLineWidth();
224}

226} // namespace sw

228/// "format" the frame (Fixsize is not set here).
229void SwFootnoteContFrame::Format( vcl::RenderContext* /*pRenderContext*/, const SwBorderAttrs * )
230{
  // calculate total border, only one distance to the top
  const SwPageFrame* pPage = FindPageFrame();
  const SwPageFootnoteInfo &rInf = pPage->GetPageDesc()->GetFootnoteInfo();
  const SwTwips nBorder = sw::FootnoteSeparatorHeight(rInf);
  SwRectFnSet aRectFnSet(this);

  if ( !isFramePrintAreaValid() )
  {
      setFramePrintAreaValid(true);
      SwFrameAreaDefinition::FramePrintAreaWriteAccess aPrt(*this);

      aRectFnSet.SetTop( aPrt, nBorder );
      aRectFnSet.SetWidth( aPrt, aRectFnSet.GetWidth(getFrameArea()) );
      aRectFnSet.SetHeight(aPrt, aRectFnSet.GetHeight(getFrameArea()) - nBorder );

      if( aRectFnSet.GetHeight(aPrt) < 0 && !pPage->IsFootnotePage() )
      {
          setFrameAreaSizeValid(false);
      }
  }

  if ( isFrameAreaSizeValid() )
      return;

  bool bGrow = pPage->IsFootnotePage();
  if( bGrow )
  {
      const SwViewShell *pSh = getRootFrame() ? getRootFrame()->GetCurrShell() : nullptr;
      if( pSh && pSh->GetViewOptions()->getBrowseMode() )
          bGrow = false;
  }
  if( bGrow )
          Grow( LONG_MAX9223372036854775807L );
  else
  {
      // VarSize is determined based on the content plus the borders
      SwTwips nRemaining = 0;
      SwFrame *pFrame = m_pLower;
      while ( pFrame )
      {   // lcl_Undersize(..) respects (recursively) TextFrames, which
          // would like to be bigger. They are created especially in
          // columnized borders, if these do not have their maximum
          // size yet.
          nRemaining += aRectFnSet.GetHeight(pFrame->getFrameArea()) + lcl_Undersize( pFrame );
          pFrame = pFrame->GetNext();
      }
      // add the own border
      nRemaining += nBorder;

      SwTwips nDiff;
      if( IsInSct() )
      {
          nDiff = -aRectFnSet.BottomDist( getFrameArea(), aRectFnSet.GetPrtBottom(*GetUpper()) );
          if( nDiff > 0 )
          {
              if( nDiff > aRectFnSet.GetHeight(getFrameArea()) )
              {
                  nDiff = aRectFnSet.GetHeight(getFrameArea());
              }

              SwFrameAreaDefinition::FrameAreaWriteAccess aFrm(*this);
              aRectFnSet.AddBottom( aFrm, -nDiff );
              aRectFnSet.AddHeight( aFrm, -nDiff );
          }
      }
      nDiff = aRectFnSet.GetHeight(getFrameArea()) - nRemaining;
      if ( nDiff > 0 )
          Shrink( nDiff );
      else if ( nDiff < 0 )
      {
          Grow( -nDiff );
          // It may happen that there is less space available,
          // than what the border needs - the size of the PrtArea
          // will then be negative.
          SwTwips nPrtHeight = aRectFnSet.GetHeight(getFramePrintArea());
          if( nPrtHeight < 0 )
          {
              const SwTwips nTmpDiff = std::max( aRectFnSet.GetTop(getFramePrintArea()), -nPrtHeight );
              SwFrameAreaDefinition::FramePrintAreaWriteAccess aPrt(*this);
              aRectFnSet.SubTop( aPrt, nTmpDiff );
          }
      }
  }

  setFrameAreaSizeValid(true);
316}

318SwTwips SwFootnoteContFrame::GrowFrame( SwTwips nDist, bool bTst, bool )
319{
  // No check if FixSize since FootnoteContainer are variable up to their max. height.
  // If the max. height is LONG_MAX, take as much space as needed.
  // If the page is a special footnote page, take also as much as possible.
  assert(GetUpper() && GetUpper()->IsFootnoteBossFrame())(static_cast <bool> (GetUpper() && GetUpper()->
IsFootnoteBossFrame()) ? void (0) : __assert_fail ("GetUpper() && GetUpper()->IsFootnoteBossFrame()"
, "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 323, __extension__ __PRETTY_FUNCTION__));

  SwRectFnSet aRectFnSet(this);
  if( aRectFnSet.GetHeight(getFrameArea()) > 0 &&
       nDist > ( LONG_MAX9223372036854775807L - aRectFnSet.GetHeight(getFrameArea()) ) )
      nDist = LONG_MAX9223372036854775807L - aRectFnSet.GetHeight(getFrameArea());

  SwFootnoteBossFrame *pBoss = static_cast<SwFootnoteBossFrame*>(GetUpper());
  if( IsInSct() )
  {
      SwSectionFrame* pSect = FindSctFrame();
      OSL_ENSURE( pSect, "GrowFrame: Missing SectFrame" )do { if (true && (!(pSect))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "334" ": "), "%s", "GrowFrame: Missing SectFrame"); } } while
 (false);
      // In a section, which has to maximize, a footnotecontainer is allowed
      // to grow, when the section can't grow anymore.
      if( !bTst && !pSect->IsColLocked() &&
          pSect->ToMaximize( false ) && pSect->Growable() )
      {
          pSect->InvalidateSize();
          return 0;
      }
  }
  const SwViewShell *pSh = getRootFrame() ? getRootFrame()->GetCurrShell() : nullptr;
  const bool bBrowseMode = pSh && pSh->GetViewOptions()->getBrowseMode();
  SwPageFrame *pPage = pBoss->FindPageFrame();
  if ( bBrowseMode || !pPage->IsFootnotePage() )
  {
      if ( pBoss->GetMaxFootnoteHeight() != LONG_MAX9223372036854775807L )
      {
          nDist = std::min( nDist, pBoss->GetMaxFootnoteHeight()
                       - aRectFnSet.GetHeight(getFrameArea()) );
          if ( nDist <= 0 )
              return 0;
      }
      // FootnoteBoss also influences the max value
      if( !IsInSct() )
      {
          const SwTwips nMax = pBoss->GetVarSpace();
          if ( nDist > nMax )
              nDist = nMax;
          if ( nDist <= 0 )
              return 0;
      }
  }
  else if( nDist > aRectFnSet.GetHeight(GetPrev()->getFrameArea()) )
      // do not use more space than the body has
      nDist = aRectFnSet.GetHeight(GetPrev()->getFrameArea());

  long nAvail = 0;
  if ( bBrowseMode )
  {
      nAvail = GetUpper()->getFramePrintArea().Height();
      const SwFrame *pAvail = GetUpper()->Lower();
      do
      {   nAvail -= pAvail->getFrameArea().Height();
          pAvail = pAvail->GetNext();
      } while ( pAvail );
      if ( nAvail > nDist )
          nAvail = nDist;
  }

  if ( !bTst )
  {
      SwFrameAreaDefinition::FrameAreaWriteAccess aFrm(*this);
      aRectFnSet.SetHeight( aFrm, aRectFnSet.GetHeight(aFrm) + nDist );

      if( IsVertical() && !IsVertLR() )
      {
          aFrm.Pos().AdjustX( -nDist );
      }
  }
  long nGrow = nDist - nAvail,
       nReal = 0;
  if ( nGrow > 0 )
  {
      SwNeighbourAdjust nAdjust = pBoss->NeighbourhoodAdjustment();
      if( SwNeighbourAdjust::OnlyAdjust == nAdjust )
          nReal = AdjustNeighbourhood( nGrow, bTst );
      else
      {
          if( SwNeighbourAdjust::GrowAdjust == nAdjust )
          {
              SwFrame* pFootnote = Lower();
              if( pFootnote )
              {
                  while( pFootnote->GetNext() )
                      pFootnote = pFootnote->GetNext();
                  if( static_cast<SwFootnoteFrame*>(pFootnote)->GetAttr()->GetFootnote().IsEndNote() )
                  {
                      nReal = AdjustNeighbourhood( nGrow, bTst );
                      nAdjust = SwNeighbourAdjust::GrowShrink; // no more AdjustNeighbourhood
                  }
              }
          }
          nReal += pBoss->Grow( nGrow - nReal, bTst );
          if( ( SwNeighbourAdjust::GrowAdjust == nAdjust || SwNeighbourAdjust::AdjustGrow == nAdjust )
                && nReal < nGrow )
              nReal += AdjustNeighbourhood( nGrow - nReal, bTst );
      }
  }

  nReal += nAvail;

  if ( !bTst )
  {
      if ( nReal != nDist )
      {
          nDist -= nReal;

          // We can only respect the boundless wish so much
          SwFrameAreaDefinition::FrameAreaWriteAccess aFrm(*this);
          aFrm.AddHeight( -nDist );

          if( IsVertical() && !IsVertLR() )
          {
              aFrm.Pos().AdjustX(nDist );
          }
      }

      // growing happens upwards, so successors to not need to be invalidated
      if( nReal )
      {
          InvalidateSize_();
          InvalidatePos_();
          InvalidatePage( pPage );
      }
  }
  return nReal;
450}

452SwTwips SwFootnoteContFrame::ShrinkFrame( SwTwips nDiff, bool bTst, bool bInfo )
453{
  SwPageFrame *pPage = FindPageFrame();
  bool bShrink = false;
  if ( pPage )
  {
      if( !pPage->IsFootnotePage() )
          bShrink = true;
      else
      {
          const SwViewShell *pSh = getRootFrame()->GetCurrShell();
          if( pSh && pSh->GetViewOptions()->getBrowseMode() )
              bShrink = true;
      }
  }
  if( bShrink )
  {
      SwTwips nRet = SwLayoutFrame::ShrinkFrame( nDiff, bTst, bInfo );
      if( IsInSct() && !bTst )
          FindSctFrame()->InvalidateNextPos();
      if ( !bTst && nRet )
      {
          InvalidatePos_();
          InvalidatePage( pPage );
      }
      return nRet;
  }
  return 0;
480}

482SwFootnoteFrame::SwFootnoteFrame( SwFrameFormat *pFormat, SwFrame* pSib, SwContentFrame *pCnt, SwTextFootnote *pAt ):
  SwLayoutFrame( pFormat, pSib ),
  mpFollow( nullptr ),
  mpMaster( nullptr ),
  mpReference( pCnt ),
  mpAttribute( pAt ),
  mbBackMoveLocked( false ),
  // #i49383#
  mbUnlockPosOfLowerObjs( true )
491{
  mnFrameType = SwFrameType::Ftn;
493}

495void SwFootnoteFrame::InvalidateNxtFootnoteCnts( SwPageFrame const *pPage )
496{
  if ( !GetNext() )
      return;

  SwFrame *pCnt = static_cast<SwLayoutFrame*>(GetNext())->ContainsAny();
  if( !pCnt )
      return;

  pCnt->InvalidatePage( pPage );
  pCnt->InvalidatePrt_();
  do
  {   pCnt->InvalidatePos_();
      if( pCnt->IsSctFrame() )
      {
          SwFrame* pTmp = static_cast<SwSectionFrame*>(pCnt)->ContainsAny();
          if( pTmp )
              pTmp->InvalidatePos_();
      }
      pCnt->GetUpper()->InvalidateSize_();
      pCnt = pCnt->FindNext();
  } while ( pCnt && GetUpper()->IsAnLower( pCnt ) );
517}

519bool SwFootnoteFrame::IsDeleteForbidden() const
520{
  if (SwLayoutFrame::IsDeleteForbidden())
      return true;
  // needs to be in sync with the ::Cut logic
  const SwLayoutFrame *pUp = GetUpper();
  if (pUp)
  {
      if (GetPrev())
          return false;

      // The last footnote takes its container along if it
      // is deleted. Cut would put pUp->Lower() to the value
      // of GetNext(), so if there is no GetNext then
      // Cut would delete pUp. If that condition is true
      // here then check if the container is delete-forbidden
      return !GetNext() && pUp->IsDeleteForbidden();
  }
  return false;
538}

540void SwFootnoteFrame::Cut()
541{
  if ( GetNext() )
      GetNext()->InvalidatePos();
  else if ( GetPrev() )
      GetPrev()->SetRetouche();

  // first move then shrink Upper
  SwLayoutFrame *pUp = GetUpper();

  // correct chaining
  SwFootnoteFrame *pFootnote = this;
  if ( pFootnote->GetFollow() )
      pFootnote->GetFollow()->SetMaster( pFootnote->GetMaster() );
  if ( pFootnote->GetMaster() )
      pFootnote->GetMaster()->SetFollow( pFootnote->GetFollow() );
  pFootnote->SetFollow( nullptr );
  pFootnote->SetMaster( nullptr );

  // cut all connections
  RemoveFromLayout();

  if ( !pUp )
      return;

  // The last footnote takes its container along
  if (!pUp->Lower())
  {
      SwPageFrame *pPage = pUp->FindPageFrame();
      if ( pPage )
      {
          SwLayoutFrame *pBody = pPage->FindBodyCont();
          if( pBody && !pBody->ContainsContent() )
              pPage->getRootFrame()->SetSuperfluous();
      }
      SwSectionFrame* pSect = pUp->FindSctFrame();
      pUp->Cut();
      SwFrame::DestroyFrame(pUp);
      // If the last footnote container was removed from a column
      // section without a Follow, then this section can be shrunk.
      if( pSect && !pSect->ToMaximize( false ) && !pSect->IsColLocked() )
          pSect->InvalidateSize_();
  }
  else
  {   if ( getFrameArea().Height() )
          pUp->Shrink( getFrameArea().Height() );
      pUp->SetCompletePaint();
      pUp->InvalidatePage();
  }
589}

591void SwFootnoteFrame::Paste(  SwFrame* pParent, SwFrame* pSibling )
592{
  OSL_ENSURE( pParent, "no parent in Paste." )do { if (true && (!(pParent))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "593" ": "), "%s", "no parent in Paste."); } } while (false
);
  OSL_ENSURE( pParent->IsLayoutFrame(), "Parent is ContentFrame." )do { if (true && (!(pParent->IsLayoutFrame()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "594" ": "), "%s", "Parent is ContentFrame."); } } while
 (false);
  OSL_ENSURE( pParent != this, "I am my own parent." )do { if (true && (!(pParent != this))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "595" ": "), "%s", "I am my own parent."); } } while (false
);
  OSL_ENSURE( pSibling != this, "I am my own sibling." )do { if (true && (!(pSibling != this))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "596" ": "), "%s", "I am my own sibling."); } } while (false
);
  OSL_ENSURE( !GetPrev() && !GetNext() && !GetUpper(),do { if (true && (!(!GetPrev() && !GetNext() &&
 !GetUpper()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "598" ": "), "%s", "I am still somewhere registered."); }
 } while (false)
          "I am still somewhere registered." )do { if (true && (!(!GetPrev() && !GetNext() &&
 !GetUpper()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "598" ": "), "%s", "I am still somewhere registered."); }
 } while (false);

  // insert into tree structure
  InsertBefore( static_cast<SwLayoutFrame*>(pParent), pSibling );

  SwRectFnSet aRectFnSet(this);
  if( aRectFnSet.GetWidth(getFrameArea())!=aRectFnSet.GetWidth(pParent->getFramePrintArea()) )
      InvalidateSize_();
  InvalidatePos_();
  SwPageFrame *pPage = FindPageFrame();
  InvalidatePage( pPage );
  if ( GetNext() )
      GetNext()->InvalidatePos_();
  if( aRectFnSet.GetHeight(getFrameArea()) )
      pParent->Grow( aRectFnSet.GetHeight(getFrameArea()) );

  // If the predecessor is the master and/or the successor is the Follow,
  // then take their content and destroy them.
  if ( GetPrev() && GetPrev() == GetMaster() )
  {
      OSL_ENSURE( SwFlowFrame::CastFlowFrame( GetPrev()->GetLower() ),do { if (true && (!(SwFlowFrame::CastFlowFrame( GetPrev
()->GetLower() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "619" ": "), "%s", "Footnote without content?"); } } while
 (false)
              "Footnote without content?" )do { if (true && (!(SwFlowFrame::CastFlowFrame( GetPrev
()->GetLower() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "619" ": "), "%s", "Footnote without content?"); } } while
 (false);
      SwFlowFrame::CastFlowFrame( GetPrev()->GetLower())->
          MoveSubTree( this, GetLower() );
      SwFrame *pDel = GetPrev();
      pDel->Cut();
      SwFrame::DestroyFrame(pDel);
  }
  if ( GetNext() && GetNext() == GetFollow() )
  {
      OSL_ENSURE( SwFlowFrame::CastFlowFrame( GetNext()->GetLower() ),do { if (true && (!(SwFlowFrame::CastFlowFrame( GetNext
()->GetLower() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "629" ": "), "%s", "Footnote without content?"); } } while
 (false)
              "Footnote without content?" )do { if (true && (!(SwFlowFrame::CastFlowFrame( GetNext
()->GetLower() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "629" ": "), "%s", "Footnote without content?"); } } while
 (false);
      SwFlowFrame::CastFlowFrame( GetNext()->GetLower() )->MoveSubTree( this );
      SwFrame *pDel = GetNext();
      pDel->Cut();
      SwFrame::DestroyFrame(pDel);
  }
635#if OSL_DEBUG_LEVEL1 > 0
  SwDoc *pDoc = GetFormat()->GetDoc();
  if ( GetPrev() )
  {
      OSL_ENSURE( lcl_FindFootnotePos( pDoc, static_cast<SwFootnoteFrame*>(GetPrev())->GetAttr() ) <=do { if (true && (!(lcl_FindFootnotePos( pDoc, static_cast
<SwFootnoteFrame*>(GetPrev())->GetAttr() ) <= lcl_FindFootnotePos
( pDoc, GetAttr() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "640" ": "), "%s", "Prev is not FootnotePrev"); } } while
 (false)
              lcl_FindFootnotePos( pDoc, GetAttr() ), "Prev is not FootnotePrev" )do { if (true && (!(lcl_FindFootnotePos( pDoc, static_cast
<SwFootnoteFrame*>(GetPrev())->GetAttr() ) <= lcl_FindFootnotePos
( pDoc, GetAttr() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "640" ": "), "%s", "Prev is not FootnotePrev"); } } while
 (false);
  }
  if ( GetNext() )
  {
      OSL_ENSURE( lcl_FindFootnotePos( pDoc, GetAttr() ) <=do { if (true && (!(lcl_FindFootnotePos( pDoc, GetAttr
() ) <= lcl_FindFootnotePos( pDoc, static_cast<SwFootnoteFrame
*>(GetNext())->GetAttr() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "646" ": "), "%s", "Next is not FootnoteNext"); } } while
 (false)
              lcl_FindFootnotePos( pDoc, static_cast<SwFootnoteFrame*>(GetNext())->GetAttr() ),do { if (true && (!(lcl_FindFootnotePos( pDoc, GetAttr
() ) <= lcl_FindFootnotePos( pDoc, static_cast<SwFootnoteFrame
*>(GetNext())->GetAttr() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "646" ": "), "%s", "Next is not FootnoteNext"); } } while
 (false)
              "Next is not FootnoteNext" )do { if (true && (!(lcl_FindFootnotePos( pDoc, GetAttr
() ) <= lcl_FindFootnotePos( pDoc, static_cast<SwFootnoteFrame
*>(GetNext())->GetAttr() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "646" ": "), "%s", "Next is not FootnoteNext"); } } while
 (false);
  }
648#endif
  InvalidateNxtFootnoteCnts( pPage );
650}

652/// Return the next layout leaf in that the frame can be moved.
653/// New pages will only be created if specified by the parameter.
654SwLayoutFrame *SwFrame::GetNextFootnoteLeaf( MakePageType eMakePage )
655{
  SwFootnoteBossFrame *pOldBoss = FindFootnoteBossFrame();
  SwPageFrame* pOldPage = pOldBoss->FindPageFrame();
  SwPageFrame* pPage;
  SwFootnoteBossFrame *pBoss = pOldBoss->IsColumnFrame() ?
      static_cast<SwFootnoteBossFrame*>(pOldBoss->GetNext()) : nullptr; // next column, if existing
  if( pBoss )
      pPage = nullptr;
  else
  {
      if( pOldBoss->GetUpper()->IsSctFrame() )
      {   // this can only be in a column area
          SwLayoutFrame* pNxt = pOldBoss->GetNextSctLeaf( eMakePage );
          if( pNxt )
          {
              OSL_ENSURE( pNxt->IsColBodyFrame(), "GetNextFootnoteLeaf: Funny Leaf" )do { if (true && (!(pNxt->IsColBodyFrame()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "670" ": "), "%s", "GetNextFootnoteLeaf: Funny Leaf"); }
 } while (false);
              pBoss = static_cast<SwFootnoteBossFrame*>(pNxt->GetUpper());
              pPage = pBoss->FindPageFrame();
          }
          else
              return nullptr;
      }
      else
      {
          // next page
          pPage = static_cast<SwPageFrame*>(pOldPage->GetNext());
          // skip empty pages
          if( pPage && pPage->IsEmptyPage() )
              pPage = static_cast<SwPageFrame*>(pPage->GetNext());
          pBoss = pPage;
      }
  }
  // What do we have until here?
  // pBoss != NULL, pPage==NULL => pBoss is the next column on the same page
  // pBoss != NULL, pPage!=NULL => pBoss and pPage are the following page (empty pages skipped)
  // pBoss == NULL => pPage == NULL, so there are no following pages

  // If the footnote has already a Follow we do not need to search.
  // However, if there are unwanted empty columns/pages between Footnote and Follow,
  // create another Follow on the next best column/page and the rest will sort itself out.
  SwFootnoteFrame *pFootnote = FindFootnoteFrame();
  if ( pFootnote && pFootnote->GetFollow() )
  {
      SwFootnoteBossFrame* pTmpBoss = pFootnote->GetFollow()->FindFootnoteBossFrame();
      // Following cases will be handled:
      // 1. both "FootnoteBoss"es are neighboring columns/pages
      // 2. the new one is the first column of a neighboring page
      // 3. the new one is the first column in a section of the next page
      while( pTmpBoss != pBoss && pTmpBoss && !pTmpBoss->GetPrev() )
          pTmpBoss = pTmpBoss->GetUpper()->FindFootnoteBossFrame();
      if( pTmpBoss == pBoss )
          return pFootnote->GetFollow();
  }

  // If no pBoss could be found or it is a "wrong" page, we need a new page.
  if ( !pBoss || ( pPage && pPage->IsEndNotePage() && !pOldPage->IsEndNotePage() ) )
  {
      if ( eMakePage == MAKEPAGE_APPEND || eMakePage == MAKEPAGE_INSERT )
      {
          pBoss = InsertPage( pOldPage, pOldPage->IsFootnotePage() );
          static_cast<SwPageFrame*>(pBoss)->SetEndNotePage( pOldPage->IsEndNotePage() );
      }
      else
          return nullptr;
  }
  if( pBoss->IsPageFrame() )
  {
      // If this page has columns, then go to the first one
      SwLayoutFrame* pLay = pBoss->FindBodyCont();
      if( pLay && pLay->Lower() && pLay->Lower()->IsColumnFrame() )
          pBoss = static_cast<SwFootnoteBossFrame*>(pLay->Lower());
  }
  // found column/page - add myself
  SwFootnoteContFrame *pCont = pBoss->FindFootnoteCont();
  if ( !pCont && pBoss->GetMaxFootnoteHeight() &&
       ( eMakePage == MAKEPAGE_APPEND || eMakePage == MAKEPAGE_INSERT ) )
      pCont = pBoss->MakeFootnoteCont();
  return pCont;
733}

735/// Get the preceding layout leaf in that the frame can be moved.
736SwLayoutFrame *SwFrame::GetPrevFootnoteLeaf( MakePageType eMakeFootnote )
737{
  // The predecessor of a footnote is (if possible)
  // the master of the chain of the footnote.
  SwFootnoteFrame *pFootnote = FindFootnoteFrame();
  SwLayoutFrame *pRet = pFootnote->GetMaster();

  SwFootnoteBossFrame* pOldBoss = FindFootnoteBossFrame();
  SwPageFrame *pOldPage = pOldBoss->FindPageFrame();

  if ( !pOldBoss->GetPrev() && !pOldPage->GetPrev() )
      return pRet; // there is neither a predecessor column nor page

  if ( !pRet )
  {
      bool bEndn = pFootnote->GetAttr()->GetFootnote().IsEndNote();
      SwFrame* pTmpRef = nullptr;
      const IDocumentSettingAccess& rSettings
          = pFootnote->GetAttrSet()->GetDoc()->getIDocumentSettingAccess();
      if( bEndn && pFootnote->IsInSct() )
      {
          SwSectionFrame* pSect = pFootnote->FindSctFrame();
          if( pSect->IsEndnAtEnd() )
              // Endnotes at the end of the section.
              pTmpRef = pSect->FindLastContent( SwFindMode::LastCnt );
      }
      else if (bEndn && rSettings.get(DocumentSettingId::CONTINUOUS_ENDNOTES))
      {
          // Endnotes at the end of the document.
          SwPageFrame* pPage = getRootFrame()->GetLastPage();
          assert(pPage)(static_cast <bool> (pPage) ? void (0) : __assert_fail (
"pPage", "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 766, __extension__ __PRETTY_FUNCTION__));
          SwFrame* pPrevPage = pPage->GetPrev();
          if (pPrevPage)
          {
              // Have a last but one page, use that since we try to get a preceding frame.
              assert(pPrevPage->IsPageFrame())(static_cast <bool> (pPrevPage->IsPageFrame()) ? void
 (0) : __assert_fail ("pPrevPage->IsPageFrame()", "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 771, __extension__ __PRETTY_FUNCTION__));
              pPage = static_cast<SwPageFrame*>(pPrevPage);
          }
          pTmpRef = pPage->FindLastBodyContent();
      }
      if( !pTmpRef )
          // Endnotes on a separate page.
          pTmpRef = pFootnote->GetRef();
      SwFootnoteBossFrame* pStop = pTmpRef->FindFootnoteBossFrame( !bEndn );

      const sal_uInt16 nNum = pStop->GetPhyPageNum();

      // Do not leave the corresponding page if the footnote should
      // be shown at the document ending or the footnote is an endnote.
      const bool bEndNote = pOldPage->IsEndNotePage();
      const bool bFootnoteEndDoc = pOldPage->IsFootnotePage();
      SwFootnoteBossFrame* pNxtBoss = pOldBoss;
      SwSectionFrame *pSect = pNxtBoss->GetUpper()->IsSctFrame() ?
                            static_cast<SwSectionFrame*>(pNxtBoss->GetUpper()) : nullptr;

      do
      {
          if( pNxtBoss->IsColumnFrame() && pNxtBoss->GetPrev() )
              pNxtBoss = static_cast<SwFootnoteBossFrame*>(pNxtBoss->GetPrev());  // one column backwards
          else // one page backwards
          {
              SwLayoutFrame* pBody = nullptr;
              if( pSect )
              {
                  if( pSect->IsFootnoteLock() )
                  {
                      if( pNxtBoss == pOldBoss )
                          return nullptr;
                      pStop = pNxtBoss;
                  }
                  else
                  {
                      pSect = pSect->FindMaster();
                      if( !pSect || !pSect->Lower() )
                          return nullptr;
                      OSL_ENSURE( pSect->Lower()->IsColumnFrame(),do { if (true && (!(pSect->Lower()->IsColumnFrame
()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "812" ": "), "%s", "GetPrevFootnoteLeaf: Where's the column?"
); } } while (false)
                              "GetPrevFootnoteLeaf: Where's the column?" )do { if (true && (!(pSect->Lower()->IsColumnFrame
()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "812" ": "), "%s", "GetPrevFootnoteLeaf: Where's the column?"
); } } while (false);
                      pNxtBoss = static_cast<SwFootnoteBossFrame*>(pSect->Lower());
                      pBody = pSect;
                  }
              }
              else
              {
                  SwPageFrame* pPage = static_cast<SwPageFrame*>(pNxtBoss->FindPageFrame()->GetPrev());
                  if( !pPage || pPage->GetPhyPageNum() < nNum ||
                      bEndNote != pPage->IsEndNotePage() || bFootnoteEndDoc != pPage->IsFootnotePage() )
                      return nullptr; // no further pages found
                  pNxtBoss = pPage;
                  pBody = pPage->FindBodyCont();
              }
              // We have the previous page, we might need to find the last column of it
              if( pBody )
              {
                  if ( pBody->Lower() && pBody->Lower()->IsColumnFrame() )
                  {
                      pNxtBoss = static_cast<SwFootnoteBossFrame*>(pBody->GetLastLower());
                  }
              }
          }
          SwFootnoteContFrame *pCont = pNxtBoss->FindFootnoteCont();
          if ( pCont )
          {
              pRet = pCont;
              break;
          }
          if ( pStop == pNxtBoss )
          {
              // Reached the column/page of the reference.
              // Try to add a container and paste our content.
              if ( eMakeFootnote == MAKEPAGE_FTN && pNxtBoss->GetMaxFootnoteHeight() )
                  pRet = pNxtBoss->MakeFootnoteCont();
              break;
          }
      } while( !pRet );
  }
  if ( pRet )
  {
      const SwFootnoteBossFrame* pNewBoss = pRet->FindFootnoteBossFrame();
      bool bJump = false;
      if( pOldBoss->IsColumnFrame() && pOldBoss->GetPrev() ) // a previous column exists
          bJump = pOldBoss->GetPrev() != static_cast<SwFrame const *>(pNewBoss); // did we chose it?
      else if( pNewBoss->IsColumnFrame() && pNewBoss->GetNext() )
          bJump = true; // there is another column after the boss (not the old boss)
      else
      {
          // Will be reached only if old and new boss are both either pages or the last (new)
          // or first (old) column of a page. In this case, check if pages were skipped.
          const sal_uInt16 nDiff = pOldPage->GetPhyPageNum() - pRet->FindPageFrame()->GetPhyPageNum();
          if ( nDiff > 2 ||
               (nDiff > 1 && !static_cast<SwPageFrame*>(pOldPage->GetPrev())->IsEmptyPage()) )
              bJump = true;
      }
      if( bJump )
          SwFlowFrame::SetMoveBwdJump( true );
  }
  return pRet;
872}

874bool SwFrame::IsFootnoteAllowed() const
875{
  if ( !IsInDocBody() )
      return false;

  if ( IsInTab() )
  {
      // no footnotes in repeated headlines
      const SwTabFrame *pTab = const_cast<SwFrame*>(this)->ImplFindTabFrame();
      assert(pTab)(static_cast <bool> (pTab) ? void (0) : __assert_fail (
"pTab", "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 883, __extension__ __PRETTY_FUNCTION__));
      if ( pTab->IsFollow() )
          return !pTab->IsInHeadline( *this );
  }
  return true;
888}

890void SwRootFrame::UpdateFootnoteNums()
891{
  // page numbering only if set at the document
  if ( GetFormat()->GetDoc()->GetFootnoteInfo().m_eNum == FTNNUM_PAGE )
  {
      SwPageFrame *pPage = static_cast<SwPageFrame*>(Lower());
      while ( pPage && !pPage->IsFootnotePage() )
      {
          pPage->UpdateFootnoteNum();
          pPage = static_cast<SwPageFrame*>(pPage->GetNext());
      }
  }
902}

904/// remove all footnotes (not the references) and all footnote pages
905void sw_RemoveFootnotes( SwFootnoteBossFrame* pBoss, bool bPageOnly, bool bEndNotes )
906{
  do
  {
      SwFootnoteContFrame *pCont = pBoss->FindFootnoteCont();
      if ( pCont )
      {
          SwFootnoteFrame *pFootnote = static_cast<SwFootnoteFrame*>(pCont->Lower());
          assert(pFootnote)(static_cast <bool> (pFootnote) ? void (0) : __assert_fail
 ("pFootnote", "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 913, __extension__ __PRETTY_FUNCTION__));
          if ( bPageOnly )
              while ( pFootnote->GetMaster() )
                  pFootnote = pFootnote->GetMaster();
          do
          {
              SwFootnoteFrame *pNxt = static_cast<SwFootnoteFrame*>(pFootnote->GetNext());
              if ( !pFootnote->GetAttr()->GetFootnote().IsEndNote() ||
                      bEndNotes )
              {
                  pFootnote->GetRef()->Prepare( PrepareHint::FootnoteInvalidation, static_cast<void*>(pFootnote->GetAttr()) );
                  if ( bPageOnly && !pNxt )
                      pNxt = pFootnote->GetFollow();
                  pFootnote->Cut();
                  SwFrame::DestroyFrame(pFootnote);
              }
              pFootnote = pNxt;

          } while ( pFootnote );
      }
      if( !pBoss->IsInSct() )
      {
          // A sectionframe with the Footnote/EndnAtEnd-flags may contain
          // foot/endnotes. If the last lower frame of the bodyframe is
          // a multicolumned sectionframe, it may contain footnotes, too.
          SwLayoutFrame* pBody = pBoss->FindBodyCont();
          if( pBody && pBody->Lower() )
          {
              SwFrame* pLow = pBody->Lower();
              while (pLow)
              {
                  if( pLow->IsSctFrame() && ( !pLow->GetNext() ||
                      static_cast<SwSectionFrame*>(pLow)->IsAnyNoteAtEnd() ) &&
                      static_cast<SwSectionFrame*>(pLow)->Lower() &&
                      static_cast<SwSectionFrame*>(pLow)->Lower()->IsColumnFrame() )
                      sw_RemoveFootnotes( static_cast<SwColumnFrame*>(static_cast<SwSectionFrame*>(pLow)->Lower()),
                          bPageOnly, bEndNotes );
                  pLow = pLow->GetNext();
              }
          }
      }
      // is there another column?
      pBoss = pBoss->IsColumnFrame() ? static_cast<SwColumnFrame*>(pBoss->GetNext()) : nullptr;
  } while( pBoss );
957}

959void SwRootFrame::RemoveFootnotes( SwPageFrame *pPage, bool bPageOnly, bool bEndNotes )
960{
  if ( !pPage )
      pPage = static_cast<SwPageFrame*>(Lower());

  do
  {   // On columned pages we have to clean up in all columns
      SwFootnoteBossFrame* pBoss;
      SwLayoutFrame* pBody = pPage->FindBodyCont();
      if( pBody && pBody->Lower() && pBody->Lower()->IsColumnFrame() )
          pBoss = static_cast<SwFootnoteBossFrame*>(pBody->Lower()); // the first column
      else
          pBoss = pPage; // no columns
      sw_RemoveFootnotes( pBoss, bPageOnly, bEndNotes );
      if ( !bPageOnly )
      {
          if ( pPage->IsFootnotePage() &&
               (!pPage->IsEndNotePage() || bEndNotes) )
          {
              SwFrame *pDel = pPage;
              pPage = static_cast<SwPageFrame*>(pPage->GetNext());
              pDel->Cut();
              SwFrame::DestroyFrame(pDel);
          }
          else
              pPage = static_cast<SwPageFrame*>(pPage->GetNext());
      }
      else
          break;

  } while ( pPage );
990}

992/// Change the page template of the footnote pages
993void SwRootFrame::CheckFootnotePageDescs( bool bEndNote )
994{
  SwPageFrame *pPage = static_cast<SwPageFrame*>(Lower());
  while ( pPage && !pPage->IsFootnotePage() )
      pPage = static_cast<SwPageFrame*>(pPage->GetNext());
  while ( pPage && pPage->IsEndNotePage() != bEndNote )
      pPage = static_cast<SwPageFrame*>(pPage->GetNext());

  if ( pPage )
      SwFrame::CheckPageDescs( pPage, false );
1003}

1005/** Insert a footnote container
*
* A footnote container is always placed directly behind the body text.
*
* The frame format (FrameFormat) is always the default frame format.
*
* @return footnote container frame
*/
1013SwFootnoteContFrame *SwFootnoteBossFrame::MakeFootnoteCont()
1014{
  SAL_WARN_IF(FindFootnoteCont(), "sw.core", "footnote container exists already")do { if (true && (FindFootnoteCont())) { switch (sal_detail_log_report
(::SAL_DETAIL_LOG_LEVEL_WARN, "sw.core")) { case SAL_DETAIL_LOG_ACTION_IGNORE
: break; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail
::getResult( ::sal::detail::StreamStart() << "footnote container exists already"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("sw.core"
), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1015" ": "), ::sal::detail::unwrapStream( ::sal::detail
::StreamStart() << "footnote container exists already")
, 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
 << "footnote container exists already"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("sw.core"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1015" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "footnote container exists already") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("sw.core"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1015" ": "), ::sal::detail::unwrapStream( ::sal::detail
::StreamStart() << "footnote container exists already")
, 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
 << "footnote container exists already"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("sw.core"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1015" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);

  SwFootnoteContFrame *pNew = new SwFootnoteContFrame( GetFormat()->GetDoc()->GetDfltFrameFormat(), this );
  SwLayoutFrame *pLay = FindBodyCont();
  pNew->Paste( this, pLay->GetNext() );
  return pNew;
1021}

1023SwFootnoteContFrame *SwFootnoteBossFrame::FindFootnoteCont()
1024{
  SwFrame *pFrame = Lower();
  while( pFrame && !pFrame->IsFootnoteContFrame() )
      pFrame = pFrame->GetNext();

1029#if OSL_DEBUG_LEVEL1 > 0
  if ( pFrame )
  {
      SwFrame *pFootnote = pFrame->GetLower();
      assert(pFootnote)(static_cast <bool> (pFootnote) ? void (0) : __assert_fail
 ("pFootnote", "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 1033, __extension__ __PRETTY_FUNCTION__));
      while ( pFootnote )
      {
          assert(pFootnote->IsFootnoteFrame() && "Neighbor of footnote must be a footnote")(static_cast <bool> (pFootnote->IsFootnoteFrame() &&
 "Neighbor of footnote must be a footnote") ? void (0) : __assert_fail
 ("pFootnote->IsFootnoteFrame() && \"Neighbor of footnote must be a footnote\""
, "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 1036, __extension__ __PRETTY_FUNCTION__));
          pFootnote = pFootnote->GetNext();
      }
  }
1040#endif

  return static_cast<SwFootnoteContFrame*>(pFrame);
1043}

1045/// Search the next available footnote container.
1046SwFootnoteContFrame *SwFootnoteBossFrame::FindNearestFootnoteCont( bool bDontLeave )
1047{
  SwFootnoteContFrame *pCont = nullptr;
  if ( !GetFormat()->GetDoc()->GetFootnoteIdxs().empty() )
  {
      pCont = FindFootnoteCont();
      if ( !pCont )
      {
          SwPageFrame *pPage = FindPageFrame();
          SwFootnoteBossFrame* pBoss = this;
          bool bEndNote = pPage->IsEndNotePage();
          do
          {
              bool bChgPage = lcl_NextFootnoteBoss( pBoss, pPage, bDontLeave );
              // Found another boss? When changing pages, also the endnote flag must match.
              if( pBoss && ( !bChgPage || pPage->IsEndNotePage() == bEndNote ) )
                  pCont = pBoss->FindFootnoteCont();
          } while ( !pCont && pPage );
      }
  }
  return pCont;
1067}

1069SwFootnoteFrame *SwFootnoteBossFrame::FindFirstFootnote()
1070{
  // search for the nearest footnote container
  SwFootnoteContFrame *pCont = FindNearestFootnoteCont();
  if ( !pCont )
      return nullptr;

  // Starting from the first footnote, search the first
  // footnote that is referenced by the current column/page

  SwFootnoteFrame *pRet = static_cast<SwFootnoteFrame*>(pCont->Lower());
  const sal_uInt16 nRefNum = FindPageFrame()->GetPhyPageNum();
  const sal_uInt16 nRefCol = lcl_ColumnNum( this );
  sal_uInt16 nPgNum, nColNum; // page number, column number
  SwFootnoteBossFrame* pBoss;
  SwPageFrame* pPage;
  if( pRet )
  {
      pBoss = pRet->GetRef()->FindFootnoteBossFrame();
      OSL_ENSURE( pBoss, "FindFirstFootnote: No boss found" )do { if (true && (!(pBoss))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1088" ": "), "%s", "FindFirstFootnote: No boss found");
 } } while (false);
      if( !pBoss )
          return nullptr; // ?There must be a bug, but no GPF
      pPage = pBoss->FindPageFrame();
      nPgNum = pPage->GetPhyPageNum();
      if ( nPgNum == nRefNum )
      {
          nColNum = lcl_ColumnNum( pBoss );
          if( nColNum == nRefCol )
              return pRet; // found
          else if( nColNum > nRefCol )
              return nullptr; // at least one column too far
      }
      else if ( nPgNum > nRefNum )
          return nullptr;    // at least one column too far
  }
  else
      return nullptr;
  // Done if Ref is on a subsequent page or on the same page in a subsequent column

  do
  {
      while ( pRet->GetFollow() )
          pRet = pRet->GetFollow();

      SwFootnoteFrame *pNxt = static_cast<SwFootnoteFrame*>(pRet->GetNext());
      if ( !pNxt )
      {
          pBoss = pRet->FindFootnoteBossFrame();
          pPage = pBoss->FindPageFrame();
          lcl_NextFootnoteBoss( pBoss, pPage, false ); // next FootnoteBoss
          pCont = pBoss ? pBoss->FindNearestFootnoteCont() : nullptr;
          if ( pCont )
              pNxt = static_cast<SwFootnoteFrame*>(pCont->Lower());
      }
      if ( pNxt )
      {
          pRet = pNxt;
          pBoss = pRet->GetRef()->FindFootnoteBossFrame();
          pPage = pBoss->FindPageFrame();
          nPgNum = pPage->GetPhyPageNum();
          if ( nPgNum == nRefNum )
          {
              nColNum = lcl_ColumnNum( pBoss );
              if( nColNum == nRefCol )
                  break; // found
              else if( nColNum > nRefCol )
                  pRet = nullptr; // at least one column too far
          }
          else if ( nPgNum > nRefNum )
              pRet = nullptr;   // at least a page too far
      }
      else
          pRet = nullptr;   // there is none
  } while( pRet );
  return pRet;
1144}

1146/// Get the first footnote of a given content
1147const SwFootnoteFrame *SwFootnoteBossFrame::FindFirstFootnote( SwContentFrame const *pCnt ) const
1148{
  const SwFootnoteFrame *pRet = const_cast<SwFootnoteBossFrame*>(this)->FindFirstFootnote();
  if ( pRet )
  {
      const sal_uInt16 nColNum = lcl_ColumnNum( this );
      const sal_uInt16 nPageNum = GetPhyPageNum();
      while ( pRet && (pRet->GetRef() != pCnt) )
      {
          while ( pRet->GetFollow() )
              pRet = pRet->GetFollow();

          if ( pRet->GetNext() )
              pRet = static_cast<const SwFootnoteFrame*>(pRet->GetNext());
          else
          {   SwFootnoteBossFrame *pBoss = const_cast<SwFootnoteBossFrame*>(pRet->FindFootnoteBossFrame());
              SwPageFrame *pPage = pBoss->FindPageFrame();
              lcl_NextFootnoteBoss( pBoss, pPage, false ); // next FootnoteBoss
              SwFootnoteContFrame *pCont = pBoss ? pBoss->FindNearestFootnoteCont() : nullptr;
              pRet = pCont ? static_cast<SwFootnoteFrame*>(pCont->Lower()) : nullptr;
          }
          if ( pRet )
          {
              const SwFootnoteBossFrame* pBoss = pRet->GetRef()->FindFootnoteBossFrame();
              if( pBoss->GetPhyPageNum() != nPageNum ||
                  nColNum != lcl_ColumnNum( pBoss ) )
                  pRet = nullptr;
          }
      }
  }
  return pRet;
1178}

1180void SwFootnoteBossFrame::ResetFootnote( const SwFootnoteFrame *pCheck )
1181{
  // Destroy the incarnations of footnotes to an attribute, if they don't
  // belong to pAssumed
  OSL_ENSURE( !pCheck->GetMaster(), "given master is not a Master." )do { if (true && (!(!pCheck->GetMaster()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1184" ": "), "%s", "given master is not a Master."); } }
 while (false);

  SwNodeIndex aIdx( *pCheck->GetAttr()->GetStartNode(), 1 );
  SwContentNode *pNd = aIdx.GetNode().GetContentNode();
  if ( !pNd )
      pNd = pCheck->GetFormat()->GetDoc()->
            GetNodes().GoNextSection( &aIdx, true, false );
  SwIterator<SwFrame, SwContentNode, sw::IteratorMode::UnwrapMulti> aIter(*pNd);
  SwFrame* pFrame = aIter.First();
  while( pFrame )
  {
      if( pFrame->getRootFrame() == pCheck->getRootFrame() )
      {
          SwFrame *pTmp = pFrame->GetUpper();
          while ( pTmp && !pTmp->IsFootnoteFrame() )
              pTmp = pTmp->GetUpper();

          SwFootnoteFrame *pFootnote = static_cast<SwFootnoteFrame*>(pTmp);
          while ( pFootnote && pFootnote->GetMaster() )
              pFootnote = pFootnote->GetMaster();
          if ( pFootnote != pCheck )
          {
              while (pFootnote && !pFootnote->IsDeleteForbidden())
              {
                  SwFootnoteFrame *pNxt = pFootnote->GetFollow();
                  pFootnote->Cut();
                  SwFrame::DestroyFrame(pFootnote);
                  pFootnote = pNxt;
              }
          }
      }

      pFrame = aIter.Next();
  }
1218}

1220void SwFootnoteBossFrame::InsertFootnote( SwFootnoteFrame* pNew )
1221{
  // Place the footnote in front of the footnote whose attribute
  // is in front of the new one (get position via the Doc).
  // If there is no footnote in this footnote-boss yet, create a new container.
  // If there is a container but no footnote for this footnote-boss yet, place
  // the footnote behind the last footnote of the closest previous column/page.

  ResetFootnote( pNew );
  SwFootnoteFrame *pSibling = FindFirstFootnote();
  bool bDontLeave = false;

  // Ok, a sibling has been found, but is the sibling in an acceptable
  // environment?
  if( IsInSct() )
  {
      SwSectionFrame* pMySect = ImplFindSctFrame();
      bool bEndnt = pNew->GetAttr()->GetFootnote().IsEndNote();
      if( bEndnt )
      {
          const SwSectionFormat* pEndFormat = pMySect->GetEndSectFormat();
          bDontLeave = nullptr != pEndFormat;
          if( pSibling )
          {
              if( pEndFormat )
              {
                  if( !pSibling->IsInSct() ||
                      !pSibling->ImplFindSctFrame()->IsDescendantFrom( pEndFormat ) )
                      pSibling = nullptr;
              }
              else if( pSibling->IsInSct() )
                  pSibling = nullptr;
          }
      }
      else
      {
          bDontLeave = pMySect->IsFootnoteAtEnd();
          if( pSibling )
          {
              if( pMySect->IsFootnoteAtEnd() )
              {
                  if( !pSibling->IsInSct() ||
                      !pMySect->IsAnFollow( pSibling->ImplFindSctFrame() ) )
                      pSibling = nullptr;
              }
              else if( pSibling->IsInSct() )
                  pSibling = nullptr;
          }
      }
  }

  if( pSibling && pSibling->FindPageFrame()->IsEndNotePage() !=
      FindPageFrame()->IsEndNotePage() )
      pSibling = nullptr;

  // use the Doc to find out the position
  SwDoc *pDoc = GetFormat()->GetDoc();
  const sal_uLong nStPos = ::lcl_FindFootnotePos( pDoc, pNew->GetAttr() );

  sal_uLong nCmpPos = 0;
  sal_uLong nLastPos = 0;
  SwFootnoteContFrame *pParent = nullptr;
  if( pSibling )
  {
      nCmpPos = ::lcl_FindFootnotePos( pDoc, pSibling->GetAttr() );
      if( nCmpPos > nStPos )
          pSibling = nullptr;
  }

  if ( !pSibling )
  {   pParent = FindFootnoteCont();
      if ( !pParent )
      {
          // There is no footnote container yet. Before creating one, keep in mind that
          // there might exist another following footnote that must be placed before the
          // new inserted one e.g. because it was divided over multiple pages etc.
          pParent = FindNearestFootnoteCont( bDontLeave );
          if ( pParent )
          {
              SwFootnoteFrame *pFootnote = static_cast<SwFootnoteFrame*>(pParent->Lower());
              if ( pFootnote )
              {

                  nCmpPos = ::lcl_FindFootnotePos( pDoc, pFootnote->GetAttr() );
                  if ( nCmpPos > nStPos )
                      pParent = nullptr;
              }
              else
                  pParent = nullptr;
          }
      }
      if ( !pParent )
          // here, we are sure that we can create a footnote container
          pParent = MakeFootnoteCont();
      else
      {
          // Based on the first footnote below the Parent, search for the first footnote whose
          // index is after the index of the newly inserted, to place the new one correctly
          pSibling = static_cast<SwFootnoteFrame*>(pParent->Lower());
          if ( !pSibling )
          {
              OSL_ENSURE( false, "Could not find space for footnote.")do { if (true && (!(false))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1321" ": "), "%s", "Could not find space for footnote."
); } } while (false);
              return;
          }
          nCmpPos  = ::lcl_FindFootnotePos( pDoc, pSibling->GetAttr() );

          SwFootnoteBossFrame *pNxtB; // remember the last one to not
          SwFootnoteFrame  *pLastSib = nullptr;    // go too far.

          while ( pSibling && nCmpPos <= nStPos )
          {
              pLastSib = pSibling; // potential candidate
              nLastPos = nCmpPos;

              while ( pSibling->GetFollow() )
                  pSibling = pSibling->GetFollow();

              if ( pSibling->GetNext() )
              {
                  pSibling = static_cast<SwFootnoteFrame*>(pSibling->GetNext());
                  OSL_ENSURE( !pSibling->GetMaster() || ( ENDNOTE > nStPos &&do { if (true && (!(!pSibling->GetMaster() || ( 0x80000000
 > nStPos && pSibling->GetAttr()->GetFootnote
().IsEndNote() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1342" ": "), "%s", "InsertFootnote: Master expected I")
; } } while (false)
                          pSibling->GetAttr()->GetFootnote().IsEndNote() ),do { if (true && (!(!pSibling->GetMaster() || ( 0x80000000
 > nStPos && pSibling->GetAttr()->GetFootnote
().IsEndNote() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1342" ": "), "%s", "InsertFootnote: Master expected I")
; } } while (false)
                          "InsertFootnote: Master expected I" )do { if (true && (!(!pSibling->GetMaster() || ( 0x80000000
 > nStPos && pSibling->GetAttr()->GetFootnote
().IsEndNote() )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1342" ": "), "%s", "InsertFootnote: Master expected I")
; } } while (false);
              }
              else
              {
                  pNxtB = pSibling->FindFootnoteBossFrame();
                  SwPageFrame *pSibPage = pNxtB->FindPageFrame();
                  bool bEndNote = pSibPage->IsEndNotePage();
                  bool bChgPage = lcl_NextFootnoteBoss( pNxtB, pSibPage, bDontLeave );
                  // When changing pages, also the endnote flag must match.
                  SwFootnoteContFrame *pCont = pNxtB && ( !bChgPage ||
                      pSibPage->IsEndNotePage() == bEndNote )
                      ? pNxtB->FindNearestFootnoteCont( bDontLeave ) : nullptr;
                  if( pCont )
                      pSibling = static_cast<SwFootnoteFrame*>(pCont->Lower());
                  else // no further FootnoteContainer, insert after pSibling
                      break;
              }
              if ( pSibling )
              {
                  nCmpPos = ::lcl_FindFootnotePos( pDoc, pSibling->GetAttr() );
                  OSL_ENSURE( nCmpPos > nLastPos, "InsertFootnote: Order of FootnoteFrame's buggy" )do { if (true && (!(nCmpPos > nLastPos))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1362" ": "), "%s", "InsertFootnote: Order of FootnoteFrame's buggy"
); } } while (false);
              }
          }
          // pLastSib is the last footnote before the new one and
          // pSibling is empty or the first one after the new one
          if ( pSibling && pLastSib && (pSibling != pLastSib) )
          {
              // too far?
              if ( nCmpPos > nStPos )
                  pSibling = pLastSib;
          }
          else if ( !pSibling )
          {
              // Last chance: Take the last footnote of the parent.
              // Special case that happens e.g. when moving paragraphs with multiple footnotes.
              // To keep the order, use the parent of the last inspected footnote.
              pSibling = pLastSib;
              while( pSibling->GetFollow() )
                  pSibling = pSibling->GetFollow();
              OSL_ENSURE( !pSibling->GetNext(), "InsertFootnote: Who's that guy?" )do { if (true && (!(!pSibling->GetNext()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1381" ": "), "%s", "InsertFootnote: Who's that guy?"); }
 } while (false);
          }
      }
  }
  else
  {
      // First footnote of the column/page found. Now search from there for the first one on the
      // same column/page whose index is after the given one. The last one found is the predecessor.
      SwFootnoteBossFrame* pBoss = pNew->GetRef()->FindFootnoteBossFrame(
          !pNew->GetAttr()->GetFootnote().IsEndNote() );
      sal_uInt16 nRefNum = pBoss->GetPhyPageNum();    // page number of the new footnote
      sal_uInt16 nRefCol = lcl_ColumnNum( pBoss );    // column number of the new footnote
      bool bEnd = false;
      SwFootnoteFrame *pLastSib = nullptr;
      while ( pSibling && !bEnd && (nCmpPos <= nStPos) )
      {
          pLastSib = pSibling;
          nLastPos = nCmpPos;

          while ( pSibling->GetFollow() )
              pSibling = pSibling->GetFollow();

          SwFootnoteFrame *pFoll = static_cast<SwFootnoteFrame*>(pSibling->GetNext());
          if ( pFoll )
          {
              pBoss = pSibling->GetRef()->FindFootnoteBossFrame( !pSibling->
                                          GetAttr()->GetFootnote().IsEndNote() );
              sal_uInt16 nTmpRef;
              if( nStPos >= ENDNOTE0x80000000 ||
                  (nTmpRef = pBoss->GetPhyPageNum()) < nRefNum ||
                  ( nTmpRef == nRefNum && lcl_ColumnNum( pBoss ) <= nRefCol ))
                  pSibling = pFoll;
              else
                  bEnd = true;
          }
          else
          {
              SwFootnoteBossFrame* pNxtB = pSibling->FindFootnoteBossFrame();
              SwPageFrame *pSibPage = pNxtB->FindPageFrame();
              bool bEndNote = pSibPage->IsEndNotePage();
              bool bChgPage = lcl_NextFootnoteBoss( pNxtB, pSibPage, bDontLeave );
              // When changing pages, also the endnote flag must match.
              SwFootnoteContFrame *pCont = pNxtB && ( !bChgPage ||
                  pSibPage->IsEndNotePage() == bEndNote )
                  ? pNxtB->FindNearestFootnoteCont( bDontLeave ) : nullptr;
              if ( pCont )
                  pSibling = static_cast<SwFootnoteFrame*>(pCont->Lower());
              else
                  bEnd = true;
          }
          if ( !bEnd && pSibling )
              nCmpPos = ::lcl_FindFootnotePos( pDoc, pSibling->GetAttr() );
          if (pSibling && (pSibling != pLastSib))
          {
              // too far?
              if ( (nLastPos < nCmpPos) && (nCmpPos > nStPos) )
              {
                  pSibling = pLastSib;
                  bEnd = true;
              }
          }
      }
  }
  if ( pSibling )
  {
      nCmpPos = ::lcl_FindFootnotePos( pDoc, pSibling->GetAttr() );
      if ( nCmpPos < nStPos )
      {
          while ( pSibling->GetFollow() )
              pSibling = pSibling->GetFollow();
          pParent = static_cast<SwFootnoteContFrame*>(pSibling->GetUpper());
          pSibling = static_cast<SwFootnoteFrame*>(pSibling->GetNext());
      }
      else
      {
          if( pSibling->GetMaster() )
          {
              if( ENDNOTE0x80000000 > nCmpPos || nStPos >= ENDNOTE0x80000000 )
              {
                  OSL_FAIL( "InsertFootnote: Master expected II" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1460" ": "), "%s", "InsertFootnote: Master expected II"
); } } while (false);
                  do
                      pSibling = pSibling->GetMaster();
                  while ( pSibling->GetMaster() );
              }
          }
          pParent = static_cast<SwFootnoteContFrame*>(pSibling->GetUpper());
      }
  }
  OSL_ENSURE( pParent, "paste in space?" )do { if (true && (!(pParent))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1469" ": "), "%s", "paste in space?"); } } while (false
);
  pNew->Paste( pParent, pSibling );
1471}

1473static SwPageFrame* lcl_GetApproximateFootnotePage(const bool bEnd, const SwPageFrame* pPage,
                                                 const SwDoc *pDoc, const SwTextFootnote *pAttr)
1475{
  // We can at least search the approximately correct page
  // to ensure that we will finish in finite time even if
  // hundreds of footnotes exist.
  const SwPageFrame *pNxt = static_cast<const SwPageFrame*>(pPage->GetNext());
  const sal_uLong nStPos = ::lcl_FindFootnotePos(pDoc, pAttr);
  while (pNxt && (bEnd ? pNxt->IsEndNotePage() : pNxt->IsFootnotePage() && !pNxt->IsEndNotePage()))
  {
      const SwFootnoteContFrame *pCont = pNxt->FindFootnoteCont();
      if (pCont && pCont->Lower())
      {
          OSL_ENSURE( pCont->Lower()->IsFootnoteFrame(), "no footnote in the container" )do { if (true && (!(pCont->Lower()->IsFootnoteFrame
()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1486" ": "), "%s", "no footnote in the container"); } }
 while (false);
          if (nStPos > ::lcl_FindFootnotePos(pDoc,
                              static_cast<const SwFootnoteFrame*>(pCont->Lower())->GetAttr()))
          {
              pPage = pNxt;
              pNxt = static_cast<const SwPageFrame*>(pPage->GetNext());
              continue;
          }
      }
      break;
  }
  return const_cast<SwPageFrame*>(pPage);
1498}

1500void SwFootnoteBossFrame::AppendFootnote( SwContentFrame *pRef, SwTextFootnote *pAttr )
1501{
  // If the footnote already exists, do nothing.
  if ( FindFootnote( pRef, pAttr ) )
      return;

  // If footnotes are inserted at the end of the document,
  // we only need to search from the relevant page on.
  // If there is none yet, we need to create one.
  // If it is an Endnote, we need to search for or create an
  // Endnote page.
  SwDoc *pDoc = GetFormat()->GetDoc();
  SwFootnoteBossFrame *pBoss = this;
  SwPageFrame *pPage = FindPageFrame();
  SwPageFrame *pMyPage = pPage;
  bool bChgPage = false;
  const bool bEnd = pAttr->GetFootnote().IsEndNote();
  if (bEnd)
  {
      const IDocumentSettingAccess& rSettings = *pAttr->GetTextNode().getIDocumentSettingAccess();
      if( GetUpper()->IsSctFrame() &&
          static_cast<SwSectionFrame*>(GetUpper())->IsEndnAtEnd() )
      {
          // Endnotes at the end of the section.
          SwFrame* pLast =
              static_cast<SwSectionFrame*>(GetUpper())->FindLastContent( SwFindMode::EndNote );
          if( pLast )
          {
              pBoss = pLast->FindFootnoteBossFrame();
              pPage = pBoss->FindPageFrame();
          }
      }
      else if (rSettings.get(DocumentSettingId::CONTINUOUS_ENDNOTES))
      {
          // Endnotes at the end of the document.
          pBoss = getRootFrame()->GetLastPage();
          pPage = pBoss->FindPageFrame();
      }
      else
      {
          // Endnotes on a separate page.
          while ( pPage->GetNext() && !pPage->IsEndNotePage() )
          {
              pPage = static_cast<SwPageFrame*>(pPage->GetNext());
              bChgPage = true;
          }
          if ( !pPage->IsEndNotePage() )
          {
              SwPageDesc *pDesc = pDoc->GetEndNoteInfo().GetPageDesc( *pDoc );
              pPage = ::InsertNewPage( *pDesc, pPage->GetUpper(),
                      !pPage->OnRightPage(), false, false, true, nullptr );
              pPage->SetEndNotePage( true );
              bChgPage = true;
          }
          else
              pPage = lcl_GetApproximateFootnotePage(true, pPage, pDoc, pAttr);
      }
  }
  else if( FTNPOS_CHAPTER == pDoc->GetFootnoteInfo().m_ePos && ( !GetUpper()->
           IsSctFrame() || !static_cast<SwSectionFrame*>(GetUpper())->IsFootnoteAtEnd() ) )
  {
      while ( pPage->GetNext() && !pPage->IsFootnotePage() &&
              !static_cast<SwPageFrame*>(pPage->GetNext())->IsEndNotePage() )
      {
          pPage = static_cast<SwPageFrame*>(pPage->GetNext());
          bChgPage = true;
      }

      if ( !pPage->IsFootnotePage() )
      {
          SwPageDesc *pDesc = pDoc->GetFootnoteInfo().GetPageDesc( *pDoc );
          pPage = ::InsertNewPage( *pDesc, pPage->GetUpper(),
              !pPage->OnRightPage(), false, false, true, pPage->GetNext() );
          bChgPage = true;
      }
      else
          pPage = lcl_GetApproximateFootnotePage(false, pPage, pDoc, pAttr);
  }

  // For now, create a footnote and the corresponding content frames
  if ( !pAttr->GetStartNode() )
  {
      OSL_ENSURE( false, "no footnote content." )do { if (true && (!(false))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1582" ": "), "%s", "no footnote content."); } } while (
false);
      return;
  }

  // If there is already a footnote content on the column/page,
  // another one cannot be created in a column area.
  if( pBoss->IsInSct() && pBoss->IsColumnFrame() && !pPage->IsFootnotePage() )
  {
      SwSectionFrame* pSct = pBoss->FindSctFrame();
      if( bEnd ? !pSct->IsEndnAtEnd() : !pSct->IsFootnoteAtEnd() )
      {
          SwFootnoteContFrame* pFootnoteCont = pSct->FindFootnoteBossFrame(!bEnd)->FindFootnoteCont();
          if( pFootnoteCont )
          {
              SwFootnoteFrame* pTmp = static_cast<SwFootnoteFrame*>(pFootnoteCont->Lower());
              if( bEnd )
                  while( pTmp && !pTmp->GetAttr()->GetFootnote().IsEndNote() )
                      pTmp = static_cast<SwFootnoteFrame*>(pTmp->GetNext());
              if( pTmp && *pTmp < pAttr )
                  return;
          }
      }
  }

  SwFootnoteFrame *pNew = new SwFootnoteFrame( pDoc->GetDfltFrameFormat(), this, pRef, pAttr );
  {
      SwNodeIndex aIdx( *pAttr->GetStartNode(), 1 );
      ::InsertCnt_( pNew, pDoc, aIdx.GetIndex() );
  }
  // If the page was changed or newly created,
  // we need to place ourselves in the first column
  if( bChgPage )
  {
      SwLayoutFrame* pBody = pPage->FindBodyCont();
      OSL_ENSURE( pBody, "AppendFootnote: NoPageBody?" )do { if (true && (!(pBody))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1616" ": "), "%s", "AppendFootnote: NoPageBody?"); } } while
 (false);
      if( pBody->Lower() && pBody->Lower()->IsColumnFrame() )
          pBoss = static_cast<SwFootnoteBossFrame*>(pBody->Lower());
      else
          pBoss = pPage; // page if no columns exist
  }
  pBoss->InsertFootnote( pNew );
  if ( pNew->GetUpper() ) // inserted or not?
  {
      ::RegistFlys( pNew->FindPageFrame(), pNew );
      SwSectionFrame* pSect = FindSctFrame();
      // The content of a FootnoteContainer in a (column) section only need to be calculated
      // if the section stretches already to the bottom edge of the Upper.
      if( pSect && !pSect->IsJoinLocked() && ( bEnd ? !pSect->IsEndnAtEnd() :
          !pSect->IsFootnoteAtEnd() ) && pSect->Growable() )
          pSect->InvalidateSize();
      else
      {
          // #i49383# - disable unlock of position of
          // lower objects during format of footnote content.
          const bool bOldFootnoteFrameLocked( pNew->IsColLocked() );
          pNew->ColLock();
          pNew->KeepLockPosOfLowerObjs();
          // #i57914# - adjust fix #i49383#
          SwContentFrame *pCnt = pNew->ContainsContent();
          while ( pCnt && pCnt->FindFootnoteFrame()->GetAttr() == pAttr )
          {
              pCnt->Calc(getRootFrame()->GetCurrShell()->GetOut());
              // #i49383# - format anchored objects
              if ( pCnt->IsTextFrame() && pCnt->isFrameAreaDefinitionValid() )
              {
                  if ( !SwObjectFormatter::FormatObjsAtFrame( *pCnt,
                                                            *(pCnt->FindPageFrame()) ) )
                  {
                      // restart format with first content
                      pCnt = pNew->ContainsContent();
                      continue;
                  }
              }
              pCnt = pCnt->FindNextCnt();
          }
          // #i49383#
          if ( !bOldFootnoteFrameLocked )
          {
              pNew->ColUnlock();
          }
          // #i57914# - adjust fix #i49383#
          // enable lock of lower object position before format of footnote frame.
          pNew->UnlockPosOfLowerObjs();
          pNew->Calc(getRootFrame()->GetCurrShell()->GetOut());
          // #i57914# - adjust fix #i49383#
          if ( !bOldFootnoteFrameLocked && !pNew->GetLower() &&
               !pNew->IsColLocked() && !pNew->IsBackMoveLocked() &&
               !pNew->IsDeleteForbidden() )
          {
              pNew->Cut();
              SwFrame::DestroyFrame(pNew);
          }
      }
      pMyPage->UpdateFootnoteNum();
  }
  else
      SwFrame::DestroyFrame(pNew);
1679}

1681SwFootnoteFrame *SwFootnoteBossFrame::FindFootnote( const SwContentFrame *pRef, const SwTextFootnote *pAttr )
1682{
  // the easiest and savest way goes via the attribute
  OSL_ENSURE( pAttr->GetStartNode(), "FootnoteAtr without StartNode." )do { if (true && (!(pAttr->GetStartNode()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1684" ": "), "%s", "FootnoteAtr without StartNode."); }
 } while (false);
  SwNodeIndex aIdx( *pAttr->GetStartNode(), 1 );
  SwContentNode *pNd = aIdx.GetNode().GetContentNode();
  if ( !pNd )
      pNd = pRef->GetAttrSet()->GetDoc()->
            GetNodes().GoNextSection( &aIdx, true, false );
  if ( !pNd )
      return nullptr;
  SwIterator<SwFrame, SwContentNode, sw::IteratorMode::UnwrapMulti> aIter(*pNd);
  SwFrame* pFrame = aIter.First();
  if( pFrame )
      do
      {
              pFrame = pFrame->GetUpper();
              // #i28500#, #i27243# Due to the endnode collector, there are
              // SwFootnoteFrames, which are not in the layout. Therefore the
              // bInfFootnote flags are not set correctly, and a cell of FindFootnoteFrame
              // would return 0. Therefore we better call ImplFindFootnoteFrame().
              SwFootnoteFrame *pFootnote = pFrame->ImplFindFootnoteFrame();
              if ( pFootnote && pFootnote->GetRef() == pRef )
              {
                  // The following condition becomes true, if the whole
                  // footnotecontent is a section. While no frames exist,
                  // the HiddenFlag of the section is set, this causes
                  // the GoNextSection-function leaves the footnote.
                  if( pFootnote->GetAttr() != pAttr )
                      return nullptr;
                  while ( pFootnote && pFootnote->GetMaster() )
                      pFootnote = pFootnote->GetMaster();
                  return pFootnote;
              }

      } while ( nullptr != (pFrame = aIter.Next()) );

  return nullptr;
1719}

1721bool SwFootnoteBossFrame::RemoveFootnote(
      const SwContentFrame *const pRef, const SwTextFootnote *const pAttr,
                            bool bPrep )
1724{
  bool ret(false);
  SwFootnoteFrame *pFootnote = FindFootnote( pRef, pAttr );
  if( pFootnote )
  {
      ret = true;
      do
      {
          SwFootnoteFrame *pFoll = pFootnote->GetFollow();
          pFootnote->Cut();
          SwFrame::DestroyFrame(pFootnote);
          pFootnote = pFoll;
      } while ( pFootnote );
      if( bPrep && pRef->IsFollow() )
      {
          OSL_ENSURE( pRef->IsTextFrame(), "NoTextFrame has Footnote?" )do { if (true && (!(pRef->IsTextFrame()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1739" ": "), "%s", "NoTextFrame has Footnote?"); } } while
 (false);
          SwTextFrame* pMaster = pRef->FindMaster();
          if( !pMaster->IsLocked() )
              pMaster->Prepare( PrepareHint::FootnoteInvalidationGone );
      }
  }
  FindPageFrame()->UpdateFootnoteNum();
  return ret;
1747}

1749void SwFootnoteBossFrame::ChangeFootnoteRef( const SwContentFrame *pOld, const SwTextFootnote *pAttr,
                               SwContentFrame *pNew )
1751{
  SwFootnoteFrame *pFootnote = FindFootnote( pOld, pAttr );
  while ( pFootnote )
  {
      pFootnote->SetRef( pNew );
      pFootnote = pFootnote->GetFollow();
  }
1758}

1760/// OD 03.04.2003 #108446# - add parameter <_bCollectOnlyPreviousFootnotes> in
1761/// order to control, if only footnotes, which are positioned before the
1762/// footnote boss frame <this> have to be collected.
1763void SwFootnoteBossFrame::CollectFootnotes( const SwContentFrame* _pRef,
                              SwFootnoteBossFrame*     _pOld,
                              SwFootnoteFrames&        _rFootnoteArr,
                              const bool    _bCollectOnlyPreviousFootnotes )
1767{
  SwFootnoteFrame *pFootnote = _pOld->FindFirstFootnote();
  while( !pFootnote )
  {
      if( _pOld->IsColumnFrame() )
      {
          // visit columns
          while ( !pFootnote && _pOld->GetPrev() )
          {
              // Still no problem if no footnote was found yet. The loop is needed to pick up
              // following rows in tables. In all other cases it might correct bad contexts.
              _pOld = static_cast<SwFootnoteBossFrame*>(_pOld->GetPrev());
              pFootnote = _pOld->FindFirstFootnote();
          }
      }
      if( !pFootnote )
      {
          // previous page
          SwPageFrame* pPg;
          for ( SwFrame* pTmp = _pOld;
                nullptr != ( pPg = static_cast<SwPageFrame*>(pTmp->FindPageFrame()->GetPrev()))
                  && pPg->IsEmptyPage() ;
              )
          {
              pTmp = pPg;
          }
          if( !pPg )
              return;

          SwLayoutFrame* pBody = pPg->FindBodyCont();
          if( pBody->Lower() && pBody->Lower()->IsColumnFrame() )
          {
              // multiple columns on one page => search last column
              _pOld = static_cast<SwFootnoteBossFrame*>(pBody->GetLastLower());
          }
          else
              _pOld = pPg; // single column page
          pFootnote = _pOld->FindFirstFootnote();
      }
  }

  CollectFootnotes_(_pRef, pFootnote, _rFootnoteArr, _bCollectOnlyPreviousFootnotes ? this : nullptr);
1809}

1811static void FootnoteInArr( SwFootnoteFrames& rFootnoteArr, SwFootnoteFrame* pFootnote )
1812{
  if ( rFootnoteArr.end() == std::find( rFootnoteArr.begin(), rFootnoteArr.end(), pFootnote ) )
      rFootnoteArr.push_back( pFootnote );
1815}

1817void SwFootnoteBossFrame::CollectFootnotes_( const SwContentFrame*   _pRef,
                               SwFootnoteFrame*           _pFootnote,
                               SwFootnoteFrames&          _rFootnoteArr,
                               const SwFootnoteBossFrame* _pRefFootnoteBossFrame)
1821{
  // Collect all footnotes referenced by pRef (attribute by attribute), combine them
  // (the content might be divided over multiple pages) and cut them.

  // For robustness, we do not log the corresponding footnotes here. If a footnote
  // is touched twice, there might be a crash. This allows this function here to
  // also handle corrupt layouts in some degrees (without loops or even crashes).
  SwFootnoteFrames aNotFootnoteArr;

  // here we have a footnote placed in front of the first one of the reference
  OSL_ENSURE( !_pFootnote->GetMaster() || _pFootnote->GetRef() != _pRef, "move FollowFootnote?" )do { if (true && (!(!_pFootnote->GetMaster() || _pFootnote
->GetRef() != _pRef))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1831" ": "), "%s", "move FollowFootnote?"); } } while (
false);
  while ( _pFootnote->GetMaster() )
      _pFootnote = _pFootnote->GetMaster();

  bool bFound = false;

  do
  {
      // Search for the next footnote in this column/page so that
      // we do not start from zero again after cutting one footnote.
      SwFootnoteFrame *pNxtFootnote = _pFootnote;
      while ( pNxtFootnote->GetFollow() )
          pNxtFootnote = pNxtFootnote->GetFollow();
      pNxtFootnote = static_cast<SwFootnoteFrame*>(pNxtFootnote->GetNext());

      if ( !pNxtFootnote )
      {
          SwFootnoteBossFrame* pBoss = _pFootnote->FindFootnoteBossFrame();
          SwPageFrame* pPage = pBoss->FindPageFrame();
          do
          {
              lcl_NextFootnoteBoss( pBoss, pPage, false );
              if( pBoss )
              {
                  SwLayoutFrame* pCont = pBoss->FindFootnoteCont();
                  if( pCont )
                  {
                      pNxtFootnote = static_cast<SwFootnoteFrame*>(pCont->Lower());
                      if( pNxtFootnote )
                      {
                          while( pNxtFootnote->GetMaster() )
                              pNxtFootnote = pNxtFootnote->GetMaster();
                          if( pNxtFootnote == _pFootnote )
                              pNxtFootnote = nullptr;
                      }
                  }
              }
          } while( !pNxtFootnote && pBoss );
      }
      else if( !pNxtFootnote->GetAttr()->GetFootnote().IsEndNote() )
      {
          OSL_ENSURE( !pNxtFootnote->GetMaster(), "_CollectFootnote: Master expected" )do { if (true && (!(!pNxtFootnote->GetMaster()))) {
 sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1872" ": "), "%s", "_CollectFootnote: Master expected")
; } } while (false);
          while ( pNxtFootnote->GetMaster() )
              pNxtFootnote = pNxtFootnote->GetMaster();
      }
      if ( pNxtFootnote == _pFootnote )
      {
          OSL_FAIL(   "_CollectFootnote: Vicious circle" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1878" ": "), "%s", "_CollectFootnote: Vicious circle");
 } } while (false);
          pNxtFootnote = nullptr;
      }

      // OD 03.04.2003 #108446# - determine, if found footnote has to be collected.
      bool bCollectFoundFootnote = false;
      // Ignore endnotes which are on a separate endnote page.
      bool bEndNote = _pFootnote->GetAttr()->GetFootnote().IsEndNote();
      const IDocumentSettingAccess& rSettings
          = _pFootnote->GetAttrSet()->GetDoc()->getIDocumentSettingAccess();
      bool bContinuousEndnotes = rSettings.get(DocumentSettingId::CONTINUOUS_ENDNOTES);
      if (_pFootnote->GetRef() == _pRef && (!bEndNote || bContinuousEndnotes))
      {
          if (_pRefFootnoteBossFrame)
          {
              SwFootnoteBossFrame* pBossOfFoundFootnote = _pFootnote->FindFootnoteBossFrame( true );
              OSL_ENSURE( pBossOfFoundFootnote,do { if (true && (!(pBossOfFoundFootnote))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1895" ": "), "%s", "<SwFootnoteBossFrame::CollectFootnotes_(..)> - footnote boss frame of found footnote frame missing.\nWrong layout!"
); } } while (false)
                      "<SwFootnoteBossFrame::CollectFootnotes_(..)> - footnote boss frame of found footnote frame missing.\nWrong layout!" )do { if (true && (!(pBossOfFoundFootnote))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1895" ": "), "%s", "<SwFootnoteBossFrame::CollectFootnotes_(..)> - footnote boss frame of found footnote frame missing.\nWrong layout!"
); } } while (false);
              if ( !pBossOfFoundFootnote ||    // don't crash, if no footnote boss is found.
                   pBossOfFoundFootnote->IsBefore( _pRefFootnoteBossFrame )
                 )
              {
                  bCollectFoundFootnote = true;
              }
          }
          else
          {
              bCollectFoundFootnote = true;
          }
      }

      if ( bCollectFoundFootnote )
      {
          OSL_ENSURE( !_pFootnote->GetMaster(), "move FollowFootnote?" )do { if (true && (!(!_pFootnote->GetMaster()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1911" ": "), "%s", "move FollowFootnote?"); } } while (
false);
          SwFootnoteFrame *pNxt = _pFootnote->GetFollow();
          while ( pNxt )
          {
              SwFrame *pCnt = pNxt->ContainsAny();
              if ( pCnt )
              {
                  // destroy the follow on the way as it is empty
                  do
                  {   SwFrame *pNxtCnt = pCnt->GetNext();
                      pCnt->Cut();
                      pCnt->Paste( _pFootnote );
                      pCnt = pNxtCnt;
                  } while ( pCnt );
              }
              else
              {
                  OSL_ENSURE( !pNxt, "footnote without content?" )do { if (true && (!(!pNxt))) { sal_detail_logFormat((
SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "1928" ": "), "%s", "footnote without content?"); } } while
 (false);
                  pNxt->Cut();
                  SwFrame::DestroyFrame(pNxt);
              }
              pNxt = _pFootnote->GetFollow();
          }
          _pFootnote->Cut();
          FootnoteInArr( _rFootnoteArr, _pFootnote );
          bFound = true;
      }
      else
      {
          FootnoteInArr( aNotFootnoteArr, _pFootnote );
          if( bFound )
              break;
      }
      if ( pNxtFootnote &&
           _rFootnoteArr.end() == std::find( _rFootnoteArr.begin(), _rFootnoteArr.end(), pNxtFootnote ) &&
           aNotFootnoteArr.end() == std::find( aNotFootnoteArr.begin(), aNotFootnoteArr.end(), pNxtFootnote ) )
          _pFootnote = pNxtFootnote;
      else
          break;
  }
  while ( _pFootnote );
1952}

1954void SwFootnoteBossFrame::MoveFootnotes_( SwFootnoteFrames &rFootnoteArr, bool bCalc )
1955{
  // All footnotes referenced by pRef need to be moved
  // to a new position (based on the new column/page)
  const sal_uInt16 nMyNum = FindPageFrame()->GetPhyPageNum();
  const sal_uInt16 nMyCol = lcl_ColumnNum( this );
  SwRectFnSet aRectFnSet(this);

  // #i21478# - keep last inserted footnote in order to
  // format the content of the following one.
  SwFootnoteFrame* pLastInsertedFootnote = nullptr;
  for (SwFootnoteFrame* pFootnote : rFootnoteArr)
  {
      SwFootnoteBossFrame* pRefBoss(pFootnote->GetRef()->FindFootnoteBossFrame(
              !pFootnote->GetAttr()->GetFootnote().IsEndNote()));
      if( pRefBoss != this )
      {
          const sal_uInt16 nRefNum = pRefBoss->FindPageFrame()->GetPhyPageNum();
          const sal_uInt16 nRefCol = lcl_ColumnNum( this );
          if( nRefNum < nMyNum || ( nRefNum == nMyNum && nRefCol <= nMyCol ) )
              pRefBoss = this;
      }
      pRefBoss->InsertFootnote( pFootnote );

      if ( pFootnote->GetUpper() ) // robust, e.g. with duplicates
      {
          // First condense the content so that footnote frames that do not fit on the page
          // do not do too much harm (Loop 66312). So, the footnote content first grows as
          // soon as the content gets formatted and it is sure that it fits on the page.
          SwFrame *pCnt = pFootnote->ContainsAny();
          while( pCnt )
          {
              if( pCnt->IsLayoutFrame() )
              {
                  SwFrame* pTmp = static_cast<SwLayoutFrame*>(pCnt)->ContainsAny();
                  while( pTmp && static_cast<SwLayoutFrame*>(pCnt)->IsAnLower( pTmp ) )
                  {
                      pTmp->Prepare( PrepareHint::FootnoteMove );

                      SwFrameAreaDefinition::FrameAreaWriteAccess aFrm(*pTmp);
                      aRectFnSet.SetHeight(aFrm, 0);

                      SwFrameAreaDefinition::FramePrintAreaWriteAccess aPrt(*pTmp);
                      aRectFnSet.SetHeight(aPrt, 0);

                      pTmp = pTmp->FindNext();
                  }
              }
              else
              {
                  pCnt->Prepare( PrepareHint::FootnoteMove );
              }

              SwFrameAreaDefinition::FrameAreaWriteAccess aFrm(*pCnt);
              aRectFnSet.SetHeight(aFrm, 0);

              SwFrameAreaDefinition::FramePrintAreaWriteAccess aPrt(*pCnt);
              aRectFnSet.SetHeight(aPrt, 0);

              pCnt = pCnt->GetNext();
          }

          {
              SwFrameAreaDefinition::FrameAreaWriteAccess aFrm(*pFootnote);
              aRectFnSet.SetHeight(aFrm, 0);
          }

          {
              SwFrameAreaDefinition::FramePrintAreaWriteAccess aPrt(*pFootnote);
              aRectFnSet.SetHeight(aPrt, 0);
          }

          pFootnote->Calc(getRootFrame()->GetCurrShell()->GetOut());
          pFootnote->GetUpper()->Calc(getRootFrame()->GetCurrShell()->GetOut());

          if( bCalc )
          {
              SwTextFootnote *pAttr = pFootnote->GetAttr();
              pCnt = pFootnote->ContainsAny();
              bool bUnlock = !pFootnote->IsBackMoveLocked();
              pFootnote->LockBackMove();

              // #i49383# - disable unlock of position of
              // lower objects during format of footnote content.
              pFootnote->KeepLockPosOfLowerObjs();
              // #i57914# - adjust fix #i49383#

              while ( pCnt && pCnt->FindFootnoteFrame()->GetAttr() == pAttr )
              {
                  pCnt->InvalidatePos_();
                  pCnt->Calc(getRootFrame()->GetCurrShell()->GetOut());
                  // #i49383# - format anchored objects
                  if ( pCnt->IsTextFrame() && pCnt->isFrameAreaDefinitionValid() )
                  {
                      if ( !SwObjectFormatter::FormatObjsAtFrame( *pCnt,
                                                                *(pCnt->FindPageFrame()) ) )
                      {
                          // restart format with first content
                          pCnt = pFootnote->ContainsAny();
                          continue;
                      }
                  }
                  if( pCnt->IsSctFrame() )
                  {
                      // If the area is not empty, iterate also over the content
                      SwFrame* pTmp = static_cast<SwSectionFrame*>(pCnt)->ContainsAny();
                      if( pTmp )
                          pCnt = pTmp;
                      else
                          pCnt = pCnt->FindNext();
                  }
                  else
                      pCnt = pCnt->FindNext();
              }
              if( bUnlock )
              {
                  pFootnote->UnlockBackMove();
                  if( !pFootnote->ContainsAny() && !pFootnote->IsColLocked() )
                  {
                      pFootnote->Cut();
                      SwFrame::DestroyFrame(pFootnote);
                      // #i21478#
                      pFootnote = nullptr;
                  }
              }
              // #i49383#
              if ( pFootnote )
              {
                  // #i57914# - adjust fix #i49383#
                  // enable lock of lower object position before format of footnote frame.
                  pFootnote->UnlockPosOfLowerObjs();
                  pFootnote->Calc(getRootFrame()->GetCurrShell()->GetOut());
              }
          }
      }
      else
      {
          OSL_ENSURE( !pFootnote->GetMaster() && !pFootnote->GetFollow(),do { if (true && (!(!pFootnote->GetMaster() &&
 !pFootnote->GetFollow()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2092" ": "), "%s", "DelFootnote and Master/Follow?"); }
 } while (false)
                  "DelFootnote and Master/Follow?" )do { if (true && (!(!pFootnote->GetMaster() &&
 !pFootnote->GetFollow()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2092" ": "), "%s", "DelFootnote and Master/Follow?"); }
 } while (false);
          SwFrame::DestroyFrame(pFootnote);
          // #i21478#
          pFootnote = nullptr;
      }

      // #i21478#
      if ( pFootnote )
      {
          pLastInsertedFootnote = pFootnote;
      }
  }

  // #i21478# - format content of footnote following
  // the new inserted ones.
  if ( !(bCalc && pLastInsertedFootnote) )
      return;

  if ( !pLastInsertedFootnote->GetNext() )
      return;

  SwFootnoteFrame* pNextFootnote = static_cast<SwFootnoteFrame*>(pLastInsertedFootnote->GetNext());
  SwTextFootnote* pAttr = pNextFootnote->GetAttr();
  SwFrame* pCnt = pNextFootnote->ContainsAny();

  bool bUnlock = !pNextFootnote->IsBackMoveLocked();
  pNextFootnote->LockBackMove();
  // #i49383# - disable unlock of position of
  // lower objects during format of footnote content.
  pNextFootnote->KeepLockPosOfLowerObjs();
  // #i57914# - adjust fix #i49383#

  while ( pCnt && pCnt->FindFootnoteFrame()->GetAttr() == pAttr )
  {
      pCnt->InvalidatePos_();
      pCnt->Calc(getRootFrame()->GetCurrShell()->GetOut());
      // #i49383# - format anchored objects
      if ( pCnt->IsTextFrame() && pCnt->isFrameAreaDefinitionValid() )
      {
          if ( !SwObjectFormatter::FormatObjsAtFrame( *pCnt,
                                                    *(pCnt->FindPageFrame()) ) )
          {
              // restart format with first content
              pCnt = pNextFootnote->ContainsAny();
              continue;
          }
      }
      if( pCnt->IsSctFrame() )
      {
          // If the area is not empty, iterate also over the content
          SwFrame* pTmp = static_cast<SwSectionFrame*>(pCnt)->ContainsAny();
          if( pTmp )
              pCnt = pTmp;
          else
              pCnt = pCnt->FindNext();
      }
      else
          pCnt = pCnt->FindNext();
  }
  if( bUnlock )
  {
      pNextFootnote->UnlockBackMove();
  }
  // #i49383#
  // #i57914# - adjust fix #i49383#
  // enable lock of lower object position before format of footnote frame.
  pNextFootnote->UnlockPosOfLowerObjs();
  pNextFootnote->Calc(getRootFrame()->GetCurrShell()->GetOut());
2160}

2162void SwFootnoteBossFrame::MoveFootnotes( const SwContentFrame *pSrc, SwContentFrame *pDest,
                           SwTextFootnote const *pAttr )
2164{
  if( ( GetFormat()->GetDoc()->GetFootnoteInfo().m_ePos == FTNPOS_CHAPTER &&
      (!GetUpper()->IsSctFrame() || !static_cast<SwSectionFrame*>(GetUpper())->IsFootnoteAtEnd()))
      || pAttr->GetFootnote().IsEndNote() )
      return;

  OSL_ENSURE( this == pSrc->FindFootnoteBossFrame( true ),do { if (true && (!(this == pSrc->FindFootnoteBossFrame
( true )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2171" ": "), "%s", "SwPageFrame::MoveFootnotes: source frame isn't on that FootnoteBoss"
); } } while (false)
          "SwPageFrame::MoveFootnotes: source frame isn't on that FootnoteBoss" )do { if (true && (!(this == pSrc->FindFootnoteBossFrame
( true )))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2171" ": "), "%s", "SwPageFrame::MoveFootnotes: source frame isn't on that FootnoteBoss"
); } } while (false);

  SwFootnoteFrame *pFootnote = FindFirstFootnote();
  if( !pFootnote )
      return;

  ChangeFootnoteRef( pSrc, pAttr, pDest );
  SwFootnoteBossFrame *pDestBoss = pDest->FindFootnoteBossFrame( true );
  OSL_ENSURE( pDestBoss, "+SwPageFrame::MoveFootnotes: no destination boss" )do { if (true && (!(pDestBoss))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2179" ": "), "%s", "+SwPageFrame::MoveFootnotes: no destination boss"
); } } while (false);
  if( !pDestBoss )     // robust
      return;

  SwFootnoteFrames aFootnoteArr;
  SwFootnoteBossFrame::CollectFootnotes_(pDest, pFootnote, aFootnoteArr, nullptr);
  if ( aFootnoteArr.empty() )
      return;

  pDestBoss->MoveFootnotes_( aFootnoteArr, true );
  SwPageFrame* pSrcPage = FindPageFrame();
  SwPageFrame* pDestPage = pDestBoss->FindPageFrame();
  // update FootnoteNum only at page change
  if( pSrcPage != pDestPage )
  {
      if( pSrcPage->GetPhyPageNum() > pDestPage->GetPhyPageNum() )
          pSrcPage->UpdateFootnoteNum();
      pDestPage->UpdateFootnoteNum();
  }
2198}

2200void SwFootnoteBossFrame::RearrangeFootnotes( const SwTwips nDeadLine, const bool bLock,
                                const SwTextFootnote *pAttr )
2202{
  // Format all footnotes of a column/page so that they might change the column/page.

  SwSaveFootnoteHeight aSave( this, nDeadLine );
  SwFootnoteFrame *pFootnote = FindFirstFootnote();
  if( pFootnote && pFootnote->GetPrev() && bLock )
1
Assuming 'pFootnote' is non-null→
2
←
Assuming the condition is false→
  {
      SwFootnoteFrame* pFirst = static_cast<SwFootnoteFrame*>(pFootnote->GetUpper()->Lower());
      SwFrame* pContent = pFirst->ContainsAny();
      if( pContent )
      {
          bool bUnlock = !pFirst->IsBackMoveLocked();
          pFirst->LockBackMove();
          pFirst->Calc(getRootFrame()->GetCurrShell()->GetOut());
          pContent->Calc(getRootFrame()->GetCurrShell()->GetOut());
          // #i49383# - format anchored objects
          if ( pContent->IsTextFrame() && pContent->isFrameAreaDefinitionValid() )
          {
              SwObjectFormatter::FormatObjsAtFrame( *pContent,
                                                  *(pContent->FindPageFrame()) );
          }
          if( bUnlock )
              pFirst->UnlockBackMove();
      }
      pFootnote = FindFirstFootnote();
  }
  SwDoc *pDoc = GetFormat()->GetDoc();
  const sal_uLong nFootnotePos = pAttr ? ::lcl_FindFootnotePos( pDoc, pAttr ) : 0;
3
←
Assuming 'pAttr' is non-null→
4
←
'?' condition is true→
  SwFrame *pCnt = pFootnote4.1
'pFootnote' is non-null
1
'pFootnote' is non-null
 ? pFootnote->ContainsAny() : nullptr;
5
←
'?' condition is true→
  if ( !pCnt )
6
←
Assuming 'pCnt' is non-null→
7
←
Taking false branch→
      return;

  bool bMore = true;
  bool bStart = pAttr == nullptr; // If no attribute is given, process all
  // #i49383# - disable unlock of position of
  // lower objects during format of footnote and footnote content.
  SwFootnoteFrame* pLastFootnoteFrame( nullptr );
  // footnote frame needs to be locked, if <bLock> isn't set.
  bool bUnlockLastFootnoteFrame( false );
  do
  {
      if( !bStart7.1
'bStart' is false
1
'bStart' is false
 )
8
←
Taking true branch→
          bStart = ::lcl_FindFootnotePos( pDoc, pCnt->FindFootnoteFrame()->GetAttr() )
                   == nFootnotePos;
      if( bStart8.1
'bStart' is true
1
'bStart' is true
 )
9
←
Taking true branch→
      {
          pCnt->InvalidatePos_();
          pCnt->InvalidateSize_();
          pCnt->Prepare( PrepareHint::AdjustSizeWithoutFormatting );
          SwFootnoteFrame* pFootnoteFrame = pCnt->FindFootnoteFrame();
10
←
Calling 'SwFrame::FindFootnoteFrame'→
14
←
Returning from 'SwFrame::FindFootnoteFrame'→
15
←
'pFootnoteFrame' initialized here→
          // #i49383#
          if ( pFootnoteFrame != pLastFootnoteFrame )
16
←
Assuming 'pFootnoteFrame' is equal to 'pLastFootnoteFrame'→
17
←
Taking false branch→
          {
              if ( pLastFootnoteFrame )
              {
                  if ( !bLock && bUnlockLastFootnoteFrame )
                  {
                      pLastFootnoteFrame->ColUnlock();
                  }
                  // #i57914# - adjust fix #i49383#
                  // enable lock of lower object position before format of footnote frame.
                  pLastFootnoteFrame->UnlockPosOfLowerObjs();
                  pLastFootnoteFrame->Calc(getRootFrame()->GetCurrShell()->GetOut());
                  if ( !bLock && bUnlockLastFootnoteFrame &&
                       !pLastFootnoteFrame->GetLower() &&
                       !pLastFootnoteFrame->IsColLocked() &&
                       !pLastFootnoteFrame->IsBackMoveLocked() &&
                       !pLastFootnoteFrame->IsDeleteForbidden() )
                  {
                      pLastFootnoteFrame->Cut();
                      SwFrame::DestroyFrame(pLastFootnoteFrame);
                      pLastFootnoteFrame = nullptr;
                  }
              }
              if ( !bLock )
              {
                  bUnlockLastFootnoteFrame = !pFootnoteFrame->IsColLocked();
                  pFootnoteFrame->ColLock();
              }
              pFootnoteFrame->KeepLockPosOfLowerObjs();
              pLastFootnoteFrame = pFootnoteFrame;
          }
          // OD 30.10.2002 #97265# - invalidate position of footnote
          // frame, if it's below its footnote container, in order to
          // assure its correct position, probably calculating its previous
          // footnote frames.
          {
              SwRectFnSet aRectFnSet(this);
              SwFrame* pFootnoteContFrame = pFootnoteFrame->GetUpper();
18
←
Called C++ object pointer is null
              if ( aRectFnSet.TopDist(pFootnoteFrame->getFrameArea(), aRectFnSet.GetPrtBottom(*pFootnoteContFrame)) > 0 )
              {
                  pFootnoteFrame->InvalidatePos_();
              }
          }
          if ( bLock )
          {
              bool bUnlock = !pFootnoteFrame->IsBackMoveLocked();
              pFootnoteFrame->LockBackMove();
              pFootnoteFrame->Calc(getRootFrame()->GetCurrShell()->GetOut());
              pCnt->Calc(getRootFrame()->GetCurrShell()->GetOut());
              // #i49383# - format anchored objects
              if ( pCnt->IsTextFrame() && pCnt->isFrameAreaDefinitionValid() )
              {
                  SwFrameDeleteGuard aDeleteGuard(pFootnote);
                  if ( !SwObjectFormatter::FormatObjsAtFrame( *pCnt,
                                                            *(pCnt->FindPageFrame()) ) )
                  {
                      // restart format with first content
                      pCnt = pFootnote ? pFootnote->ContainsAny() : nullptr;
                      if (!pCnt)
                          bMore = false;
                      continue;
                  }
              }
              if( bUnlock )
              {
                  pFootnoteFrame->UnlockBackMove();
                  if( !pFootnoteFrame->Lower() &&
                      !pFootnoteFrame->IsColLocked() )
                  {
                      // #i49383#
                      OSL_ENSURE( pLastFootnoteFrame == pFootnoteFrame,do { if (true && (!(pLastFootnoteFrame == pFootnoteFrame
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2324" ": "), "%s", "<SwFootnoteBossFrame::RearrangeFootnotes(..)> - <pLastFootnoteFrame> != <pFootnoteFrame>"
); } } while (false)
                              "<SwFootnoteBossFrame::RearrangeFootnotes(..)> - <pLastFootnoteFrame> != <pFootnoteFrame>" )do { if (true && (!(pLastFootnoteFrame == pFootnoteFrame
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2324" ": "), "%s", "<SwFootnoteBossFrame::RearrangeFootnotes(..)> - <pLastFootnoteFrame> != <pFootnoteFrame>"
); } } while (false);
                      pLastFootnoteFrame = nullptr;
                      pFootnoteFrame->Cut();
                      SwFrame::DestroyFrame(pFootnoteFrame);
                      if (pFootnote == pFootnoteFrame)
                          pFootnote = nullptr;
                  }
              }
          }
          else
          {
              pFootnoteFrame->Calc(getRootFrame()->GetCurrShell()->GetOut());
              pCnt->Calc(getRootFrame()->GetCurrShell()->GetOut());
              // #i49383# - format anchored objects
              if ( pCnt->IsTextFrame() && pCnt->isFrameAreaDefinitionValid() )
              {
                  if ( !SwObjectFormatter::FormatObjsAtFrame( *pCnt,
                                                            *(pCnt->FindPageFrame()) ) )
                  {
                      // restart format with first content
                      pCnt = pFootnote->ContainsAny();
                      continue;
                  }
              }
          }
      }
      SwSectionFrame *pDel = nullptr;
      if( pCnt->IsSctFrame() )
      {
          SwFrame* pTmp = static_cast<SwSectionFrame*>(pCnt)->ContainsAny();
          if( pTmp )
          {
              pCnt = pTmp;
              continue;
          }
          pDel = static_cast<SwSectionFrame*>(pCnt);
      }
      if ( pCnt->GetNext() )
          pCnt = pCnt->GetNext();
      else
      {
          pCnt = pCnt->FindNext();
          if ( pCnt )
          {
              SwFootnoteFrame* pFootnoteFrame = pCnt->FindFootnoteFrame();
              if( pFootnoteFrame->GetRef()->FindFootnoteBossFrame(
                  pFootnoteFrame->GetAttr()->GetFootnote().IsEndNote() ) != this )
                  bMore = false;
          }
          else
              bMore = false;
      }
      if( pDel )
      {
          bool bUnlockLastFootnoteFrameGuard = pLastFootnoteFrame && !pLastFootnoteFrame->IsColLocked();
          if (bUnlockLastFootnoteFrameGuard)
              pLastFootnoteFrame->ColLock();
          pDel->Cut();
          if (bUnlockLastFootnoteFrameGuard)
              pLastFootnoteFrame->ColUnlock();
          SwFrame::DestroyFrame(pDel);
      }
      if ( bMore )
      {
          // Go not further than to the provided footnote (if given)
          if ( pAttr &&
               (::lcl_FindFootnotePos( pDoc,
                              pCnt->FindFootnoteFrame()->GetAttr()) > nFootnotePos ) )
              bMore = false;
      }
  } while ( bMore );
  // #i49383#
  if ( !pLastFootnoteFrame )
      return;

  if ( !bLock && bUnlockLastFootnoteFrame )
  {
      pLastFootnoteFrame->ColUnlock();
  }
  // #i57914# - adjust fix #i49383#
  // enable lock of lower object position before format of footnote frame.
  pLastFootnoteFrame->UnlockPosOfLowerObjs();
  pLastFootnoteFrame->Calc(getRootFrame()->GetCurrShell()->GetOut());
  if ( !bLock && bUnlockLastFootnoteFrame &&
       !pLastFootnoteFrame->GetLower() &&
       !pLastFootnoteFrame->IsColLocked() &&
       !pLastFootnoteFrame->IsBackMoveLocked() )
  {
      pLastFootnoteFrame->Cut();
      SwFrame::DestroyFrame(pLastFootnoteFrame);
  }
2415}

2417void SwPageFrame::UpdateFootnoteNum()
2418{
  // page numbering only if set at the document
  if ( GetFormat()->GetDoc()->GetFootnoteInfo().m_eNum != FTNNUM_PAGE )
      return;

  SwLayoutFrame* pBody = FindBodyCont();
  if( !pBody || !pBody->Lower() )
      return;

  SwContentFrame* pContent = pBody->ContainsContent();
  sal_uInt16 nNum = 0;

  while( pContent && pContent->FindPageFrame() == this )
  {
      if( static_cast<SwTextFrame*>(pContent)->HasFootnote() )
      {
          SwFootnoteBossFrame* pBoss = pContent->FindFootnoteBossFrame( true );
          if( pBoss->GetUpper()->IsSctFrame() &&
              static_cast<SwSectionFrame*>(pBoss->GetUpper())->IsOwnFootnoteNum() )
              pContent = static_cast<SwSectionFrame*>(pBoss->GetUpper())->FindLastContent();
          else
          {
              SwFootnoteFrame* pFootnote = const_cast<SwFootnoteFrame*>(pBoss->FindFirstFootnote( pContent ));
              while( pFootnote )
              {
                  SwTextFootnote* pTextFootnote = pFootnote->GetAttr();
                  if( !pTextFootnote->GetFootnote().IsEndNote() &&
                       pTextFootnote->GetFootnote().GetNumStr().isEmpty() &&
                       !pFootnote->GetMaster())
                  {
                      // sw_redlinehide: the layout can only keep one number
                      // up to date; depending on its setting, this is either
                      // the non-hidden or the hidden number; the other
                      // number will simply be preserved as-is (so in case
                      // there are 2 layouts, maybe both can be updated...)
                      ++nNum;
                      sal_uInt16 const nOldNum(pTextFootnote->GetFootnote().GetNumber());
                      sal_uInt16 const nOldNumRLHidden(pTextFootnote->GetFootnote().GetNumberRLHidden());
                      if (getRootFrame()->IsHideRedlines())
                      {
                          if (nNum != nOldNumRLHidden)
                          {
                              pTextFootnote->SetNumber(nOldNum, nNum, OUString());
                          }
                      }
                      else
                      {
                          if (nNum != nOldNum)
                          {
                              pTextFootnote->SetNumber(nNum, nOldNumRLHidden, OUString());
                          }
                      }
                  }
                  if ( pFootnote->GetNext() )
                      pFootnote = static_cast<SwFootnoteFrame*>(pFootnote->GetNext());
                  else
                  {
                      SwFootnoteBossFrame* pTmpBoss = pFootnote->FindFootnoteBossFrame( true );
                      if( pTmpBoss )
                      {
                          SwPageFrame* pPage = pTmpBoss->FindPageFrame();
                          pFootnote = nullptr;
                          lcl_NextFootnoteBoss( pTmpBoss, pPage, false );
                          SwFootnoteContFrame *pCont = pTmpBoss ? pTmpBoss->FindNearestFootnoteCont() : nullptr;
                          if ( pCont )
                              pFootnote = static_cast<SwFootnoteFrame*>(pCont->Lower());
                      }
                  }
                  if( pFootnote && pFootnote->GetRef() != pContent )
                      pFootnote = nullptr;
              }
          }
      }
      pContent = pContent->FindNextCnt();
  }
2493}

2495void SwFootnoteBossFrame::SetFootnoteDeadLine( const SwTwips nDeadLine )
2496{
  SwFrame *pBody = FindBodyCont();
  pBody->Calc(getRootFrame()->GetCurrShell()->GetOut());

  SwFrame *pCont = FindFootnoteCont();
  const SwTwips nMax = m_nMaxFootnoteHeight;// current should exceed MaxHeight
  SwRectFnSet aRectFnSet(this);
  if ( pCont )
  {
      pCont->Calc(getRootFrame()->GetCurrShell()->GetOut());
      m_nMaxFootnoteHeight = -aRectFnSet.BottomDist( pCont->getFrameArea(), nDeadLine );
  }
  else
      m_nMaxFootnoteHeight = -aRectFnSet.BottomDist( pBody->getFrameArea(), nDeadLine );

  const SwViewShell *pSh = getRootFrame() ? getRootFrame()->GetCurrShell() : nullptr;
  if( pSh && pSh->GetViewOptions()->getBrowseMode() )
      m_nMaxFootnoteHeight += pBody->Grow( LONG_MAX9223372036854775807L, true );
  if ( IsInSct() )
      m_nMaxFootnoteHeight += FindSctFrame()->Grow( LONG_MAX9223372036854775807L, true );

  if ( m_nMaxFootnoteHeight < 0 )
      m_nMaxFootnoteHeight = 0;
  if ( nMax != LONG_MAX9223372036854775807L && m_nMaxFootnoteHeight > nMax )
      m_nMaxFootnoteHeight = nMax;
2521}

2523SwTwips SwFootnoteBossFrame::GetVarSpace() const
2524{
  // To not fall below 20% of the page height
  // (in contrast to MSOffice where footnotes can fill a whole column/page)

  const SwPageFrame* pPg = FindPageFrame();
  OSL_ENSURE( pPg || IsInSct(), "Footnote lost page" )do { if (true && (!(pPg || IsInSct()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2529" ": "), "%s", "Footnote lost page"); } } while (false
);

  const SwFrame *pBody = FindBodyCont();
  SwTwips nRet;
  if( pBody )
  {
      SwRectFnSet aRectFnSet(this);
      if( IsInSct() )
      {
          nRet = 0;
          SwTwips nTmp = aRectFnSet.YDiff( aRectFnSet.GetPrtTop(*pBody),
                                             aRectFnSet.GetTop(getFrameArea()) );
          const SwSectionFrame* pSect = FindSctFrame();
          //  Endnotes in a ftncontainer causes a deadline:
          // the bottom of the last contentfrm
          if( pSect->IsEndnAtEnd() ) // endnotes allowed?
          {
              OSL_ENSURE( !Lower() || !Lower()->GetNext() || Lower()->GetNext()->do { if (true && (!(!Lower() || !Lower()->GetNext(
) || Lower()->GetNext()-> IsFootnoteContFrame()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2547" ": "), "%s", "FootnoteContainer expected"); } } while
 (false)
                      IsFootnoteContFrame(), "FootnoteContainer expected" )do { if (true && (!(!Lower() || !Lower()->GetNext(
) || Lower()->GetNext()-> IsFootnoteContFrame()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2547" ": "), "%s", "FootnoteContainer expected"); } } while
 (false);
              const SwFootnoteContFrame* pCont = Lower() ?
                  static_cast<const SwFootnoteContFrame*>(Lower()->GetNext()) : nullptr;
              if( pCont )
              {
                  const SwFootnoteFrame* pFootnote = static_cast<const SwFootnoteFrame*>(pCont->Lower());
                  while( pFootnote)
                  {
                      if( pFootnote->GetAttr()->GetFootnote().IsEndNote() )
                      { // endnote found
                          const SwFrame* pFrame = static_cast<const SwLayoutFrame*>(Lower())->Lower();
                          if( pFrame )
                          {
                              while( pFrame->GetNext() )
                                  pFrame = pFrame->GetNext(); // last cntntfrm
                              nTmp += aRectFnSet.YDiff(
                                       aRectFnSet.GetTop(getFrameArea()),
                                       aRectFnSet.GetBottom(pFrame->getFrameArea()) );
                          }
                          break;
                      }
                      pFootnote = static_cast<const SwFootnoteFrame*>(pFootnote->GetNext());
                  }
              }
          }
          if( nTmp < nRet )
              nRet = nTmp;
      }
      else
          nRet = - aRectFnSet.GetHeight(pPg->getFramePrintArea())/5;
      nRet += aRectFnSet.GetHeight(pBody->getFrameArea());
      if( nRet < 0 )
          nRet = 0;
  }
  else
      nRet = 0;
  if ( IsPageFrame() )
  {
      const SwViewShell *pSh = getRootFrame() ? getRootFrame()->GetCurrShell() : nullptr;
      if( pSh && pSh->GetViewOptions()->getBrowseMode() )
          nRet += BROWSE_HEIGHT(56700L * 10L) - getFrameArea().Height();
  }
  return nRet;
2590}

2592/** Obtain if pFrame's size adjustment should be processed
*
* For a page frame of columns directly below the page AdjustNeighbourhood() needs
* to be called, or Grow()/ Shrink() for frame columns respectively.
*
* A column section is special, since if there is a footnote container in a column
* and those footnotes are not collected, it is handled like a page frame.
*
* @see AdjustNeighbourhood()
* @see Grow()
* @see Shrink()
*/
2604SwNeighbourAdjust SwFootnoteBossFrame::NeighbourhoodAdjustment_() const
2605{
  SwNeighbourAdjust nRet = SwNeighbourAdjust::OnlyAdjust;
  if( GetUpper() && !GetUpper()->IsPageBodyFrame() )
  {
      // column sections need grow/shrink
      if( GetUpper()->IsFlyFrame() )
          nRet = SwNeighbourAdjust::GrowShrink;
      else
      {
          OSL_ENSURE( GetUpper()->IsSctFrame(), "NeighbourhoodAdjustment: Unexpected Upper" )do { if (true && (!(GetUpper()->IsSctFrame()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2614" ": "), "%s", "NeighbourhoodAdjustment: Unexpected Upper"
); } } while (false);
          if( !GetNext() && !GetPrev() )
              nRet = SwNeighbourAdjust::GrowAdjust; // section with a single column (FootnoteAtEnd)
          else
          {
              const SwFrame* pTmp = Lower();
              OSL_ENSURE( pTmp, "NeighbourhoodAdjustment: Missing Lower()" )do { if (true && (!(pTmp))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2620" ": "), "%s", "NeighbourhoodAdjustment: Missing Lower()"
); } } while (false);
              if( !pTmp->GetNext() )
                  nRet = SwNeighbourAdjust::GrowShrink;
              else if( !GetUpper()->IsColLocked() )
                  nRet = SwNeighbourAdjust::AdjustGrow;
              OSL_ENSURE( !pTmp->GetNext() || pTmp->GetNext()->IsFootnoteContFrame(),do { if (true && (!(!pTmp->GetNext() || pTmp->GetNext
()->IsFootnoteContFrame()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2626" ": "), "%s", "NeighbourhoodAdjustment: Who's that guy?"
); } } while (false)
                      "NeighbourhoodAdjustment: Who's that guy?" )do { if (true && (!(!pTmp->GetNext() || pTmp->GetNext
()->IsFootnoteContFrame()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2626" ": "), "%s", "NeighbourhoodAdjustment: Who's that guy?"
); } } while (false);
          }
      }
  }
  return nRet;
2631}

2633void SwPageFrame::SetColMaxFootnoteHeight()
2634{
  SwLayoutFrame *pBody = FindBodyCont();
  if( pBody && pBody->Lower() && pBody->Lower()->IsColumnFrame() )
  {
      SwColumnFrame* pCol = static_cast<SwColumnFrame*>(pBody->Lower());
      do
      {
          pCol->SetMaxFootnoteHeight( GetMaxFootnoteHeight() );
          pCol = static_cast<SwColumnFrame*>(pCol->GetNext());
      } while ( pCol );
  }
2645}

2647bool SwLayoutFrame::MoveLowerFootnotes( SwContentFrame *pStart, SwFootnoteBossFrame *pOldBoss,
                               SwFootnoteBossFrame *pNewBoss, const bool bFootnoteNums )
2649{
  SwDoc *pDoc = GetFormat()->GetDoc();
  if ( pDoc->GetFootnoteIdxs().empty() )
      return false;
  if( pDoc->GetFootnoteInfo().m_ePos == FTNPOS_CHAPTER &&
      ( !IsInSct() || !FindSctFrame()->IsFootnoteAtEnd() ) )
      return true;

  if ( !pNewBoss )
      pNewBoss = FindFootnoteBossFrame( true );
  if ( pNewBoss == pOldBoss )
      return false;

  bool bMoved = false;
  if( !pStart )
      pStart = ContainsContent();

  SwFootnoteFrames aFootnoteArr;

  while ( IsAnLower( pStart ) )
  {
      if ( static_cast<SwTextFrame*>(pStart)->HasFootnote() )
      {
          // OD 03.04.2003 #108446# - To avoid unnecessary moves of footnotes
          // use new parameter <_bCollectOnlyPreviousFootnote> (4th parameter of
          // method <SwFootnoteBossFrame::CollectFootnote(..)>) to control, that only
          // footnotes have to be collected, that are positioned before the
          // new dedicated footnote boss frame.
          pNewBoss->CollectFootnotes( pStart, pOldBoss, aFootnoteArr, true );
      }
      pStart = pStart->GetNextContentFrame();
  }

  OSL_ENSURE( pOldBoss->IsInSct() == pNewBoss->IsInSct(),do { if (true && (!(pOldBoss->IsInSct() == pNewBoss
->IsInSct()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2683" ": "), "%s", "MoveLowerFootnotes: Section confusion"
); } } while (false)
          "MoveLowerFootnotes: Section confusion" )do { if (true && (!(pOldBoss->IsInSct() == pNewBoss
->IsInSct()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2683" ": "), "%s", "MoveLowerFootnotes: Section confusion"
); } } while (false);
  std::unique_ptr<SwFootnoteFrames> pFootnoteArr;
  SwLayoutFrame* pNewChief = nullptr;
  SwLayoutFrame* pOldChief = nullptr;

  bool bFoundCandidate = false;
  if (pStart && pOldBoss->IsInSct())
  {
      pOldChief = pOldBoss->FindSctFrame();
      pNewChief = pNewBoss->FindSctFrame();
      bFoundCandidate = pOldChief != pNewChief;
  }

  if (bFoundCandidate)
  {
      pFootnoteArr.reset(new SwFootnoteFrames);
      pOldChief = pOldBoss->FindFootnoteBossFrame( true );
      pNewChief = pNewBoss->FindFootnoteBossFrame( true );
      while( pOldChief->IsAnLower( pStart ) )
      {
          if ( static_cast<SwTextFrame*>(pStart)->HasFootnote() )
              static_cast<SwFootnoteBossFrame*>(pNewChief)->CollectFootnotes( pStart,
                                      pOldBoss, *pFootnoteArr );
          pStart = pStart->GetNextContentFrame();
      }
      if( pFootnoteArr->empty() )
      {
          pFootnoteArr.reset();
      }
  }
  else
      pFootnoteArr = nullptr;

  if ( !aFootnoteArr.empty() || pFootnoteArr )
  {
      if( !aFootnoteArr.empty() )
          pNewBoss->MoveFootnotes_( aFootnoteArr, true );
      if( pFootnoteArr )
      {
          assert(pNewChief)(static_cast <bool> (pNewChief) ? void (0) : __assert_fail
 ("pNewChief", "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 2722, __extension__ __PRETTY_FUNCTION__));
          static_cast<SwFootnoteBossFrame*>(pNewChief)->MoveFootnotes_( *pFootnoteArr, true );
          pFootnoteArr.reset();
      }
      bMoved = true;

      // update FootnoteNum only at page change
      if ( bFootnoteNums )
      {
          SwPageFrame* pOldPage = pOldBoss->FindPageFrame();
          SwPageFrame* pNewPage =pNewBoss->FindPageFrame();
          if( pOldPage != pNewPage )
          {
              pOldPage->UpdateFootnoteNum();
              pNewPage->UpdateFootnoteNum();
          }
      }
  }
  return bMoved;
2741}

2743/// Return value guarantees that a new page was not created. See SwFlowFrame::MoveFwd.
2744bool SwContentFrame::MoveFootnoteCntFwd( bool bMakePage, SwFootnoteBossFrame *pOldBoss )
2745{
  OSL_ENSURE( IsInFootnote(), "no footnote." )do { if (true && (!(IsInFootnote()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2746" ": "), "%s", "no footnote."); } } while (false);
  SwLayoutFrame *pFootnote = FindFootnoteFrame();

  // The first paragraph in the first footnote in the first column in the
  // sectionfrm at the top of the page has not to move forward, if the
  // columnbody is empty.
  if( pOldBoss->IsInSct() && !pOldBoss->GetIndPrev() && !GetIndPrev() &&
      !pFootnote->GetPrev() )
  {
      SwLayoutFrame* pBody = pOldBoss->FindBodyCont();
      if( !pBody || !pBody->Lower() )
          return true;
  }

  //fix(9538): if the footnote has neighbors behind itself, remove them temporarily
  SwLayoutFrame *pNxt = static_cast<SwLayoutFrame*>(pFootnote->GetNext());
  SwLayoutFrame *pLst = nullptr;
  while ( pNxt )
  {
      while ( pNxt->GetNext() )
          pNxt = static_cast<SwLayoutFrame*>(pNxt->GetNext());
      if ( pNxt == pLst )
          pNxt = nullptr;
      else
      {   pLst = pNxt;
          SwContentFrame *pCnt = pNxt->ContainsContent();
          if( pCnt )
              pCnt->MoveFootnoteCntFwd( true, pOldBoss );
          pNxt = static_cast<SwLayoutFrame*>(pFootnote->GetNext());
      }
  }

  bool bSamePage = true;
  SwLayoutFrame *pNewUpper =
              GetLeaf( bMakePage ? MAKEPAGE_INSERT : MAKEPAGE_NONE, true );

  if ( pNewUpper )
  {
      SwFootnoteBossFrame * const pNewBoss = pNewUpper->FindFootnoteBossFrame();
      // Are we changing the column/page?
      bool bSameBoss = pNewBoss == pOldBoss;
      if ( !bSameBoss )
      {
          bSamePage = pOldBoss->FindPageFrame() == pNewBoss->FindPageFrame(); // page change?
          pNewUpper->Calc(getRootFrame()->GetCurrShell()->GetOut());
      }

      // The layout leaf of the footnote is either a footnote container or a footnote.
      // If it is a footnote and it has the same footnote reference like the old Upper,
      // then move the content inside of it.
      // If it is a container or the reference differs, create a new footnote and add
      // it into the container.
      // Create also a SectionFrame if currently in an area inside a footnote.
      SwFootnoteFrame* pTmpFootnote = pNewUpper->IsFootnoteFrame() ? static_cast<SwFootnoteFrame*>(pNewUpper) : nullptr;
      if (!pTmpFootnote && pNewUpper->IsFootnoteContFrame())
      {
          SwFootnoteContFrame *pCont = static_cast<SwFootnoteContFrame*>(pNewUpper);
          pTmpFootnote = SwFootnoteContFrame::AppendChained(this, true);
          SwFrame* pNx = pCont->Lower();
          if( pNx && pTmpFootnote->GetAttr()->GetFootnote().IsEndNote() )
              while(pNx && !static_cast<SwFootnoteFrame*>(pNx)->GetAttr()->GetFootnote().IsEndNote())
                  pNx = pNx->GetNext();
          pTmpFootnote->Paste( pCont, pNx );
          pTmpFootnote->Calc(getRootFrame()->GetCurrShell()->GetOut());
      }
      OSL_ENSURE( pTmpFootnote->GetAttr() == FindFootnoteFrame()->GetAttr(), "Wrong Footnote!" )do { if (true && (!(pTmpFootnote->GetAttr() == FindFootnoteFrame
()->GetAttr()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2811" ": "), "%s", "Wrong Footnote!"); } } while (false
);
      // areas inside of footnotes get a special treatment
      SwLayoutFrame *pNewUp = pTmpFootnote;
      if( IsInSct() )
      {
          SwSectionFrame* pSect = FindSctFrame();
          // area inside of a footnote (or only footnote in an area)?
          if( pSect->IsInFootnote() )
          {
              if( pTmpFootnote->Lower() && pTmpFootnote->Lower()->IsSctFrame() &&
                  pSect->GetFollow() == static_cast<SwSectionFrame*>(pTmpFootnote->Lower()) )
                  pNewUp = static_cast<SwSectionFrame*>(pTmpFootnote->Lower());
              else
              {
                  pNewUp = new SwSectionFrame( *pSect, false );
                  pNewUp->InsertBefore( pTmpFootnote, pTmpFootnote->Lower() );
                  static_cast<SwSectionFrame*>(pNewUp)->Init();

                  {
                      SwFrameAreaDefinition::FrameAreaWriteAccess aFrm(*pNewUp);
                      aFrm.Pos() = pTmpFootnote->getFrameArea().Pos();
                      aFrm.Pos().AdjustY(1 ); // for notifications
                  }

                  // If the section frame has a successor then the latter needs
                  // to be moved behind the new Follow of the section frame.
                  SwFrame* pTmp = pSect->GetNext();
                  if( pTmp )
                  {
                      SwFlowFrame* pTmpNxt;
                      if( pTmp->IsContentFrame() )
                          pTmpNxt = static_cast<SwContentFrame*>(pTmp);
                      else if( pTmp->IsSctFrame() )
                          pTmpNxt = static_cast<SwSectionFrame*>(pTmp);
                      else
                      {
                          OSL_ENSURE( pTmp->IsTabFrame(), "GetNextSctLeaf: Wrong Type" )do { if (true && (!(pTmp->IsTabFrame()))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
 ":" "2847" ": "), "%s", "GetNextSctLeaf: Wrong Type"); } } while
 (false);
                          pTmpNxt = static_cast<SwTabFrame*>(pTmp);
                      }
                      pTmpNxt->MoveSubTree( pTmpFootnote, pNewUp->GetNext() );
                  }
              }
          }
      }

      MoveSubTree( pNewUp, pNewUp->Lower() );

      if( !bSameBoss )
          Prepare( PrepareHint::BossChanged );
  }
  return bSamePage;
2862}

2864SwSaveFootnoteHeight::SwSaveFootnoteHeight( SwFootnoteBossFrame *pBs, const SwTwips nDeadLine ) :
  pBoss( pBs ),
  nOldHeight( pBs->GetMaxFootnoteHeight() )
2867{
  pBoss->SetFootnoteDeadLine( nDeadLine );
  nNewHeight = pBoss->GetMaxFootnoteHeight();
2870}

2872SwSaveFootnoteHeight::~SwSaveFootnoteHeight()
2873{
  // If somebody tweaked the deadline meanwhile, we let it happen
  if ( nNewHeight == pBoss->GetMaxFootnoteHeight() )
      pBoss->m_nMaxFootnoteHeight = nOldHeight;
2877}

2879#ifdef DBG_UTIL
2880//JP 15.10.2001: in a non pro version test if the attribute has the same
2881//              meaning which his reference is

2883// Normally, the pRef member and the GetRefFromAttr() result has to be
2884// identically. Sometimes footnote will be moved from a master to its follow,
2885// but the GetRef() is called first, so we have to ignore a master/follow
2886// mismatch.

2888const SwContentFrame* SwFootnoteFrame::GetRef() const
2889{
  const SwContentFrame* pRefAttr = GetRefFromAttr();
  // check consistency: access to deleted frame?
  assert(mpReference == pRefAttr || mpReference->IsAnFollow(pRefAttr)(static_cast <bool> (mpReference == pRefAttr || mpReference
->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference
)) ? void (0) : __assert_fail ("mpReference == pRefAttr || mpReference->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference)"
, "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 2893, __extension__ __PRETTY_FUNCTION__))
          || pRefAttr->IsAnFollow(mpReference))(static_cast <bool> (mpReference == pRefAttr || mpReference
->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference
)) ? void (0) : __assert_fail ("mpReference == pRefAttr || mpReference->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference)"
, "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 2893, __extension__ __PRETTY_FUNCTION__));
  (void) pRefAttr;
  return mpReference;
2896}

2898SwContentFrame* SwFootnoteFrame::GetRef()
2899{
  const SwContentFrame* pRefAttr = GetRefFromAttr();
  // check consistency: access to deleted frame?
  assert(mpReference == pRefAttr || mpReference->IsAnFollow(pRefAttr)(static_cast <bool> (mpReference == pRefAttr || mpReference
->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference
)) ? void (0) : __assert_fail ("mpReference == pRefAttr || mpReference->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference)"
, "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 2903, __extension__ __PRETTY_FUNCTION__))
          || pRefAttr->IsAnFollow(mpReference))(static_cast <bool> (mpReference == pRefAttr || mpReference
->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference
)) ? void (0) : __assert_fail ("mpReference == pRefAttr || mpReference->IsAnFollow(pRefAttr) || pRefAttr->IsAnFollow(mpReference)"
, "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 2903, __extension__ __PRETTY_FUNCTION__));
  (void) pRefAttr;
  return mpReference;
2906}
2907#endif

2909const SwContentFrame* SwFootnoteFrame::GetRefFromAttr()  const
2910{
  SwFootnoteFrame* pThis = const_cast<SwFootnoteFrame*>(this);
  return pThis->GetRefFromAttr();
2913}

2915SwContentFrame* SwFootnoteFrame::GetRefFromAttr()
2916{
  assert(mpAttribute && "invalid Attribute")(static_cast <bool> (mpAttribute && "invalid Attribute"
) ? void (0) : __assert_fail ("mpAttribute && \"invalid Attribute\""
, "/home/maarten/src/libreoffice/core/sw/source/core/layout/ftnfrm.cxx"
, 2917, __extension__ __PRETTY_FUNCTION__));
  SwTextNode& rTNd = const_cast<SwTextNode&>(mpAttribute->GetTextNode());
  SwPosition aPos( rTNd, SwIndex( &rTNd, mpAttribute->GetStart() ));
  SwContentFrame* pCFrame = rTNd.getLayoutFrame(getRootFrame(), &aPos);
  return pCFrame;
2922}

2924/** search for last content in the current footnote frame

  OD 2005-12-02 #i27138#
2927*/
2928SwContentFrame* SwFootnoteFrame::FindLastContent()
2929{
  SwContentFrame* pLastContentFrame( nullptr );

  // find last lower, which is a content frame or contains content.
  // hidden text frames, empty sections and empty tables have to be skipped.
  SwFrame* pLastLowerOfFootnote( GetLower() );
  SwFrame* pTmpLastLower( pLastLowerOfFootnote );
  while ( pTmpLastLower && pTmpLastLower->GetNext() )
  {
      pTmpLastLower = pTmpLastLower->GetNext();
      if ( ( pTmpLastLower->IsTextFrame() &&
             !static_cast<SwTextFrame*>(pTmpLastLower)->IsHiddenNow() ) ||
           ( pTmpLastLower->IsSctFrame() &&
             static_cast<SwSectionFrame*>(pTmpLastLower)->GetSection() &&
             static_cast<SwSectionFrame*>(pTmpLastLower)->ContainsContent() ) ||
           ( pTmpLastLower->IsTabFrame() &&
             static_cast<SwTabFrame*>(pTmpLastLower)->ContainsContent() ) )
      {
          pLastLowerOfFootnote = pTmpLastLower;
      }
  }

  // determine last content frame depending on type of found last lower.
  if ( pLastLowerOfFootnote && pLastLowerOfFootnote->IsTabFrame() )
  {
      pLastContentFrame = static_cast<SwTabFrame*>(pLastLowerOfFootnote)->FindLastContent();
  }
  else if ( pLastLowerOfFootnote && pLastLowerOfFootnote->IsSctFrame() )
  {
      pLastContentFrame = static_cast<SwSectionFrame*>(pLastLowerOfFootnote)->FindLastContent();
  }
  else
  {
      pLastContentFrame = dynamic_cast<SwContentFrame*>(pLastLowerOfFootnote);
  }

  return pLastContentFrame;
2966}

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

←

/home/maarten/src/libreoffice/core/sw/source/core/inc/frame.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_SW_SOURCE_CORE_INC_FRAME_HXX
21#define INCLUDED_SW_SOURCE_CORE_INC_FRAME_HXX

23#include <drawinglayer/primitive2d/baseprimitive2d.hxx>
24#include <editeng/borderline.hxx>
25#include <svl/poolitem.hxx>
26#include <swtypes.hxx>
27#include <swrect.hxx>
28#include <calbck.hxx>
29#include <svl/SfxBroadcaster.hxx>
30#include <o3tl/typed_flags_set.hxx>
31#include <com/sun/star/style/TabStop.hpp>
32#include <basegfx/matrix/b2dhommatrix.hxx>
33#include <vcl/outdev.hxx>

35#include <memory>

37namespace drawinglayer::processor2d { class BaseProcessor2D; }

39class SwLayoutFrame;
40class SwRootFrame;
41class SwPageFrame;
42class SwBodyFrame;
43class SwFlyFrame;
44class SwSectionFrame;
45class SwFootnoteFrame;
46class SwFootnoteBossFrame;
47class SwTabFrame;
48class SwRowFrame;
49class SwContentFrame;
50class SwAttrSet;
51class Color;
52class SwBorderAttrs;
53class SwCache;
54class SvxBrushItem;
55class SvxFormatBreakItem;
56class SwFormatPageDesc;
57class SwSelectionList;
58struct SwPosition;
59struct SwCursorMoveState;
60class SwFormat;
61class SwPrintData;
62class SwSortedObjs;
63class SwAnchoredObject;
64enum class SvxFrameDirection;
65class IDocumentDrawModelAccess;

67// Each FrameType is represented here as a bit.
68// The bits must be set in a way that it can be determined with masking of
69// which kind of FrameType an instance is _and_ from what classes it was derived.
70// Each frame has in its base class a member that must be set by the
71// constructors accordingly.
72enum class SwFrameType
73{
  None        = 0x0000,
  Root        = 0x0001,
  Page        = 0x0002,
  Column      = 0x0004,
  Header      = 0x0008,
  Footer      = 0x0010,
  FtnCont     = 0x0020,
  Ftn         = 0x0040,
  Body        = 0x0080,
  Fly         = 0x0100,
  Section     = 0x0200,
85//  UNUSED      0x0400
  Tab         = 0x0800,
  Row         = 0x1000,
  Cell        = 0x2000,
  Txt         = 0x4000,
  NoTxt       = 0x8000,
91};

93namespace o3tl
94{
  template<> struct typed_flags<SwFrameType> : is_typed_flags<SwFrameType, 0xfbff> {};
96};

98// for internal use some common combinations
99#define FRM_LAYOUTSwFrameType(0x3bFF)      SwFrameType(0x3bFF)
100#define FRM_ALLSwFrameType(0xfbff)         SwFrameType(0xfbff)
101#define FRM_CNTNT(SwFrameType::Txt | SwFrameType::NoTxt)       (SwFrameType::Txt | SwFrameType::NoTxt)
102#define FRM_FTNBOSS(SwFrameType::Page | SwFrameType::Column)     (SwFrameType::Page | SwFrameType::Column)
103#define FRM_ACCESSIBLE(SwFrameType::Root | SwFrameType::Page | SwFrameType::Header |
 SwFrameType::Footer | SwFrameType::Ftn | SwFrameType::Fly | SwFrameType
::Tab | SwFrameType::Cell | SwFrameType::Txt)  (SwFrameType::Root | SwFrameType::Page | SwFrameType::Header | SwFrameType::Footer | SwFrameType::Ftn | SwFrameType::Fly | SwFrameType::Tab | SwFrameType::Cell | SwFrameType::Txt)
104#define FRM_NEIGHBOUR(SwFrameType::Column | SwFrameType::Cell)   (SwFrameType::Column | SwFrameType::Cell)
105#define FRM_NOTE_VERT(SwFrameType::FtnCont | SwFrameType::Ftn | SwFrameType::Section
 | SwFrameType::Tab | SwFrameType::Row | SwFrameType::Cell | SwFrameType
::Txt)   (SwFrameType::FtnCont | SwFrameType::Ftn | SwFrameType::Section | SwFrameType::Tab | SwFrameType::Row | SwFrameType::Cell | SwFrameType::Txt)
106#define FRM_HEADFOOT(SwFrameType::Header | SwFrameType::Footer)    (SwFrameType::Header | SwFrameType::Footer)
107#define FRM_BODYFTNC(SwFrameType::FtnCont | SwFrameType::Body)    (SwFrameType::FtnCont | SwFrameType::Body)

109// for GetNextLeaf/GetPrevLeaf.
110enum MakePageType
111{
  MAKEPAGE_NONE,      // do not create page/footnote
  MAKEPAGE_APPEND,    // only append page if needed
  MAKEPAGE_INSERT,    // add or append page if needed
  MAKEPAGE_FTN,       // add footnote if needed
  MAKEPAGE_NOSECTION  // Don't create section frames
117};

119namespace drawinglayer::attribute {
  class SdrAllFillAttributesHelper;
  typedef std::shared_ptr< SdrAllFillAttributesHelper > SdrAllFillAttributesHelperPtr;
122}

124/// Helper class to isolate geometry-defining members of SwFrame
125/// and to control their accesses. Moved to own class to have no
126/// hidden accesses to 'private' members anymore.
127///
128/// Added most important flags about the state of this geometric
129/// information and if it is valid or not
130class SAL_DLLPUBLIC_RTTI__attribute__ ((type_visibility("default"))) SwFrameAreaDefinition
131{
132private:
  friend void FriendHackInvalidateRowFrame(SwFrameAreaDefinition &);

  // The absolute position and size of the SwFrame in the document.
  // This values are set by the layouter implementations
  SwRect  maFrameArea;

  // The 'inner' Frame Area defined by a SwRect relative to FrameArea:
  // When identical to FrameArea, Pos() will be (0, 0) and Size identical.
  SwRect  maFramePrintArea;

  // bitfield
  bool mbFrameAreaPositionValid   : 1;
  bool mbFrameAreaSizeValid       : 1;
  bool mbFramePrintAreaValid      : 1;

  // #i65250#
  // frame ID is now in general available - used for layout loop control
  static sal_uInt32 mnLastFrameId;
  const  sal_uInt32 mnFrameId;

153protected:
  // write access to mb*Valid flags
  void setFrameAreaPositionValid(bool bNew);
  void setFrameAreaSizeValid(bool bNew);
  void setFramePrintAreaValid(bool bNew);

159public:
  SwFrameAreaDefinition();
  virtual ~SwFrameAreaDefinition();

  // read access to mb*Valid flags
  bool isFrameAreaPositionValid() const { return mbFrameAreaPositionValid; }
  bool isFrameAreaSizeValid() const { return mbFrameAreaSizeValid; }
  bool isFramePrintAreaValid() const { return mbFramePrintAreaValid; }

  // syntactic sugar: test whole FrameAreaDefinition
  bool isFrameAreaDefinitionValid() const { return isFrameAreaPositionValid() && isFrameAreaSizeValid() && isFramePrintAreaValid(); }

  // #i65250#
  sal_uInt32 GetFrameId() const { return mnFrameId; }

  // read accesses to FrameArea definitions - only const access allowed.
  // Do *not* const_cast results, it is necessary to track changes. use
  // the below offered WriteAccess helper classes instead
  const SwRect& getFrameArea() const { return maFrameArea; }
  const SwRect& getFramePrintArea() const { return maFramePrintArea; }

  // helper class(es) for FrameArea manipulation. These
  // have to be used to apply changes to FrameAreas. They hold a copy of the
  // SwRect for manipulation. It gets written back at destruction. Thus, this
  // mechanism depends on scope usage, take care. It prevents errors using
  // different instances of SwFrame in get/set methods which is more safe
  class FrameAreaWriteAccess : public SwRect
  {
  private:
      SwFrameAreaDefinition&        mrTarget;

      FrameAreaWriteAccess(const FrameAreaWriteAccess&) = delete;
      FrameAreaWriteAccess& operator=(const FrameAreaWriteAccess&) = delete;

  public:
      FrameAreaWriteAccess(SwFrameAreaDefinition& rTarget) : SwRect(rTarget.getFrameArea()), mrTarget(rTarget) {}
      ~FrameAreaWriteAccess();
      void setSwRect(const SwRect& rNew) { *reinterpret_cast< SwRect* >(this) = rNew; }
  };

  // same helper for FramePrintArea
  class FramePrintAreaWriteAccess : public SwRect
  {
  private:
      SwFrameAreaDefinition&        mrTarget;

      FramePrintAreaWriteAccess(const FramePrintAreaWriteAccess&) = delete;
      FramePrintAreaWriteAccess& operator=(const FramePrintAreaWriteAccess&) = delete;

  public:
      FramePrintAreaWriteAccess(SwFrameAreaDefinition& rTarget) : SwRect(rTarget.getFramePrintArea()), mrTarget(rTarget) {}
      ~FramePrintAreaWriteAccess();
      void setSwRect(const SwRect& rNew) { *reinterpret_cast< SwRect* >(this) = rNew; }
  };

  // RotateFlyFrame3 - Support for Transformations
  // Hand out the Transformations for the current FrameAreaDefinition
  // for the FrameArea and FramePrintArea.
  // FramePrintArea is not relative to FrameArea in this
  // transformation representation (to make it easier to use and understand).
  // There is no 'set' method since SwFrame is a layout object. For
  // some cases rotation will be included (used for SwGrfNode in inner
  // SwFrame of a SwFlyFrame)
  virtual basegfx::B2DHomMatrix getFrameAreaTransformation() const;
  virtual basegfx::B2DHomMatrix getFramePrintAreaTransformation() const;

  // RotateFlyFrame3 - Support for Transformations
  // Modify current transformations by applying given translation
  virtual void transform_translate(const Point& rOffset);
228};

230/// RotateFlyFrame3: Helper class when you want to make your SwFrame derivate
231/// transformable. It provides some tooling to do so. To use, add as member
232/// (see e.g. SwFlyFreeFrame which uses 'std::unique_ptr< TransformableSwFrame >')
233class TransformableSwFrame
234{
235private:
  // The SwFrameAreaDefinition to work on
  SwFrameAreaDefinition&  mrSwFrameAreaDefinition;

  // FrameAreaTransformation and FramePrintAreaTransformation
  // !identity when needed (translate/scale is used (e.g. rotation))
  basegfx::B2DHomMatrix   maFrameAreaTransformation;
  basegfx::B2DHomMatrix   maFramePrintAreaTransformation;

244public:
  TransformableSwFrame(SwFrameAreaDefinition& rSwFrameAreaDefinition)
  :   mrSwFrameAreaDefinition(rSwFrameAreaDefinition),
      maFrameAreaTransformation(),
      maFramePrintAreaTransformation()
  {
  }

  // get SwFrameArea in transformation form
  const basegfx::B2DHomMatrix& getLocalFrameAreaTransformation() const
  {
      return maFrameAreaTransformation;
  }

  // get SwFramePrintArea in transformation form
  const basegfx::B2DHomMatrix& getLocalFramePrintAreaTransformation() const
  {
      return maFramePrintAreaTransformation;
  }

  // Helpers to re-create the untransformed SwRect(s) originally
  // in the SwFrameAreaDefinition, based on the current Transformations.
  SwRect getUntransformedFrameArea() const;
  SwRect getUntransformedFramePrintArea() const;

  // Helper method to re-create FrameAreaTransformations based on the
  // current FrameAreaDefinition transformed by given rotation and Center
  void createFrameAreaTransformations(
      double fRotation,
      const basegfx::B2DPoint& rCenter);

  // Tooling method to reset the SwRect(s) in the current
  // SwFrameAreaDefinition which are already adapted to
  // Transformation back to the untransformed state, using
  // the getUntransformedFrame*Area calls above when needed.
  // Only the SwRect(s) are changed back, not the transformations.
  void restoreFrameAreas();

  // Re-Creates the SwRect(s) as BoundAreas based on the current
  // set Transformations.
  void adaptFrameAreasToTransformations();

  // Modify current definitions by applying the given transformation
  void transform(const basegfx::B2DHomMatrix& aTransform);
288};

290/**
* Base class of the Writer layout elements.
*
* This includes not only fly frames, but everything down to the paragraph
* level: pages, headers, footers, etc. (Inside a paragraph SwLinePortion
* instances are used.)
*/
297class SW_DLLPUBLIC__attribute__ ((visibility("default"))) SwFrame : public SwFrameAreaDefinition, public SwClient, public SfxBroadcaster
298{
  // the hidden Frame
  friend class SwFlowFrame;
  friend class SwLayoutFrame;
  friend class SwLooping;
  friend class SwDeletionChecker; // for GetDep()

  // voids lower during creation of a column
  friend SwFrame *SaveContent( SwLayoutFrame *, SwFrame* pStart );
  friend void   RestoreContent( SwFrame *, SwLayoutFrame *, SwFrame *pSibling );

  // for validating a mistakenly invalidated one in SwContentFrame::MakeAll
  friend void ValidateSz( SwFrame *pFrame );
  // implemented in text/txtftn.cxx, prevents Footnote oscillation
  friend void ValidateText( SwFrame *pFrame );

  friend void MakeNxt( SwFrame *pFrame, SwFrame *pNxt );

  // cache for (border) attributes
  static SwCache *mpCache;

  SwRootFrame   *mpRoot;
  SwLayoutFrame *mpUpper;
  SwFrame       *mpNext;
  SwFrame       *mpPrev;

  // sw_redlinehide: hide these dangerous SwClient functions
  using SwClient::GetRegisteredInNonConst;
  using SwClient::GetRegisteredIn;

  SwFrame *FindNext_();
  SwFrame *FindPrev_();

  /** method to determine next content frame in the same environment
      for a flow frame (content frame, table frame, section frame)

      #i27138# - adding documentation:
      Travelling downwards through the layout to determine the next content
      frame in the same environment. There are several environments in a
      document, which form a closed context regarding this function. These
      environments are:
      - Each page header
      - Each page footer
      - Each unlinked fly frame
      - Each group of linked fly frames
      - All footnotes
      - All document body frames
      #i27138# - adding parameter <_bInSameFootnote>
      Its default value is <false>. If its value is <true>, the environment
      'All footnotes' is no longer treated. Instead each footnote is treated
      as an own environment.

      @param _bInSameFootnote
      input parameter - boolean indicating, that the found next content
      frame has to be in the same footnote frame. This parameter is only
      relevant for flow frames in footnotes.

      @return SwContentFrame*
      pointer to the found next content frame. It's NULL, if none exists.
  */
  SwContentFrame* FindNextCnt_( const bool _bInSameFootnote );

  /** method to determine previous content frame in the same environment
      for a flow frame (content frame, table frame, section frame)

      #i27138#
      Travelling upwards through the layout to determine the previous content
      frame in the same environment. There are several environments in a
      document, which form a closed context regarding this function. These
      environments are:
      - Each page header
      - Each page footer
      - Each unlinked fly frame
      - Each group of linked fly frames
      - All footnotes
      - All document body frames
      #i27138# - adding parameter <_bInSameFootnote>
      Its default value is <false>. If its value is <true>, the environment
      'All footnotes' is no longer treated. Instead each footnote is treated
      as an own environment.

      The found previous content frame has to be in the same footnote frame. This is only
      relevant for flow frames in footnotes.

      @return SwContentFrame*
      pointer to the found previous content frame. It's NULL, if none exists.
  */
  SwContentFrame* FindPrevCnt_();

  void UpdateAttrFrame( const SfxPoolItem*, const SfxPoolItem*, sal_uInt8 & );
  SwFrame* GetIndNext_();
  void SetDirFlags( bool bVert );

  const SwLayoutFrame* ImplGetNextLayoutLeaf( bool bFwd ) const;

  SwPageFrame* ImplFindPageFrame();

395protected:
  std::unique_ptr<SwSortedObjs> m_pDrawObjs; // draw objects, can be null
  SwFrameType mnFrameType;  //Who am I?

  bool mbInDtor      : 1;
  bool mbInvalidR2L  : 1;
  bool mbDerivedR2L  : 1;
  bool mbRightToLeft : 1;
  bool mbInvalidVert : 1;
  bool mbDerivedVert : 1;
  bool mbVertical    : 1;

  bool mbVertLR      : 1;
  bool mbVertLRBT    : 1;

  bool mbValidLineNum  : 1;
  bool mbFixSize       : 1;

  // if true, frame will be painted completely even content was changed
  // only partially. For ContentFrames a border (from Action) will exclusively
  // painted if <mbCompletePaint> is true.
  bool mbCompletePaint : 1;

  bool mbRetouche      : 1; // frame is responsible for retouching

  bool mbInfInvalid    : 1;  // InfoFlags are invalid
  bool mbInfBody       : 1;  // Frame is in document body
  bool mbInfTab        : 1;  // Frame is in a table
  bool mbInfFly        : 1;  // Frame is in a Fly
  bool mbInfFootnote        : 1;  // Frame is in a footnote
  bool mbInfSct        : 1;  // Frame is in a section
  bool mbColLocked     : 1;  // lock Grow/Shrink for column-wise section
                                // or fly frames, will be set in Format
  bool m_isInDestroy : 1;
  bool mbForbidDelete : 1;

  void ColLock()      { mbColLocked = true; }
  void ColUnlock()    { mbColLocked = false; }

  virtual void DestroyImpl();
  virtual ~SwFrame() override;

  // Only used by SwRootFrame Ctor to get 'this' into mpRoot...
  void setRootFrame( SwRootFrame* pRoot ) { mpRoot = pRoot; }

  SwPageFrame *InsertPage( SwPageFrame *pSibling, bool bFootnote );
  void PrepareMake(vcl::RenderContext* pRenderContext);
  void OptPrepareMake();
  virtual void MakePos();
  // Format next frame of table frame to assure keeping attributes.
  // In case of nested tables method <SwFrame::MakeAll()> is called to
  // avoid formatting of superior table frame.
  friend SwFrame* sw_FormatNextContentForKeep( SwTabFrame* pTabFrame );

  virtual void MakeAll(vcl::RenderContext* pRenderContext) = 0;
  // adjust frames of a page
  SwTwips AdjustNeighbourhood( SwTwips nDiff, bool bTst = false );

  // change only frame size not the size of PrtArea
  virtual SwTwips ShrinkFrame( SwTwips, bool bTst = false, bool bInfo = false ) = 0;
  virtual SwTwips GrowFrame  ( SwTwips, bool bTst = false, bool bInfo = false ) = 0;

  /// use these so we can grep for SwFrame's GetRegisteredIn accesses
  /// beware that SwTextFrame may return sw::WriterMultiListener
  SwModify        *GetDep()       { return GetRegisteredInNonConst(); }
  const SwModify  *GetDep() const { return GetRegisteredIn(); }

  SwFrame( SwModify*, SwFrame* );

  void CheckDir( SvxFrameDirection nDir, bool bVert, bool bOnlyBiDi, bool bBrowse );

  /** enumeration for the different invalidations
      #i28701#
  */
  enum InvalidationType
  {
      INVALID_SIZE, INVALID_PRTAREA, INVALID_POS, INVALID_LINENUM, INVALID_ALL
  };

  /** method to determine, if an invalidation is allowed.
      #i28701
  */
  virtual bool InvalidationAllowed( const InvalidationType _nInvalid ) const;

  /** method to perform additional actions on an invalidation

      #i28701#
      Method has *only* to contain actions, which has to be performed on
      *every* assignment of the corresponding flag to <false>.
  */
  virtual void ActionOnInvalidation( const InvalidationType _nInvalid );

  // draw shadow and borders
  void PaintShadow( const SwRect&, SwRect&, const SwBorderAttrs& ) const;
  virtual void Modify( const SfxPoolItem*, const SfxPoolItem* ) override;

  virtual const IDocumentDrawModelAccess& getIDocumentDrawModelAccess( );

493public:
  virtual css::uno::Sequence< css::style::TabStop > GetTabStopInfo( SwTwips )
  {
      return css::uno::Sequence< css::style::TabStop >();
  }


  SwFrameType GetType() const { return mnFrameType; }

  static SwCache &GetCache()                { return *mpCache; }
  static SwCache *GetCachePtr()             { return mpCache;  }
  static void     SetCache( SwCache *pNew ) { mpCache = pNew;  }

  // change PrtArea size and FrameSize
  SwTwips Shrink( SwTwips, bool bTst = false, bool bInfo = false );
  SwTwips Grow  ( SwTwips, bool bTst = false, bool bInfo = false );

  // different methods for inserting in layout tree (for performance reasons)

  // insert before pBehind or at the end of the chain below mpUpper
  void InsertBefore( SwLayoutFrame* pParent, SwFrame* pBehind );
  // insert after pBefore or at the beginning of the chain below mpUpper
  void InsertBehind( SwLayoutFrame *pParent, SwFrame *pBefore );
  // insert before pBehind or at the end of the chain while considering
  // the siblings of pSct
  bool InsertGroupBefore( SwFrame* pParent, SwFrame* pWhere, SwFrame* pSct );
  void RemoveFromLayout();

  // For internal use only - who ignores this will be put in a sack and has
  // to stay there for two days
  // Does special treatment for Get_[Next|Prev]Leaf() (for tables).
  SwLayoutFrame *GetLeaf( MakePageType eMakePage, bool bFwd );
  SwLayoutFrame *GetNextLeaf   ( MakePageType eMakePage );
  SwLayoutFrame *GetNextFootnoteLeaf( MakePageType eMakePage );
  SwLayoutFrame *GetNextSctLeaf( MakePageType eMakePage );
  SwLayoutFrame *GetNextCellLeaf();
  SwLayoutFrame *GetPrevLeaf   ();
  SwLayoutFrame *GetPrevFootnoteLeaf( MakePageType eMakeFootnote );
  SwLayoutFrame *GetPrevSctLeaf();
  SwLayoutFrame *GetPrevCellLeaf();
  const SwLayoutFrame *GetLeaf ( MakePageType eMakePage, bool bFwd,
                               const SwFrame *pAnch ) const;

  bool WrongPageDesc( SwPageFrame* pNew );

  //#i28701# - new methods to append/remove drawing objects
  void AppendDrawObj( SwAnchoredObject& _rNewObj );
  void RemoveDrawObj( SwAnchoredObject& _rToRemoveObj );

  // work with chain of FlyFrames
  void  AppendFly( SwFlyFrame *pNew );
  void  RemoveFly( SwFlyFrame *pToRemove );
  const SwSortedObjs *GetDrawObjs() const { return m_pDrawObjs.get(); }
        SwSortedObjs *GetDrawObjs()       { return m_pDrawObjs.get(); }
  // #i28701# - change purpose of method and adjust its name
  void InvalidateObjs( const bool _bNoInvaOfAsCharAnchoredObjs = true );

  virtual void PaintSwFrameShadowAndBorder(
      const SwRect&,
      const SwPageFrame* pPage,
      const SwBorderAttrs&) const;
  void PaintBaBo( const SwRect&, const SwPageFrame *pPage,
                  const bool bOnlyTextBackground = false) const;
  void PaintSwFrameBackground( const SwRect&, const SwPageFrame *pPage,
                        const SwBorderAttrs &,
                        const bool bLowerMode = false,
                        const bool bLowerBorder = false,
                        const bool bOnlyTextBackground = false ) const;
  void PaintBorderLine( const SwRect&, const SwRect&, const SwPageFrame*,
                        const Color *pColor,
                        const SvxBorderLineStyle = SvxBorderLineStyle::SOLID ) const;

  std::unique_ptr<drawinglayer::processor2d::BaseProcessor2D> CreateProcessor2D( ) const;
  void ProcessPrimitives( const drawinglayer::primitive2d::Primitive2DContainer& rSequence ) const;

  // retouch, not in the area of the given Rect!
  void Retouch( const SwPageFrame *pPage, const SwRect &rRect ) const;

  bool GetBackgroundBrush(
      drawinglayer::attribute::SdrAllFillAttributesHelperPtr& rFillAttributes,
      const SvxBrushItem*& rpBrush,
      const Color*& rpColor,
      SwRect &rOrigRect,
      bool bLowerMode,
      bool bConsiderTextBox ) const;

  inline void SetCompletePaint() const;
  inline void ResetCompletePaint() const;
  bool IsCompletePaint() const { return mbCompletePaint; }

  inline void SetRetouche() const;
  inline void ResetRetouche() const;
  bool IsRetouche() const { return mbRetouche; }

  void SetInfFlags();
  void InvalidateInfFlags() { mbInfInvalid = true; }
  inline bool IsInDocBody() const;    // use InfoFlags, determine flags
  inline bool IsInFootnote() const;        // if necessary
  inline bool IsInTab() const;
  inline bool IsInFly() const;
  inline bool IsInSct() const;

  // If frame is inside a split table row, this function returns
  // the corresponding row frame in the follow table.
  const SwRowFrame* IsInSplitTableRow() const;

  // If frame is inside a follow flow row, this function returns
  // the corresponding row frame master table
  const SwRowFrame* IsInFollowFlowRow() const;

  bool IsInBalancedSection() const;

  inline bool IsVertical() const;
  inline bool IsVertLR() const;
  inline bool IsVertLRBT() const;

  void SetDerivedVert( bool bNew ){ mbDerivedVert = bNew; }
  void SetInvalidVert( bool bNew) { mbInvalidVert = bNew; }
  inline bool IsRightToLeft() const;
  void SetDerivedR2L( bool bNew ) { mbDerivedR2L  = bNew; }

  void CheckDirChange();
  // returns upper left frame position for LTR and
  // upper right frame position for Asian / RTL frames
  Point   GetFrameAnchorPos( bool bIgnoreFlysAnchoredAtThisFrame ) const;

  /** determine, if frame is moveable in given environment

      method replaced 'old' method <bool IsMoveable() const>.
      Determines, if frame is moveable in given environment. if no environment
      is given (parameter _pLayoutFrame == 0), the movability in the actual
      environment (<GetUpper()) is checked.

      @param _pLayoutFrame
      input parameter - given environment (layout frame), in which the movability
      will be checked. If not set ( == 0 ), actual environment is taken.

      @return boolean, indicating, if frame is moveable in given environment
  */
  bool IsMoveable( const SwLayoutFrame* _pLayoutFrame = nullptr ) const;

  // Is it permitted for the (Text)Frame to add a footnote in the current
  // environment (not e.g. for repeating table headlines)
  bool IsFootnoteAllowed() const;

  virtual void  Format( vcl::RenderContext* pRenderContext, const SwBorderAttrs *pAttrs = nullptr );

  virtual void CheckDirection( bool bVert );

  void ReinitializeFrameSizeAttrFlags();

  /// WARNING: this may not return correct RES_PAGEDESC/RES_BREAK items for
  /// SwTextFrame, use GetBreakItem()/GetPageDescItem() instead
  const SwAttrSet *GetAttrSet() const;
  virtual const SvxFormatBreakItem& GetBreakItem() const;
  virtual const SwFormatPageDesc& GetPageDescItem() const;

  bool HasFixSize() const { return mbFixSize; }

  // check all pages (starting from the given) and correct them if needed
  static void CheckPageDescs( SwPageFrame *pStart, bool bNotifyFields = true, SwPageFrame** ppPrev = nullptr);

  // might return 0, with and without const
  SwFrame               *GetNext()  { return mpNext; }
  SwFrame               *GetPrev()  { return mpPrev; }
  SwLayoutFrame         *GetUpper() { return mpUpper; }
  SwRootFrame           *getRootFrame(){ return mpRoot; }
  SwPageFrame           *FindPageFrame() { return IsPageFrame() ? reinterpret_cast<SwPageFrame*>(this) : ImplFindPageFrame(); }
  SwFrame               *FindColFrame();
  SwRowFrame            *FindRowFrame();
  SwFootnoteBossFrame   *FindFootnoteBossFrame( bool bFootnotes = false );
  SwTabFrame            *ImplFindTabFrame();
  SwFootnoteFrame       *ImplFindFootnoteFrame();
  SwFlyFrame            *ImplFindFlyFrame();
  SwSectionFrame        *ImplFindSctFrame();
  const SwBodyFrame     *ImplFindBodyFrame() const;
  SwFrame               *FindFooterOrHeader();
  SwFrame               *GetLower();
  const SwFrame         *GetNext()  const { return mpNext; }
  const SwFrame         *GetPrev()  const { return mpPrev; }
  const SwLayoutFrame   *GetUpper() const { return mpUpper; }
  const SwRootFrame     *getRootFrame()   const { return mpRoot; }
  inline SwTabFrame     *FindTabFrame();
  inline SwFootnoteFrame     *FindFootnoteFrame();
  inline SwFlyFrame     *FindFlyFrame();
  inline SwSectionFrame *FindSctFrame();
  inline SwFrame        *FindNext();
  // #i27138# - add parameter <_bInSameFootnote>
  SwContentFrame* FindNextCnt( const bool _bInSameFootnote = false );
  inline SwFrame        *FindPrev();
  inline const SwPageFrame *FindPageFrame() const;
  inline const SwFootnoteBossFrame *FindFootnoteBossFrame( bool bFootnote = false ) const;
  inline const SwFrame     *FindColFrame() const;
  inline const SwFrame     *FindFooterOrHeader() const;
  inline const SwTabFrame  *FindTabFrame() const;
  inline const SwFootnoteFrame  *FindFootnoteFrame() const;
  inline const SwFlyFrame  *FindFlyFrame() const;
  inline const SwSectionFrame *FindSctFrame() const;
  inline const SwBodyFrame    *FindBodyFrame() const;
  inline const SwFrame     *FindNext() const;
  // #i27138# - add parameter <_bInSameFootnote>
  const SwContentFrame* FindNextCnt( const bool _bInSameFootnote = false ) const;
  inline const SwFrame     *FindPrev() const;
         const SwFrame     *GetLower()  const;

  SwContentFrame* FindPrevCnt();

  const SwContentFrame* FindPrevCnt() const;

  // #i79774#
  SwFrame* GetIndPrev_() const;
  SwFrame* GetIndPrev() const
      { return ( mpPrev || !IsInSct() ) ? mpPrev : GetIndPrev_(); }

  SwFrame* GetIndNext()
      { return ( mpNext || !IsInSct() ) ? mpNext : GetIndNext_(); }
  const SwFrame* GetIndNext() const { return const_cast<SwFrame*>(this)->GetIndNext(); }

  sal_uInt16 GetPhyPageNum() const;   // page number without offset
  sal_uInt16 GetVirtPageNum() const;  // page number with offset
  bool OnRightPage() const { return 0 != GetPhyPageNum() % 2; };
  bool WannaRightPage() const;
  bool OnFirstPage() const;

  inline const  SwLayoutFrame *GetPrevLayoutLeaf() const;
  inline const  SwLayoutFrame *GetNextLayoutLeaf() const;
  inline SwLayoutFrame *GetPrevLayoutLeaf();
  inline SwLayoutFrame *GetNextLayoutLeaf();

  virtual void Calc(vcl::RenderContext* pRenderContext) const; // here might be "formatted"
  inline void OptCalc() const;    // here we assume (for optimization) that
                                  // the predecessors are already formatted
  Point   GetRelPos() const;

  // PaintArea is the area where content might be displayed.
  // The margin of a page or the space between columns belongs to it.
  SwRect GetPaintArea() const;

  // UnionFrame is the union of Frame- and PrtArea, normally identical
  // to the FrameArea except in case of negative Prt margins.
  SwRect UnionFrame( bool bBorder = false ) const;

  virtual Size ChgSize( const Size& aNewSize );

  virtual void Cut() = 0;
  virtual void Paste( SwFrame* pParent, SwFrame* pSibling = nullptr ) = 0;

  void ValidateLineNum() { mbValidLineNum = true; }

  bool GetValidLineNumFlag()const { return mbValidLineNum; }

  // Only invalidate Frame
  // #i28701# - add call to method <ActionOnInvalidation(..)>
  //            for all invalidation methods.
  // #i28701# - use method <InvalidationAllowed(..)> to
  //            decide, if invalidation will to be performed or not.
  // #i26945# - no additional invalidation, if it's already
  //            invalidate.
  void InvalidateSize_()
  {
      if ( isFrameAreaSizeValid() && InvalidationAllowed( INVALID_SIZE ) )
      {
          setFrameAreaSizeValid(false);
          ActionOnInvalidation( INVALID_SIZE );
      }
  }
  void InvalidatePrt_()
  {
      if ( isFramePrintAreaValid() && InvalidationAllowed( INVALID_PRTAREA ) )
      {
          setFramePrintAreaValid(false);
          ActionOnInvalidation( INVALID_PRTAREA );
      }
  }
  void InvalidatePos_()
  {
      if ( isFrameAreaPositionValid() && InvalidationAllowed( INVALID_POS ) )
      {
          setFrameAreaPositionValid(false);
          ActionOnInvalidation( INVALID_POS );
      }
  }
  void InvalidateLineNum_()
  {
      if ( mbValidLineNum && InvalidationAllowed( INVALID_LINENUM ) )
      {
          mbValidLineNum = false;
          ActionOnInvalidation( INVALID_LINENUM );
      }
  }
  void InvalidateAll_()
  {
      if ( ( isFrameAreaSizeValid() || isFramePrintAreaValid() || isFrameAreaPositionValid() ) && InvalidationAllowed( INVALID_ALL ) )
      {
          setFrameAreaSizeValid(false);
          setFrameAreaPositionValid(false);
          setFramePrintAreaValid(false);
          ActionOnInvalidation( INVALID_ALL );
      }
  }
  // also notify page at the same time
  inline void InvalidateSize();
  inline void InvalidatePrt();
  inline void InvalidatePos();
  inline void InvalidateLineNum();
  inline void InvalidateAll();
  void ImplInvalidateSize();
  void ImplInvalidatePrt();
  void ImplInvalidatePos();
  void ImplInvalidateLineNum();

  inline void InvalidateNextPos( bool bNoFootnote = false );
  void ImplInvalidateNextPos( bool bNoFootnote );

  /** method to invalidate printing area of next frame
      #i11859#
  */
  void InvalidateNextPrtArea();

  void InvalidatePage( const SwPageFrame *pPage = nullptr ) const;

  virtual bool    FillSelection( SwSelectionList& rList, const SwRect& rRect ) const;

  virtual bool    GetModelPositionForViewPoint( SwPosition *, Point&,
                               SwCursorMoveState* = nullptr, bool bTestBackground = false ) const;
  virtual bool    GetCharRect( SwRect &, const SwPosition&,
                               SwCursorMoveState* = nullptr, bool bAllowFarAway = true ) const;
  virtual void PaintSwFrame( vcl::RenderContext& rRenderContext, SwRect const&,
                      SwPrintData const*const pPrintData = nullptr ) const;

  // HACK: shortcut between frame and formatting
  // It's your own fault if you cast void* incorrectly! In any case check
  // the void* for 0.
  virtual bool Prepare( const PrepareHint ePrep = PrepareHint::Clear,
                        const void *pVoid = nullptr, bool bNotify = true );

  // true if it is the correct class, false otherwise
  inline bool IsLayoutFrame() const;
  inline bool IsRootFrame() const;
  inline bool IsPageFrame() const;
  inline bool IsColumnFrame() const;
  inline bool IsFootnoteBossFrame() const;  // footnote bosses might be PageFrames or ColumnFrames
  inline bool IsHeaderFrame() const;
  inline bool IsFooterFrame() const;
  inline bool IsFootnoteContFrame() const;
  inline bool IsFootnoteFrame() const;
  inline bool IsBodyFrame() const;
  inline bool IsColBodyFrame() const;  // implemented in layfrm.hxx, BodyFrame above ColumnFrame
  inline bool IsPageBodyFrame() const; // implemented in layfrm.hxx, BodyFrame above PageFrame
  inline bool IsFlyFrame() const;
  inline bool IsSctFrame() const;
  inline bool IsTabFrame() const;
  inline bool IsRowFrame() const;
  inline bool IsCellFrame() const;
  inline bool IsContentFrame() const;
  inline bool IsTextFrame() const;
  inline bool IsNoTextFrame() const;
  // Frames where its PrtArea depends on their neighbors and that are
  // positioned in the content flow
  inline bool IsFlowFrame() const;
  // Frames that are capable of retouching or that might need to retouch behind
  // themselves
  inline bool IsRetoucheFrame() const;
  inline bool IsAccessibleFrame() const;

  void PrepareCursor();                 // CursorShell is allowed to call this

  // Is the Frame (or the section containing it) protected? Same for Fly in
  // Fly in ... and footnotes
  bool IsProtected() const;

  bool IsColLocked()  const { return mbColLocked; }
  virtual bool IsDeleteForbidden() const { return mbForbidDelete; }

  /// this is the only way to delete a SwFrame instance
  static void DestroyFrame(SwFrame *const pFrame);

  bool IsInDtor() const { return mbInDtor; }

  // No inline cause we need the function pointers
  long GetTopMargin() const;
  long GetBottomMargin() const;
  long GetLeftMargin() const;
  long GetRightMargin() const;
  void SetTopBottomMargins( long, long );
  void SetLeftRightMargins( long, long );
  void SetRightLeftMargins( long, long );
  long GetPrtLeft() const;
  long GetPrtBottom() const;
  long GetPrtRight() const;
  long GetPrtTop() const;
  bool SetMinLeft( long );
  bool SetMaxBottom( long );
  bool SetMaxRight( long );
  void MakeBelowPos( const SwFrame*, const SwFrame*, bool );
  void MakeLeftPos( const SwFrame*, const SwFrame*, bool );
  void MakeRightPos( const SwFrame*, const SwFrame*, bool );
  bool IsNeighbourFrame() const
      { return bool(GetType() & FRM_NEIGHBOUR(SwFrameType::Column | SwFrameType::Cell)); }

  // NEW TABLES
  // Some functions for covered/covering table cells. This way unnecessary
  // includes can be avoided
  virtual bool IsLeaveUpperAllowed() const;
  virtual bool IsCoveredCell() const;
  bool IsInCoveredCell() const;

  // #i81146# new loop control
  bool KnowsFormat( const SwFormat& rFormat ) const;
  void RegisterToFormat( SwFormat& rFormat );
  void ValidateThisAndAllLowers( const sal_uInt16 nStage );

  void ForbidDelete()      { mbForbidDelete = true; }
  void AllowDelete()    { mbForbidDelete = false; }

  drawinglayer::attribute::SdrAllFillAttributesHelperPtr getSdrAllFillAttributesHelper() const;
  bool supportsFullDrawingLayerFillAttributeSet() const;

911public:
  // if writer is NULL, dumps the layout structure as XML in layout.xml
  virtual void dumpAsXml(xmlTextWriterPtr writer = nullptr) const;
  void dumpTopMostAsXml(xmlTextWriterPtr writer = nullptr) const;
  void dumpInfosAsXml(xmlTextWriterPtr writer) const;
  virtual void dumpAsXmlAttributes(xmlTextWriterPtr writer) const;
  void dumpChildrenAsXml(xmlTextWriterPtr writer) const;
  bool IsCollapse() const;
919};

921inline bool SwFrame::IsInDocBody() const
922{
  if ( mbInfInvalid )
      const_cast<SwFrame*>(this)->SetInfFlags();
  return mbInfBody;
926}
927inline bool SwFrame::IsInFootnote() const
928{
  if ( mbInfInvalid )
      const_cast<SwFrame*>(this)->SetInfFlags();
  return mbInfFootnote;
932}
933inline bool SwFrame::IsInTab() const
934{
  if ( mbInfInvalid )
      const_cast<SwFrame*>(this)->SetInfFlags();
  return mbInfTab;
938}
939inline bool SwFrame::IsInFly() const
940{
  if ( mbInfInvalid )
      const_cast<SwFrame*>(this)->SetInfFlags();
  return mbInfFly;
944}
945inline bool SwFrame::IsInSct() const
946{
  if ( mbInfInvalid )
      const_cast<SwFrame*>(this)->SetInfFlags();
  return mbInfSct;
950}
951bool SwFrame::IsVertical() const
952{
  if( mbInvalidVert )
      const_cast<SwFrame*>(this)->SetDirFlags( true );
  return mbVertical;
956}
957inline bool SwFrame::IsVertLR() const
958{
  return mbVertLR;
960}
961inline bool SwFrame::IsVertLRBT() const
962{
  return mbVertLRBT;
964}
965inline bool SwFrame::IsRightToLeft() const
966{
  if( mbInvalidR2L )
      const_cast<SwFrame*>(this)->SetDirFlags( false );
  return mbRightToLeft;
970}

972inline void SwFrame::SetCompletePaint() const
973{
  const_cast<SwFrame*>(this)->mbCompletePaint = true;
975}
976inline void SwFrame::ResetCompletePaint() const
977{
  const_cast<SwFrame*>(this)->mbCompletePaint = false;
979}

981inline void SwFrame::SetRetouche() const
982{
  const_cast<SwFrame*>(this)->mbRetouche = true;
984}
985inline void SwFrame::ResetRetouche() const
986{
  const_cast<SwFrame*>(this)->mbRetouche = false;
988}

990inline SwLayoutFrame *SwFrame::GetNextLayoutLeaf()
991{
  return const_cast<SwLayoutFrame*>(static_cast<const SwFrame*>(this)->GetNextLayoutLeaf());
993}
994inline SwLayoutFrame *SwFrame::GetPrevLayoutLeaf()
995{
  return const_cast<SwLayoutFrame*>(static_cast<const SwFrame*>(this)->GetPrevLayoutLeaf());
997}
998inline const SwLayoutFrame *SwFrame::GetNextLayoutLeaf() const
999{
  return ImplGetNextLayoutLeaf( true );
1001}
1002inline const SwLayoutFrame *SwFrame::GetPrevLayoutLeaf() const
1003{
  return ImplGetNextLayoutLeaf( false );
1005}

1007inline void SwFrame::InvalidateSize()
1008{
  if ( isFrameAreaSizeValid() )
  {
      ImplInvalidateSize();
  }
1013}
1014inline void SwFrame::InvalidatePrt()
1015{
  if ( isFramePrintAreaValid() )
  {
      ImplInvalidatePrt();
  }
1020}
1021inline void SwFrame::InvalidatePos()
1022{
  if ( isFrameAreaPositionValid() )
  {
      ImplInvalidatePos();
  }
1027}
1028inline void SwFrame::InvalidateLineNum()
1029{
  if ( mbValidLineNum )
      ImplInvalidateLineNum();
1032}
1033inline void SwFrame::InvalidateAll()
1034{
  if ( InvalidationAllowed( INVALID_ALL ) )
  {
      if ( isFrameAreaDefinitionValid()  )
      {
          ImplInvalidatePos();
      }

      setFrameAreaSizeValid(false);
      setFrameAreaPositionValid(false);
      setFramePrintAreaValid(false);

      // #i28701#
      ActionOnInvalidation( INVALID_ALL );
  }
1049}
1050inline void SwFrame::InvalidateNextPos( bool bNoFootnote )
1051{
  if ( mpNext && !mpNext->IsSctFrame() )
      mpNext->InvalidatePos();
  else
      ImplInvalidateNextPos( bNoFootnote );
1056}

1058inline void SwFrame::OptCalc() const
1059{
  if ( !isFrameAreaPositionValid() || !isFramePrintAreaValid() || !isFrameAreaSizeValid() )
  {
      const_cast<SwFrame*>(this)->OptPrepareMake();
  }
1064}
1065inline const SwPageFrame *SwFrame::FindPageFrame() const
1066{
  return const_cast<SwFrame*>(this)->FindPageFrame();
1068}
1069inline const SwFrame *SwFrame::FindColFrame() const
1070{
  return const_cast<SwFrame*>(this)->FindColFrame();
1072}
1073inline const SwFrame *SwFrame::FindFooterOrHeader() const
1074{
  return const_cast<SwFrame*>(this)->FindFooterOrHeader();
1076}
1077inline SwTabFrame *SwFrame::FindTabFrame()
1078{
  return IsInTab() ? ImplFindTabFrame() : nullptr;
1080}
1081inline const SwFootnoteBossFrame *SwFrame::FindFootnoteBossFrame( bool bFootnote ) const
1082{
  return const_cast<SwFrame*>(this)->FindFootnoteBossFrame( bFootnote );
1084}
1085inline SwFootnoteFrame *SwFrame::FindFootnoteFrame()
1086{
  return IsInFootnote() ? ImplFindFootnoteFrame() : nullptr;
11
←
Assuming the condition is true→
12
←
'?' condition is true→
13
←
Returning pointer→
1088}
1089inline SwFlyFrame *SwFrame::FindFlyFrame()
1090{
  return IsInFly() ? ImplFindFlyFrame() : nullptr;
1092}
1093inline SwSectionFrame *SwFrame::FindSctFrame()
1094{
  return IsInSct() ? ImplFindSctFrame() : nullptr;
1096}

1098inline const SwBodyFrame *SwFrame::FindBodyFrame() const
1099{
  return IsInDocBody() ? ImplFindBodyFrame() : nullptr;
1101}

1103inline const SwTabFrame *SwFrame::FindTabFrame() const
1104{
  return IsInTab() ? const_cast<SwFrame*>(this)->ImplFindTabFrame() : nullptr;
1106}
1107inline const SwFootnoteFrame *SwFrame::FindFootnoteFrame() const
1108{
  return IsInFootnote() ? const_cast<SwFrame*>(this)->ImplFindFootnoteFrame() : nullptr;
1110}
1111inline const SwFlyFrame *SwFrame::FindFlyFrame() const
1112{
  return IsInFly() ? const_cast<SwFrame*>(this)->ImplFindFlyFrame() : nullptr;
1114}
1115inline const SwSectionFrame *SwFrame::FindSctFrame() const
1116{
  return IsInSct() ? const_cast<SwFrame*>(this)->ImplFindSctFrame() : nullptr;
1118}
1119inline SwFrame *SwFrame::FindNext()
1120{
  if ( mpNext )
      return mpNext;
  else
      return FindNext_();
1125}
1126inline const SwFrame *SwFrame::FindNext() const
1127{
  if ( mpNext )
      return mpNext;
  else
      return const_cast<SwFrame*>(this)->FindNext_();
1132}
1133inline SwFrame *SwFrame::FindPrev()
1134{
  if ( mpPrev && !mpPrev->IsSctFrame() )
      return mpPrev;
  else
      return FindPrev_();
1139}
1140inline const SwFrame *SwFrame::FindPrev() const
1141{
  if ( mpPrev && !mpPrev->IsSctFrame() )
      return mpPrev;
  else
      return const_cast<SwFrame*>(this)->FindPrev_();
1146}

1148inline bool SwFrame::IsLayoutFrame() const
1149{
  return bool(GetType() & FRM_LAYOUTSwFrameType(0x3bFF));
1151}
1152inline bool SwFrame::IsRootFrame() const
1153{
  return mnFrameType == SwFrameType::Root;
1155}
1156inline bool SwFrame::IsPageFrame() const
1157{
  return mnFrameType == SwFrameType::Page;
1159}
1160inline bool SwFrame::IsColumnFrame() const
1161{
  return mnFrameType == SwFrameType::Column;
1163}
1164inline bool SwFrame::IsFootnoteBossFrame() const
1165{
  return bool(GetType() & FRM_FTNBOSS(SwFrameType::Page | SwFrameType::Column));
1167}
1168inline bool SwFrame::IsHeaderFrame() const
1169{
  return mnFrameType == SwFrameType::Header;
1171}
1172inline bool SwFrame::IsFooterFrame() const
1173{
  return mnFrameType == SwFrameType::Footer;
1175}
1176inline bool SwFrame::IsFootnoteContFrame() const
1177{
  return mnFrameType == SwFrameType::FtnCont;
1179}
1180inline bool SwFrame::IsFootnoteFrame() const
1181{
  return mnFrameType == SwFrameType::Ftn;
1183}
1184inline bool SwFrame::IsBodyFrame() const
1185{
  return mnFrameType == SwFrameType::Body;
1187}
1188inline bool SwFrame::IsFlyFrame() const
1189{
  return mnFrameType == SwFrameType::Fly;
1191}
1192inline bool SwFrame::IsSctFrame() const
1193{
  return mnFrameType == SwFrameType::Section;
1195}
1196inline bool SwFrame::IsTabFrame() const
1197{
  return mnFrameType == SwFrameType::Tab;
1199}
1200inline bool SwFrame::IsRowFrame() const
1201{
  return mnFrameType == SwFrameType::Row;
1203}
1204inline bool SwFrame::IsCellFrame() const
1205{
  return mnFrameType == SwFrameType::Cell;
1207}
1208inline bool SwFrame::IsContentFrame() const
1209{
  return bool(GetType() & FRM_CNTNT(SwFrameType::Txt | SwFrameType::NoTxt));
1211}
1212inline bool SwFrame::IsTextFrame() const
1213{
  return mnFrameType == SwFrameType::Txt;
1215}
1216inline bool SwFrame::IsNoTextFrame() const
1217{
  return mnFrameType == SwFrameType::NoTxt;
1219}
1220inline bool SwFrame::IsFlowFrame() const
1221{
  return bool(GetType() & (FRM_CNTNT(SwFrameType::Txt | SwFrameType::NoTxt)|SwFrameType::Tab|SwFrameType::Section));
1223}
1224inline bool SwFrame::IsRetoucheFrame() const
1225{
  return bool(GetType() & (FRM_CNTNT(SwFrameType::Txt | SwFrameType::NoTxt)|SwFrameType::Tab|SwFrameType::Section|SwFrameType::Ftn));
1227}
1228inline bool SwFrame::IsAccessibleFrame() const
1229{
  return bool(GetType() & FRM_ACCESSIBLE(SwFrameType::Root | SwFrameType::Page | SwFrameType::Header |
 SwFrameType::Footer | SwFrameType::Ftn | SwFrameType::Fly | SwFrameType
::Tab | SwFrameType::Cell | SwFrameType::Txt));
1231}

1233//use this to protect a SwFrame for a given scope from getting deleted
1234class SwFrameDeleteGuard
1235{
1236private:
  SwFrame *m_pForbidFrame;
1238public:
  //Flag pFrame for SwFrameDeleteGuard lifetime that we shouldn't delete
  //it in e.g. SwSectionFrame::MergeNext etc because we will need it
  //again after the SwFrameDeleteGuard dtor
  explicit SwFrameDeleteGuard(SwFrame* pFrame)
      : m_pForbidFrame((pFrame && !pFrame->IsDeleteForbidden()) ?
          pFrame : nullptr)
  {
      if (m_pForbidFrame)
          m_pForbidFrame->ForbidDelete();
  }

  SwFrameDeleteGuard(const SwFrameDeleteGuard&) =delete;

  ~SwFrameDeleteGuard()
  {
      if (m_pForbidFrame)
          m_pForbidFrame->AllowDelete();
  }

  SwFrameDeleteGuard& operator=(const SwFrameDeleteGuard&) =delete;
1259};

1261typedef long (SwFrame::*SwFrameGet)() const;
1262typedef bool (SwFrame::*SwFrameMax)( long );
1263typedef void (SwFrame::*SwFrameMakePos)( const SwFrame*, const SwFrame*, bool );
1264typedef long (*SwOperator)( long, long );
1265typedef void (SwFrame::*SwFrameSet)( long, long );

1267struct SwRectFnCollection
1268{
  SwRectGet     fnGetTop;
  SwRectGet     fnGetBottom;
  SwRectGet     fnGetLeft;
  SwRectGet     fnGetRight;
  SwRectGet     fnGetWidth;
  SwRectGet     fnGetHeight;
  SwRectPoint   fnGetPos;
  SwRectSize    fnGetSize;

  SwRectSet     fnSetTop;
  SwRectSet     fnSetBottom;
  SwRectSet     fnSetLeft;
  SwRectSet     fnSetRight;
  SwRectSet     fnSetWidth;
  SwRectSet     fnSetHeight;

  SwRectSet     fnSubTop;
  SwRectSet     fnAddBottom;
  SwRectSet     fnSubLeft;
  SwRectSet     fnAddRight;
  SwRectSet     fnAddWidth;
  SwRectSet     fnAddHeight;

  SwRectSet     fnSetPosX;
  SwRectSet     fnSetPosY;

  SwFrameGet      fnGetTopMargin;
  SwFrameGet      fnGetBottomMargin;
  SwFrameGet      fnGetLeftMargin;
  SwFrameGet      fnGetRightMargin;
  SwFrameSet      fnSetXMargins;
  SwFrameSet      fnSetYMargins;
  SwFrameGet      fnGetPrtTop;
  SwFrameGet      fnGetPrtBottom;
  SwFrameGet      fnGetPrtLeft;
  SwFrameGet      fnGetPrtRight;
  SwRectDist      fnTopDist;
  SwRectDist      fnBottomDist;
  SwRectDist      fnLeftDist;
  SwRectDist      fnRightDist;
  SwFrameMax      fnSetLimit;
  SwRectMax       fnOverStep;

  SwRectSetPos    fnSetPos;
  SwFrameMakePos  fnMakePos;
  SwOperator      fnXDiff;
  SwOperator      fnYDiff;
  SwOperator      fnXInc;
  SwOperator      fnYInc;

  SwRectSetTwice  fnSetLeftAndWidth;
  SwRectSetTwice  fnSetTopAndHeight;
1321};

1323typedef SwRectFnCollection* SwRectFn;

1325// This class allows to use proper methods regardless of orientation (LTR/RTL, horizontal or vertical)
1326extern SwRectFn fnRectHori, fnRectVert, fnRectVertL2R, fnRectVertL2RB2T;
1327class SwRectFnSet {
1328public:
  explicit SwRectFnSet(const SwFrame *pFrame)
      : m_bVert(pFrame->IsVertical())
      , m_bVertL2R(pFrame->IsVertLR())
      , m_bVertL2RB2T(pFrame->IsVertLRBT())
  {
      m_fnRect = m_bVert ? (m_bVertL2R ? (m_bVertL2RB2T ? fnRectVertL2RB2T : fnRectVertL2R) : fnRectVert) : fnRectHori;
  }

  void Refresh(const SwFrame *pFrame)
  {
      m_bVert = pFrame->IsVertical();
      m_bVertL2R = pFrame->IsVertLR();
      m_bVertL2RB2T = pFrame->IsVertLRBT();
      m_fnRect = m_bVert ? (m_bVertL2R ? (m_bVertL2RB2T ? fnRectVertL2RB2T : fnRectVertL2R) : fnRectVert) : fnRectHori;
  }

  bool IsVert() const    { return m_bVert; }
  bool IsVertL2R() const { return m_bVertL2R; }
  SwRectFn FnRect() const { return m_fnRect; }

  bool PosDiff(const SwRect &rRect1, const SwRect &rRect2) const
  {
      return ((rRect1.*m_fnRect->fnGetTop)() != (rRect2.*m_fnRect->fnGetTop)()
          || (rRect1.*m_fnRect->fnGetLeft)() != (rRect2.*m_fnRect->fnGetLeft)());
  }

  long  GetTop   (const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetTop)   (); }
  long  GetBottom(const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetBottom)(); }
  long  GetLeft  (const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetLeft)  (); }
  long  GetRight (const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetRight) (); }
  long  GetWidth (const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetWidth) (); }
  long  GetHeight(const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetHeight)(); }
  Point GetPos   (const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetPos)   (); }
  Size  GetSize  (const SwRect& rRect) const { return (rRect.*m_fnRect->fnGetSize)  (); }

  void SetTop   (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetTop)   (nNew); }
  void SetBottom(SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetBottom)(nNew); }
  void SetLeft  (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetLeft)  (nNew); }
  void SetRight (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetRight) (nNew); }
  void SetWidth (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetWidth) (nNew); }
  void SetHeight(SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetHeight)(nNew); }

  void SubTop   (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSubTop)   (nNew); }
  void AddBottom(SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnAddBottom)(nNew); }
  void SubLeft  (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSubLeft)  (nNew); }
  void AddRight (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnAddRight) (nNew); }
  void AddWidth (SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnAddWidth) (nNew); }
  void AddHeight(SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnAddHeight)(nNew); }

  void SetPosX(SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetPosX)(nNew); }
  void SetPosY(SwRect& rRect, long nNew) const { (rRect.*m_fnRect->fnSetPosY)(nNew); }

  long  GetTopMargin   (const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetTopMargin)   (); }
  long  GetBottomMargin(const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetBottomMargin)(); }
  long  GetLeftMargin  (const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetLeftMargin)  (); }
  long  GetRightMargin (const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetRightMargin) (); }
  void  SetXMargins(SwFrame& rFrame, long nLeft, long nRight) const { (rFrame.*m_fnRect->fnSetXMargins)(nLeft, nRight); }
  void  SetYMargins(SwFrame& rFrame, long nTop, long nBottom) const { (rFrame.*m_fnRect->fnSetYMargins)(nTop, nBottom); }
  long  GetPrtTop      (const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetPrtTop)      (); }
  long  GetPrtBottom   (const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetPrtBottom)   (); }
  long  GetPrtLeft     (const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetPrtLeft)     (); }
  long  GetPrtRight    (const SwFrame& rFrame) const { return (rFrame.*m_fnRect->fnGetPrtRight)    (); }
  long  TopDist   (const SwRect& rRect, long nPos) const { return (rRect.*m_fnRect->fnTopDist)    (nPos); }
  long  BottomDist(const SwRect& rRect, long nPos) const { return (rRect.*m_fnRect->fnBottomDist) (nPos); }
  long  LeftDist   (const SwRect& rRect, long nPos) const { return (rRect.*m_fnRect->fnLeftDist)    (nPos); }
  long  RightDist   (const SwRect& rRect, long nPos) const { return (rRect.*m_fnRect->fnRightDist)    (nPos); }
  void  SetLimit (SwFrame& rFrame, long nNew) const { (rFrame.*m_fnRect->fnSetLimit) (nNew); }
  bool  OverStep  (const SwRect& rRect, long nPos) const { return (rRect.*m_fnRect->fnOverStep)   (nPos); }

  void SetPos(SwRect& rRect, const Point& rNew) const { (rRect.*m_fnRect->fnSetPos)(rNew); }
  void MakePos(SwFrame& rFrame, const SwFrame* pUp, const SwFrame* pPrv, bool bNotify) const { (rFrame.*m_fnRect->fnMakePos)(pUp, pPrv, bNotify); }
  long XDiff(long n1, long n2) const { return (m_fnRect->fnXDiff) (n1, n2); }
  long YDiff(long n1, long n2) const { return (m_fnRect->fnYDiff) (n1, n2); }
  long XInc (long n1, long n2) const { return (m_fnRect->fnXInc)  (n1, n2); }
  long YInc (long n1, long n2) const { return (m_fnRect->fnYInc)  (n1, n2); }

  void SetLeftAndWidth(SwRect& rRect, long nLeft, long nWidth) const { (rRect.*m_fnRect->fnSetLeftAndWidth)(nLeft, nWidth); }
  void SetTopAndHeight(SwRect& rRect, long nTop, long nHeight) const { (rRect.*m_fnRect->fnSetTopAndHeight)(nTop, nHeight); }

1408private:
  bool m_bVert;
  bool m_bVertL2R;
  bool m_bVertL2RB2T;
  SwRectFn m_fnRect;
1413};

1415#endif

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