sw/source/core/layout/layouter.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <memory>
  21 #include <layouter.hxx>
  22 #include <doc.hxx>
  23 #include <sectfrm.hxx>
  24 #include <pagefrm.hxx>
  25 #include <ftnfrm.hxx>
  26 #include <txtfrm.hxx>
  27 #include <IDocumentLayoutAccess.hxx>
  28
  29 #include <movedfwdfrmsbyobjpos.hxx>
  30 #include "objstmpconsiderwrapinfl.hxx"
  31 #include <osl/diagnose.h>
  32
  33 #define LOOP_DETECT 250
  34
  35 class SwLooping
  36 {
  37     sal_uInt16 mnMinPage;
  38     sal_uInt16 mnMaxPage;
  39     sal_uInt16 mnCount;
  40     sal_uInt16 mnLoopControlStage;
  41 public:
  42     explicit SwLooping( SwPageFrame const * pPage );
  43     void Control( SwPageFrame* pPage );
  44     void Drastic( SwFrame* pFrame );
  45     bool IsLoopingLouieLight() const { return mnCount > LOOP_DETECT - 30; };
  46 };
  47
  48 class SwEndnoter
  49 {
  50     SwLayouter*                        m_pMaster;
  51     SwSectionFrame*                    m_pSect;
  52     std::unique_ptr<SwFootnoteFrames>  m_pEndArr;
  53 public:
  54     explicit SwEndnoter( SwLayouter* pLay )
  55         : m_pMaster( pLay ), m_pSect( nullptr ) {}
  56     void CollectEndnotes( SwSectionFrame* pSct );
  57     void CollectEndnote( SwFootnoteFrame* pFootnote );
  58     const SwSectionFrame* GetSect() const { return m_pSect; }
  59     void InsertEndnotes();
  60     bool HasEndnotes() const { return m_pEndArr && !m_pEndArr->empty(); }
  61 };
  62
  63 void SwEndnoter::CollectEndnotes( SwSectionFrame* pSct )
  64 {
  65     OSL_ENSURE( pSct, "CollectEndnotes: Which section?" );
  66     if( !m_pSect )
  67         m_pSect = pSct;
  68     else if( pSct != m_pSect )
  69         return;
  70     m_pSect->CollectEndnotes( m_pMaster );
  71 }
  72
  73 void SwEndnoter::CollectEndnote( SwFootnoteFrame* pFootnote )
  74 {
  75     if( m_pEndArr && m_pEndArr->end() != std::find( m_pEndArr->begin(), m_pEndArr->end(), pFootnote ) )
  76         return;
  77
  78     if( pFootnote->GetUpper() )
  79     {
  80         // pFootnote is the master, he incorporates its follows
  81         SwFootnoteFrame *pNxt = pFootnote->GetFollow();
  82         while ( pNxt )
  83         {
  84             SwFrame *pCnt = pNxt->ContainsAny();
  85             if ( pCnt )
  86             {
  87                 do
  88                 {   SwFrame *pNxtCnt = pCnt->GetNext();
  89                     pCnt->Cut();
  90                     pCnt->Paste( pFootnote );
  91                     pCnt = pNxtCnt;
  92                 } while ( pCnt );
  93             }
  94             else
  95             {
  96 #ifdef DBG_UTIL
  97                 SwFrame* pLower = pNxt->Lower();
  98                 OSL_ENSURE( pLower && pLower->IsSctFrame(),
  99                         "Endnote without content?" );
 100 #endif
 101                 pNxt->Cut();
 102                 SwFrame::DestroyFrame(pNxt);
 103             }
 104             pNxt = pFootnote->GetFollow();
 105         }
 106         if( pFootnote->GetMaster() )
 107             return;
 108         pFootnote->Cut();
 109     }
 110     else if( m_pEndArr )
 111     {
 112         for (SwFootnoteFrame* pEndFootnote : *m_pEndArr)
 113         {
 114             if( pEndFootnote->GetAttr() == pFootnote->GetAttr() )
 115             {
 116                 SwFrame::DestroyFrame(pFootnote);
 117                 return;
 118             }
 119         }
 120     }
 121     if( !m_pEndArr )
 122         m_pEndArr.reset( new SwFootnoteFrames );  // deleted from the SwLayouter
 123     m_pEndArr->push_back( pFootnote );
 124 }
 125
 126 void SwEndnoter::InsertEndnotes()
 127 {
 128     if( !m_pSect )
 129         return;
 130     if( !m_pEndArr || m_pEndArr->empty() )
 131     {
 132         m_pSect = nullptr;
 133         return;
 134     }
 135     SwFrame* pLower = m_pSect->Lower();
 136     OSL_ENSURE( pLower && pLower->IsFootnoteBossFrame(),
 137             "InsertEndnotes: Where's my column?" );
 138     SwFrame* pRef = m_pSect->FindLastContent( SwFindMode::MyLast );
 139     SwFootnoteBossFrame *pBoss = pRef ? pRef->FindFootnoteBossFrame()
 140                                : static_cast<SwFootnoteBossFrame*>(pLower);
 141     pBoss->MoveFootnotes_( *m_pEndArr );
 142     m_pEndArr.reset();
 143     m_pSect = nullptr;
 144 }
 145
 146 SwLooping::SwLooping( SwPageFrame const * pPage )
 147 {
 148     assert(pPage);
 149     mnMinPage = pPage->GetPhyPageNum();
 150     mnMaxPage = mnMinPage;
 151     mnCount = 0;
 152     mnLoopControlStage = 0;
 153 }
 154
 155 void SwLooping::Drastic( SwFrame* pFrame )
 156 {
 157     while( pFrame )
 158     {
 159         pFrame->ValidateThisAndAllLowers( mnLoopControlStage );
 160         pFrame = pFrame->GetNext();
 161     }
 162 }
 163
 164 void SwLooping::Control( SwPageFrame* pPage )
 165 {
 166     if( !pPage )
 167         return;
 168     const sal_uInt16 nNew = pPage->GetPhyPageNum();
 169     if (nNew > mnMaxPage)
 170         mnMaxPage = nNew;
 171     if (nNew < mnMinPage)
 172     {
 173         mnMinPage = nNew;
 174         mnMaxPage = nNew;
 175         mnCount = 0;
 176         mnLoopControlStage = 0;
 177     }
 178     else if (nNew > mnMinPage + 2)
 179     {
 180         mnMinPage = nNew - 2;
 181         mnMaxPage = nNew;
 182         mnCount = 0;
 183         mnLoopControlStage = 0;
 184     }
 185     else if (++mnCount > LOOP_DETECT)
 186     {
 187 #if OSL_DEBUG_LEVEL > 1
 188         static bool bNoLouie = false;
 189         if( bNoLouie )
 190             return;
 191 #endif
 192
 193         // FME 2007-08-30 #i81146# new loop control
 194         SAL_WARN("sw.layout", "Looping Louie: Stage " << (mnLoopControlStage + 1) << "!");
 195
 196         Drastic( pPage->Lower() );
 197         if (nNew > mnMinPage && pPage->GetPrev())
 198             Drastic( static_cast<SwPageFrame*>(pPage->GetPrev())->Lower() );
 199         if (nNew < mnMaxPage && pPage->GetNext())
 200             Drastic( static_cast<SwPageFrame*>(pPage->GetNext())->Lower() );
 201
 202         ++mnLoopControlStage;
 203         mnCount = 0;
 204     }
 205 }
 206
 207 SwLayouter::SwLayouter()
 208 {
 209 }
 210
 211 SwLayouter::~SwLayouter()
 212 {
 213 }
 214
 215 void SwLayouter::CollectEndnotes_( SwSectionFrame* pSect )
 216 {
 217     if( !mpEndnoter )
 218         mpEndnoter.reset(new SwEndnoter( this ));
 219     mpEndnoter->CollectEndnotes( pSect );
 220 }
 221
 222 bool SwLayouter::HasEndnotes() const
 223 {
 224     return mpEndnoter->HasEndnotes();
 225 }
 226
 227 void SwLayouter::CollectEndnote( SwFootnoteFrame* pFootnote )
 228 {
 229     mpEndnoter->CollectEndnote( pFootnote );
 230 }
 231
 232 void SwLayouter::InsertEndnotes( SwSectionFrame const * pSect )
 233 {
 234     if( !mpEndnoter || mpEndnoter->GetSect() != pSect )
 235         return;
 236     mpEndnoter->InsertEndnotes();
 237 }
 238
 239 void SwLayouter::LoopControl( SwPageFrame* pPage )
 240 {
 241     assert(mpLooping);
 242     mpLooping->Control( pPage );
 243 }
 244
 245 void SwLayouter::LoopingLouieLight( const SwDoc& rDoc, const SwTextFrame& rFrame )
 246 {
 247     if ( mpLooping && mpLooping->IsLoopingLouieLight() )
 248     {
 249         SAL_WARN("sw.layout", "Looping Louie (Light): Fixating fractious frame");
 250         SwLayouter::InsertMovedFwdFrame( rDoc, rFrame, rFrame.FindPageFrame()->GetPhyPageNum() );
 251     }
 252 }
 253
 254 bool SwLayouter::StartLooping( SwPageFrame const * pPage )
 255 {
 256     if( mpLooping )
 257         return false;
 258     mpLooping.reset(new SwLooping( pPage ));
 259     return true;
 260 }
 261
 262 void SwLayouter::EndLoopControl()
 263 {
 264     mpLooping.reset();
 265 }
 266
 267 void SwLayouter::CollectEndnotes( SwDoc* pDoc, SwSectionFrame* pSect )
 268 {
 269     assert(pDoc && "No doc, no fun");
 270     if( !pDoc->getIDocumentLayoutAccess().GetLayouter() )
 271         pDoc->getIDocumentLayoutAccess().SetLayouter( new SwLayouter() );
 272     pDoc->getIDocumentLayoutAccess().GetLayouter()->CollectEndnotes_( pSect );
 273 }
 274
 275 bool SwLayouter::Collecting( SwDoc* pDoc, SwSectionFrame const * pSect, SwFootnoteFrame* pFootnote )
 276 {
 277     if( !pDoc->getIDocumentLayoutAccess().GetLayouter() )
 278         return false;
 279     SwLayouter *pLayouter = pDoc->getIDocumentLayoutAccess().GetLayouter();
 280     if( pLayouter->mpEndnoter && pLayouter->mpEndnoter->GetSect() && pSect &&
 281         ( pLayouter->mpEndnoter->GetSect()->IsAnFollow( pSect ) ||
 282           pSect->IsAnFollow( pLayouter->mpEndnoter->GetSect() ) ) )
 283     {
 284         if( pFootnote )
 285             pLayouter->CollectEndnote( pFootnote );
 286         return true;
 287     }
 288     return false;
 289 }
 290
 291 bool SwLayouter::StartLoopControl( SwDoc* pDoc, SwPageFrame const *pPage )
 292 {
 293     assert(pDoc);
 294     if( !pDoc->getIDocumentLayoutAccess().GetLayouter() )
 295         pDoc->getIDocumentLayoutAccess().SetLayouter( new SwLayouter() );
 296     return !pDoc->getIDocumentLayoutAccess().GetLayouter()->mpLooping &&
 297             pDoc->getIDocumentLayoutAccess().GetLayouter()->StartLooping( pPage );
 298 }
 299
 300 // #i28701#
 301 // methods to manage text frames, which are moved forward by the positioning
 302 // of its anchored objects
 303 void SwLayouter::ClearMovedFwdFrames( const SwDoc& _rDoc )
 304 {
 305     if ( _rDoc.getIDocumentLayoutAccess().GetLayouter() &&
 306          _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames )
 307     {
 308         _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames->Clear();
 309     }
 310 }
 311
 312 void SwLayouter::InsertMovedFwdFrame( const SwDoc& _rDoc,
 313                                     const SwTextFrame& _rMovedFwdFrameByObjPos,
 314                                     const sal_uInt32 _nToPageNum )
 315 {
 316     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter() )
 317     {
 318         const_cast<SwDoc&>(_rDoc).getIDocumentLayoutAccess().SetLayouter( new SwLayouter() );
 319     }
 320
 321     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames )
 322     {
 323         const_cast<SwDoc&>(_rDoc).getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames.reset(
 324                                                 new SwMovedFwdFramesByObjPos());
 325     }
 326
 327     _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames->Insert( _rMovedFwdFrameByObjPos,
 328                                                  _nToPageNum );
 329 }
 330
 331 // #i40155#
 332 void SwLayouter::RemoveMovedFwdFrame( const SwDoc& _rDoc,
 333                                     const SwTextFrame& _rTextFrame )
 334 {
 335     sal_uInt32 nDummy;
 336     if ( SwLayouter::FrameMovedFwdByObjPos( _rDoc, _rTextFrame, nDummy ) )
 337     {
 338         _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames->Remove( _rTextFrame );
 339     }
 340 }
 341
 342 bool SwLayouter::FrameMovedFwdByObjPos( const SwDoc& _rDoc,
 343                                       const SwTextFrame& _rTextFrame,
 344                                       sal_uInt32& _ornToPageNum )
 345 {
 346     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter() )
 347     {
 348         _ornToPageNum = 0;
 349         return false;
 350     }
 351     else if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames )
 352     {
 353         _ornToPageNum = 0;
 354         return false;
 355     }
 356     else
 357     {
 358         return _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames->
 359                                 FrameMovedFwdByObjPos( _rTextFrame, _ornToPageNum );
 360     }
 361 }
 362
 363 // #i26945#
 364 bool SwLayouter::DoesRowContainMovedFwdFrame( const SwDoc& _rDoc,
 365                                             const SwRowFrame& _rRowFrame )
 366 {
 367     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter() )
 368     {
 369         return false;
 370     }
 371     else if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter()->mpMovedFwdFrames )
 372     {
 373         return false;
 374     }
 375     else
 376     {
 377         return _rDoc.getIDocumentLayoutAccess().GetLayouter()->
 378                         mpMovedFwdFrames->DoesRowContainMovedFwdFrame( _rRowFrame );
 379     }
 380 }
 381
 382 // #i35911#
 383 void SwLayouter::ClearObjsTmpConsiderWrapInfluence( const SwDoc& _rDoc )
 384 {
 385     if ( _rDoc.getIDocumentLayoutAccess().GetLayouter() &&
 386          _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpObjsTmpConsiderWrapInfl )
 387     {
 388         _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpObjsTmpConsiderWrapInfl->Clear();
 389     }
 390 }
 391
 392 void SwLayouter::InsertObjForTmpConsiderWrapInfluence(
 393                                             const SwDoc& _rDoc,
 394                                             SwAnchoredObject& _rAnchoredObj )
 395 {
 396     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter() )
 397     {
 398         const_cast<SwDoc&>(_rDoc).getIDocumentLayoutAccess().SetLayouter( new SwLayouter() );
 399     }
 400
 401     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter()->mpObjsTmpConsiderWrapInfl )
 402     {
 403         const_cast<SwDoc&>(_rDoc).getIDocumentLayoutAccess().GetLayouter()->mpObjsTmpConsiderWrapInfl.reset(
 404                                 new SwObjsMarkedAsTmpConsiderWrapInfluence());
 405     }
 406
 407     _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpObjsTmpConsiderWrapInfl->Insert( _rAnchoredObj );
 408 }
 409
 410 void SwLayouter::RemoveObjForTmpConsiderWrapInfluence(
 411                                             const SwDoc& _rDoc,
 412                                             SwAnchoredObject& _rAnchoredObj )
 413 {
 414     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter() )
 415         return;
 416
 417     if ( !_rDoc.getIDocumentLayoutAccess().GetLayouter()->mpObjsTmpConsiderWrapInfl )
 418         return;
 419
 420     _rDoc.getIDocumentLayoutAccess().GetLayouter()->mpObjsTmpConsiderWrapInfl->Remove( _rAnchoredObj );
 421 }
 422
 423
 424 void LOOPING_LOUIE_LIGHT( bool bCondition, const SwTextFrame& rTextFrame )
 425 {
 426     if ( bCondition )
 427     {
 428         const SwDoc& rDoc = *rTextFrame.GetAttrSet()->GetDoc();
 429         if ( rDoc.getIDocumentLayoutAccess().GetLayouter() )
 430         {
 431             const_cast<SwDoc&>(rDoc).getIDocumentLayoutAccess().GetLayouter()->LoopingLouieLight( rDoc, rTextFrame );
 432         }
 433     }
 434 }
 435
 436 // #i65250#
 437 bool SwLayouter::MoveBwdSuppressed( const SwDoc& p_rDoc,
 438                                     const SwFlowFrame& p_rFlowFrame,
 439                                     const SwLayoutFrame& p_rNewUpperFrame )
 440 {
 441     bool bMoveBwdSuppressed( false );
 442
 443     if ( !p_rDoc.getIDocumentLayoutAccess().GetLayouter() )
 444     {
 445         const_cast<SwDoc&>(p_rDoc).getIDocumentLayoutAccess().SetLayouter( new SwLayouter() );
 446     }
 447
 448     // create hash map key
 449     tMoveBwdLayoutInfoKey aMoveBwdLayoutInfo;
 450     aMoveBwdLayoutInfo.mnFrameId = p_rFlowFrame.GetFrame().GetFrameId();
 451     aMoveBwdLayoutInfo.mnNewUpperPosX = p_rNewUpperFrame.getFrameArea().Pos().X();
 452     aMoveBwdLayoutInfo.mnNewUpperPosY = p_rNewUpperFrame.getFrameArea().Pos().Y();
 453     aMoveBwdLayoutInfo.mnNewUpperWidth = p_rNewUpperFrame.getFrameArea().Width();
 454     aMoveBwdLayoutInfo.mnNewUpperHeight =  p_rNewUpperFrame.getFrameArea().Height();
 455     SwRectFnSet aRectFnSet(&p_rNewUpperFrame);
 456     const SwFrame* pLastLower( p_rNewUpperFrame.Lower() );
 457     while ( pLastLower && pLastLower->GetNext() )
 458     {
 459         pLastLower = pLastLower->GetNext();
 460     }
 461     aMoveBwdLayoutInfo.mnFreeSpaceInNewUpper =
 462             pLastLower
 463             ? aRectFnSet.BottomDist( pLastLower->getFrameArea(), aRectFnSet.GetPrtBottom(p_rNewUpperFrame) )
 464             : aRectFnSet.GetHeight(p_rNewUpperFrame.getFrameArea());
 465
 466     // check for moving backward suppress threshold
 467     const sal_uInt16 cMoveBwdCountSuppressThreshold = 20;
 468     if ( ++const_cast<SwDoc&>(p_rDoc).getIDocumentLayoutAccess().GetLayouter()->maMoveBwdLayoutInfo[ aMoveBwdLayoutInfo ] >
 469                                                 cMoveBwdCountSuppressThreshold )
 470     {
 471         bMoveBwdSuppressed = true;
 472     }
 473
 474     return bMoveBwdSuppressed;
 475 }
 476
 477 void SwLayouter::ClearMoveBwdLayoutInfo( const SwDoc& _rDoc )
 478 {
 479     if ( _rDoc.getIDocumentLayoutAccess().GetLayouter() )
 480         const_cast<SwDoc&>(_rDoc).getIDocumentLayoutAccess().GetLayouter()->maMoveBwdLayoutInfo.clear();
 481 }
 482
 483 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */