Bug Summary

File:home/maarten/src/libreoffice/core/vcl/source/control/fixed.cxx
Warning:line 415, 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 fixed.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 /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/glm -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/libmount -isystem /usr/include/blkid -isystem /usr/include/cairo -isystem /usr/include/glib-2.0 -isystem /usr/lib64/glib-2.0/include -isystem /usr/include/pixman-1 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/libxml2 -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -isystem /usr/include/freetype2 -isystem /usr/include/libpng16 -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 VCL_DLLIMPLEMENTATION -D DLLIMPLEMENTATION_UITEST -D CUI_DLL_NAME="libcuilo.so" -D DESKTOP_DETECTOR_DLL_NAME="libdesktop_detectorlo.so" -D TK_DLL_NAME="libtklo.so" -D SYSTEM_ZLIB -D GLM_FORCE_CTOR_INIT -D SK_USER_CONFIG_HEADER=</home/maarten/src/libreoffice/core/config_host/config_skia.h> -D SKIA_DLL -D ENABLE_CUPS -D HAVE_VALGRIND_HEADERS -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/core -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/effects -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/config -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/ports -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/include/third_party/vulkan -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia/tools/gpu -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/skia -I /home/maarten/src/libreoffice/core/external/skia/inc/ -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/mdds/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/lcms2/include -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/workdir/UnpackedTarball/harfbuzz/src -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/graphite/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/pdfium/public -D COMPONENT_BUILD -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libpng -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/libjpeg-turbo -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/vcl/inc -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/CustomTarget/officecfg/registry -I /usr/include/freetype2 -I /usr/include/libpng16 -I /usr/include/libxml2 -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/vcl/source/control/fixed.cxx

