Line data Source code
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 <objectformattertxtfrm.hxx>
21 : #include <objectformatterlayfrm.hxx>
22 : #include <anchoreddrawobject.hxx>
23 : #include <sortedobjs.hxx>
24 : #include <pagefrm.hxx>
25 : #include <flyfrms.hxx>
26 : #include <txtfrm.hxx>
27 : #include <layact.hxx>
28 : #include <fmtanchr.hxx>
29 : #include <doc.hxx>
30 :
31 : #include <vector>
32 :
33 : // --> #i26945# - Additionally the type of the anchor text frame
34 : // is collected - by type is meant 'master' or 'follow'.
35 : class SwPageNumAndTypeOfAnchors
36 : {
37 : private:
38 : struct tEntry
39 : {
40 : SwAnchoredObject* mpAnchoredObj;
41 : sal_uInt32 mnPageNumOfAnchor;
42 : bool mbAnchoredAtMaster;
43 : };
44 :
45 : std::vector< tEntry* > maObjList;
46 :
47 : public:
48 0 : inline SwPageNumAndTypeOfAnchors()
49 0 : {
50 0 : }
51 0 : inline ~SwPageNumAndTypeOfAnchors()
52 0 : {
53 0 : for ( std::vector< tEntry* >::iterator aIter = maObjList.begin();
54 0 : aIter != maObjList.end(); ++aIter )
55 : {
56 0 : delete (*aIter);
57 : }
58 0 : maObjList.clear();
59 0 : }
60 :
61 0 : inline void Collect( SwAnchoredObject& _rAnchoredObj )
62 : {
63 0 : tEntry* pNewEntry = new tEntry();
64 0 : pNewEntry->mpAnchoredObj = &_rAnchoredObj;
65 : // #i33751#, #i34060# - method <GetPageFrmOfAnchor()>
66 : // is replaced by method <FindPageFrmOfAnchor()>. It's return value
67 : // have to be checked.
68 0 : SwPageFrm* pPageFrmOfAnchor = _rAnchoredObj.FindPageFrmOfAnchor();
69 0 : if ( pPageFrmOfAnchor )
70 : {
71 0 : pNewEntry->mnPageNumOfAnchor = pPageFrmOfAnchor->GetPhyPageNum();
72 : }
73 : else
74 : {
75 0 : pNewEntry->mnPageNumOfAnchor = 0;
76 : }
77 : // --> #i26945# - collect type of anchor
78 0 : SwTxtFrm* pAnchorCharFrm = _rAnchoredObj.FindAnchorCharFrm();
79 0 : if ( pAnchorCharFrm )
80 : {
81 0 : pNewEntry->mbAnchoredAtMaster = !pAnchorCharFrm->IsFollow();
82 : }
83 : else
84 : {
85 0 : pNewEntry->mbAnchoredAtMaster = true;
86 : }
87 0 : maObjList.push_back( pNewEntry );
88 0 : }
89 :
90 0 : inline SwAnchoredObject* operator[]( sal_uInt32 _nIndex )
91 : {
92 0 : SwAnchoredObject* bRetObj = 0L;
93 :
94 0 : if ( _nIndex < Count())
95 : {
96 0 : bRetObj = maObjList[_nIndex]->mpAnchoredObj;
97 : }
98 :
99 0 : return bRetObj;
100 : }
101 :
102 0 : inline sal_uInt32 GetPageNum( sal_uInt32 _nIndex ) const
103 : {
104 0 : sal_uInt32 nRetPgNum = 0L;
105 :
106 0 : if ( _nIndex < Count())
107 : {
108 0 : nRetPgNum = maObjList[_nIndex]->mnPageNumOfAnchor;
109 : }
110 :
111 0 : return nRetPgNum;
112 : }
113 :
114 : // --> #i26945#
115 0 : inline bool AnchoredAtMaster( sal_uInt32 _nIndex )
116 : {
117 0 : bool bAnchoredAtMaster( true );
118 :
119 0 : if ( _nIndex < Count())
120 : {
121 0 : bAnchoredAtMaster = maObjList[_nIndex]->mbAnchoredAtMaster;
122 : }
123 :
124 0 : return bAnchoredAtMaster;
125 : }
126 :
127 0 : inline sal_uInt32 Count() const
128 : {
129 0 : return maObjList.size();
130 : }
131 : };
132 :
133 0 : SwObjectFormatter::SwObjectFormatter( const SwPageFrm& _rPageFrm,
134 : SwLayAction* _pLayAction,
135 : const bool _bCollectPgNumOfAnchors )
136 : : mrPageFrm( _rPageFrm ),
137 : mbFormatOnlyAsCharAnchored( false ),
138 0 : mbConsiderWrapOnObjPos( _rPageFrm.GetFmt()->getIDocumentSettingAccess()->get(IDocumentSettingAccess::CONSIDER_WRAP_ON_OBJECT_POSITION) ),
139 : mpLayAction( _pLayAction ),
140 : // --> #i26945#
141 0 : mpPgNumAndTypeOfAnchors( _bCollectPgNumOfAnchors ? new SwPageNumAndTypeOfAnchors() : 0L )
142 : {
143 0 : }
144 :
145 0 : SwObjectFormatter::~SwObjectFormatter()
146 : {
147 0 : delete mpPgNumAndTypeOfAnchors;
148 0 : }
149 :
150 0 : SwObjectFormatter* SwObjectFormatter::CreateObjFormatter(
151 : SwFrm& _rAnchorFrm,
152 : const SwPageFrm& _rPageFrm,
153 : SwLayAction* _pLayAction )
154 : {
155 0 : SwObjectFormatter* pObjFormatter = 0L;
156 0 : if ( _rAnchorFrm.IsTxtFrm() )
157 : {
158 : pObjFormatter = SwObjectFormatterTxtFrm::CreateObjFormatter(
159 : static_cast<SwTxtFrm&>(_rAnchorFrm),
160 0 : _rPageFrm, _pLayAction );
161 : }
162 0 : else if ( _rAnchorFrm.IsLayoutFrm() )
163 : {
164 : pObjFormatter = SwObjectFormatterLayFrm::CreateObjFormatter(
165 : static_cast<SwLayoutFrm&>(_rAnchorFrm),
166 0 : _rPageFrm, _pLayAction );
167 : }
168 : else
169 : {
170 : OSL_FAIL( "<SwObjectFormatter::CreateObjFormatter(..)> - unexcepted type of anchor frame" );
171 : }
172 :
173 0 : return pObjFormatter;
174 : }
175 :
176 : /** method to format all floating screen objects at the given anchor frame
177 : */
178 0 : bool SwObjectFormatter::FormatObjsAtFrm( SwFrm& _rAnchorFrm,
179 : const SwPageFrm& _rPageFrm,
180 : SwLayAction* _pLayAction )
181 : {
182 0 : bool bSuccess( true );
183 :
184 : // create corresponding object formatter
185 : SwObjectFormatter* pObjFormatter =
186 0 : SwObjectFormatter::CreateObjFormatter( _rAnchorFrm, _rPageFrm, _pLayAction );
187 :
188 0 : if ( pObjFormatter )
189 : {
190 : // format anchored floating screen objects
191 0 : bSuccess = pObjFormatter->DoFormatObjs();
192 : }
193 0 : delete pObjFormatter;
194 :
195 0 : return bSuccess;
196 : }
197 :
198 : /** method to format a given floating screen object
199 : */
200 0 : bool SwObjectFormatter::FormatObj( SwAnchoredObject& _rAnchoredObj,
201 : SwFrm* _pAnchorFrm,
202 : const SwPageFrm* _pPageFrm,
203 : SwLayAction* _pLayAction )
204 : {
205 0 : bool bSuccess( true );
206 :
207 : OSL_ENSURE( _pAnchorFrm || _rAnchoredObj.GetAnchorFrm(),
208 : "<SwObjectFormatter::FormatObj(..)> - missing anchor frame" );
209 0 : SwFrm& rAnchorFrm = _pAnchorFrm ? *(_pAnchorFrm) : *(_rAnchoredObj.AnchorFrm());
210 :
211 : OSL_ENSURE( _pPageFrm || rAnchorFrm.FindPageFrm(),
212 : "<SwObjectFormatter::FormatObj(..)> - missing page frame" );
213 0 : const SwPageFrm& rPageFrm = _pPageFrm ? *(_pPageFrm) : *(rAnchorFrm.FindPageFrm());
214 :
215 : // create corresponding object formatter
216 : SwObjectFormatter* pObjFormatter =
217 0 : SwObjectFormatter::CreateObjFormatter( rAnchorFrm, rPageFrm, _pLayAction );
218 :
219 0 : if ( pObjFormatter )
220 : {
221 : // format given floating screen object
222 : // --> #i40147# - check for moved forward anchor frame
223 0 : bSuccess = pObjFormatter->DoFormatObj( _rAnchoredObj, true );
224 : }
225 0 : delete pObjFormatter;
226 :
227 0 : return bSuccess;
228 : }
229 :
230 : /** helper method for method <_FormatObj(..)> - performs the intrinsic format
231 : of the layout of the given layout frame and all its lower layout frames.
232 :
233 : #i28701#
234 : IMPORTANT NOTE:
235 : Method corresponds to methods <SwLayAction::FormatLayoutFly(..)> and
236 : <SwLayAction::FormatLayout(..)>. Thus, its code for the formatting have
237 : to be synchronised.
238 : */
239 0 : void SwObjectFormatter::_FormatLayout( SwLayoutFrm& _rLayoutFrm )
240 : {
241 0 : _rLayoutFrm.Calc();
242 :
243 0 : SwFrm* pLowerFrm = _rLayoutFrm.Lower();
244 0 : while ( pLowerFrm )
245 : {
246 0 : if ( pLowerFrm->IsLayoutFrm() )
247 : {
248 0 : _FormatLayout( *(static_cast<SwLayoutFrm*>(pLowerFrm)) );
249 : }
250 0 : pLowerFrm = pLowerFrm->GetNext();
251 : }
252 0 : }
253 :
254 : /** helper method for method <_FormatObj(..)> - performs the intrinsic
255 : format of the content of the given floating screen object.
256 :
257 : #i28701#
258 : */
259 0 : void SwObjectFormatter::_FormatObjCntnt( SwAnchoredObject& _rAnchoredObj )
260 : {
261 0 : if ( !_rAnchoredObj.ISA(SwFlyFrm) )
262 : {
263 : // only Writer fly frames have content
264 0 : return;
265 : }
266 :
267 0 : SwFlyFrm& rFlyFrm = static_cast<SwFlyFrm&>(_rAnchoredObj);
268 0 : SwCntntFrm* pCntnt = rFlyFrm.ContainsCntnt();
269 :
270 0 : while ( pCntnt )
271 : {
272 : // format content
273 0 : pCntnt->OptCalc();
274 :
275 : // format floating screen objects at content text frame
276 : // #i23129#, #i36347# - pass correct page frame to
277 : // the object formatter
278 0 : if ( pCntnt->IsTxtFrm() &&
279 : !SwObjectFormatter::FormatObjsAtFrm( *pCntnt,
280 0 : *(pCntnt->FindPageFrm()),
281 0 : GetLayAction() ) )
282 : {
283 : // restart format with first content
284 0 : pCntnt = rFlyFrm.ContainsCntnt();
285 0 : continue;
286 : }
287 :
288 : // continue with next content
289 0 : pCntnt = pCntnt->GetNextCntntFrm();
290 : }
291 : }
292 :
293 : /** performs the intrinsic format of a given floating screen object and its content.
294 :
295 : #i28701#
296 : */
297 0 : void SwObjectFormatter::_FormatObj( SwAnchoredObject& _rAnchoredObj )
298 : {
299 : // check, if only as-character anchored object have to be formatted, and
300 : // check the anchor type
301 0 : if ( FormatOnlyAsCharAnchored() &&
302 0 : !(_rAnchoredObj.GetFrmFmt().GetAnchor().GetAnchorId() == FLY_AS_CHAR) )
303 : {
304 0 : return;
305 : }
306 :
307 : // collect anchor object and its 'anchor' page number, if requested
308 0 : if ( mpPgNumAndTypeOfAnchors )
309 : {
310 0 : mpPgNumAndTypeOfAnchors->Collect( _rAnchoredObj );
311 : }
312 :
313 0 : if ( _rAnchoredObj.ISA(SwFlyFrm) )
314 : {
315 0 : SwFlyFrm& rFlyFrm = static_cast<SwFlyFrm&>(_rAnchoredObj);
316 : // --> #i34753# - reset flag, which prevents a positioning
317 0 : if ( rFlyFrm.IsFlyLayFrm() )
318 : {
319 0 : static_cast<SwFlyLayFrm&>(rFlyFrm).SetNoMakePos( false );
320 : }
321 :
322 : // #i81146# new loop control
323 0 : sal_uInt16 nLoopControlRuns = 0;
324 0 : const sal_uInt16 nLoopControlMax = 15;
325 :
326 0 : do {
327 0 : if ( mpLayAction )
328 : {
329 0 : mpLayAction->FormatLayoutFly( &rFlyFrm );
330 : // --> consider, if the layout action
331 : // has to be restarted due to a delete of a page frame.
332 0 : if ( mpLayAction->IsAgain() )
333 : {
334 0 : break;
335 : }
336 : }
337 : else
338 : {
339 0 : _FormatLayout( rFlyFrm );
340 : }
341 : // --> #i34753# - prevent further positioning, if
342 : // to-page|to-fly anchored Writer fly frame is already clipped.
343 0 : if ( rFlyFrm.IsFlyLayFrm() && rFlyFrm.IsClipped() )
344 : {
345 0 : static_cast<SwFlyLayFrm&>(rFlyFrm).SetNoMakePos( true );
346 : }
347 : // #i23129#, #i36347# - pass correct page frame
348 : // to the object formatter
349 : SwObjectFormatter::FormatObjsAtFrm( rFlyFrm,
350 0 : *(rFlyFrm.FindPageFrm()),
351 0 : mpLayAction );
352 0 : if ( mpLayAction )
353 : {
354 0 : mpLayAction->_FormatFlyCntnt( &rFlyFrm );
355 : // --> consider, if the layout action
356 : // has to be restarted due to a delete of a page frame.
357 0 : if ( mpLayAction->IsAgain() )
358 : {
359 0 : break;
360 : }
361 : }
362 : else
363 : {
364 0 : _FormatObjCntnt( rFlyFrm );
365 : }
366 :
367 0 : if ( ++nLoopControlRuns >= nLoopControlMax )
368 : {
369 : OSL_FAIL( "LoopControl in SwObjectFormatter::_FormatObj: Stage 3!!!" );
370 0 : rFlyFrm.ValidateThisAndAllLowers( 2 );
371 0 : nLoopControlRuns = 0;
372 : }
373 :
374 : // --> #i57917#
375 : // stop formatting of anchored object, if restart of layout process is requested.
376 0 : } while ( !rFlyFrm.IsValid() &&
377 0 : !_rAnchoredObj.RestartLayoutProcess() &&
378 0 : rFlyFrm.GetAnchorFrm() == &GetAnchorFrm() );
379 : }
380 0 : else if ( _rAnchoredObj.ISA(SwAnchoredDrawObject) )
381 : {
382 0 : _rAnchoredObj.MakeObjPos();
383 : }
384 : }
385 :
386 : /** invokes the intrinsic format method for all floating screen objects,
387 : anchored at anchor frame on the given page frame
388 :
389 : #i28701#
390 : #i26945# - for format of floating screen objects for
391 : follow text frames, the 'master' text frame is passed to the method.
392 : Thus, the objects, whose anchor character is inside the follow text
393 : frame can be formatted.
394 : */
395 0 : bool SwObjectFormatter::_FormatObjsAtFrm( SwTxtFrm* _pMasterTxtFrm )
396 : {
397 : // --> #i26945#
398 0 : SwFrm* pAnchorFrm( 0L );
399 0 : if ( GetAnchorFrm().IsTxtFrm() &&
400 0 : static_cast<SwTxtFrm&>(GetAnchorFrm()).IsFollow() &&
401 : _pMasterTxtFrm )
402 : {
403 0 : pAnchorFrm = _pMasterTxtFrm;
404 : }
405 : else
406 : {
407 0 : pAnchorFrm = &GetAnchorFrm();
408 : }
409 0 : if ( !pAnchorFrm->GetDrawObjs() )
410 : {
411 : // nothing to do, if no floating screen object is registered at the anchor frame.
412 0 : return true;
413 : }
414 :
415 0 : bool bSuccess( true );
416 :
417 0 : sal_uInt32 i = 0;
418 0 : for ( ; i < pAnchorFrm->GetDrawObjs()->Count(); ++i )
419 : {
420 0 : SwAnchoredObject* pAnchoredObj = (*pAnchorFrm->GetDrawObjs())[i];
421 :
422 : // check, if object's anchor is on the given page frame or
423 : // object is registered at the given page frame.
424 : // --> #i26945# - check, if the anchor character of the
425 : // anchored object is located in a follow text frame. If this anchor
426 : // follow text frame differs from the given anchor frame, the given
427 : // anchor frame is a 'master' text frame of the anchor follow text frame.
428 : // If the anchor follow text frame is in the same body as its 'master'
429 : // text frame, do not format the anchored object.
430 : // E.g., this situation can occur during the table row splitting algorithm.
431 0 : SwTxtFrm* pAnchorCharFrm = pAnchoredObj->FindAnchorCharFrm();
432 : const bool bAnchoredAtFollowInSameBodyAsMaster =
433 0 : pAnchorCharFrm && pAnchorCharFrm->IsFollow() &&
434 0 : pAnchorCharFrm != pAnchoredObj->GetAnchorFrm() &&
435 0 : pAnchorCharFrm->FindBodyFrm() ==
436 0 : static_cast<SwTxtFrm*>(pAnchoredObj->AnchorFrm())->FindBodyFrm();
437 0 : if ( bAnchoredAtFollowInSameBodyAsMaster )
438 : {
439 0 : continue;
440 : }
441 : // #i33751#, #i34060# - method <GetPageFrmOfAnchor()>
442 : // is replaced by method <FindPageFrmOfAnchor()>. It's return value
443 : // have to be checked.
444 0 : SwPageFrm* pPageFrmOfAnchor = pAnchoredObj->FindPageFrmOfAnchor();
445 : OSL_ENSURE( pPageFrmOfAnchor,
446 : "<SwObjectFormatter::_FormatObjsAtFrm()> - missing page frame." );
447 : // --> #i26945#
448 0 : if ( pPageFrmOfAnchor && pPageFrmOfAnchor == &mrPageFrm )
449 : {
450 : // if format of object fails, stop formatting and pass fail to
451 : // calling method via the return value.
452 0 : if ( !DoFormatObj( *pAnchoredObj ) )
453 : {
454 0 : bSuccess = false;
455 0 : break;
456 : }
457 :
458 : // considering changes at <pAnchorFrm->GetDrawObjs()> during
459 : // format of the object.
460 0 : if ( !pAnchorFrm->GetDrawObjs() ||
461 0 : i > pAnchorFrm->GetDrawObjs()->Count() )
462 : {
463 0 : break;
464 : }
465 : else
466 : {
467 : sal_uInt32 nActPosOfObj =
468 0 : pAnchorFrm->GetDrawObjs()->ListPosOf( *pAnchoredObj );
469 0 : if ( nActPosOfObj == pAnchorFrm->GetDrawObjs()->Count() ||
470 : nActPosOfObj > i )
471 : {
472 0 : --i;
473 : }
474 0 : else if ( nActPosOfObj < i )
475 : {
476 0 : i = nActPosOfObj;
477 : }
478 : }
479 : }
480 : } // end of loop on <pAnchorFrm->.GetDrawObjs()>
481 :
482 0 : return bSuccess;
483 : }
484 :
485 : /** accessor to collected anchored object
486 :
487 : #i28701#
488 : */
489 0 : SwAnchoredObject* SwObjectFormatter::GetCollectedObj( const sal_uInt32 _nIndex )
490 : {
491 0 : return mpPgNumAndTypeOfAnchors ? (*mpPgNumAndTypeOfAnchors)[_nIndex] : 0L;
492 : }
493 :
494 : /** accessor to 'anchor' page number of collected anchored object
495 :
496 : #i28701#
497 : */
498 0 : sal_uInt32 SwObjectFormatter::GetPgNumOfCollected( const sal_uInt32 _nIndex )
499 : {
500 0 : return mpPgNumAndTypeOfAnchors ? mpPgNumAndTypeOfAnchors->GetPageNum(_nIndex) : 0L;
501 : }
502 :
503 : /** accessor to 'anchor' type of collected anchored object
504 :
505 : #i26945#
506 : */
507 0 : bool SwObjectFormatter::IsCollectedAnchoredAtMaster( const sal_uInt32 _nIndex )
508 : {
509 : return mpPgNumAndTypeOfAnchors
510 0 : ? mpPgNumAndTypeOfAnchors->AnchoredAtMaster(_nIndex)
511 0 : : true;
512 : }
513 :
514 : /** accessor to total number of collected anchored objects
515 :
516 : #i28701#
517 : */
518 0 : sal_uInt32 SwObjectFormatter::CountOfCollected()
519 : {
520 0 : return mpPgNumAndTypeOfAnchors ? mpPgNumAndTypeOfAnchors->Count() : 0L;
521 : }
522 :
523 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
