sw/source/core/layout/layouter.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: layouter.cxx,v $
  10  * $Revision: 1.17 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sw.hxx"
  33
  34
  35
  36 #include "layouter.hxx"
  37 #include "doc.hxx"
  38 #include "sectfrm.hxx"
  39 #include "ftnboss.hxx"
  40 #include "cntfrm.hxx"
  41 #include "pagefrm.hxx"
  42 #include "ftnfrm.hxx"
  43 #include "txtfrm.hxx"
  44
  45 // --> OD 2004-06-23 #i28701#
  46 #include <movedfwdfrmsbyobjpos.hxx>
  47 // <--
  48 // --> OD 2004-10-22 #i35911#
  49 #include <objstmpconsiderwrapinfl.hxx>
  50 // <--
  51
  52 #define LOOP_DETECT 250
  53
  54 class SwLooping
  55 {
  56     USHORT nMinPage;
  57     USHORT nMaxPage;
  58     USHORT nCount;
  59     USHORT mnLoopControlStage;
  60 public:
  61     SwLooping( SwPageFrm* pPage );
  62     void Control( SwPageFrm* pPage );
  63     void Drastic( SwFrm* pFrm );
  64     bool IsLoopingLouieLight() const { return nCount > LOOP_DETECT - 30; };
  65 };
  66
  67 class SwEndnoter
  68 {
  69     SwLayouter* pMaster;
  70     SwSectionFrm* pSect;
  71     SvPtrarr* pEndArr;
  72 public:
  73     SwEndnoter( SwLayouter* pLay )
  74         : pMaster( pLay ), pSect( NULL ), pEndArr( NULL ) {}
  75     ~SwEndnoter() { delete pEndArr;     }
  76     void CollectEndnotes( SwSectionFrm* pSct );
  77     void CollectEndnote( SwFtnFrm* pFtn );
  78     const SwSectionFrm* GetSect() {     return pSect; }
  79     void InsertEndnotes();
  80     BOOL HasEndnotes() const { return pEndArr && pEndArr->Count(); }
  81 };
  82
  83 void SwEndnoter::CollectEndnotes( SwSectionFrm* pSct )
  84 {
  85     ASSERT( pSct, "CollectEndnotes: Which section?" );
  86     if( !pSect )
  87         pSect = pSct;
  88     else if( pSct != pSect )
  89         return;
  90     pSect->CollectEndnotes( pMaster );
  91 }
  92
  93 void SwEndnoter::CollectEndnote( SwFtnFrm* pFtn )
  94 {
  95     if( pEndArr && USHRT_MAX != pEndArr->GetPos( (VoidPtr)pFtn ) )
  96         return;
  97
  98     if( pFtn->GetUpper() )
  99     {
 100         // pFtn is the master, he incorporates its follows
 101         SwFtnFrm *pNxt = pFtn->GetFollow();
 102         while ( pNxt )
 103         {
 104             SwFrm *pCnt = pNxt->ContainsAny();
 105             if ( pCnt )
 106             {
 107                 do
 108                 {       SwFrm *pNxtCnt = pCnt->GetNext();
 109                     pCnt->Cut();
 110                     pCnt->Paste( pFtn );
 111                     pCnt = pNxtCnt;
 112                 } while ( pCnt );
 113             }
 114             else
 115             {   ASSERT( pNxt->Lower() && pNxt->Lower()->IsSctFrm(),
 116                         "Endnote without content?" );
 117                 pNxt->Cut();
 118                 delete pNxt;
 119             }
 120             pNxt = pFtn->GetFollow();
 121         }
 122         if( pFtn->GetMaster() )
 123             return;
 124         pFtn->Cut();
 125     }
 126     else if( pEndArr )
 127     {
 128         for ( USHORT i = 0; i < pEndArr->Count(); ++i )
 129         {
 130             SwFtnFrm *pEndFtn = (SwFtnFrm*)((*pEndArr)[i]);
 131             if( pEndFtn->GetAttr() == pFtn->GetAttr() )
 132             {
 133                 delete pFtn;
 134                 return;
 135             }
 136         }
 137     }
 138     if( !pEndArr )
 139         pEndArr = new SvPtrarr( 5, 5 );  // deleted from the SwLayouter
 140     pEndArr->Insert( (VoidPtr)pFtn, pEndArr->Count() );
 141 }
 142
 143 void SwEndnoter::InsertEndnotes()
 144 {
 145     if( !pSect )
 146         return;
 147     if( !pEndArr || !pEndArr->Count() )
 148     {
 149         pSect = NULL;
 150         return;
 151     }
 152     ASSERT( pSect->Lower() && pSect->Lower()->IsFtnBossFrm(),
 153             "InsertEndnotes: Where's my column?" );
 154     SwFrm* pRef = pSect->FindLastCntnt( FINDMODE_MYLAST );
 155     SwFtnBossFrm *pBoss = pRef ? pRef->FindFtnBossFrm()
 156                                : (SwFtnBossFrm*)pSect->Lower();
 157     pBoss->_MoveFtns( *pEndArr );
 158     delete pEndArr;
 159     pEndArr = NULL;
 160     pSect = NULL;
 161 }
 162
 163 SwLooping::SwLooping( SwPageFrm* pPage )
 164 {
 165     ASSERT( pPage, "Where's my page?" );
 166     nMinPage = pPage->GetPhyPageNum();
 167     nMaxPage = nMinPage;
 168     nCount = 0;
 169     mnLoopControlStage = 0;
 170 }
 171
 172 void SwLooping::Drastic( SwFrm* pFrm )
 173 {
 174     while( pFrm )
 175     {
 176         pFrm->ValidateThisAndAllLowers( mnLoopControlStage );
 177         pFrm = pFrm->GetNext();
 178     }
 179 }
 180
 181 void SwLooping::Control( SwPageFrm* pPage )
 182 {
 183     if( !pPage )
 184         return;
 185     USHORT nNew = pPage->GetPhyPageNum();
 186     if( nNew > nMaxPage )
 187         nMaxPage = nNew;
 188     if( nNew < nMinPage )
 189     {
 190         nMinPage = nNew;
 191         nMaxPage = nNew;
 192         nCount = 0;
 193         mnLoopControlStage = 0;
 194     }
 195     else if( nNew > nMinPage + 2 )
 196     {
 197         nMinPage = nNew - 2;
 198         nMaxPage = nNew;
 199         nCount = 0;
 200         mnLoopControlStage = 0;
 201     }
 202     else if( ++nCount > LOOP_DETECT )
 203     {
 204 #ifndef PRODUCT
 205 #if OSL_DEBUG_LEVEL > 1
 206         static BOOL bNoLouie = FALSE;
 207         if( bNoLouie )
 208             return;
 209 #endif
 210 #endif
 211
 212         // FME 2007-08-30 #i81146# new loop control
 213 #if OSL_DEBUG_LEVEL > 1
 214         ASSERT( 0 != mnLoopControlStage, "Looping Louie: Stage 1!" );
 215         ASSERT( 1 != mnLoopControlStage, "Looping Louie: Stage 2!!" );
 216         ASSERT( 2 >  mnLoopControlStage, "Looping Louie: Stage 3!!!" );
 217 #endif
 218
 219         Drastic( pPage->Lower() );
 220         if( nNew > nMinPage && pPage->GetPrev() )
 221             Drastic( ((SwPageFrm*)pPage->GetPrev())->Lower() );
 222         if( nNew < nMaxPage && pPage->GetNext() )
 223             Drastic( ((SwPageFrm*)pPage->GetNext())->Lower() );
 224
 225         ++mnLoopControlStage;
 226         nCount = 0;
 227     }
 228 }
 229
 230 /*************************************************************************
 231 |*
 232 |*      SwLayouter::SwLayouter()
 233 |*
 234 |*      Ersterstellung          AMA 02. Nov. 99
 235 |*      Letzte Aenderung        AMA 02. Nov. 99
 236 |*
 237 |*************************************************************************/
 238
 239 SwLayouter::SwLayouter()
 240         : pEndnoter( NULL ),
 241           pLooping( NULL ),
 242           // --> OD 2004-06-23 #i28701#
 243           mpMovedFwdFrms( 0L ),
 244           // <--
 245           // --> OD 2004-10-22 #i35911#
 246           mpObjsTmpConsiderWrapInfl( 0L )
 247           // <--
 248 {
 249 }
 250
 251 SwLayouter::~SwLayouter()
 252 {
 253     delete pEndnoter;
 254     delete pLooping;
 255     // --> OD 2004-06-23 #i28701#
 256     delete mpMovedFwdFrms;
 257     mpMovedFwdFrms = 0L;
 258     // <--
 259     // --> OD 2004-10-22 #i35911#
 260     delete mpObjsTmpConsiderWrapInfl;
 261     mpObjsTmpConsiderWrapInfl = 0L;
 262     // <--
 263 }
 264
 265 void SwLayouter::_CollectEndnotes( SwSectionFrm* pSect )
 266 {
 267     if( !pEndnoter )
 268         pEndnoter = new SwEndnoter( this );
 269     pEndnoter->CollectEndnotes( pSect );
 270 }
 271
 272 BOOL SwLayouter::HasEndnotes() const
 273 {
 274     return pEndnoter->HasEndnotes();
 275 }
 276
 277 void SwLayouter::CollectEndnote( SwFtnFrm* pFtn )
 278 {
 279     pEndnoter->CollectEndnote( pFtn );
 280 }
 281
 282 void SwLayouter::InsertEndnotes( SwSectionFrm* pSect )
 283 {
 284     if( !pEndnoter || pEndnoter->GetSect() != pSect )
 285         return;
 286     pEndnoter->InsertEndnotes();
 287 }
 288
 289 void SwLayouter::LoopControl( SwPageFrm* pPage, BYTE )
 290 {
 291     ASSERT( pLooping, "Looping: Lost control" );
 292     pLooping->Control( pPage );
 293 }
 294
 295 void SwLayouter::LoopingLouieLight( const SwDoc& rDoc, const SwTxtFrm& rFrm )
 296 {
 297     if ( pLooping && pLooping->IsLoopingLouieLight() )
 298     {
 299 #if OSL_DEBUG_LEVEL > 1
 300         ASSERT( false, "Looping Louie (Light): Fixating fractious frame" )
 301 #endif
 302         SwLayouter::InsertMovedFwdFrm( rDoc, rFrm, rFrm.FindPageFrm()->GetPhyPageNum() );
 303     }
 304 }
 305
 306 BOOL SwLayouter::StartLooping( SwPageFrm* pPage )
 307 {
 308     if( pLooping )
 309         return FALSE;
 310     pLooping = new SwLooping( pPage );
 311     return TRUE;
 312 }
 313
 314 void SwLayouter::EndLoopControl()
 315 {
 316     delete pLooping;
 317     pLooping = NULL;
 318 }
 319
 320 void SwLayouter::CollectEndnotes( SwDoc* pDoc, SwSectionFrm* pSect )
 321 {
 322     ASSERT( pDoc, "No doc, no fun" );
 323     if( !pDoc->GetLayouter() )
 324         pDoc->SetLayouter( new SwLayouter() );
 325     pDoc->GetLayouter()->_CollectEndnotes( pSect );
 326 }
 327
 328 BOOL SwLayouter::Collecting( SwDoc* pDoc, SwSectionFrm* pSect, SwFtnFrm* pFtn )
 329 {
 330     if( !pDoc->GetLayouter() )
 331         return FALSE;
 332     SwLayouter *pLayouter = pDoc->GetLayouter();
 333     if( pLayouter->pEndnoter && pLayouter->pEndnoter->GetSect() && pSect &&
 334         ( pLayouter->pEndnoter->GetSect()->IsAnFollow( pSect ) ||
 335           pSect->IsAnFollow( pLayouter->pEndnoter->GetSect() ) ) )
 336     {
 337         if( pFtn )
 338             pLayouter->CollectEndnote( pFtn );
 339         return TRUE;
 340     }
 341     return FALSE;
 342 }
 343
 344 BOOL SwLayouter::StartLoopControl( SwDoc* pDoc, SwPageFrm *pPage )
 345 {
 346     ASSERT( pDoc, "No doc, no fun" );
 347     if( !pDoc->GetLayouter() )
 348         pDoc->SetLayouter( new SwLayouter() );
 349     return !pDoc->GetLayouter()->pLooping &&
 350             pDoc->GetLayouter()->StartLooping( pPage );
 351 }
 352
 353 // --> OD 2004-06-23 #i28701#
 354 // -----------------------------------------------------------------------------
 355 // methods to manage text frames, which are moved forward by the positioning
 356 // of its anchored objects
 357 // -----------------------------------------------------------------------------
 358 void SwLayouter::ClearMovedFwdFrms( const SwDoc& _rDoc )
 359 {
 360     if ( _rDoc.GetLayouter() &&
 361          _rDoc.GetLayouter()->mpMovedFwdFrms )
 362     {
 363         _rDoc.GetLayouter()->mpMovedFwdFrms->Clear();
 364     }
 365 }
 366
 367 void SwLayouter::InsertMovedFwdFrm( const SwDoc& _rDoc,
 368                                     const SwTxtFrm& _rMovedFwdFrmByObjPos,
 369                                     const sal_uInt32 _nToPageNum )
 370 {
 371     if ( !_rDoc.GetLayouter() )
 372     {
 373         const_cast<SwDoc&>(_rDoc).SetLayouter( new SwLayouter() );
 374     }
 375
 376     if ( !_rDoc.GetLayouter()->mpMovedFwdFrms )
 377     {
 378         const_cast<SwDoc&>(_rDoc).GetLayouter()->mpMovedFwdFrms =
 379                                                 new SwMovedFwdFrmsByObjPos();
 380     }
 381
 382     _rDoc.GetLayouter()->mpMovedFwdFrms->Insert( _rMovedFwdFrmByObjPos,
 383                                                  _nToPageNum );
 384 }
 385
 386 // --> OD 2005-01-12 #i40155#
 387 void SwLayouter::RemoveMovedFwdFrm( const SwDoc& _rDoc,
 388                                     const SwTxtFrm& _rTxtFrm )
 389 {
 390     sal_uInt32 nDummy;
 391     if ( SwLayouter::FrmMovedFwdByObjPos( _rDoc, _rTxtFrm, nDummy ) )
 392     {
 393         _rDoc.GetLayouter()->mpMovedFwdFrms->Remove( _rTxtFrm );
 394     }
 395 }
 396 // <--
 397
 398 bool SwLayouter::FrmMovedFwdByObjPos( const SwDoc& _rDoc,
 399                                       const SwTxtFrm& _rTxtFrm,
 400                                       sal_uInt32& _ornToPageNum )
 401 {
 402     if ( !_rDoc.GetLayouter() )
 403     {
 404         _ornToPageNum = 0;
 405         return false;
 406     }
 407     else if ( !_rDoc.GetLayouter()->mpMovedFwdFrms )
 408     {
 409         _ornToPageNum = 0;
 410         return false;
 411     }
 412     else
 413     {
 414         return _rDoc.GetLayouter()->mpMovedFwdFrms->
 415                                 FrmMovedFwdByObjPos( _rTxtFrm, _ornToPageNum );
 416     }
 417 }
 418 // <--
 419 // --> OD 2004-10-05 #i26945#
 420 bool SwLayouter::DoesRowContainMovedFwdFrm( const SwDoc& _rDoc,
 421                                             const SwRowFrm& _rRowFrm )
 422 {
 423     if ( !_rDoc.GetLayouter() )
 424     {
 425         return false;
 426     }
 427     else if ( !_rDoc.GetLayouter()->mpMovedFwdFrms )
 428     {
 429         return false;
 430     }
 431     else
 432     {
 433         return _rDoc.GetLayouter()->
 434                         mpMovedFwdFrms->DoesRowContainMovedFwdFrm( _rRowFrm );
 435     }
 436 }
 437 // <--
 438
 439 // --> OD 2004-10-22 #i35911#
 440 void SwLayouter::ClearObjsTmpConsiderWrapInfluence( const SwDoc& _rDoc )
 441 {
 442     if ( _rDoc.GetLayouter() &&
 443          _rDoc.GetLayouter()->mpObjsTmpConsiderWrapInfl )
 444     {
 445         _rDoc.GetLayouter()->mpObjsTmpConsiderWrapInfl->Clear();
 446     }
 447 }
 448 void SwLayouter::InsertObjForTmpConsiderWrapInfluence(
 449                                             const SwDoc& _rDoc,
 450                                             SwAnchoredObject& _rAnchoredObj )
 451 {
 452     if ( !_rDoc.GetLayouter() )
 453     {
 454         const_cast<SwDoc&>(_rDoc).SetLayouter( new SwLayouter() );
 455     }
 456
 457     if ( !_rDoc.GetLayouter()->mpObjsTmpConsiderWrapInfl )
 458     {
 459         const_cast<SwDoc&>(_rDoc).GetLayouter()->mpObjsTmpConsiderWrapInfl =
 460                                 new SwObjsMarkedAsTmpConsiderWrapInfluence();
 461     }
 462
 463     _rDoc.GetLayouter()->mpObjsTmpConsiderWrapInfl->Insert( _rAnchoredObj );
 464 }
 465 // <--
 466 // --> OD 2005-01-12 #i40155#
 467 void SwLayouter::ClearFrmsNotToWrap( const SwDoc& _rDoc )
 468 {
 469     if ( _rDoc.GetLayouter() )
 470     {
 471         const_cast<SwDoc&>(_rDoc).GetLayouter()->maFrmsNotToWrap.clear();
 472     }
 473 }
 474
 475 void SwLayouter::InsertFrmNotToWrap( const SwDoc& _rDoc,
 476                                              const SwFrm& _rFrm )
 477 {
 478     if ( !_rDoc.GetLayouter() )
 479     {
 480         const_cast<SwDoc&>(_rDoc).SetLayouter( new SwLayouter() );
 481     }
 482
 483     if ( !SwLayouter::FrmNotToWrap( _rDoc, _rFrm ) )
 484     {
 485         const_cast<SwDoc&>(_rDoc).GetLayouter()->maFrmsNotToWrap.push_back( &_rFrm );
 486     }
 487 }
 488
 489 bool SwLayouter::FrmNotToWrap( const IDocumentLayoutAccess& _rDLA,
 490                                const SwFrm& _rFrm )
 491 {
 492     const SwLayouter* pLayouter = _rDLA.GetLayouter();
 493     if ( !pLayouter )
 494     {
 495         return false;
 496     }
 497     else
 498     {
 499         bool bFrmNotToWrap( false );
 500         std::vector< const SwFrm* >::const_iterator aIter =
 501                             pLayouter->maFrmsNotToWrap.begin();
 502         for ( ; aIter != pLayouter->maFrmsNotToWrap.end(); ++aIter )
 503         {
 504             const SwFrm* pFrm = *(aIter);
 505             if ( pFrm == &_rFrm )
 506             {
 507                 bFrmNotToWrap = true;
 508                 break;
 509             }
 510         }
 511         return bFrmNotToWrap;
 512     }
 513 }
 514 // <--
 515
 516 void LOOPING_LOUIE_LIGHT( bool bCondition, const SwTxtFrm& rTxtFrm )
 517 {
 518     if ( bCondition )
 519     {
 520         const SwDoc& rDoc = *rTxtFrm.GetAttrSet()->GetDoc();
 521         if ( rDoc.GetLayouter() )
 522         {
 523             const_cast<SwDoc&>(rDoc).GetLayouter()->LoopingLouieLight( rDoc, rTxtFrm );
 524         }
 525     }
 526 }
 527
 528 // --> OD 2006-05-10 #i65250#
 529 bool SwLayouter::MoveBwdSuppressed( const SwDoc& p_rDoc,
 530                                     const SwFlowFrm& p_rFlowFrm,
 531                                     const SwLayoutFrm& p_rNewUpperFrm )
 532 {
 533     bool bMoveBwdSuppressed( false );
 534
 535     if ( !p_rDoc.GetLayouter() )
 536     {
 537         const_cast<SwDoc&>(p_rDoc).SetLayouter( new SwLayouter() );
 538     }
 539
 540     // create hash map key
 541     tMoveBwdLayoutInfoKey aMoveBwdLayoutInfo;
 542     aMoveBwdLayoutInfo.mnFrmId = p_rFlowFrm.GetFrm()->GetFrmId();
 543     aMoveBwdLayoutInfo.mnNewUpperPosX = p_rNewUpperFrm.Frm().Pos().X();
 544     aMoveBwdLayoutInfo.mnNewUpperPosY = p_rNewUpperFrm.Frm().Pos().Y();
 545     aMoveBwdLayoutInfo.mnNewUpperWidth = p_rNewUpperFrm.Frm().Width();
 546     aMoveBwdLayoutInfo.mnNewUpperHeight =  p_rNewUpperFrm.Frm().Height();
 547     SWRECTFN( (&p_rNewUpperFrm) )
 548     const SwFrm* pLastLower( p_rNewUpperFrm.Lower() );
 549     while ( pLastLower && pLastLower->GetNext() )
 550     {
 551         pLastLower = pLastLower->GetNext();
 552     }
 553     aMoveBwdLayoutInfo.mnFreeSpaceInNewUpper =
 554             pLastLower
 555             ? (pLastLower->Frm().*fnRect->fnBottomDist)( (p_rNewUpperFrm.*fnRect->fnGetPrtBottom)() )
 556             : (p_rNewUpperFrm.Frm().*fnRect->fnGetHeight)();
 557
 558     // check for moving backward suppress threshold
 559     const sal_uInt16 cMoveBwdCountSuppressThreshold = 20;
 560     if ( ++const_cast<SwDoc&>(p_rDoc).GetLayouter()->maMoveBwdLayoutInfo[ aMoveBwdLayoutInfo ] >
 561                                                 cMoveBwdCountSuppressThreshold )
 562     {
 563         bMoveBwdSuppressed = true;
 564     }
 565
 566     return bMoveBwdSuppressed;
 567 }
 568
 569 void SwLayouter::ClearMoveBwdLayoutInfo( const SwDoc& _rDoc )
 570 {
 571     if ( _rDoc.GetLayouter() )
 572         const_cast<SwDoc&>(_rDoc).GetLayouter()->maMoveBwdLayoutInfo.clear();
 573 }
 574 // <--