/home/maarten/src/libreoffice/core/vcl/source/control/fixed.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 <vcl/decoview.hxx>
21#include <vcl/event.hxx>
22#include <vcl/toolkit/fixed.hxx>
23#include <vcl/settings.hxx>
24
25#include <comphelper/string.hxx>
26#include <sal/log.hxx>
27#include <controldata.hxx>
28
29#define FIXEDLINE_TEXT_BORDER4 4
30
31constexpr auto FIXEDTEXT_VIEW_STYLE = WB_3DLOOK |
32 WB_LEFT | WB_CENTER | WB_RIGHT |
33 WB_TOP | WB_VCENTER | WB_BOTTOM |
34 WB_WORDBREAK | WB_NOLABEL |
35 WB_PATHELLIPSIS;
36constexpr auto FIXEDLINE_VIEW_STYLE = WB_3DLOOK | WB_NOLABEL;
37constexpr auto FIXEDBITMAP_VIEW_STYLE = WB_3DLOOK |
38 WB_LEFT | WB_CENTER | WB_RIGHT |
39 WB_TOP | WB_VCENTER | WB_BOTTOM |
40 WB_SCALE;
41constexpr auto FIXEDIMAGE_VIEW_STYLE = WB_3DLOOK |
42 WB_LEFT | WB_CENTER | WB_RIGHT |
43 WB_TOP | WB_VCENTER | WB_BOTTOM |
44 WB_SCALE;
45
46static Point ImplCalcPos( WinBits nStyle, const Point& rPos,
47 const Size& rObjSize, const Size& rWinSize )
48{
49 long nX;
50 long nY;
51
52 if ( nStyle & WB_LEFT )
53 nX = 0;
54 else if ( nStyle & WB_RIGHT )
55 nX = rWinSize.Width()-rObjSize.Width();
56 else
57 nX = (rWinSize.Width()-rObjSize.Width())/2;
58
59 if ( nStyle & WB_TOP )
60 nY = 0;
61 else if ( nStyle & WB_BOTTOM )
62 nY = rWinSize.Height()-rObjSize.Height();
63 else
64 nY = (rWinSize.Height()-rObjSize.Height())/2;
65
66 Point aPos( nX+rPos.X(), nY+rPos.Y() );
67 return aPos;
68}
69
70void FixedText::ImplInit( vcl::Window* pParent, WinBits nStyle )
71{
72 nStyle = ImplInitStyle( nStyle );
73 Control::ImplInit( pParent, nStyle, nullptr );
74 ApplySettings(*this);
75}
76
77WinBits FixedText::ImplInitStyle( WinBits nStyle )
78{
79 if ( !(nStyle & WB_NOGROUP) )
80 nStyle |= WB_GROUP;
81 return nStyle;
82}
83
84const vcl::Font& FixedText::GetCanonicalFont( const StyleSettings& _rStyle ) const
85{
86 return _rStyle.GetLabelFont();
87}
88
89const Color& FixedText::GetCanonicalTextColor( const StyleSettings& _rStyle ) const
90{
91 return _rStyle.GetLabelTextColor();
92}
93
94FixedText::FixedText( vcl::Window* pParent, WinBits nStyle )
95 : Control(WindowType::FIXEDTEXT)
96 , m_nMaxWidthChars(-1)
97 , m_nMinWidthChars(-1)
98 , m_pMnemonicWindow(nullptr)
99{
100 ImplInit( pParent, nStyle );
101}
102
103DrawTextFlags FixedText::ImplGetTextStyle( WinBits nWinStyle )
104{
105 DrawTextFlags nTextStyle = DrawTextFlags::Mnemonic | DrawTextFlags::EndEllipsis;
106
107 if( ! (nWinStyle & WB_NOMULTILINE) )
108 nTextStyle |= DrawTextFlags::MultiLine;
109
110 if ( nWinStyle & WB_RIGHT )
111 nTextStyle |= DrawTextFlags::Right;
112 else if ( nWinStyle & WB_CENTER )
113 nTextStyle |= DrawTextFlags::Center;
114 else
115 nTextStyle |= DrawTextFlags::Left;
116 if ( nWinStyle & WB_BOTTOM )
117 nTextStyle |= DrawTextFlags::Bottom;
118 else if ( nWinStyle & WB_VCENTER )
119 nTextStyle |= DrawTextFlags::VCenter;
120 else
121 nTextStyle |= DrawTextFlags::Top;
122 if ( nWinStyle & WB_WORDBREAK )
123 {
124 nTextStyle |= DrawTextFlags::WordBreak;
125 if ( (nWinStyle & WB_HYPHENATION ) == WB_HYPHENATION )
126 nTextStyle |= DrawTextFlags::WordBreakHyphenation;
127 }
128 if ( nWinStyle & WB_NOLABEL )
129 nTextStyle &= ~DrawTextFlags::Mnemonic;
130
131 return nTextStyle;
132}
133
134void FixedText::ImplDraw(OutputDevice* pDev, DrawFlags nDrawFlags,
135 const Point& rPos, const Size& rSize,
136 bool bFillLayout) const
137{
138 const StyleSettings& rStyleSettings = pDev->GetSettings().GetStyleSettings();
139 WinBits nWinStyle = GetStyle();
140 OUString aText(GetText());
141 DrawTextFlags nTextStyle = FixedText::ImplGetTextStyle( nWinStyle );
142 Point aPos = rPos;
143
144 if ( nWinStyle & WB_EXTRAOFFSET )
145 aPos.AdjustX(2 );
146
147 if ( nWinStyle & WB_PATHELLIPSIS )
148 {
149 nTextStyle &= ~DrawTextFlags(DrawTextFlags::EndEllipsis | DrawTextFlags::MultiLine | DrawTextFlags::WordBreak);
150 nTextStyle |= DrawTextFlags::PathEllipsis;
151 }
152 if ( !IsEnabled() )
153 nTextStyle |= DrawTextFlags::Disable;
154 if ( (nDrawFlags & DrawFlags::Mono) ||
155 (rStyleSettings.GetOptions() & StyleSettingsOptions::Mono) )
156 nTextStyle |= DrawTextFlags::Mono;
157
158 if( bFillLayout )
159 mpControlData->mpLayoutData->m_aDisplayText.clear();
160
161 const tools::Rectangle aRect(aPos, rSize);
162 DrawControlText(*pDev, aRect, aText, nTextStyle,
163 bFillLayout ? &mpControlData->mpLayoutData->m_aUnicodeBoundRects : nullptr,
164 bFillLayout ? &mpControlData->mpLayoutData->m_aDisplayText : nullptr);
165}
166
167void FixedText::ApplySettings(vcl::RenderContext& rRenderContext)
168{
169 Control::ApplySettings(rRenderContext);
170
171 vcl::Window* pParent = GetParent();
172 bool bEnableTransparent = true;
173 if (!pParent->IsChildTransparentModeEnabled() || IsControlBackground())
174 {
175 EnableChildTransparentMode(false);
176 SetParentClipMode();
177 SetPaintTransparent(false);
178
179 if (IsControlBackground())
180 rRenderContext.SetBackground(GetControlBackground());
181 else
182 rRenderContext.SetBackground(pParent->GetBackground());
183
184 if (rRenderContext.IsBackground())
185 bEnableTransparent = false;
186 }
187
188 if (bEnableTransparent)
189 {
190 EnableChildTransparentMode();
191 SetParentClipMode(ParentClipMode::NoClip);
192 SetPaintTransparent(true);
193 rRenderContext.SetBackground();
194 }
195}
196
197void FixedText::Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& )
198{
199 ImplDraw(&rRenderContext, DrawFlags::NONE, Point(), GetOutputSizePixel());
200}
201
202void FixedText::Draw( OutputDevice* pDev, const Point& rPos,
203 DrawFlags nFlags )
204{
205 ApplySettings(*pDev);
206
207 Point aPos = pDev->LogicToPixel( rPos );
208 Size aSize = GetSizePixel();
209 vcl::Font aFont = GetDrawPixelFont( pDev );
210
211 pDev->Push();
212 pDev->SetMapMode();
213 pDev->SetFont( aFont );
214 if ( nFlags & DrawFlags::Mono )
215 pDev->SetTextColor( COL_BLACK );
216 else
217 pDev->SetTextColor( GetTextColor() );
218 pDev->SetTextFillColor();
219
220 bool bBorder = (GetStyle() & WB_BORDER);
221 bool bBackground = IsControlBackground();
222 if ( bBorder || bBackground )
223 {
224 tools::Rectangle aRect( aPos, aSize );
225 if ( bBorder )
226 {
227 ImplDrawFrame( pDev, aRect );
228 }
229 if ( bBackground )
230 {
231 pDev->SetFillColor( GetControlBackground() );
232 pDev->DrawRect( aRect );
233 }
234 }
235
236 ImplDraw( pDev, nFlags, aPos, aSize );
237 pDev->Pop();
238}
239
240void FixedText::Resize()
241{
242 Control::Resize();
243 Invalidate();
244}
245
246void FixedText::StateChanged( StateChangedType nType )
247{
248 Control::StateChanged( nType );
249
250 if ( (nType == StateChangedType::Enable) ||
251 (nType == StateChangedType::Text) ||
252 (nType == StateChangedType::UpdateMode) )
253 {
254 if ( IsReallyVisible() && IsUpdateMode() )
255 Invalidate();
256 }
257 else if ( nType == StateChangedType::Style )
258 {
259 SetStyle( ImplInitStyle( GetStyle() ) );
260 if ( (GetPrevStyle() & FIXEDTEXT_VIEW_STYLE) !=
261 (GetStyle() & FIXEDTEXT_VIEW_STYLE) )
262 {
263 ApplySettings(*this);
264 Invalidate();
265 }
266 }
267 else if ( (nType == StateChangedType::Zoom) ||
268 (nType == StateChangedType::ControlFont) )
269 {
270 ApplySettings(*this);
271 Invalidate();
272 }
273 else if ( nType == StateChangedType::ControlForeground )
274 {
275 ApplySettings(*this);
276 Invalidate();
277 }
278 else if ( nType == StateChangedType::ControlBackground )
279 {
280 ApplySettings(*this);
281 Invalidate();
282 }
283}
284
285void FixedText::DataChanged( const DataChangedEvent& rDCEvt )
286{
287 Control::DataChanged( rDCEvt );
288
289 if ( (rDCEvt.GetType() == DataChangedEventType::FONTS) ||
290 (rDCEvt.GetType() == DataChangedEventType::FONTSUBSTITUTION) ||
291 ((rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
292 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE)) )
293 {
294 ApplySettings(*this);
295 Invalidate();
296 }
297}
298
299Size FixedText::getTextDimensions(Control const *pControl, const OUString &rTxt, long nMaxWidth)
300{
301 DrawTextFlags nStyle = ImplGetTextStyle( pControl->GetStyle() );
302 if ( !( pControl->GetStyle() & WB_NOLABEL ) )
303 nStyle |= DrawTextFlags::Mnemonic;
304
305 return pControl->GetTextRect(tools::Rectangle( Point(), Size(nMaxWidth, 0x7fffffff)),
306 rTxt, nStyle).GetSize();
307}
308
309Size FixedText::CalcMinimumTextSize( Control const *pControl, long nMaxWidth )
310{
311 Size aSize = getTextDimensions(pControl, pControl->GetText(), nMaxWidth);
312
313 if ( pControl->GetStyle() & WB_EXTRAOFFSET )
314 aSize.AdjustWidth(2 );
315
316 // GetTextRect cannot take an empty string
317 if ( aSize.Width() < 0 )
318 aSize.setWidth( 0 );
319 if ( aSize.Height() <= 0 )
320 aSize.setHeight( pControl->GetTextHeight() );
321
322 return aSize;
323}
324
325Size FixedText::CalcMinimumSize( long nMaxWidth ) const
326{
327 return CalcWindowSize( CalcMinimumTextSize ( this, nMaxWidth ) );
328}
329
330Size FixedText::GetOptimalSize() const
331{
332 sal_Int32 nMaxAvailWidth = 0x7fffffff;
333 if (m_nMaxWidthChars != -1)
334 {
335 OUStringBuffer aBuf;
336 comphelper::string::padToLength(aBuf, m_nMaxWidthChars, 'x');
337 nMaxAvailWidth = getTextDimensions(this,
338 aBuf.makeStringAndClear(), 0x7fffffff).Width();
339 }
340 Size aRet = CalcMinimumSize(nMaxAvailWidth);
341 if (m_nMinWidthChars != -1)
342 {
343 OUStringBuffer aBuf;
344 comphelper::string::padToLength(aBuf, m_nMinWidthChars, 'x');
345 Size aMinAllowed = getTextDimensions(this,
346 aBuf.makeStringAndClear(), 0x7fffffff);
347 aRet.setWidth(std::max(aMinAllowed.Width(), aRet.Width()));
348 }
349 return aRet;
350}
351
352void FixedText::FillLayoutData() const
353{
354 mpControlData->mpLayoutData.reset( new vcl::ControlLayoutData );
355 ImplDraw(const_cast<FixedText*>(this), DrawFlags::NONE, Point(), GetOutputSizePixel(), true);
356 //const_cast<FixedText*>(this)->Invalidate();
357}
358
359void FixedText::setMaxWidthChars(sal_Int32 nWidth)
360{
361 if (nWidth != m_nMaxWidthChars)
362 {
363 m_nMaxWidthChars = nWidth;
364 queue_resize();
365 }
366}
367
368void FixedText::setMinWidthChars(sal_Int32 nWidth)
369{
370 if (nWidth != m_nMinWidthChars)
371 {
372 m_nMinWidthChars = nWidth;
373 queue_resize();
374 }
375}
376
377bool FixedText::set_property(const OString &rKey, const OUString &rValue)
378{
379 if (rKey == "max-width-chars")
380 setMaxWidthChars(rValue.toInt32());
381 else if (rKey == "width-chars")
382 setMinWidthChars(rValue.toInt32());
383 else if (rKey == "ellipsize")
384 {
385 WinBits nBits = GetStyle();
386 nBits &= ~WB_PATHELLIPSIS;
387 if (rValue != "none")
388 {
389 SAL_WARN_IF(rValue != "end", "vcl.layout", "Only endellipsis support for now")do { if (true && (rValue != "end")) { switch (sal_detail_log_report
(::SAL_DETAIL_LOG_LEVEL_WARN, "vcl.layout")) { case SAL_DETAIL_LOG_ACTION_IGNORE
: break; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail
::getResult( ::sal::detail::StreamStart() << "Only endellipsis support for now"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.layout"
), ("/home/maarten/src/libreoffice/core/vcl/source/control/fixed.cxx"
":" "389" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Only endellipsis support for now"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "Only endellipsis support for now"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.layout"), ("/home/maarten/src/libreoffice/core/vcl/source/control/fixed.cxx"
":" "389" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "Only endellipsis support for now") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.layout"), ("/home/maarten/src/libreoffice/core/vcl/source/control/fixed.cxx"
":" "389" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Only endellipsis support for now"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "Only endellipsis support for now"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.layout"), ("/home/maarten/src/libreoffice/core/vcl/source/control/fixed.cxx"
":" "389" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
390 nBits |= WB_PATHELLIPSIS;
391 }
392 SetStyle(nBits);
393 }
394 else
395 return Control::set_property(rKey, rValue);
396 return true;
397}
398
399vcl::Window* FixedText::getAccessibleRelationLabelFor() const
400{
401 vcl::Window *pWindow = Control::getAccessibleRelationLabelFor();
402 if (pWindow)
403 return pWindow;
404 return get_mnemonic_widget();
405}
406
407void FixedText::set_mnemonic_widget(vcl::Window *pWindow)
408{
409 if (pWindow == m_pMnemonicWindow)
2
←
Taking false branch
→
410 return;
411 if (m_pMnemonicWindow)
3
←
Taking true branch
→
412 {
413 vcl::Window *pTempReEntryGuard = m_pMnemonicWindow;
414 m_pMnemonicWindow = nullptr;
4
←
Calling 'VclPtr::operator='
→
14
←
Returning; memory was released
→
415 pTempReEntryGuard->remove_mnemonic_label(this);
15
←
Use of memory after it is freed
416 }
417 m_pMnemonicWindow = pWindow;
418 if (m_pMnemonicWindow)
419 m_pMnemonicWindow->add_mnemonic_label(this);
420}
421
422FixedText::~FixedText()
423{
424 disposeOnce();
425}
426
427void FixedText::dispose()
428{
429 set_mnemonic_widget(nullptr);
1
Calling 'FixedText::set_mnemonic_widget'
→
430 m_pMnemonicWindow.clear();
431 Control::dispose();
432}
433
434SelectableFixedText::SelectableFixedText(vcl::Window* pParent, WinBits nStyle)
435 : Edit(pParent, nStyle)
436{
437 // no border
438 SetBorderStyle( WindowBorderStyle::NOBORDER );
439 // read-only
440 SetReadOnly();
441 // make it transparent
442 SetPaintTransparent(true);
443 SetControlBackground();
444}
445
446void SelectableFixedText::ApplySettings(vcl::RenderContext& rRenderContext)
447{
448 rRenderContext.SetBackground();
449}
450
451void SelectableFixedText::LoseFocus()
452{
453 Edit::LoseFocus();
454 // clear cursor
455 Invalidate();
456}
457
458void FixedLine::ImplInit( vcl::Window* pParent, WinBits nStyle )
459{
460 nStyle = ImplInitStyle( nStyle );
461 Control::ImplInit( pParent, nStyle, nullptr );
462 ApplySettings(*this);
463}
464
465WinBits FixedLine::ImplInitStyle( WinBits nStyle )
466{
467 if ( !(nStyle & WB_NOGROUP) )
468 nStyle |= WB_GROUP;
469 return nStyle;
470}
471
472const vcl::Font& FixedLine::GetCanonicalFont( const StyleSettings& _rStyle ) const
473{
474 return _rStyle.GetGroupFont();
475}
476
477const Color& FixedLine::GetCanonicalTextColor( const StyleSettings& _rStyle ) const
478{
479 return _rStyle.GetGroupTextColor();
480}
481
482void FixedLine::ImplDraw(vcl::RenderContext& rRenderContext)
483{
484 // we need to measure according to the window, not according to the
485 // RenderContext we paint to
486 Size aOutSize = GetOutputSizePixel();
487
488 OUString aText = GetText();
489 WinBits nWinStyle = GetStyle();
490
491 DecorationView aDecoView(&rRenderContext);
492 if (aText.isEmpty())
493 {
494 if (nWinStyle & WB_VERT)
495 {
496 long nX = (aOutSize.Width() - 1) / 2;
497 aDecoView.DrawSeparator(Point(nX, 0), Point(nX, aOutSize.Height() - 1));
498 }
499 else
500 {
501 long nY = (aOutSize.Height() - 1) / 2;
502 aDecoView.DrawSeparator(Point(0, nY), Point(aOutSize.Width() - 1, nY), false);
503 }
504 }
505 else if (nWinStyle & WB_VERT)
506 {
507 long nWidth = rRenderContext.GetTextWidth(aText);
508 rRenderContext.Push(PushFlags::FONT);
509 vcl::Font aFont(rRenderContext.GetFont());
510 aFont.SetOrientation(900);
511 SetFont(aFont);
512 Point aStartPt(aOutSize.Width() / 2, aOutSize.Height() - 1);
513 if (nWinStyle & WB_VCENTER)
514 aStartPt.AdjustY( -((aOutSize.Height() - nWidth) / 2) );
515 Point aTextPt(aStartPt);
516 aTextPt.AdjustX( -(GetTextHeight() / 2) );
517 rRenderContext.DrawText(aTextPt, aText, 0, aText.getLength());
518 rRenderContext.Pop();
519 if (aOutSize.Height() - aStartPt.Y() > FIXEDLINE_TEXT_BORDER4)
520 aDecoView.DrawSeparator(Point(aStartPt.X(), aStartPt.Y() + FIXEDLINE_TEXT_BORDER4),
521 Point(aStartPt.X(), aOutSize.Height() - 1));
522 if (aStartPt.Y() - nWidth - FIXEDLINE_TEXT_BORDER4 > 0)
523 aDecoView.DrawSeparator(Point(aStartPt.X(), 0),
524 Point(aStartPt.X(), aStartPt.Y() - nWidth - FIXEDLINE_TEXT_BORDER4));
525 }
526 else
527 {
528 DrawTextFlags nStyle = DrawTextFlags::Mnemonic | DrawTextFlags::Left | DrawTextFlags::VCenter | DrawTextFlags::EndEllipsis;
529 tools::Rectangle aRect(0, 0, aOutSize.Width(), aOutSize.Height());
530 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
531 if (nWinStyle & WB_CENTER)
532 nStyle |= DrawTextFlags::Center;
533
534 if (!IsEnabled())
535 nStyle |= DrawTextFlags::Disable;
536 if (GetStyle() & WB_NOLABEL)
537 nStyle &= ~DrawTextFlags::Mnemonic;
538 if (rStyleSettings.GetOptions() & StyleSettingsOptions::Mono)
539 nStyle |= DrawTextFlags::Mono;
540
541 aRect = DrawControlText(*this, aRect, aText, nStyle, nullptr, nullptr);
542
543 long nTop = aRect.Top() + ((aRect.GetHeight() - 1) / 2);
544 aDecoView.DrawSeparator(Point(aRect.Right() + FIXEDLINE_TEXT_BORDER4, nTop), Point(aOutSize.Width() - 1, nTop), false);
545 if (aRect.Left() > FIXEDLINE_TEXT_BORDER4)
546 aDecoView.DrawSeparator(Point(0, nTop), Point(aRect.Left() - FIXEDLINE_TEXT_BORDER4, nTop), false);
547 }
548}
549
550FixedLine::FixedLine( vcl::Window* pParent, WinBits nStyle ) :
551 Control( WindowType::FIXEDLINE )
552{
553 ImplInit( pParent, nStyle );
554 SetSizePixel( Size( 2, 2 ) );
555}
556
557void FixedLine::FillLayoutData() const
558{
559 mpControlData->mpLayoutData.reset( new vcl::ControlLayoutData );
560 const_cast<FixedLine*>(this)->Invalidate();
561}
562
563void FixedLine::ApplySettings(vcl::RenderContext& rRenderContext)
564{
565 Control::ApplySettings(rRenderContext);
566
567 vcl::Window* pParent = GetParent();
568 if (pParent->IsChildTransparentModeEnabled() && !IsControlBackground())
569 {
570 EnableChildTransparentMode();
571 SetParentClipMode(ParentClipMode::NoClip);
572 SetPaintTransparent(true);
573 rRenderContext.SetBackground();
574 }
575 else
576 {
577 EnableChildTransparentMode(false);
578 SetParentClipMode();
579 SetPaintTransparent(false);
580
581 if (IsControlBackground())
582 rRenderContext.SetBackground(GetControlBackground());
583 else
584 rRenderContext.SetBackground(pParent->GetBackground());
585 }
586}
587
588void FixedLine::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&)
589{
590 ImplDraw(rRenderContext);
591}
592
593void FixedLine::Draw( OutputDevice*, const Point&, DrawFlags )
594{
595}
596
597void FixedLine::Resize()
598{
599 Control::Resize();
600 Invalidate();
601}
602
603void FixedLine::StateChanged( StateChangedType nType )
604{
605 Control::StateChanged( nType );
606
607 if ( (nType == StateChangedType::Enable) ||
608 (nType == StateChangedType::Text) ||
609 (nType == StateChangedType::UpdateMode) )
610 {
611 if ( IsReallyVisible() && IsUpdateMode() )
612 Invalidate();
613 }
614 else if ( nType == StateChangedType::Style )
615 {
616 SetStyle( ImplInitStyle( GetStyle() ) );
617 if ( (GetPrevStyle() & FIXEDLINE_VIEW_STYLE) !=
618 (GetStyle() & FIXEDLINE_VIEW_STYLE) )
619 Invalidate();
620 }
621 else if ( (nType == StateChangedType::Zoom) ||
622 (nType == StateChangedType::Style) ||
623 (nType == StateChangedType::ControlFont) )
624 {
625 ApplySettings(*this);
626 Invalidate();
627 }
628 else if ( nType == StateChangedType::ControlForeground )
629 {
630 ApplySettings(*this);
631 Invalidate();
632 }
633 else if ( nType == StateChangedType::ControlBackground )
634 {
635 ApplySettings(*this);
636 Invalidate();
637 }
638}
639
640void FixedLine::DataChanged( const DataChangedEvent& rDCEvt )
641{
642 Control::DataChanged( rDCEvt );
643
644 if ( (rDCEvt.GetType() == DataChangedEventType::FONTS) ||
645 (rDCEvt.GetType() == DataChangedEventType::FONTSUBSTITUTION) ||
646 ((rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
647 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE)) )
648 {
649 ApplySettings(*this);
650 Invalidate();
651 }
652}
653
654Size FixedLine::GetOptimalSize() const
655{
656 return CalcWindowSize( FixedText::CalcMinimumTextSize ( this ) );
657}
658
659void FixedBitmap::ImplInit( vcl::Window* pParent, WinBits nStyle )
660{
661 nStyle = ImplInitStyle( nStyle );
662 Control::ImplInit( pParent, nStyle, nullptr );
663 ApplySettings(*this);
664}
665
666WinBits FixedBitmap::ImplInitStyle( WinBits nStyle )
667{
668 if ( !(nStyle & WB_NOGROUP) )
669 nStyle |= WB_GROUP;
670 return nStyle;
671}
672
673FixedBitmap::FixedBitmap( vcl::Window* pParent, WinBits nStyle ) :
674 Control( WindowType::FIXEDBITMAP )
675{
676 ImplInit( pParent, nStyle );
677}
678
679void FixedBitmap::ImplDraw( OutputDevice* pDev, const Point& rPos, const Size& rSize )
680{
681 // do we have a Bitmap?
682 if ( !!maBitmap )
683 {
684 if ( GetStyle() & WB_SCALE )
685 pDev->DrawBitmapEx( rPos, rSize, maBitmap );
686 else
687 {
688 Point aPos = ImplCalcPos( GetStyle(), rPos, maBitmap.GetSizePixel(), rSize );
689 pDev->DrawBitmapEx( aPos, maBitmap );
690 }
691 }
692}
693
694void FixedBitmap::ApplySettings(vcl::RenderContext& rRenderContext)
695{
696 vcl::Window* pParent = GetParent();
697 if (pParent->IsChildTransparentModeEnabled() && !IsControlBackground())
698 {
699 EnableChildTransparentMode();
700 SetParentClipMode(ParentClipMode::NoClip);
701 SetPaintTransparent(true);
702 rRenderContext.SetBackground();
703 }
704 else
705 {
706 EnableChildTransparentMode(false);
707 SetParentClipMode();
708 SetPaintTransparent(false);
709
710 if (IsControlBackground())
711 rRenderContext.SetBackground(GetControlBackground());
712 else
713 rRenderContext.SetBackground(pParent->GetBackground());
714 }
715}
716
717void FixedBitmap::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&)
718{
719 ImplDraw(&rRenderContext, Point(), GetOutputSizePixel());
720}
721
722void FixedBitmap::Draw( OutputDevice* pDev, const Point& rPos,
723 DrawFlags )
724{
725 Point aPos = pDev->LogicToPixel( rPos );
726 Size aSize = GetSizePixel();
727 tools::Rectangle aRect( aPos, aSize );
728
729 pDev->Push();
730 pDev->SetMapMode();
731
732 // Border
733 if ( GetStyle() & WB_BORDER )
734 {
735 DecorationView aDecoView( pDev );
736 aRect = aDecoView.DrawFrame( aRect, DrawFrameStyle::DoubleIn );
737 }
738 pDev->IntersectClipRegion( aRect );
739 ImplDraw( pDev, aRect.TopLeft(), aRect.GetSize() );
740
741 pDev->Pop();
742}
743
744void FixedBitmap::Resize()
745{
746 Control::Resize();
747 Invalidate();
748}
749
750void FixedBitmap::StateChanged( StateChangedType nType )
751{
752 Control::StateChanged( nType );
753
754 if ( (nType == StateChangedType::Data) ||
755 (nType == StateChangedType::UpdateMode) )
756 {
757 if ( IsReallyVisible() && IsUpdateMode() )
758 Invalidate();
759 }
760 else if ( nType == StateChangedType::Style )
761 {
762 SetStyle( ImplInitStyle( GetStyle() ) );
763 if ( (GetPrevStyle() & FIXEDBITMAP_VIEW_STYLE) !=
764 (GetStyle() & FIXEDBITMAP_VIEW_STYLE) )
765 Invalidate();
766 }
767 else if ( nType == StateChangedType::ControlBackground )
768 {
769 ApplySettings(*this);
770 Invalidate();
771 }
772}
773
774void FixedBitmap::DataChanged( const DataChangedEvent& rDCEvt )
775{
776 Control::DataChanged( rDCEvt );
777
778 if ( (rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
779 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) )
780 {
781 ApplySettings(*this);
782 Invalidate();
783 }
784}
785
786void FixedBitmap::SetBitmap( const BitmapEx& rBitmap )
787{
788 maBitmap = rBitmap;
789 CompatStateChanged( StateChangedType::Data );
790 queue_resize();
791}
792
793void FixedImage::ImplInit( vcl::Window* pParent, WinBits nStyle )
794{
795 nStyle = ImplInitStyle( nStyle );
796 Control::ImplInit( pParent, nStyle, nullptr );
797 ApplySettings(*this);
798}
799
800WinBits FixedImage::ImplInitStyle( WinBits nStyle )
801{
802 if ( !(nStyle & WB_NOGROUP) )
803 nStyle |= WB_GROUP;
804 return nStyle;
805}
806
807FixedImage::FixedImage( vcl::Window* pParent, WinBits nStyle ) :
808 Control( WindowType::FIXEDIMAGE )
809{
810 ImplInit( pParent, nStyle );
811}
812
813void FixedImage::ImplDraw( OutputDevice* pDev,
814 const Point& rPos, const Size& rSize )
815{
816 DrawImageFlags nStyle = DrawImageFlags::NONE;
817 if ( !IsEnabled() )
818 nStyle |= DrawImageFlags::Disable;
819
820 Image *pImage = &maImage;
821
822 // do we have an image?
823 if ( !(!(*pImage)) )
824 {
825 if ( GetStyle() & WB_SCALE )
826 pDev->DrawImage( rPos, rSize, *pImage, nStyle );
827 else
828 {
829 Point aPos = ImplCalcPos( GetStyle(), rPos, pImage->GetSizePixel(), rSize );
830 pDev->DrawImage( aPos, *pImage, nStyle );
831 }
832 }
833}
834
835void FixedImage::ApplySettings(vcl::RenderContext& rRenderContext)
836{
837 vcl::Window* pParent = GetParent();
838 if (pParent && pParent->IsChildTransparentModeEnabled() && !IsControlBackground())
839 {
840 EnableChildTransparentMode();
841 SetParentClipMode(ParentClipMode::NoClip);
842 SetPaintTransparent(true);
843 rRenderContext.SetBackground();
844 }
845 else
846 {
847 EnableChildTransparentMode(false);
848 SetParentClipMode();
849 SetPaintTransparent(false);
850
851 if (IsControlBackground())
852 rRenderContext.SetBackground(GetControlBackground());
853 else if (pParent)
854 rRenderContext.SetBackground(pParent->GetBackground());
855 }
856}
857
858
859void FixedImage::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&)
860{
861 ImplDraw(&rRenderContext, Point(), GetOutputSizePixel());
862}
863
864Size FixedImage::GetOptimalSize() const
865{
866 return maImage.GetSizePixel();
867}
868
869void FixedImage::Draw( OutputDevice* pDev, const Point& rPos,
870 DrawFlags )
871{
872 Point aPos = pDev->LogicToPixel( rPos );
873 Size aSize = GetSizePixel();
874 tools::Rectangle aRect( aPos, aSize );
875
876 pDev->Push();
877 pDev->SetMapMode();
878
879 // Border
880 if ( GetStyle() & WB_BORDER )
881 {
882 ImplDrawFrame( pDev, aRect );
883 }
884 pDev->IntersectClipRegion( aRect );
885 ImplDraw( pDev, aRect.TopLeft(), aRect.GetSize() );
886
887 pDev->Pop();
888}
889
890void FixedImage::Resize()
891{
892 Control::Resize();
893 Invalidate();
894}
895
896void FixedImage::StateChanged( StateChangedType nType )
897{
898 Control::StateChanged( nType );
899
900 if ( (nType == StateChangedType::Enable) ||
901 (nType == StateChangedType::Data) ||
902 (nType == StateChangedType::UpdateMode) )
903 {
904 if ( IsReallyVisible() && IsUpdateMode() )
905 Invalidate();
906 }
907 else if ( nType == StateChangedType::Style )
908 {
909 SetStyle( ImplInitStyle( GetStyle() ) );
910 if ( (GetPrevStyle() & FIXEDIMAGE_VIEW_STYLE) !=
911 (GetStyle() & FIXEDIMAGE_VIEW_STYLE) )
912 Invalidate();
913 }
914 else if ( nType == StateChangedType::ControlBackground )
915 {
916 ApplySettings(*this);
917 Invalidate();
918 }
919}
920
921void FixedImage::DataChanged( const DataChangedEvent& rDCEvt )
922{
923 Control::DataChanged( rDCEvt );
924
925 if ( (rDCEvt.GetType() == DataChangedEventType::SETTINGS) &&
926 (rDCEvt.GetFlags() & AllSettingsFlags::STYLE) )
927 {
928 ApplySettings(*this);
929 Invalidate();
930 }
931}
932
933void FixedImage::SetImage( const Image& rImage )
934{
935 if ( rImage != maImage )
936 {
937 maImage = rImage;
938 CompatStateChanged( StateChangedType::Data );
939 queue_resize();
940 }
941}
942
943void FixedImage::SetModeImage( const Image& rImage )
944{
945 SetImage( rImage );
946}
947
948Image FixedImage::loadThemeImage(const OUString &rFileName)
949{
950 return Image(StockImage::Yes, rFileName);
951}
952
953bool FixedImage::set_property(const OString &rKey, const OUString &rValue)
954{
955 if (rKey == "pixbuf" || rKey == "icon-name")
956 {
957 SetImage(loadThemeImage(rValue));
958 }
959 else if (rKey == "icon-size")
960 {
961 WinBits nBits = GetStyle();
962 nBits &= ~WB_SMALLSTYLE;
963 if (rValue == "2")
964 nBits |= WB_SMALLSTYLE;
965 SetStyle(nBits);
966 }
967 else
968 return Control::set_property(rKey, rValue);
969 return true;
970}
971
972/* 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);
5
←
Calling 'Reference::set'
→
13
←
Returning; memory was released
→
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 ;-)
205 if (aTmp.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)
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
5.1
'pBody' is null
5.1
'pBody' is null
5.1
'pBody' is null
5.1
'pBody' is null
)
6
←
Taking false branch
→
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld
6.1
'pOld' is non-null
6.1
'pOld' is non-null
6.1
'pOld' is non-null
6.1
'pOld' is non-null
)
7
←
Taking true branch
→
127 pOld->release();
8
←
Calling 'VclReferenceBase::release'
→
12
←
Returning; memory was released
→
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)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
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;
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)
9
←
Assuming the condition is true
→
10
←
Taking true branch
→
40 delete this;
11
←
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