Bug Summary

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

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-unknown-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name lwppagelayout.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 -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 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/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/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/lotuswordpro/inc -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/lotuswordpro/source/filter/lwppagelayout.cxx

/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*************************************************************************
3 *
4 * The Contents of this file are made available subject to the terms of
5 * either of the following licenses
6 *
7 * - GNU Lesser General Public License Version 2.1
8 * - Sun Industry Standards Source License Version 1.1
9 *
10 * Sun Microsystems Inc., October, 2000
11 *
12 * GNU Lesser General Public License Version 2.1
13 * =============================================
14 * Copyright 2000 by Sun Microsystems, Inc.
15 * 901 San Antonio Road, Palo Alto, CA 94303, USA
16 *
17 * This library is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU Lesser General Public
19 * License version 2.1, as published by the Free Software Foundation.
20 *
21 * This library is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 * Lesser General Public License for more details.
25 *
26 * You should have received a copy of the GNU Lesser General Public
27 * License along with this library; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 * MA 02111-1307 USA
30 *
31 *
32 * Sun Industry Standards Source License Version 1.1
33 * =================================================
34 * The contents of this file are subject to the Sun Industry Standards
35 * Source License Version 1.1 (the "License"); You may not use this file
36 * except in compliance with the License. You may obtain a copy of the
37 * License at http://www.openoffice.org/license.html.
38 *
39 * Software provided under this License is provided on an "AS IS" basis,
40 * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
41 * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
42 * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
43 * See the License for the specific provisions governing your rights and
44 * obligations concerning the Software.
45 *
46 * The Initial Developer of the Original Code is: IBM Corporation
47 *
48 * Copyright: 2008 by IBM Corporation
49 *
50 * All Rights Reserved.
51 *
52 * Contributor(s): _______________________________________
53 *
54 *
55 ************************************************************************/
56
57#include <memory>
58#include "lwppagelayout.hxx"
59#include "lwplaypiece.hxx"
60#include "lwpfootnote.hxx"
61#include "lwpdoc.hxx"
62#include "lwpholder.hxx"
63#include "lwppagehint.hxx"
64#include "lwpdivinfo.hxx"
65#include "lwpstory.hxx"
66#include <o3tl/numeric.hxx>
67#include <xfilter/xfstylemanager.hxx>
68#include <xfilter/xfmasterpage.hxx>
69#include <xfilter/xfcontentcontainer.hxx>
70#include <xfilter/xfheader.hxx>
71#include <xfilter/xfheaderstyle.hxx>
72#include <xfilter/xffooterstyle.hxx>
73#include <xfilter/xffooter.hxx>
74#include <lwpchangemgr.hxx>
75#include <lwpfilehdr.hxx>
76#include <lwpglobalmgr.hxx>
77#include <sal/log.hxx>
78#include <vcl/print.hxx>
79
80LwpPageLayout::LwpPageLayout(LwpObjectHeader const &objHdr, LwpSvStream* pStrm)
81 : LwpLayout(objHdr, pStrm)
82 , m_nPrinterBin(0)
83 , m_nBdroffset(0)
84 , m_pXFPageMaster(nullptr)
85{
86}
87
88LwpPageLayout::~LwpPageLayout()
89{
90}
91void LwpPageLayout::Read()
92{
93 LwpLayout::Read();
94
95 if (LwpFileHeader::m_nFileRevision < 0x000B)
96 {
97 // read PreRevBLayout...
98 }
99
100 m_nPrinterBin = m_pObjStrm->QuickReaduInt16();
101 m_PrinterBinName.Read(m_pObjStrm.get());
102
103 if (LwpFileHeader::m_nFileRevision >= 0x000B)
104 m_nBdroffset = m_pObjStrm->QuickReadInt32();
105
106 if (m_pObjStrm->CheckExtra())
107 {
108 m_PaperName.Read(m_pObjStrm.get());
109 m_pObjStrm->SkipExtra();
110 }
111
112}
113
114void LwpPageLayout::Parse(IXFStream* pOutputStream)
115{
116 //Only parse this layout
117 rtl::Reference<LwpObject> pStory = m_Content.obj();
118 if(pStory.is())
119 {
120 pStory->SetFoundry(m_pFoundry);
121 pStory->DoParse(pOutputStream); //Do not parse the next story
122 }
123}
124
125/**
126* @descr: set page margins
127*
128*/
129void LwpPageLayout::ParseMargins(XFPageMaster* pm1)
130{
131 double fLeft = GetMarginsValue(MARGIN_LEFT);
132 double fRight = GetMarginsValue(MARGIN_RIGHT);
133 double fTop = GetMarginsValue(MARGIN_TOP);
134 double fBottom = GetMarginsValue(MARGIN_BOTTOM);
135
136 pm1->SetMargins( fLeft, fRight, fTop, fBottom );
137
138}
139
140/**
141* @descr: set page height and width
142*
143*/
144void LwpPageLayout::ParseGeometry(XFPageMaster* pm1)
145{
146 /*
147 LwpLayoutGeometry* pLayoutGeo = GetGeometry();
148 if(pLayoutGeo)
149 {
150 pm1->SetPageHeight( GetGeometryHeight() );
151 pm1->SetPageWidth( GetGeometryWidth() );
152 }
153 */
154 double fWidth =0;
155 double fHeight = 0;
156 GetWidthAndHeight(fWidth, fHeight);
157 pm1->SetPageWidth( fWidth );
158 pm1->SetPageHeight( fHeight );
159}
160
161/**
162* @descr: set page watermark
163*
164*/
165void LwpPageLayout::ParseWaterMark(XFPageMaster *pm1)
166{
167 std::unique_ptr<XFBGImage> xXFBGImage(GetXFBGImage());
168 if (xXFBGImage)
169 {
170 pm1->SetBackImage(xXFBGImage);
171 }
172}
173
174/**
175* @descr: set page columns
176*
177*/
178void LwpPageLayout::ParseColumns(XFPageMaster * pm1)
179{
180 XFColumns* pColumns = GetXFColumns();
181 if(pColumns)
182 {
183 pm1->SetColumns(pColumns);
184 }
185}
186
187/**
188* @descr: set page borders
189*
190*/
191void LwpPageLayout::ParseBorders(XFPageMaster *pm1)
192{
193 std::unique_ptr<XFBorders> pBordres = GetXFBorders();
194 if(pBordres)
195 {
196 pm1->SetBorders(std::move(pBordres));
197 }
198}
199
200/**
201* @descr: set page shadow
202*
203*/
204void LwpPageLayout::ParseShadow(XFPageMaster *pm1)
205{
206 XFShadow* pXFShadow = GetXFShadow();
207 if(pXFShadow)
208 {
209 pm1->SetShadow(pXFShadow);
210 }
211}
212
213/**
214* @descr: set page back pattern
215*
216*/
217void LwpPageLayout::ParsePatternFill(XFPageMaster* pm1)
218{
219 std::unique_ptr<XFBGImage> xXFBGImage(GetFillPattern());
220 if (xXFBGImage)
221 {
222 pm1->SetBackImage(xXFBGImage);
223 }
224}
225/**
226* @descr: set page background
227*
228*/
229void LwpPageLayout::ParseBackGround(XFPageMaster* pm1)
230{
231 if (IsPatternFill())
232 {
233 ParsePatternFill(pm1);
234 }
235 else
236 {
237 ParseBackColor(pm1);
238 }
239}
240
241/**
242* @descr: set page back color
243*
244*/
245void LwpPageLayout::ParseBackColor(XFPageMaster* pm1)
246{
247 LwpColor* pColor = GetBackColor();
248 if(pColor)
249 {
250 pm1->SetBackColor(XFColor(pColor->To24Color()));
251 }
252}
253
254/**
255* @descr: set page footnote separator information
256*
257*/
258void LwpPageLayout::ParseFootNoteSeparator(XFPageMaster * pm1)
259{
260 //Get the footnoteoptions for the root document
261 LwpDocument* pDocument = m_pFoundry ? m_pFoundry->GetDocument() : nullptr;
262 if (!pDocument)
263 return;
264
265 LwpObjectID* pFontnodeId = pDocument->GetValidFootnoteOpts();
266
267 LwpFootnoteOptions* pFootnoteOpts = pFontnodeId ? dynamic_cast<LwpFootnoteOptions*>(pFontnodeId->obj().get()) : nullptr;
268 if(!pFootnoteOpts)
269 return;
270
271 LwpFootnoteSeparatorOptions& rFootnoteSep = pFootnoteOpts->GetFootnoteSeparator();
272 //set length
273 sal_uInt32 nLengthPercent = 100;
274 double fWidth = 0;
275 if(rFootnoteSep.HasSeparator())
276 {
277 fWidth = rFootnoteSep.GetTopBorderWidth();
278 }
279 if(rFootnoteSep.HasCustomLength())
280 {
281 const double fMarginWidth = GetMarginWidth();
282 if (fMarginWidth == 0.0)
283 throw o3tl::divide_by_zero();
284
285 nLengthPercent = static_cast<sal_uInt32>(100*LwpTools::ConvertFromUnitsToMetric(rFootnoteSep.GetLength()) / fMarginWidth);
286 if (nLengthPercent > 100)
287 nLengthPercent = 100;
288 }
289 double fAbove = LwpTools::ConvertFromUnitsToMetric(rFootnoteSep.GetAbove());
290 double fBelow = LwpTools::ConvertFromUnitsToMetric(rFootnoteSep.GetBelow());
291 LwpColor aColor = rFootnoteSep.GetTopBorderColor();
292 enumXFAlignType eAlignType = enumXFAlignStart;
293 if(rFootnoteSep.GetIndent() > 0)
294 {
295 const double fMarginWidth = GetMarginWidth();
296 if (fMarginWidth == 0.0)
297 throw o3tl::divide_by_zero();
298
299 //SODC don't support indent
300 sal_uInt32 nIndentPercent = static_cast<sal_uInt32>(100*LwpTools::ConvertFromUnitsToMetric(rFootnoteSep.GetIndent()) / fMarginWidth);
301 if (nIndentPercent + nLengthPercent >= 100)
302 eAlignType = enumXFAlignEnd;
303 }
304 if(aColor.IsValidColor())
305 {
306 XFColor aXFColor(aColor.To24Color());
307 pm1->SetFootNoteSeparator(eAlignType,fWidth, nLengthPercent, fAbove, fBelow, aXFColor);
308 }
309}
310
311/**
312* @descr: Register master page and page master style
313*
314*/
315void LwpPageLayout::RegisterStyle()
316{
317 std::unique_ptr<XFPageMaster> xpm1(new XFPageMaster);
318
319 ParseGeometry(xpm1.get());
320 //Does not process LayoutScale, for watermark is not supported in SODC.
321 ParseWaterMark(xpm1.get());
322 ParseMargins(xpm1.get());
323 ParseColumns(xpm1.get());
324 ParseBorders(xpm1.get());
325 ParseShadow(xpm1.get());
326 ParseBackGround(xpm1.get());
327 ParseFootNoteSeparator(xpm1.get());
328 xpm1->SetTextDir(GetTextDirection());
329
330 LwpUseWhen* pUseWhen = GetUseWhen();
331 if(IsComplex() ||( pUseWhen && pUseWhen->IsUseOnAllOddPages()))
332 {
333 xpm1->SetPageUsage(enumXFPageUsageMirror);
334 }
335
336 //Add the page master to stylemanager
337 XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
338 XFPageMaster* pm1 = static_cast<XFPageMaster*>(pXFStyleManager->AddStyle(std::move(xpm1)).m_pStyle);
339 m_pXFPageMaster = pm1;
340 OUString pmname = pm1->GetStyleName();
341
342 //Add master page
343 std::unique_ptr<XFMasterPage> p1(new XFMasterPage);
344 p1->SetStyleName(GetName().str());
345 p1->SetPageMaster(pmname);
346 XFMasterPage* p1_added = static_cast<XFMasterPage*>(pXFStyleManager->AddStyle(std::move(p1)).m_pStyle);
347 m_StyleName = p1_added->GetStyleName();
348
349 //Set footer style
350 LwpFooterLayout* pLayoutFooter = GetFooterLayout();
351 if(pLayoutFooter)
352 {
353 pLayoutFooter->SetFoundry(m_pFoundry);
354 pLayoutFooter->RegisterStyle(pm1);
355 pLayoutFooter->RegisterStyle(p1_added);
356 }
357
358 //Set header style
359 LwpHeaderLayout* pLayoutHeader = GetHeaderLayout();
360 if(pLayoutHeader)
361 {
362 pLayoutHeader->SetFoundry(m_pFoundry);
363 pLayoutHeader->RegisterStyle(pm1);
364 pLayoutHeader->RegisterStyle(p1_added);
365 }
366 //register child layout style for mirror page and frame
367 RegisterChildStyle();
368}
369
370/**
371* @descr: Register master page for endnote which name is "endnote"
372* @return: Return the master page name.
373*/
374OUString LwpPageLayout::RegisterEndnoteStyle()
375{
376 std::unique_ptr<XFPageMaster> pm1(new XFPageMaster);
377
378 ParseGeometry(pm1.get());
379 ParseWaterMark(pm1.get());
380 ParseMargins(pm1.get());
381 ParseColumns(pm1.get());
382 ParseBorders(pm1.get());
383 ParseShadow(pm1.get());
384 ParseBackGround(pm1.get());
385 pm1->SetTextDir(GetTextDirection());
386
387 LwpUseWhen* pUseWhen = GetUseWhen();
388 if(IsComplex() ||( pUseWhen && pUseWhen->IsUseOnAllOddPages()))
389 {
390 pm1->SetPageUsage(enumXFPageUsageMirror);
391 }
392
393 //Add the page master to stylemanager
394 XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
395 m_pXFPageMaster = static_cast<XFPageMaster*>(pXFStyleManager->AddStyle(std::move(pm1)).m_pStyle);
396 OUString pmname = m_pXFPageMaster->GetStyleName();
397
398 //Add master page
399 std::unique_ptr<XFMasterPage> p1(new XFMasterPage);
400 p1->SetStyleName("Endnote");
401 p1->SetPageMaster(pmname);
402
403 //Set footer style
404 LwpFooterLayout* pLayoutFooter = GetFooterLayout();
405 if(pLayoutFooter)
406 {
407 pLayoutFooter->SetFoundry(m_pFoundry);
408 pLayoutFooter->RegisterStyle(m_pXFPageMaster);
409 pLayoutFooter->RegisterStyle(p1.get());
410 }
411
412 //Set header style
413 LwpHeaderLayout* pLayoutHeader = GetHeaderLayout();
414 if(pLayoutHeader)
415 {
416 pLayoutHeader->SetFoundry(m_pFoundry);
417 pLayoutHeader->RegisterStyle(m_pXFPageMaster);
418 pLayoutHeader->RegisterStyle(p1.get());
419 }
420
421 return pXFStyleManager->AddStyle(std::move(p1)).m_pStyle->GetStyleName();
422}
423/**
424* @descr: Whether current page layout has columns
425*
426*/
427bool LwpPageLayout::HasColumns()
428{
429 return GetNumCols() > 1;
430}
431
432/**
433* @descr: Whether has filler page text in current page layout
434*
435*/
436bool LwpPageLayout::HasFillerPageText(LwpFoundry const * pFoundry)
437{
438 if(!pFoundry) return false;
439
440 bool bFillerPage = false;
441 LwpLayout::UseWhenType eWhenType = GetUseWhenType();
442 if(eWhenType==LwpLayout::StartOnOddPage||eWhenType==LwpLayout::StartOnEvenPage)
443 {
444 //get the page number that current page layout inserted
445 sal_Int32 nPageNumber = GetPageNumber(FIRST_LAYOUTPAGENO0x0001)-1;
446
447 if(nPageNumber>0)
448 {
449 if((eWhenType==LwpLayout::StartOnOddPage)&&(LwpTools::IsOddNumber(nPageNumber)))
450 {
451 bFillerPage = true;
452 }
453 else if((eWhenType==LwpLayout::StartOnEvenPage)&&(LwpTools::IsEvenNumber(nPageNumber)))
454 {
455 bFillerPage = true;
456 }
457 else
458 {
459 bFillerPage = false;
460 }
461 }
462 }
463
464 return bFillerPage;
465}
466
467/**
468* @descr: Parse filler page text
469*
470*/
471void LwpPageLayout::ConvertFillerPageText(XFContentContainer* pCont)
472{
473 if(!HasFillerPageText(m_pFoundry))
474 return;
475
476 //get fillerpage story from division info
477 LwpDocument* pDoc = m_pFoundry->GetDocument();
478 LwpDivInfo* pDivInfo = dynamic_cast<LwpDivInfo*>(pDoc->GetDivInfoID().obj().get());
479 LwpStory* pStory = pDivInfo ? dynamic_cast<LwpStory*>(pDivInfo->GetFillerPageTextID().obj().get()) : nullptr;
480
481 //parse fillerpage story
482 if(pStory)
483 {
484 pStory->XFConvert(pCont);
485 }
486}
487/**
488* @descr: Clear columns style in page layout
489*
490*/
491void LwpPageLayout::ResetXFColumns()
492{
493 if(m_pXFPageMaster)
494 {
495 m_pXFPageMaster->SetColumns(nullptr);
496 }
497}
498
499LwpHeaderLayout* LwpPageLayout::GetHeaderLayout()
500{
501 rtl::Reference<LwpVirtualLayout> xLay(dynamic_cast<LwpVirtualLayout*>(GetChildHead().obj().get()));
502 while (xLay.is())
503 {
504 if (xLay->GetLayoutType() == LWP_HEADER_LAYOUT)
505 return dynamic_cast<LwpHeaderLayout*>(xLay.get());
506 rtl::Reference<LwpVirtualLayout> xNext(dynamic_cast<LwpVirtualLayout*>(xLay->GetNext().obj().get()));
507 if (xNext == xLay)
508 {
509 SAL_WARN("lwp", "loop in layout")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "lwp")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case SAL_DETAIL_LOG_ACTION_LOG
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "loop in layout") == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("lwp"), ("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "509" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "loop in layout"), 0); } else { ::std::
ostringstream sal_detail_stream; sal_detail_stream << "loop in layout"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("lwp"),
("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "509" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "loop in layout") == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("lwp"), ("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "509" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "loop in layout"), 0); } else { ::std::
ostringstream sal_detail_stream; sal_detail_stream << "loop in layout"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("lwp"),
("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "509" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
;
510 break;
511 }
512 xLay = xNext;
513 }
514 return nullptr;
515}
516
517LwpFooterLayout* LwpPageLayout::GetFooterLayout()
518{
519 rtl::Reference<LwpVirtualLayout> xLay(dynamic_cast<LwpVirtualLayout*>(GetChildHead().obj().get()));
520 while (xLay.is())
521 {
522 if (xLay->GetLayoutType() == LWP_FOOTER_LAYOUT)
523 return dynamic_cast<LwpFooterLayout*>(xLay.get());
524 rtl::Reference<LwpVirtualLayout> xNext(dynamic_cast<LwpVirtualLayout*>(xLay->GetNext().obj().get()));
525 if (xNext == xLay)
526 {
527 SAL_WARN("lwp", "loop in layout")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "lwp")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case SAL_DETAIL_LOG_ACTION_LOG
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "loop in layout") == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("lwp"), ("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "527" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "loop in layout"), 0); } else { ::std::
ostringstream sal_detail_stream; sal_detail_stream << "loop in layout"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("lwp"),
("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "527" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "loop in layout") == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("lwp"), ("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "527" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "loop in layout"), 0); } else { ::std::
ostringstream sal_detail_stream; sal_detail_stream << "loop in layout"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("lwp"),
("/home/maarten/src/libreoffice/core/lotuswordpro/source/filter/lwppagelayout.cxx"
":" "527" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
;
528 break;
529 }
530 xLay = xNext;
531 }
532 return nullptr;
533}
534
535/**
536* @descr: Get the odd layout if current page layout is mirror page
537*
538*/
539LwpPageLayout* LwpPageLayout::GetOddChildLayout()
540{
541 if(IsComplex())
542 {
543 rtl::Reference<LwpVirtualLayout> xLay(dynamic_cast<LwpVirtualLayout*>(GetChildHead().obj().get()));
544 while (xLay.is())
545 {
546 if (xLay->GetLayoutType() == LWP_PAGE_LAYOUT)
547 {
548 LwpPageLayout* pPageLayout = static_cast<LwpPageLayout*>(xLay.get());
549 LwpUseWhen* pUseWhen = pPageLayout->GetUseWhen();
550 if(pUseWhen && pUseWhen->IsUseOnAllOddPages())
551 {
552 return pPageLayout;
553 }
554 }
555 xLay.set(dynamic_cast<LwpVirtualLayout*>(xLay->GetNext().obj().get()));
556 }
557 }
558 return nullptr;
559}
560
561/**
562* @descr: Get margin width of page
563*
564*/
565double LwpPageLayout::GetMarginWidth()
566{
567 double fPagewidth = GetGeometryWidth();
568 double fLeftMargin = GetMarginsValue(MARGIN_LEFT);
569 double fRightMargin = GetMarginsValue(MARGIN_RIGHT);
570
571 return fPagewidth - (fLeftMargin + fRightMargin);
572}
573
574/**
575 * @descr: Get the pagenumber
576 * @param: if nLayoutNumber =FIRST_LAYOUTPAGENO, return the first page number that current page layout covers
577 =LAST_LAYOUTPAGENO, return the last page number that current page layout covers
578 else, return the specified page number that current page layout covers
579 * @param:
580 * @return: if return value >=0, success to find the page number, or fail.
581*/
582sal_Int32 LwpPageLayout::GetPageNumber(sal_uInt16 nLayoutNumber)
583{
584 sal_Int16 nPageNumber = -1;
585 LwpFoundry* pFoundry = GetFoundry();
586 if (!pFoundry)
587 return nPageNumber;
588 LwpDocument* pDoc = pFoundry->GetDocument();
589 LwpDLVListHeadTailHolder* pHeadTail = dynamic_cast<LwpDLVListHeadTailHolder*>(pDoc->GetPageHintsID().obj().get());
590 if(!pHeadTail) return nPageNumber;
591
592 //get first pagehint
593 LwpPageHint* pPageHint = dynamic_cast<LwpPageHint*>(pHeadTail->GetHead().obj().get());
594 while(pPageHint)
595 {
596 if(GetObjectID() == pPageHint->GetPageLayoutID())
597 {
598 sal_uInt16 nNumber = pPageHint->GetPageNumber();
599 if(nLayoutNumber==FIRST_LAYOUTPAGENO0x0001 && pPageHint->GetLayoutPageNumber()==1)
600 {
601 //get the first page number
602 nPageNumber = nNumber;
603 break;
604 }
605 else if( nLayoutNumber ==LAST_LAYOUTPAGENO0xffff && nNumber >nPageNumber )
606 {
607 //get the last page number
608 nPageNumber = nNumber;
609 if(pPageHint->GetNext().IsNull())
610 {
611 //if is last page number of entire document, return directly
612 return nPageNumber + pDoc->GetNumberOfPagesBefore();
613 }
614 }
615 else if(nLayoutNumber > 0 && pPageHint->GetLayoutPageNumber() == nLayoutNumber)
616 {
617 //get specified page number
618 nPageNumber = nNumber;
619 break;
620 }
621
622 }
623 pPageHint = dynamic_cast<LwpPageHint*>(pPageHint->GetNext().obj().get());
624 }
625 if(nPageNumber>=0)
626 {
627 return nPageNumber + 1 + pDoc->GetNumberOfPagesBefore();
628 }
629 return -1;
630}
631
632/**
633* @descr: Get page width and height
634*
635*/
636void LwpPageLayout::GetWidthAndHeight(double& fWidth, double& fHeight)
637{
638 //use customized size
639 LwpLayoutGeometry* pLayoutGeo = GetGeometry();
640 if(pLayoutGeo)
2
Assuming 'pLayoutGeo' is null
3
Taking false branch
641 {
642 fWidth = GetGeometryWidth();
643 fHeight = GetGeometryHeight();
644 }
645
646 if(GetUsePrinterSettings())
4
Assuming the condition is true
5
Taking true branch
647 {
648 //replaced by printer paper size
649 ScopedVclPtrInstance< Printer > pPrinter;
6
Calling default constructor for 'ScopedVclPtrInstance<Printer>'
8
Returning from default constructor for 'ScopedVclPtrInstance<Printer>'
650 bool bScreen = pPrinter->IsDisplayPrinter();
651 if (!bScreen
8.1
'bScreen' is true
8.1
'bScreen' is true
8.1
'bScreen' is true
8.1
'bScreen' is true
)//Printer available
9
Taking false branch
652 {
653 Size aPaperSize = pPrinter->GetPaperSize();
654 aPaperSize = pPrinter->PixelToLogic( aPaperSize, MapMode( MapUnit::Map10thMM ) );
655 fWidth = static_cast<double>(aPaperSize.Width())/100; //cm unit
656 fHeight = static_cast<double>(aPaperSize.Height())/100;
657 }
658 }
10
Calling implicit destructor for 'ScopedVclPtrInstance<Printer>'
11
Calling '~ScopedVclPtr'
659
660 //Follow the former design of Lotus WordPro filter, some default will be given:
661 //Page Width: 8.5 Inch -> 21.59 cm
662 //Page Height: 11 Inch -> 27.94 cm
663 if (fWidth < 4.39)
664 fWidth = 21.59;
665 if (fHeight < 4.49)
666 fHeight = 27.94;
667 //End of modification, by ZF
668}
669
670/**
671* @descr: Get page width
672*
673*/
674double LwpPageLayout::GetWidth()
675{
676 double fWidth =0, fHeight = 0;
677 GetWidthAndHeight(fWidth, fHeight);
678 return fWidth;
679}
680
681/**
682* @descr: Get page height
683*
684*/
685double LwpPageLayout::GetHeight()
686{
687 double fWidth =0, fHeight = 0;
688 GetWidthAndHeight(fWidth, fHeight);
1
Calling 'LwpPageLayout::GetWidthAndHeight'
689 return fHeight;
690}
691/**
692* @descr: Compare the position of layout. If the position of this layout is earlier than other layout,return true, or return false
693*
694*/
695bool LwpPageLayout::operator<(LwpPageLayout& Other)
696{
697 LwpPara* pThisPara = GetPagePosition();
698 LwpPara* pOtherPara = Other.GetPagePosition();
699 if(pThisPara && pOtherPara)
700 {
701 if(pThisPara == pOtherPara)
702 {
703 //If the two layouts in the same para, compare which layout is earlied according to frib order
704 return pThisPara->ComparePagePosition(this, &Other);
705 }
706 else
707 {
708 return *pThisPara < *pOtherPara;
709 }
710 }
711
712 return pThisPara == nullptr;
713}
714
715/**
716* @descr: Get the position of pagelayout
717*
718*/
719LwpPara* LwpPageLayout::GetPagePosition()
720{
721 LwpPara* pPara = dynamic_cast<LwpPara*>(GetPosition().obj().get());
722 if(pPara)
723 return pPara;
724 //Get the position from its related section
725 LwpFoundry* pFoundry = GetFoundry();
726 if(pFoundry)
727 {
728 LwpSection* pSection = nullptr;
729 while( (pSection = pFoundry->EnumSections(pSection)) )
730 {
731 if(pSection->GetPageLayout() == this)
732 return dynamic_cast<LwpPara*>(pSection->GetPosition().obj().get());
733 }
734 }
735
736 return nullptr;
737}
738LwpHeaderLayout::LwpHeaderLayout( LwpObjectHeader const &objHdr, LwpSvStream* pStrm )
739 : LwpPlacableLayout(objHdr, pStrm)
740 , m_nBorderOffset(0)
741{
742}
743
744LwpHeaderLayout::~LwpHeaderLayout()
745{
746}
747
748void LwpHeaderLayout::Read()
749{
750 LwpPlacableLayout::Read();
751
752 if(LwpFileHeader::m_nFileRevision >= 0x000E)
753 m_nBorderOffset = m_pObjStrm->QuickReadInt32();
754 else
755 m_nBorderOffset = 0;
756 m_pObjStrm->SkipExtra();
757}
758
759void LwpHeaderLayout::RegisterStyle(XFPageMaster* pm1)
760{
761 std::unique_ptr<XFHeaderStyle> xHeaderStyle(new XFHeaderStyle);
762
763 //Modify page top margin
764 //page top margin: from top of header to the top edge
765 double top = GetMarginsValue(MARGIN_TOP);
766 pm1->SetMargins(-1, -1, top, -1);
767
768 ParseMargins(xHeaderStyle.get());
769 ParseBorder(xHeaderStyle.get());
770 ParseShadow(xHeaderStyle.get());
771 ParseBackGround(xHeaderStyle.get());
772
773 ParseWaterMark(xHeaderStyle.get());
774 //End by
775
776 pm1->SetHeaderStyle(xHeaderStyle.release());
777}
778
779void LwpHeaderLayout::ParseMargins(XFHeaderStyle* ph1)
780{
781 //Set height: from top of header to top of body, including the spacing between header and body
782 double height = GetGeometryHeight()- GetMarginsValue(MARGIN_TOP);
783 if (GetIsAutoGrowDown())
784 {
785 ph1->SetMinHeight(height);
786 }
787 else
788 {
789 ph1->SetHeight(height);
790 }
791
792 //Set left,right,bottom margins
793 LwpMiddleLayout* parent = dynamic_cast<LwpMiddleLayout*> (GetParent().obj().get());
794 //left margin in SODC: the space from the left edge of body to the left edge of header
795 double left = GetMarginsValue(MARGIN_LEFT) - (parent ? parent->GetMarginsValue(MARGIN_LEFT) : 0);
796 if(left<=0) //The left margin in SODC can not be minus value
797 {
798 left = -1;
799 }
800 //left margin in SODC: the space from the right edge of header to the right edge of body
801 double right = GetMarginsValue(MARGIN_RIGHT) - (parent ? parent->GetMarginsValue(MARGIN_RIGHT) : 0);
802 if(right<=0)//The right margin in SODC can not be minus value
803 {
804 right = -1;
805 }
806 ph1->SetMargins( left, right, GetMarginsValue(MARGIN_BOTTOM));
807
808 //Word Pro has no dynamic spacing, should be set to false
809 ph1->SetDynamicSpace(false);
810}
811
812void LwpHeaderLayout::ParseBorder(XFHeaderStyle* pHeaderStyle)
813{
814 std::unique_ptr<XFBorders> pBordres = GetXFBorders();
815 if(pBordres)
816 {
817 pHeaderStyle->SetBorders(std::move(pBordres));
818 }
819}
820
821void LwpHeaderLayout::ParseShadow(XFHeaderStyle* pHeaderStyle)
822{
823 XFShadow* pXFShadow = GetXFShadow();
824 if(pXFShadow)
825 {
826 pHeaderStyle->SetShadow(pXFShadow);
827 }
828}
829
830/**
831* @descr: set header back pattern
832*
833*/
834void LwpHeaderLayout::ParsePatternFill(XFHeaderStyle* pHeaderStyle)
835{
836 std::unique_ptr<XFBGImage> xXFBGImage(GetFillPattern());
837 if (xXFBGImage)
838 {
839 pHeaderStyle->SetBackImage(xXFBGImage);
840 }
841}
842/**
843* @descr: set header background
844*
845*/
846void LwpHeaderLayout::ParseBackGround(XFHeaderStyle* pHeaderStyle)
847{
848 if (IsPatternFill())
849 {
850 ParsePatternFill(pHeaderStyle);
851 }
852 else
853 {
854 ParseBackColor(pHeaderStyle);
855 }
856}
857
858void LwpHeaderLayout::ParseBackColor(XFHeaderStyle* pHeaderStyle)
859{
860 LwpColor* pColor = GetBackColor();
861 if(pColor)
862 {
863 pHeaderStyle->SetBackColor(XFColor(pColor->To24Color()));
864 }
865}
866
867void LwpHeaderLayout::ParseWaterMark(XFHeaderStyle * pHeaderStyle)
868{
869 std::unique_ptr<XFBGImage> xXFBGImage(GetXFBGImage());
870 if (xXFBGImage)
871 {
872 pHeaderStyle->SetBackImage(xXFBGImage);
873 }
874}
875//End by
876
877void LwpHeaderLayout::RegisterStyle(XFMasterPage* mp1)
878{
879 rtl::Reference<XFHeader> xHeader(new XFHeader);
880 rtl::Reference<LwpObject> pStory = m_Content.obj();
881 if(pStory.is())
882 {
883 LwpGlobalMgr* pGlobal = LwpGlobalMgr::GetInstance();
884 LwpChangeMgr* pChangeMgr = pGlobal->GetLwpChangeMgr();
885 pChangeMgr->SetHeadFootFribMap(true);
886
887 //Call the RegisterStyle first to register the styles in header paras, and then XFConvert()
888 pStory->SetFoundry(m_pFoundry);
889 pStory->DoRegisterStyle();
890 //, 06/27/2005
891 //register child layout style for framelayout,
892 RegisterChildStyle();
893 //End
894 pChangeMgr->SetHeadFootChange(xHeader.get());
895 pStory->DoXFConvert(xHeader.get());
896
897 pChangeMgr->SetHeadFootFribMap(false);
898 }
899 mp1->SetHeader(xHeader);
900}
901
902LwpFooterLayout::LwpFooterLayout( LwpObjectHeader const &objHdr, LwpSvStream* pStrm )
903 : LwpPlacableLayout( objHdr, pStrm )
904 , m_nBorderOffset(0)
905{
906}
907
908LwpFooterLayout::~LwpFooterLayout()
909{
910}
911
912void LwpFooterLayout::Read()
913{
914 LwpPlacableLayout::Read();
915
916 if(LwpFileHeader::m_nFileRevision >= 0x000E)
917 m_nBorderOffset = m_pObjStrm->QuickReadInt32();
918 else
919 m_nBorderOffset = 0;
920 m_pObjStrm->SkipExtra();
921}
922
923void LwpFooterLayout::RegisterStyle(XFPageMaster* pm1)
924{
925 std::unique_ptr<XFFooterStyle> xFooterStyle(new XFFooterStyle);
926
927 //Modify page bottom margin
928 //page bottom margin: from bottom of footer to the bottom edge
929 double bottom = GetMarginsValue(MARGIN_BOTTOM);
930 pm1->SetMargins(-1, -1, -1, bottom);
931
932 ParseMargins(xFooterStyle.get());
933 ParseBorder(xFooterStyle.get());
934 ParseShadow(xFooterStyle.get());
935 ParseBackGround(xFooterStyle.get());
936
937 ParseWaterMark(xFooterStyle.get());
938
939 pm1->SetFooterStyle(xFooterStyle.release());
940}
941
942void LwpFooterLayout::ParseMargins(XFFooterStyle* pFooterStyle)
943{
944
945 //Set height: from top of header to top of body, including the spacing between header and body
946 double height = GetGeometryHeight() - GetMarginsValue(MARGIN_BOTTOM);
947 if( IsAutoGrowUp() )
948 {
949 pFooterStyle->SetMinHeight(height);
950 }
951 else
952 {
953 pFooterStyle->SetHeight(height);
954 }
955
956 //Set left,right,top margins
957 LwpMiddleLayout* parent = dynamic_cast<LwpMiddleLayout*> (GetParent().obj().get());
958 double left = GetMarginsValue(MARGIN_LEFT) - (parent ? parent->GetMarginsValue(MARGIN_LEFT) : 0);
959 if(left<=0) //The left margin in SODC can not be minus value
960 {
961 left = -1;
962 }
963 double right = GetMarginsValue(MARGIN_RIGHT) - (parent ? parent->GetMarginsValue(MARGIN_RIGHT) : 0);
964 if(right<=0)//The left margin in SODC can not be minus value
965 {
966 right = -1;
967 }
968 pFooterStyle->SetMargins( left, right, GetMarginsValue(MARGIN_TOP));
969
970 //Word Pro has no dynamic spacing, should be set to false
971 pFooterStyle->SetDynamicSpace(false);
972}
973
974void LwpFooterLayout::ParseBorder(XFFooterStyle* pFooterStyle)
975{
976 std::unique_ptr<XFBorders> pBordres = GetXFBorders();
977 if(pBordres)
978 {
979 pFooterStyle->SetBorders(std::move(pBordres));
980 }
981}
982
983void LwpFooterLayout::ParseShadow(XFFooterStyle* pFooterStyle)
984{
985 XFShadow* pXFShadow = GetXFShadow();
986 if(pXFShadow)
987 {
988 pFooterStyle->SetShadow(pXFShadow);
989 }
990}
991/**
992* @descr: set footer back pattern
993*
994*/
995void LwpFooterLayout::ParsePatternFill(XFFooterStyle* pFooterStyle)
996{
997 std::unique_ptr<XFBGImage> xXFBGImage(GetFillPattern());
998 if (xXFBGImage)
999 {
1000 pFooterStyle->SetBackImage(xXFBGImage);
1001 }
1002}
1003/**
1004* @descr: set footer background
1005*
1006*/
1007void LwpFooterLayout::ParseBackGround(XFFooterStyle* pFooterStyle)
1008{
1009 if (IsPatternFill())
1010 {
1011 ParsePatternFill(pFooterStyle);
1012 }
1013 else
1014 {
1015 ParseBackColor(pFooterStyle);
1016 }
1017}
1018
1019void LwpFooterLayout::ParseBackColor(XFFooterStyle* pFooterStyle)
1020{
1021 LwpColor* pColor = GetBackColor();
1022 if(pColor)
1023 {
1024 pFooterStyle->SetBackColor(XFColor(pColor->To24Color()));
1025 }
1026}
1027
1028void LwpFooterLayout::RegisterStyle(XFMasterPage* mp1)
1029{
1030 rtl::Reference<XFFooter> xFooter(new XFFooter);
1031 rtl::Reference<LwpObject> pStory = m_Content.obj(VO_STORY);
1032 //Call the RegisterStyle first to register the styles in footer paras, and then XFConvert()
1033 if(pStory.is())
1034 {
1035 LwpGlobalMgr* pGlobal = LwpGlobalMgr::GetInstance();
1036 LwpChangeMgr* pChangeMgr = pGlobal->GetLwpChangeMgr();
1037 pChangeMgr->SetHeadFootFribMap(true);
1038
1039 pStory->SetFoundry(m_pFoundry);
1040 pStory->DoRegisterStyle();
1041 //register child layout style for framelayout,
1042 RegisterChildStyle();
1043
1044 pChangeMgr->SetHeadFootChange(xFooter.get());
1045
1046 pStory->DoXFConvert(xFooter.get());
1047
1048 pChangeMgr->SetHeadFootFribMap(false);
1049 }
1050 mp1->SetFooter(xFooter);
1051}
1052
1053void LwpFooterLayout::ParseWaterMark(XFFooterStyle * pFooterStyle)
1054{
1055 std::unique_ptr<XFBGImage> xXFBGImage(GetXFBGImage());
1056 if (xXFBGImage)
1057 {
1058 pFooterStyle->SetBackImage(xXFBGImage);
1059 }
1060}
1061
1062/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
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#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__))
;
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
;
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
13
Calling 'Reference::clear'
20
Returning; memory was released
205 if (aTmp.get()) {
21
Calling 'Reference::get'
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
12
Calling 'VclPtr::disposeAndClear'
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
7
Memory is allocated
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
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#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
13.1
Field 'm_pBody' is non-null
)
14
Taking true branch
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
15
Calling 'VclReferenceBase::release'
19
Returning; memory was released
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
22
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
16
Assuming the condition is true
17
Taking true branch
40 delete this;
18
Memory is released
41 }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44 sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47
48
49private:
50 VclReferenceBase(const VclReferenceBase&) = delete;
51 VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52
53 bool mbDisposed : 1;
54
55protected:
56 VclReferenceBase();
57protected:
58 virtual ~VclReferenceBase();
59
60protected:
61 virtual void dispose();
62
63public:
64 void disposeOnce();
65 bool isDisposed() const { return mbDisposed; }
66
67};
68#endif