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 drpcps.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -D BOOST_ERROR_CODE_HEADER_ONLY -D BOOST_SYSTEM_NO_DEPRECATED -D CPPU_ENV=gcc3 -D LINUX -D OSL_DEBUG_LEVEL=1 -D SAL_LOG_INFO -D SAL_LOG_WARN -D UNIX -D UNX -D X86_64 -D _PTHREADS -D _REENTRANT -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/i18n -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/icu/source/common -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/sw/inc -I /home/maarten/src/libreoffice/core/sw/source/uibase/inc -I /home/maarten/src/libreoffice/core/sw/source/ui/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sw/sdi -I /home/maarten/src/libreoffice/core/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include -I /usr/lib/jvm/java-11-openjdk-11.0.9.10-0.0.ea.fc33.x86_64/include/linux -I /home/maarten/src/libreoffice/core/config_host -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/oovbaapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/sw/source/ui/chrdlg/drpcps.cxx

/home/maarten/src/libreoffice/core/sw/source/ui/chrdlg/drpcps.cxx

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#include <hintids.hxx>
21
22#include <cmdid.h>
23#include <docsh.hxx>
24#include <swmodule.hxx>
25#include <view.hxx>
26#include <wrtsh.hxx>
27#include <strings.hrc>
28
29#include <vcl/metric.hxx>
30#include <vcl/settings.hxx>
31
32#include <rtl/ustrbuf.hxx>
33#include <svl/stritem.hxx>
34#include <editeng/fontitem.hxx>
35#include <sfx2/dialoghelper.hxx>
36#include <sfx2/htmlmode.hxx>
37#include <sfx2/objsh.hxx>
38#include <sfx2/printer.hxx>
39#include <svtools/unitconv.hxx>
40#include <vcl/print.hxx>
41#include <vcl/svapp.hxx>
42#include <com/sun/star/i18n/BreakIterator.hpp>
43#include <com/sun/star/i18n/ScriptType.hpp>
44#include <comphelper/processfactory.hxx>
45
46#include <charatr.hxx>
47#include <viewopt.hxx>
48#include <drpcps.hxx>
49#include <paratr.hxx>
50#include <uitool.hxx>
51#include <charfmt.hxx>
52
53using namespace css;
54using namespace css::uno;
55using namespace css::lang;
56
57const sal_uInt16 SwDropCapsPage::aPageRg[] = {
58 RES_PARATR_DROP, RES_PARATR_DROP,
59 0
60};
61
62void SwDropCapsPict::SetText( const OUString& rT )
63{
64 maText = rT;
65 UpdatePaintSettings();
66}
67
68void SwDropCapsPict::SetDrawingArea(weld::DrawingArea* pDrawingArea)
69{
70 CustomWidgetController::SetDrawingArea(pDrawingArea);
71 Size aPrefSize(getParagraphPreviewOptimalSize(pDrawingArea->get_ref_device()));
72 pDrawingArea->set_size_request(aPrefSize.Width(), aPrefSize.Height());
73}
74
75void SwDropCapsPict::Resize()
76{
77 CustomWidgetController::Resize();
78 UpdatePaintSettings();
79}
80
81void SwDropCapsPict::SetLines( sal_uInt8 nL )
82{
83 mnLines = nL;
84 UpdatePaintSettings();
85}
86
87void SwDropCapsPict::SetDistance( sal_uInt16 nD )
88{
89 mnDistance = nD;
90 UpdatePaintSettings();
91}
92
93void SwDropCapsPict::SetValues( const OUString& rText, sal_uInt8 nLines, sal_uInt16 nDistance )
94{
95 maText = rText;
96 mnLines = nLines;
97 mnDistance = nDistance;
98
99 UpdatePaintSettings();
100}
101
102void SwDropCapsPict::InitPrinter()
103{
104 if( !mpPrinter )
105 InitPrinter_();
106}
107
108// Create Default-String from character-count (A, AB, ABC, ...)
109static OUString GetDefaultString(sal_Int32 nChars)
110{
111 OUStringBuffer aStr(nChars);
112 for (sal_Int32 i = 0; i < nChars; i++)
113 aStr.append(static_cast<sal_Unicode>(i + 65));
114 return aStr.makeStringAndClear();
115}
116
117static void calcFontHeightAnyAscent(vcl::RenderContext& rWin, vcl::Font const & _rFont, long& _nHeight, long& _nAscent)
118{
119 if ( !_nHeight )
120 {
121 rWin.Push(PushFlags::FONT);
122 rWin.SetFont(_rFont);
123 FontMetric aMetric(rWin.GetFontMetric());
124 _nHeight = aMetric.GetLineHeight();
125 _nAscent = aMetric.GetAscent();
126 rWin.Pop();
127 }
128}
129
130SwDropCapsPict::~SwDropCapsPict()
131{
132 if (mbDelPrinter)
2
Assuming field 'mbDelPrinter' is true
3
Taking true branch
133 mpPrinter.disposeAndClear();
4
Calling 'VclPtr::disposeAndClear'
134}
135
136/// Get the details of the first script change.
137/// @param[out] start The character position of the start of the segment.
138/// @param[out] end The character position of the end of the segment.
139/// @param[out] scriptType The script type (Latin, Asian, Complex etc.)
140void SwDropCapsPict::GetFirstScriptSegment(sal_Int32 &start, sal_Int32 &end, sal_uInt16 &scriptType)
141{
142 start = 0;
143 if( maScriptChanges.empty() )
144 {
145 end = maText.getLength();
146 scriptType = css::i18n::ScriptType::LATIN;
147 }
148 else
149 {
150 end = maScriptChanges[ 0 ].changePos;
151 scriptType = maScriptChanges[ 0 ].scriptType;
152 }
153}
154
155/// Get the details of the first script change.
156/// @param[in,out] nIdx Index of the current script change.
157/// @param[out] start The character position of the start of the segment.
158/// @param[in,out] end The character position of the end of the segment.
159/// @param[out] scriptType The script type (Latin, Asian, Complex etc.)
160/// @returns True if there was a next segment, false if not.
161bool SwDropCapsPict::GetNextScriptSegment(size_t &nIdx, sal_Int32 &start, sal_Int32 &end, sal_uInt16 &scriptType)
162{
163 if (maScriptChanges.empty() || nIdx >= maScriptChanges.size() - 1 || end >= maText.getLength())
164 return false;
165 start = maScriptChanges[nIdx++].changePos;
166 end = maScriptChanges[ nIdx ].changePos;
167 scriptType = maScriptChanges[ nIdx ].scriptType;
168 return true;
169}
170
171#define LINES10 10
172#define BORDER2 2
173
174void SwDropCapsPict::GetFontSettings( const SwDropCapsPage& _rPage, vcl::Font& _rFont, sal_uInt16 _nWhich )
175{
176 SfxItemSet aSet( _rPage.rSh.GetAttrPool(), {{_nWhich, _nWhich}});
177 _rPage.rSh.GetCurAttr(aSet);
178 SvxFontItem aFormatFont(static_cast<const SvxFontItem &>( aSet.Get(_nWhich)));
179
180 _rFont.SetFamily(aFormatFont.GetFamily());
181 _rFont.SetFamilyName(aFormatFont.GetFamilyName());
182 _rFont.SetPitch(aFormatFont.GetPitch());
183 _rFont.SetCharSet(aFormatFont.GetCharSet());
184}
185
186void SwDropCapsPict::UpdatePaintSettings()
187{
188 maBackColor = Application::GetSettings().GetStyleSettings().GetWindowColor();
189 maTextLineColor = COL_LIGHTGRAY;
190
191 // gray lines
192 mnTotLineH = (GetOutputSizePixel().Height() - 2 * BORDER2) / LINES10;
193 mnLineH = mnTotLineH - 2;
194
195 vcl::Font aFont;
196 if (mpPage)
197 {
198 // tdf#135244: preview generation should not jump document view
199 auto aLock(mpPage->rSh.GetView().GetDocShell()->LockAllViews());
200
201 if (!mpPage->m_xTemplateBox->get_active())
202 {
203 // query the Font at paragraph's beginning
204 mpPage->rSh.Push();
205 mpPage->rSh.SttCursorMove();
206 mpPage->rSh.ClearMark();
207 SwWhichPara pSwuifnParaCurr = GoCurrPara;
208 SwMoveFnCollection const & pSwuifnParaStart = fnParaStart;
209 mpPage->rSh.MovePara(pSwuifnParaCurr,pSwuifnParaStart);
210 // normal
211 GetFontSettings( *mpPage, aFont, RES_CHRATR_FONT );
212
213 // CJK
214 GetFontSettings( *mpPage, maCJKFont, RES_CHRATR_CJK_FONT );
215
216 // CTL
217 GetFontSettings( *mpPage, maCTLFont, RES_CHRATR_CTL_FONT );
218
219 mpPage->rSh.EndCursorMove();
220 mpPage->rSh.Pop(SwCursorShell::PopMode::DeleteCurrent);
221 }
222 else
223 {
224 // query Font at character template
225 SwCharFormat *pFormat = mpPage->rSh.GetCharStyle(
226 mpPage->m_xTemplateBox->get_active_text(),
227 SwWrtShell::GETSTYLE_CREATEANY );
228 OSL_ENSURE(pFormat, "character style doesn't exist!")do { if (true && (!(pFormat))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/ui/chrdlg/drpcps.cxx"
":" "228" ": "), "%s", "character style doesn't exist!"); } }
while (false)
;
229 const SvxFontItem &rFormatFont = pFormat->GetFont();
230
231 aFont.SetFamily(rFormatFont.GetFamily());
232 aFont.SetFamilyName(rFormatFont.GetFamilyName());
233 aFont.SetPitch(rFormatFont.GetPitch());
234 aFont.SetCharSet(rFormatFont.GetCharSet());
235 }
236 }
237
238 mnTextH = mnLines * mnTotLineH;
239 aFont.SetFontSize(Size(0, mnTextH));
240 maCJKFont.SetFontSize(Size(0, mnTextH));
241 maCTLFont.SetFontSize(Size(0, mnTextH));
242
243 aFont.SetTransparent(true);
244 maCJKFont.SetTransparent(true);
245 maCTLFont.SetTransparent(true);
246
247 aFont.SetColor( SwViewOption::GetFontColor() );
248 maCJKFont.SetColor( SwViewOption::GetFontColor() );
249 maCTLFont.SetColor( SwViewOption::GetFontColor() );
250
251 aFont.SetFillColor(Application::GetSettings().GetStyleSettings().GetWindowColor());
252 maCJKFont.SetFillColor(Application::GetSettings().GetStyleSettings().GetWindowColor());
253 maCTLFont.SetFillColor(Application::GetSettings().GetStyleSettings().GetWindowColor());
254
255 maCJKFont.SetFontSize(Size(0, maCJKFont.GetFontSize().Height()));
256 maCTLFont.SetFontSize(Size(0, maCTLFont.GetFontSize().Height()));
257
258 aFont.SetFontSize(Size(0, aFont.GetFontSize().Height()));
259 maFont = aFont;
260
261 CheckScript();
262
263 maTextSize = CalcTextSize();
264
265 Invalidate();
266}
267
268void SwDropCapsPict::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& /*rRect*/)
269{
270 if (!IsVisible())
271 return;
272
273 rRenderContext.SetMapMode(MapMode(MapUnit::MapPixel));
274 rRenderContext.SetLineColor();
275
276 rRenderContext.SetFillColor(maBackColor);
277
278 Size aOutputSizePixel(GetOutputSizePixel());
279
280 rRenderContext.DrawRect(tools::Rectangle(Point(0, 0), aOutputSizePixel));
281 rRenderContext.SetClipRegion(vcl::Region(tools::Rectangle(Point(BORDER2, BORDER2),
282 Size(aOutputSizePixel.Width () - 2 * BORDER2,
283 aOutputSizePixel.Height() - 2 * BORDER2))));
284
285 OSL_ENSURE(mnLineH > 0, "We cannot make it that small")do { if (true && (!(mnLineH > 0))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sw/source/ui/chrdlg/drpcps.cxx"
":" "285" ": "), "%s", "We cannot make it that small"); } } while
(false)
;
286 long nY0 = (aOutputSizePixel.Height() - (LINES10 * mnTotLineH)) / 2;
287
288 rRenderContext.SetFillColor(maTextLineColor);
289
290 for (int i = 0; i < LINES10; ++i)
291 {
292 rRenderContext.DrawRect(tools::Rectangle(Point(BORDER2, nY0 + i * mnTotLineH),
293 Size(aOutputSizePixel.Width() - 2 * BORDER2, mnLineH)));
294 }
295
296 // Text background with gap (240 twips ~ 1 line height)
297 const long nDistW = (((static_cast<long>(mnDistance) * 100) / 240) * mnTotLineH) / 100;
298 rRenderContext.SetFillColor(maBackColor);
299 if (mpPage && mpPage->m_xDropCapsBox->get_active())
300 {
301 const Size aTextSize(maTextSize.Width() + nDistW, maTextSize.Height());
302 rRenderContext.DrawRect(tools::Rectangle(Point(BORDER2, nY0), aTextSize));
303
304 // draw Text
305 DrawPrev(rRenderContext, Point(BORDER2, nY0));
306 }
307 rRenderContext.SetClipRegion();
308}
309
310void SwDropCapsPict::DrawPrev(vcl::RenderContext& rRenderContext, const Point& rPt)
311{
312 Point aPt(rPt);
313 InitPrinter();
314
315 vcl::Font aOldFont = mpPrinter->GetFont();
316 sal_uInt16 nScript;
317 size_t nIdx = 0;
318 sal_Int32 nStart;
319 sal_Int32 nEnd;
320
321 GetFirstScriptSegment(nStart, nEnd, nScript);
322
323 do
324 {
325 SvxFont& rFnt = (nScript == css::i18n::ScriptType::ASIAN)
326 ? maCJKFont
327 : ((nScript == css::i18n::ScriptType::COMPLEX)
328 ? maCTLFont
329 : maFont);
330 mpPrinter->SetFont(rFnt);
331
332 rFnt.DrawPrev(&rRenderContext, mpPrinter, aPt, maText, nStart, nEnd - nStart);
333
334 if (!maScriptChanges.empty())
335 aPt.AdjustX(maScriptChanges[nIdx].textWidth );
336
337 if (!GetNextScriptSegment(nIdx, nStart, nEnd, nScript))
338 break;
339 }
340 while(true);
341
342 mpPrinter->SetFont(aOldFont);
343}
344
345void SwDropCapsPict::CheckScript()
346{
347 if( maScriptText == maText )
348 return;
349
350 maScriptText = maText;
351 maScriptChanges.clear();
352 if( !xBreak.is() )
353 {
354 Reference< XComponentContext > xContext = ::comphelper::getProcessComponentContext();
355 xBreak = css::i18n::BreakIterator::create(xContext);
356 }
357 sal_Int16 nScript = xBreak->getScriptType( maText, 0 );
358 sal_Int32 nChg = 0;
359 if( css::i18n::ScriptType::WEAK == nScript )
360 {
361 nChg = xBreak->endOfScript( maText, nChg, nScript );
362 if( nChg < maText.getLength() )
363 nScript = xBreak->getScriptType( maText, nChg );
364 else
365 nScript = css::i18n::ScriptType::LATIN;
366 }
367
368 for(;;)
369 {
370 nChg = xBreak->endOfScript( maText, nChg, nScript );
371 maScriptChanges.emplace_back(nScript, nChg );
372 if( nChg >= maText.getLength() || nChg < 0 )
373 break;
374 nScript = xBreak->getScriptType( maText, nChg );
375 }
376}
377
378Size SwDropCapsPict::CalcTextSize()
379{
380 InitPrinter();
381
382 sal_uInt16 nScript;
383 size_t nIdx = 0;
384 sal_Int32 nStart;
385 sal_Int32 nEnd;
386 GetFirstScriptSegment(nStart, nEnd, nScript);
387 long nTextWidth = 0;
388 long nCJKHeight = 0;
389 long nCTLHeight = 0;
390 long nHeight = 0;
391 long nAscent = 0;
392 long nCJKAscent = 0;
393 long nCTLAscent = 0;
394 do
395 {
396 SvxFont& rFnt = (nScript == css::i18n::ScriptType::ASIAN)
397 ? maCJKFont
398 : ((nScript == css::i18n::ScriptType::COMPLEX)
399 ? maCTLFont
400 : maFont);
401
402 sal_uLong nWidth = rFnt.GetTextSize(mpPrinter, maText, nStart, nEnd-nStart ).Width();
403
404 if (nIdx < maScriptChanges.size())
405 maScriptChanges[nIdx].textWidth = nWidth;
406 nTextWidth += nWidth;
407 switch(nScript)
408 {
409 case css::i18n::ScriptType::ASIAN:
410 calcFontHeightAnyAscent(GetDrawingArea()->get_ref_device(), maCJKFont, nCJKHeight, nCJKAscent);
411 break;
412 case css::i18n::ScriptType::COMPLEX:
413 calcFontHeightAnyAscent(GetDrawingArea()->get_ref_device(), maCTLFont, nCTLHeight, nCTLAscent);
414 break;
415 default:
416 calcFontHeightAnyAscent(GetDrawingArea()->get_ref_device(), maFont, nHeight, nAscent);
417 }
418
419 if (!GetNextScriptSegment(nIdx, nStart, nEnd, nScript))
420 break;
421 }
422 while(true);
423
424 nHeight -= nAscent;
425 nCJKHeight -= nCJKAscent;
426 nCTLHeight -= nCTLAscent;
427 if (nHeight < nCJKHeight)
428 nHeight = nCJKHeight;
429 if (nAscent < nCJKAscent)
430 nAscent = nCJKAscent;
431 if (nHeight < nCTLHeight)
432 nHeight = nCTLHeight;
433 if (nAscent < nCTLAscent)
434 nAscent = nCTLAscent;
435 nHeight += nAscent;
436
437 Size aTextSize(nTextWidth, nHeight);
438 return aTextSize;
439}
440
441void SwDropCapsPict::InitPrinter_()
442{
443 SfxViewShell* pSh = SfxViewShell::Current();
444
445 if (pSh)
446 mpPrinter = pSh->GetPrinter();
447
448 if (!mpPrinter)
449 {
450 mpPrinter = VclPtr<Printer>::Create();
451 mbDelPrinter = true;
452 }
453}
454
455SwDropCapsDlg::SwDropCapsDlg(weld::Window *pParent, const SfxItemSet &rSet)
456 : SfxSingleTabDialogController(pParent, &rSet)
457{
458 auto xNewPage(SwDropCapsPage::Create(get_content_area(), this, &rSet));
459 static_cast<SwDropCapsPage*>(xNewPage.get())->SetFormat(false);
460 SetTabPage(std::move(xNewPage));
461}
462
463SwDropCapsPage::SwDropCapsPage(weld::Container* pPage, weld::DialogController* pController, const SfxItemSet &rSet)
464 : SfxTabPage(pPage, pController, "modules/swriter/ui/dropcapspage.ui", "DropCapPage", &rSet)
465 , bModified(false)
466 , bFormat(true)
467 , rSh(::GetActiveView()->GetWrtShell())
468 , m_xDropCapsBox(m_xBuilder->weld_check_button("checkCB_SWITCH"))
469 , m_xWholeWordCB(m_xBuilder->weld_check_button("checkCB_WORD"))
470 , m_xSwitchText(m_xBuilder->weld_label("labelFT_DROPCAPS"))
471 , m_xDropCapsField(m_xBuilder->weld_spin_button("spinFLD_DROPCAPS"))
472 , m_xLinesText(m_xBuilder->weld_label("labelTXT_LINES"))
473 , m_xLinesField(m_xBuilder->weld_spin_button("spinFLD_LINES"))
474 , m_xDistanceText(m_xBuilder->weld_label("labelTXT_DISTANCE"))
475 , m_xDistanceField(m_xBuilder->weld_metric_spin_button("spinFLD_DISTANCE", FieldUnit::CM))
476 , m_xTextText(m_xBuilder->weld_label("labelTXT_TEXT"))
477 , m_xTextEdit(m_xBuilder->weld_entry("entryEDT_TEXT"))
478 , m_xTemplateText(m_xBuilder->weld_label("labelTXT_TEMPLATE"))
479 , m_xTemplateBox(m_xBuilder->weld_combo_box("comboBOX_TEMPLATE"))
480 , m_xPict(new weld::CustomWeld(*m_xBuilder, "drawingareaWN_EXAMPLE", m_aPict))
481{
482 m_aPict.SetDropCapsPage(this);
483
484 SetExchangeSupport();
485
486 const sal_uInt16 nHtmlMode = ::GetHtmlMode(static_cast<const SwDocShell*>(SfxObjectShell::Current()));
487 bHtmlMode = (nHtmlMode & HTMLMODE_ON) != 0;
488
489 // tdf#92154 limit comboBOX_TEMPLATE length
490 const int nMaxWidth(m_xTemplateBox->get_approximate_digit_width() * 50);
491 m_xTemplateBox->set_size_request(nMaxWidth , -1);
492
493 // In the template dialog the text is not influenceable
494 m_xTextText->set_sensitive(!bFormat);
495 m_xTextEdit->set_sensitive(!bFormat);
496
497 // Metrics
498 SetFieldUnit(*m_xDistanceField, GetDfltMetric(bHtmlMode));
499
500 // Install handler
501 Link<weld::SpinButton&,void> aValueChangedLk = LINK(this, SwDropCapsPage, ValueChangedHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwDropCapsPage
*>(this), &SwDropCapsPage::LinkStubValueChangedHdl)
;
502 m_xDropCapsField->connect_value_changed(aValueChangedLk);
503 m_xLinesField->connect_value_changed(aValueChangedLk);
504 Link<weld::MetricSpinButton&,void> aMetricValueChangedLk = LINK(this, SwDropCapsPage, MetricValueChangedHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwDropCapsPage
*>(this), &SwDropCapsPage::LinkStubMetricValueChangedHdl
)
;
505 m_xDistanceField->connect_value_changed(aMetricValueChangedLk);
506 m_xTextEdit->connect_changed(LINK(this, SwDropCapsPage, ModifyHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwDropCapsPage
*>(this), &SwDropCapsPage::LinkStubModifyHdl)
);
507 m_xDropCapsBox->connect_toggled(LINK(this, SwDropCapsPage, ClickHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwDropCapsPage
*>(this), &SwDropCapsPage::LinkStubClickHdl)
);
508 m_xTemplateBox->connect_changed(LINK(this, SwDropCapsPage, SelectHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwDropCapsPage
*>(this), &SwDropCapsPage::LinkStubSelectHdl)
);
509 m_xWholeWordCB->connect_toggled(LINK(this, SwDropCapsPage, WholeWordHdl)::tools::detail::makeLink( ::tools::detail::castTo<SwDropCapsPage
*>(this), &SwDropCapsPage::LinkStubWholeWordHdl)
);
510}
511
512SwDropCapsPage::~SwDropCapsPage()
513{
514}
1
Calling '~SwDropCapsPict'
515
516DeactivateRC SwDropCapsPage::DeactivatePage(SfxItemSet * _pSet)
517{
518 if (_pSet)
519 FillSet(*_pSet);
520
521 return DeactivateRC::LeavePage;
522}
523
524std::unique_ptr<SfxTabPage> SwDropCapsPage::Create(weld::Container* pPage, weld::DialogController* pController, const SfxItemSet *rSet)
525{
526 return std::make_unique<SwDropCapsPage>(pPage, pController, *rSet);
527}
528
529bool SwDropCapsPage::FillItemSet(SfxItemSet *rSet)
530{
531 if (bModified)
532 FillSet(*rSet);
533 return bModified;
534}
535
536void SwDropCapsPage::Reset(const SfxItemSet *rSet)
537{
538 // Characters, lines, gap and text
539 SwFormatDrop aFormatDrop( rSet->Get(RES_PARATR_DROP) );
540 if (aFormatDrop.GetLines() > 1)
541 {
542 m_xDropCapsField->set_value(aFormatDrop.GetChars());
543 m_xLinesField->set_value(aFormatDrop.GetLines());
544 m_xDistanceField->set_value(m_xDistanceField->normalize(aFormatDrop.GetDistance()), FieldUnit::TWIP);
545 m_xWholeWordCB->set_active(aFormatDrop.GetWholeWord());
546 }
547 else
548 {
549 m_xDropCapsField->set_value(1);
550 m_xLinesField->set_value(3);
551 m_xDistanceField->set_value(0, FieldUnit::TWIP);
552 }
553
554 ::FillCharStyleListBox(*m_xTemplateBox, rSh.GetView().GetDocShell(), true);
555
556 m_xTemplateBox->insert_text(0, SwResId(SW_STR_NONEreinterpret_cast<char const *>("SW_STR_NONE" "\004" u8"[None]"
)
));
557
558 // Reset format
559 int nSelect = 0;
560 if (aFormatDrop.GetCharFormat())
561 {
562 int nPos = m_xTemplateBox->find_text(aFormatDrop.GetCharFormat()->GetName());
563 if (nPos != -1)
564 nSelect = nPos;
565 }
566 m_xTemplateBox->set_active(nSelect);
567
568 // Enable controls
569 m_xDropCapsBox->set_active(aFormatDrop.GetLines() > 1);
570 const sal_Int32 nVal = m_xDropCapsField->get_value();
571 if (bFormat)
572 m_xTextEdit->set_text(GetDefaultString(nVal));
573 else
574 {
575 m_xTextEdit->set_text(rSh.GetDropText(nVal));
576 m_xTextEdit->set_sensitive(true);
577 m_xTextText->set_sensitive(true);
578 }
579
580 // Preview
581 m_aPict.SetValues(m_xTextEdit->get_text(),
582 sal_uInt8(m_xLinesField->get_value()),
583 sal_uInt16(m_xDistanceField->denormalize(m_xDistanceField->get_value(FieldUnit::TWIP))));
584
585 ClickHdl(*m_xDropCapsBox);
586 bModified = false;
587}
588
589IMPL_LINK_NOARG(SwDropCapsPage, ClickHdl, weld::ToggleButton&, void)void SwDropCapsPage::LinkStubClickHdl(void * instance, weld::
ToggleButton& data) { return static_cast<SwDropCapsPage
*>(instance)->ClickHdl(data); } void SwDropCapsPage::ClickHdl
(__attribute__ ((unused)) weld::ToggleButton&)
590{
591 bool bChecked = m_xDropCapsBox->get_active();
592
593 m_xWholeWordCB->set_sensitive(bChecked && !bHtmlMode);
594
595 m_xSwitchText->set_sensitive(bChecked && !m_xWholeWordCB->get_active());
596 m_xDropCapsField->set_sensitive(bChecked && !m_xWholeWordCB->get_active());
597 m_xLinesText->set_sensitive( bChecked );
598 m_xLinesField->set_sensitive( bChecked );
599 m_xDistanceText->set_sensitive( bChecked );
600 m_xDistanceField->set_sensitive( bChecked );
601 m_xTemplateText->set_sensitive( bChecked );
602 m_xTemplateBox->set_sensitive( bChecked );
603 m_xTextEdit->set_sensitive( bChecked && !bFormat );
604 m_xTextText->set_sensitive( bChecked && !bFormat );
605
606 if ( bChecked )
607 {
608 ValueChangedHdl(*m_xDropCapsField);
609 m_xDropCapsField->grab_focus();
610 }
611 else
612 m_aPict.SetText("");
613
614 bModified = true;
615}
616
617IMPL_LINK_NOARG(SwDropCapsPage, WholeWordHdl, weld::ToggleButton&, void)void SwDropCapsPage::LinkStubWholeWordHdl(void * instance, weld
::ToggleButton& data) { return static_cast<SwDropCapsPage
*>(instance)->WholeWordHdl(data); } void SwDropCapsPage
::WholeWordHdl(__attribute__ ((unused)) weld::ToggleButton&
)
618{
619 m_xDropCapsField->set_sensitive(!m_xWholeWordCB->get_active());
620 m_xSwitchText->set_sensitive(!m_xWholeWordCB->get_active());
621
622 ValueChangedHdl(*m_xDropCapsField);
623
624 bModified = true;
625}
626
627void SwDropCapsPage::ModifyEntry(weld::Entry& rEdit)
628{
629 OUString sPreview;
630
631 // set text if applicable
632 if (&rEdit == m_xDropCapsField.get())
633 {
634 const sal_Int32 nVal = !m_xWholeWordCB->get_active()
635 ? static_cast<sal_Int32>(m_xDropCapsField->get_value())
636 : 0;
637 bool bSetText = false;
638
639 if (bFormat || rSh.GetDropText(1).isEmpty())
640 sPreview = GetDefaultString(nVal);
641 else
642 {
643 bSetText = true;
644 sPreview = rSh.GetDropText(nVal);
645 }
646
647 OUString sEdit(m_xTextEdit->get_text());
648
649 if (!sEdit.isEmpty() && !sPreview.startsWith(sEdit))
650 {
651 sPreview = sEdit.copy(0, std::min(sEdit.getLength(), sPreview.getLength()));
652 bSetText = false;
653 }
654
655 if (bSetText)
656 m_xTextEdit->set_text(sPreview);
657 }
658 else if (&rEdit == m_xTextEdit.get()) // set quantity if applicable
659 {
660 const sal_Int32 nTmp = m_xTextEdit->get_text().getLength();
661 m_xDropCapsField->set_value(std::max<sal_Int32>(1, nTmp));
662 sPreview = m_xTextEdit->get_text();
663 }
664
665 // adjust image
666 if (&rEdit == m_xDropCapsField.get() || &rEdit == m_xTextEdit.get())
667 m_aPict.SetText(sPreview);
668 else if (&rEdit == m_xLinesField.get())
669 m_aPict.SetLines(static_cast<sal_uInt8>(m_xLinesField->get_value()));
670 else
671 m_aPict.SetDistance(static_cast<sal_uInt16>(m_xDistanceField->denormalize(m_xDistanceField->get_value(FieldUnit::TWIP))));
672
673 bModified = true;
674}
675
676IMPL_LINK(SwDropCapsPage, ModifyHdl, weld::Entry&, rEdit, void)void SwDropCapsPage::LinkStubModifyHdl(void * instance, weld::
Entry& data) { return static_cast<SwDropCapsPage *>
(instance)->ModifyHdl(data); } void SwDropCapsPage::ModifyHdl
(weld::Entry& rEdit)
677{
678 ModifyEntry(rEdit);
679}
680
681IMPL_LINK(SwDropCapsPage, ValueChangedHdl, weld::SpinButton&, rEdit, void)void SwDropCapsPage::LinkStubValueChangedHdl(void * instance,
weld::SpinButton& data) { return static_cast<SwDropCapsPage
*>(instance)->ValueChangedHdl(data); } void SwDropCapsPage
::ValueChangedHdl(weld::SpinButton& rEdit)
682{
683 ModifyEntry(rEdit);
684}
685
686IMPL_LINK(SwDropCapsPage, MetricValueChangedHdl, weld::MetricSpinButton&, rEdit, void)void SwDropCapsPage::LinkStubMetricValueChangedHdl(void * instance
, weld::MetricSpinButton& data) { return static_cast<SwDropCapsPage
*>(instance)->MetricValueChangedHdl(data); } void SwDropCapsPage
::MetricValueChangedHdl(weld::MetricSpinButton& rEdit)
687{
688 ModifyEntry(rEdit.get_widget());
689}
690
691IMPL_LINK_NOARG(SwDropCapsPage, SelectHdl, weld::ComboBox&, void)void SwDropCapsPage::LinkStubSelectHdl(void * instance, weld::
ComboBox& data) { return static_cast<SwDropCapsPage *>
(instance)->SelectHdl(data); } void SwDropCapsPage::SelectHdl
(__attribute__ ((unused)) weld::ComboBox&)
692{
693 m_aPict.UpdatePaintSettings();
694 bModified = true;
695}
696
697void SwDropCapsPage::FillSet( SfxItemSet &rSet )
698{
699 if(!bModified)
700 return;
701
702 SwFormatDrop aFormat;
703
704 bool bOn = m_xDropCapsBox->get_active();
705 if (bOn)
706 {
707 // quantity, lines, gap
708 aFormat.GetChars() = static_cast<sal_uInt8>(m_xDropCapsField->get_value());
709 aFormat.GetLines() = static_cast<sal_uInt8>(m_xLinesField->get_value());
710 aFormat.GetDistance() = static_cast<sal_uInt16>(m_xDistanceField->denormalize(m_xDistanceField->get_value(FieldUnit::TWIP)));
711 aFormat.GetWholeWord() = m_xWholeWordCB->get_active();
712
713 // template
714 if (m_xTemplateBox->get_active())
715 aFormat.SetCharFormat(rSh.GetCharStyle(m_xTemplateBox->get_active_text()));
716 }
717 else
718 {
719 aFormat.GetChars() = 1;
720 aFormat.GetLines() = 1;
721 aFormat.GetDistance() = 0;
722 }
723
724 // set attributes
725 const SfxPoolItem* pOldItem;
726 if (nullptr == (pOldItem = GetOldItem(rSet, FN_FORMAT_DROPCAPS((20000 + 400) + 54))) || aFormat != *pOldItem)
727 rSet.Put(aFormat);
728
729 // hard text formatting
730 // Bug 24974: in designer/template catalog this doesn't make sense!!
731 if (!bFormat && m_xDropCapsBox->get_active())
732 {
733 OUString sText(m_xTextEdit->get_text());
734
735 if (!m_xWholeWordCB->get_active())
736 {
737 sText = sText.copy(0, std::min<sal_Int32>(sText.getLength(), m_xDropCapsField->get_value()));
738 }
739
740 SfxStringItem aStr(FN_PARAM_1((20000 + 1100)+60), sText);
741 rSet.Put(aStr);
742 }
743}
744
745/* 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);
5
Calling copy constructor for 'Reference<Printer>'
8
Returning from copy constructor for 'Reference<Printer>'
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
9
Calling 'Reference::clear'
16
Returning; memory was released
205 if (aTmp.get()) {
17
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();
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 )
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)
6
Assuming field 'm_pBody' is non-null
7
Taking true branch
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
9.1
Field 'm_pBody' is non-null
9.1
Field 'm_pBody' is non-null
9.1
Field 'm_pBody' is non-null
9.1
Field 'm_pBody' is non-null
)
10
Taking true branch
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
11
Calling 'VclReferenceBase::release'
15
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;
18
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)
12
Assuming the condition is true
13
Taking true branch
40 delete this;
14
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