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 help.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/app/help.cxx

/home/maarten/src/libreoffice/core/vcl/source/app/help.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 <comphelper/string.hxx>
21#include <sal/log.hxx>
22
23#include <tools/diagnose_ex.h>
24#include <tools/time.hxx>
25
26#include <vcl/window.hxx>
27#include <vcl/event.hxx>
28#include <vcl/svapp.hxx>
29#include <vcl/wrkwin.hxx>
30#include <vcl/help.hxx>
31#include <vcl/settings.hxx>
32
33#include <helpwin.hxx>
34#include <salframe.hxx>
35#include <svdata.hxx>
36
37#define HELPWINSTYLE_QUICK0 0
38#define HELPWINSTYLE_BALLOON1 1
39
40#define HELPTEXTMARGIN_QUICK3 3
41#define HELPTEXTMARGIN_BALLOON6 6
42
43#define HELPTEXTMAXLEN150 150
44
45Help::Help()
46{
47}
48
49Help::~Help()
50{
51}
52
53bool Help::Start( const OUString&, const vcl::Window* )
54{
55 return false;
56}
57
58bool Help::Start(const OUString&, weld::Widget*)
59{
60 return false;
61}
62
63void Help::SearchKeyword( const OUString& )
64{
65}
66
67OUString Help::GetHelpText( const OUString&, const vcl::Window* )
68{
69 return OUString();
70}
71
72OUString Help::GetHelpText( const OUString&, const weld::Widget* )
73{
74 return OUString();
75}
76
77void Help::EnableContextHelp()
78{
79 ImplGetSVHelpData().mbContextHelp = true;
80}
81
82void Help::DisableContextHelp()
83{
84 ImplGetSVHelpData().mbContextHelp = false;
85}
86
87bool Help::IsContextHelpEnabled()
88{
89 return ImplGetSVHelpData().mbContextHelp;
90}
91
92void Help::EnableExtHelp()
93{
94 ImplGetSVHelpData().mbExtHelp = true;
95}
96
97void Help::DisableExtHelp()
98{
99 ImplGetSVHelpData().mbExtHelp = false;
100}
101
102bool Help::IsExtHelpEnabled()
103{
104 return ImplGetSVHelpData().mbExtHelp;
105}
106
107bool Help::StartExtHelp()
108{
109 ImplSVData* pSVData = ImplGetSVData();
110 ImplSVHelpData& aHelpData = ImplGetSVHelpData();
111
112 if ( aHelpData.mbExtHelp && !aHelpData.mbExtHelpMode )
113 {
114 aHelpData.mbExtHelpMode = true;
115 aHelpData.mbOldBalloonMode = aHelpData.mbBalloonHelp;
116 aHelpData.mbBalloonHelp = true;
117 if (pSVData->maFrameData.mpAppWin)
118 pSVData->maFrameData.mpAppWin->ImplGenerateMouseMove();
119 return true;
120 }
121
122 return false;
123}
124
125bool Help::EndExtHelp()
126{
127 ImplSVData* pSVData = ImplGetSVData();
128 ImplSVHelpData& aHelpData = ImplGetSVHelpData();
129
130 if ( aHelpData.mbExtHelp && aHelpData.mbExtHelpMode )
131 {
132 aHelpData.mbExtHelpMode = false;
133 aHelpData.mbBalloonHelp = aHelpData.mbOldBalloonMode;
134 if (pSVData->maFrameData.mpAppWin)
135 pSVData->maFrameData.mpAppWin->ImplGenerateMouseMove();
136 return true;
137 }
138
139 return false;
140}
141
142void Help::EnableBalloonHelp()
143{
144 ImplGetSVHelpData().mbBalloonHelp = true;
145}
146
147void Help::DisableBalloonHelp()
148{
149 ImplGetSVHelpData().mbBalloonHelp = false;
150}
151
152bool Help::IsBalloonHelpEnabled()
153{
154 return ImplGetSVHelpData().mbBalloonHelp;
155}
156
157void Help::ShowBalloon( vcl::Window* pParent,
158 const Point& rScreenPos, const tools::Rectangle& rRect,
159 const OUString& rHelpText )
160{
161 ImplShowHelpWindow( pParent, HELPWINSTYLE_BALLOON1, QuickHelpFlags::NONE,
162 rHelpText, rScreenPos, rRect );
163}
164
165void Help::EnableQuickHelp()
166{
167 ImplGetSVHelpData().mbQuickHelp = true;
168}
169
170void Help::DisableQuickHelp()
171{
172 ImplGetSVHelpData().mbQuickHelp = false;
173}
174
175bool Help::IsQuickHelpEnabled()
176{
177 return ImplGetSVHelpData().mbQuickHelp;
178}
179
180void Help::ShowQuickHelp( vcl::Window* pParent,
181 const tools::Rectangle& rScreenRect,
182 const OUString& rHelpText,
183 QuickHelpFlags nStyle )
184{
185 sal_uInt16 nHelpWinStyle = ( nStyle & QuickHelpFlags::TipStyleBalloon ) ? HELPWINSTYLE_BALLOON1 : HELPWINSTYLE_QUICK0;
186 ImplShowHelpWindow( pParent, nHelpWinStyle, nStyle,
187 rHelpText,
188 pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), rScreenRect );
189}
190
191void Help::HideBalloonAndQuickHelp()
192{
193 HelpTextWindow const * pHelpWin = ImplGetSVHelpData().mpHelpWin;
194 bool const bIsVisible = ( pHelpWin != nullptr ) && pHelpWin->IsVisible();
195 ImplDestroyHelpWindow( bIsVisible );
196}
197
198void* Help::ShowPopover(vcl::Window* pParent, const tools::Rectangle& rScreenRect,
199 const OUString& rText, QuickHelpFlags nStyle)
200{
201 void* nId = pParent->ImplGetFrame()->ShowPopover(rText, pParent, rScreenRect, nStyle);
202 if (nId)
203 {
204 //popovers are handled natively, return early
205 return nId;
206 }
207
208 sal_uInt16 nHelpWinStyle = ( nStyle & QuickHelpFlags::TipStyleBalloon ) ? HELPWINSTYLE_BALLOON1 : HELPWINSTYLE_QUICK0;
209 VclPtrInstance<HelpTextWindow> pHelpWin( pParent, rText, nHelpWinStyle, nStyle );
210
211 nId = pHelpWin.get();
212 UpdatePopover(nId, pParent, rScreenRect, rText);
213
214 pHelpWin->ShowHelp(true);
215 return nId;
216}
217
218void Help::UpdatePopover(void* nId, vcl::Window* pParent, const tools::Rectangle& rScreenRect,
219 const OUString& rText)
220{
221 if (pParent->ImplGetFrame()->UpdatePopover(nId, rText, pParent, rScreenRect))
222 {
223 //popovers are handled natively, return early
224 return;
225 }
226
227 HelpTextWindow* pHelpWin = static_cast< HelpTextWindow* >( nId );
228 ENSURE_OR_RETURN_VOID( pHelpWin != nullptr, "Help::UpdatePopover: invalid ID!" )if( !(pHelpWin != nullptr) ) { do { if (true && (!(pHelpWin
!= nullptr))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "228" ": "), "%s", "Help::UpdatePopover: invalid ID!"); }
} while (false); return; };
229
230 Size aSz = pHelpWin->CalcOutSize();
231 pHelpWin->SetOutputSizePixel( aSz );
232 ImplSetHelpWindowPos( pHelpWin, pHelpWin->GetWinStyle(), pHelpWin->GetStyle(),
233 pParent->OutputToScreenPixel( pParent->GetPointerPosPixel() ), rScreenRect );
234
235 pHelpWin->SetHelpText( rText );
236 pHelpWin->Invalidate();
237}
238
239void Help::HidePopover(vcl::Window const * pParent, void* nId)
240{
241 if (pParent->ImplGetFrame()->HidePopover(nId))
1
Assuming the condition is false
→
2
←
Taking false branch
→
242 {
243 //popovers are handled natively, return early
244 return;
245 }
246
247 VclPtr<HelpTextWindow> pHelpWin = static_cast<HelpTextWindow*>(nId);
3
←
Calling constructor for 'VclPtr<HelpTextWindow>'
→
8
←
Returning from constructor for 'VclPtr<HelpTextWindow>'
→
248 vcl::Window* pFrameWindow = pHelpWin->ImplGetFrameWindow();
249 pHelpWin->Hide();
250 // trigger update, so that a Paint is instantly triggered since we do not save the background
251 pFrameWindow->ImplUpdateAll();
252 pHelpWin.disposeAndClear();
9
←
Calling 'VclPtr::disposeAndClear'
→
253 ImplGetSVHelpData().mnLastHelpHideTime = tools::Time::GetSystemTicks();
254}
255
256HelpTextWindow::HelpTextWindow( vcl::Window* pParent, const OUString& rText, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle ) :
257 FloatingWindow( pParent, WB_SYSTEMWINDOW|WB_TOOLTIPWIN ), // #105827# if we change the parent, mirroring will not work correctly when positioning this window
258 maHelpText( rText )
259{
260 SetType( WindowType::HELPTEXTWINDOW );
261 ImplSetMouseTransparent( true );
262 mnHelpWinStyle = nHelpWinStyle;
263 mnStyle = nStyle;
264
265 if( mnStyle & QuickHelpFlags::BiDiRtl )
266 {
267 ComplexTextLayoutFlags nLayoutMode = GetLayoutMode();
268 nLayoutMode |= ComplexTextLayoutFlags::BiDiRtl | ComplexTextLayoutFlags::TextOriginLeft;
269 SetLayoutMode( nLayoutMode );
270 }
271 SetHelpText( rText );
272 Window::SetHelpText( rText );
273
274 if ( ImplGetSVHelpData().mbSetKeyboardHelp )
275 ImplGetSVHelpData().mbKeyboardHelp = true;
276
277
278 maShowTimer.SetInvokeHandler( LINK( this, HelpTextWindow, TimerHdl )::tools::detail::makeLink( ::tools::detail::castTo<HelpTextWindow
*>(this), &HelpTextWindow::LinkStubTimerHdl) );
279 maShowTimer.SetDebugName( "vcl::HelpTextWindow maShowTimer" );
280
281 const HelpSettings& rHelpSettings = pParent->GetSettings().GetHelpSettings();
282 maHideTimer.SetTimeout( rHelpSettings.GetTipTimeout() );
283 maHideTimer.SetInvokeHandler( LINK( this, HelpTextWindow, TimerHdl )::tools::detail::makeLink( ::tools::detail::castTo<HelpTextWindow
*>(this), &HelpTextWindow::LinkStubTimerHdl) );
284 maHideTimer.SetDebugName( "vcl::HelpTextWindow maHideTimer" );
285}
286
287void HelpTextWindow::ApplySettings(vcl::RenderContext& rRenderContext)
288{
289 const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
290 SetPointFont(rRenderContext, rStyleSettings.GetHelpFont());
291 rRenderContext.SetTextColor(rStyleSettings.GetHelpTextColor());
292 rRenderContext.SetTextAlign(ALIGN_TOP);
293
294 if (rRenderContext.IsNativeControlSupported(ControlType::Tooltip, ControlPart::Entire))
295 {
296 EnableChildTransparentMode();
297 SetParentClipMode(ParentClipMode::NoClip);
298 SetPaintTransparent(true);
299 rRenderContext.SetBackground();
300 }
301 else
302 rRenderContext.SetBackground(Wallpaper(rStyleSettings.GetHelpColor()));
303
304 if (rStyleSettings.GetHelpColor().IsDark())
305 rRenderContext.SetLineColor(COL_WHITE);
306 else
307 rRenderContext.SetLineColor(COL_BLACK);
308 rRenderContext.SetFillColor();
309}
310
311HelpTextWindow::~HelpTextWindow()
312{
313 disposeOnce();
314}
315
316void HelpTextWindow::dispose()
317{
318 maShowTimer.Stop();
319 maHideTimer.Stop();
320
321 if( this == ImplGetSVHelpData().mpHelpWin )
322 ImplGetSVHelpData().mpHelpWin = nullptr;
323 FloatingWindow::dispose();
324}
325
326void HelpTextWindow::SetHelpText( const OUString& rHelpText )
327{
328 maHelpText = rHelpText;
329 ApplySettings(*this);
330 if ( mnHelpWinStyle == HELPWINSTYLE_QUICK0 && maHelpText.getLength() < HELPTEXTMAXLEN150 && maHelpText.indexOf('\n') < 0)
331 {
332 Size aSize;
333 aSize.setHeight( GetTextHeight() );
334 if ( mnStyle & QuickHelpFlags::CtrlText )
335 aSize.setWidth( GetCtrlTextWidth( maHelpText ) );
336 else
337 aSize.setWidth( GetTextWidth( maHelpText ) );
338 maTextRect = tools::Rectangle( Point( HELPTEXTMARGIN_QUICK3, HELPTEXTMARGIN_QUICK3 ), aSize );
339 }
340 else // HELPWINSTYLE_BALLOON
341 {
342 sal_Int32 nCharsInLine = 35 + ((maHelpText.getLength()/100)*5);
343 // average width to have all windows consistent
344 OUStringBuffer aBuf;
345 comphelper::string::padToLength(aBuf, nCharsInLine, 'x');
346 OUString aXXX = aBuf.makeStringAndClear();
347 long nWidth = GetTextWidth( aXXX );
348 Size aTmpSize( nWidth, 0x7FFFFFFF );
349 tools::Rectangle aTry1( Point(), aTmpSize );
350 DrawTextFlags nDrawFlags = DrawTextFlags::MultiLine | DrawTextFlags::WordBreak |
351 DrawTextFlags::Left | DrawTextFlags::Top;
352 if ( mnStyle & QuickHelpFlags::CtrlText )
353 nDrawFlags |= DrawTextFlags::Mnemonic;
354 tools::Rectangle aTextRect = GetTextRect( aTry1, maHelpText, nDrawFlags );
355
356 // get a better width later...
357 maTextRect = aTextRect;
358
359 // safety distance...
360 maTextRect.SetPos( Point( HELPTEXTMARGIN_BALLOON6, HELPTEXTMARGIN_BALLOON6 ) );
361 }
362
363 Size aSize( CalcOutSize() );
364 SetOutputSizePixel( aSize );
365}
366
367void HelpTextWindow::ImplShow()
368{
369 VclPtr<HelpTextWindow> xWindow( this );
370 Show( true, ShowFlags::NoActivate );
371 if( !xWindow->IsDisposed() )
372 PaintImmediately();
373}
374
375void HelpTextWindow::Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& )
376{
377 // paint native background
378 bool bNativeOK = false;
379 if (rRenderContext.IsNativeControlSupported(ControlType::Tooltip, ControlPart::Entire))
380 {
381 tools::Rectangle aCtrlRegion(Point(0, 0), GetOutputSizePixel());
382 ImplControlValue aControlValue;
383 bNativeOK = rRenderContext.DrawNativeControl(ControlType::Tooltip, ControlPart::Entire, aCtrlRegion,
384 ControlState::NONE, aControlValue, OUString());
385 }
386
387 // paint text
388 if (mnHelpWinStyle == HELPWINSTYLE_QUICK0 && maHelpText.getLength() < HELPTEXTMAXLEN150 && maHelpText.indexOf('\n') < 0)
389 {
390 if ( mnStyle & QuickHelpFlags::CtrlText )
391 rRenderContext.DrawCtrlText(maTextRect.TopLeft(), maHelpText);
392 else
393 rRenderContext.DrawText(maTextRect.TopLeft(), maHelpText);
394 }
395 else // HELPWINSTYLE_BALLOON
396 {
397 DrawTextFlags nDrawFlags = DrawTextFlags::MultiLine|DrawTextFlags::WordBreak|
398 DrawTextFlags::Left|DrawTextFlags::Top;
399 if (mnStyle & QuickHelpFlags::CtrlText)
400 nDrawFlags |= DrawTextFlags::Mnemonic;
401 rRenderContext.DrawText(maTextRect, maHelpText, nDrawFlags);
402 }
403
404 // border
405 if (bNativeOK)
406 return;
407
408 Size aSz = GetOutputSizePixel();
409 rRenderContext.DrawRect(tools::Rectangle(Point(), aSz));
410 if (mnHelpWinStyle == HELPWINSTYLE_BALLOON1)
411 {
412 aSz.AdjustWidth( -2 );
413 aSz.AdjustHeight( -2 );
414 Color aColor(rRenderContext.GetLineColor());
415 rRenderContext.SetLineColor(COL_GRAY);
416 rRenderContext.DrawRect(tools::Rectangle(Point(1, 1), aSz));
417 rRenderContext.SetLineColor(aColor);
418 }
419}
420
421void HelpTextWindow::ShowHelp(bool bNoDelay)
422{
423 sal_uLong nTimeout = 0;
424 if (!bNoDelay)
425 {
426 // In case of ExtendedHelp display help sooner
427 if ( ImplGetSVHelpData().mbExtHelpMode )
428 nTimeout = 15;
429 else
430 {
431 if ( mnHelpWinStyle == HELPWINSTYLE_QUICK0 )
432 nTimeout = HelpSettings::GetTipDelay();
433 else
434 nTimeout = HelpSettings::GetBalloonDelay();
435 }
436 }
437
438 maShowTimer.SetTimeout( nTimeout );
439 maShowTimer.Start();
440}
441
442IMPL_LINK( HelpTextWindow, TimerHdl, Timer*, pTimer, void)void HelpTextWindow::LinkStubTimerHdl(void * instance, Timer*
data) { return static_cast<HelpTextWindow *>(instance)
->TimerHdl(data); } void HelpTextWindow::TimerHdl(Timer* pTimer
)
443{
444 if ( pTimer == &maShowTimer )
445 {
446 if ( mnHelpWinStyle == HELPWINSTYLE_QUICK0 )
447 {
448 // start auto-hide-timer for non-ShowTip windows
449 if ( this == ImplGetSVHelpData().mpHelpWin )
450 maHideTimer.Start();
451 }
452 ImplShow();
453 }
454 else
455 {
456 SAL_WARN_IF( pTimer != &maHideTimer, "vcl", "HelpTextWindow::TimerHdl with bad Timer" )do { if (true && (pTimer != &maHideTimer)) { switch
(sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN, "vcl")) {
case SAL_DETAIL_LOG_ACTION_IGNORE: break; case SAL_DETAIL_LOG_ACTION_LOG
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "HelpTextWindow::TimerHdl with bad Timer") == 1) {
::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "456" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "HelpTextWindow::TimerHdl with bad Timer"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "HelpTextWindow::TimerHdl with bad Timer"; ::sal::detail
::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "456" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "HelpTextWindow::TimerHdl with bad Timer") == 1) {
::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "456" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "HelpTextWindow::TimerHdl with bad Timer"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "HelpTextWindow::TimerHdl with bad Timer"; ::sal::detail
::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "456" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
457 ImplDestroyHelpWindow( true );
458 }
459}
460
461Size HelpTextWindow::CalcOutSize() const
462{
463 Size aSz = maTextRect.GetSize();
464 aSz.AdjustWidth(2*maTextRect.Left() );
465 aSz.AdjustHeight(2*maTextRect.Top() );
466 return aSz;
467}
468
469void HelpTextWindow::RequestHelp( const HelpEvent& /*rHEvt*/ )
470{
471 // Just to assure that Window::RequestHelp() is not called by
472 // ShowQuickHelp/ShowBalloonHelp in the HelpTextWindow.
473}
474
475OUString HelpTextWindow::GetText() const
476{
477 return maHelpText;
478}
479
480void ImplShowHelpWindow( vcl::Window* pParent, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
481 const OUString& rHelpText,
482 const Point& rScreenPos, const tools::Rectangle& rHelpArea )
483{
484 if (pParent->ImplGetFrame()->ShowTooltip(rHelpText, rHelpArea))
485 {
486 //tooltips are handled natively, return early
487 return;
488 }
489
490 ImplSVHelpData& aHelpData = ImplGetSVHelpData();
491
492 if (rHelpText.isEmpty() && !aHelpData.mbRequestingHelp)
493 return;
494
495 VclPtr<HelpTextWindow> pHelpWin = aHelpData.mpHelpWin;
496 bool bNoDelay = false;
497 if ( pHelpWin )
498 {
499 SAL_WARN_IF( pHelpWin == pParent, "vcl", "HelpInHelp ?!" )do { if (true && (pHelpWin == pParent)) { switch (sal_detail_log_report
(::SAL_DETAIL_LOG_LEVEL_WARN, "vcl")) { case SAL_DETAIL_LOG_ACTION_IGNORE
: break; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail
::getResult( ::sal::detail::StreamStart() << "HelpInHelp ?!"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"
), ("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "499" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "HelpInHelp ?!"), 0); } else { ::std::
ostringstream sal_detail_stream; sal_detail_stream << "HelpInHelp ?!"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"),
("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "499" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "HelpInHelp ?!") == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "499" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "HelpInHelp ?!"), 0); } else { ::std::
ostringstream sal_detail_stream; sal_detail_stream << "HelpInHelp ?!"
; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"),
("/home/maarten/src/libreoffice/core/vcl/source/app/help.cxx"
":" "499" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
500
501 if ( ( rHelpText.isEmpty()
502 || ( pHelpWin->GetWinStyle() != nHelpWinStyle )
503 )
504 && aHelpData.mbRequestingHelp
505 )
506 {
507 // remove help window if no HelpText or
508 // other help mode. but keep it if we are scrolling, ie not requesting help
509 bool bWasVisible = pHelpWin->IsVisible();
510 if ( bWasVisible )
511 bNoDelay = true; // display it quickly if we were already in quick help mode
512 pHelpWin = nullptr;
513 ImplDestroyHelpWindow( bWasVisible );
514 }
515 else
516 {
517 bool const bUpdate = (pHelpWin->GetHelpText() != rHelpText) ||
518 ((pHelpWin->GetHelpArea() != rHelpArea) && aHelpData.mbRequestingHelp);
519 if (bUpdate)
520 {
521 pHelpWin->SetHelpText( rHelpText );
522 // approach mouse position
523 ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, rHelpArea );
524 if( pHelpWin->IsVisible() )
525 pHelpWin->Invalidate();
526 }
527 }
528 }
529
530 if (pHelpWin || rHelpText.isEmpty())
531 return;
532
533 sal_uInt64 nCurTime = tools::Time::GetSystemTicks();
534 if ( ( nCurTime - aHelpData.mnLastHelpHideTime ) < HelpSettings::GetTipDelay() )
535 bNoDelay = true;
536
537 pHelpWin = VclPtr<HelpTextWindow>::Create( pParent, rHelpText, nHelpWinStyle, nStyle );
538 aHelpData.mpHelpWin = pHelpWin;
539 pHelpWin->SetHelpArea( rHelpArea );
540
541 // positioning
542 Size aSz = pHelpWin->CalcOutSize();
543 pHelpWin->SetOutputSizePixel( aSz );
544 ImplSetHelpWindowPos( pHelpWin, nHelpWinStyle, nStyle, rScreenPos, rHelpArea );
545 // if not called from Window::RequestHelp, then without delay...
546 if ( !aHelpData.mbRequestingHelp )
547 bNoDelay = true;
548 pHelpWin->ShowHelp(bNoDelay);
549
550}
551
552void ImplDestroyHelpWindow( bool bUpdateHideTime )
553{
554 ImplDestroyHelpWindow(ImplGetSVHelpData(), bUpdateHideTime);
555}
556
557void ImplDestroyHelpWindow(ImplSVHelpData& rHelpData, bool bUpdateHideTime)
558{
559 VclPtr<HelpTextWindow> pHelpWin = rHelpData.mpHelpWin;
560 if( pHelpWin )
561 {
562 rHelpData.mpHelpWin = nullptr;
563 rHelpData.mbKeyboardHelp = false;
564 pHelpWin->Hide();
565 pHelpWin.disposeAndClear();
566 if( bUpdateHideTime )
567 rHelpData.mnLastHelpHideTime = tools::Time::GetSystemTicks();
568 }
569}
570
571void ImplSetHelpWindowPos( vcl::Window* pHelpWin, sal_uInt16 nHelpWinStyle, QuickHelpFlags nStyle,
572 const Point& rPos, const tools::Rectangle& rHelpArea )
573{
574 Point aPos = rPos;
575 Size aSz = pHelpWin->GetSizePixel();
576 tools::Rectangle aScreenRect = pHelpWin->ImplGetFrameWindow()->GetDesktopRectPixel();
577 aPos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( aPos );
578 // get mouse screen coords
579 Point aMousePos( pHelpWin->GetParent()->ImplGetFrameWindow()->GetPointerPosPixel() );
580 aMousePos = pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( aMousePos );
581
582 if ( nHelpWinStyle == HELPWINSTYLE_QUICK0 )
583 {
584 if ( !(nStyle & QuickHelpFlags::NoAutoPos) )
585 {
586 long nScreenHeight = aScreenRect.GetHeight();
587 aPos.AdjustX( -4 );
588 if ( aPos.Y() > aScreenRect.Top()+nScreenHeight-(nScreenHeight/4) )
589 aPos.AdjustY( -(aSz.Height()+4) );
590 else
591 aPos.AdjustY(21 );
592 }
593 }
594 else
595 {
596 // If it's the mouse position, move the window slightly
597 // so the mouse pointer does not cover it
598 if ( aPos == aMousePos )
599 {
600 aPos.AdjustX(12 );
601 aPos.AdjustY(16 );
602 }
603 }
604
605 if ( nStyle & QuickHelpFlags::NoAutoPos )
606 {
607 // convert help area to screen coords
608 tools::Rectangle devHelpArea(
609 pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( rHelpArea.TopLeft() ),
610 pHelpWin->GetParent()->ImplGetFrameWindow()->OutputToAbsoluteScreenPixel( rHelpArea.BottomRight() ) );
611
612 // which position of the rectangle?
613 aPos = devHelpArea.Center();
614
615 if ( nStyle & QuickHelpFlags::Left )
616 aPos.setX( devHelpArea.Left() );
617 else if ( nStyle & QuickHelpFlags::Right )
618 aPos.setX( devHelpArea.Right() );
619
620 if ( nStyle & QuickHelpFlags::Top )
621 aPos.setY( devHelpArea.Top() );
622 else if ( nStyle & QuickHelpFlags::Bottom )
623 aPos.setY( devHelpArea.Bottom() );
624
625 // which direction?
626 if ( nStyle & QuickHelpFlags::Left )
627 ;
628 else if ( nStyle & QuickHelpFlags::Right )
629 aPos.AdjustX( -(aSz.Width()) );
630 else
631 aPos.AdjustX( -(aSz.Width()/2) );
632
633 if ( nStyle & QuickHelpFlags::Top )
634 ;
635 else if ( nStyle & QuickHelpFlags::Bottom )
636 aPos.AdjustY( -(aSz.Height()) );
637 else
638 aPos.AdjustY( -(aSz.Height()/2) );
639 }
640
641 if ( aPos.X() < aScreenRect.Left() )
642 aPos.setX( aScreenRect.Left() );
643 else if ( ( aPos.X() + aSz.Width() ) > aScreenRect.Right() )
644 aPos.setX( aScreenRect.Right() - aSz.Width() );
645 if ( aPos.Y() < aScreenRect.Top() )
646 aPos.setY( aScreenRect.Top() );
647 else if ( ( aPos.Y() + aSz.Height() ) > aScreenRect.Bottom() )
648 aPos.setY( aScreenRect.Bottom() - aSz.Height() );
649
650 if( ! (nStyle & QuickHelpFlags::NoEvadePointer) )
651 {
652 /* the remark below should be obsolete by now as the helpwindow should
653 not be focusable, leaving it as a hint. However it is sensible in most
654 conditions to evade the mouse pointer so the content window is fully visible.
655
656 // the popup must not appear under the mouse
657 // otherwise it would directly be closed due to a focus change...
658 */
659 tools::Rectangle aHelpRect( aPos, aSz );
660 if( aHelpRect.IsInside( aMousePos ) )
661 {
662 Point delta(2,2);
663 Point aSize( aSz.Width(), aSz.Height() );
664 Point aTest( aMousePos - aSize - delta );
665 if( aTest.X() > aScreenRect.Left() && aTest.Y() > aScreenRect.Top() )
666 aPos = aTest;
667 else
668 aPos = aMousePos + delta;
669 }
670 }
671
672 vcl::Window* pWindow = pHelpWin->GetParent()->ImplGetFrameWindow();
673 aPos = pWindow->AbsoluteScreenToOutputPixel( aPos );
674 pHelpWin->SetPosPixel( aPos );
675}
676
677/* 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)
4
←
Calling constructor for 'Reference<HelpTextWindow>'
→
7
←
Returning from constructor for 'Reference<HelpTextWindow>'
→
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__));
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__));
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
10
←
Calling 'Reference::clear'
→
17
←
Returning; memory was released
→
205 if (aTmp.get()) {
18
←
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)
5
←
Assuming field 'm_pBody' is non-null
→
6
←
Taking true branch
→
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
10.1
Field 'm_pBody' is non-null
)
11
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
12
←
Calling 'VclReferenceBase::release'
→
16
←
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;
19
←
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)
13
←
Assuming the condition is true
→
14
←
Taking true branch
→
40 delete this;
15
←
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