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

/home/maarten/src/libreoffice/core/desktop/source/splash/splash.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
21#include <sal/log.hxx>
22#include <vcl/bitmapex.hxx>
23#include <vcl/svapp.hxx>
24#include <vcl/salnativewidgets.hxx>
25
26#include <com/sun/star/lang/XInitialization.hpp>
27#include <com/sun/star/lang/XServiceInfo.hpp>
28#include <com/sun/star/task/XStatusIndicator.hpp>
29#include <cppuhelper/implbase.hxx>
30#include <cppuhelper/supportsservice.hxx>
31#include <rtl/bootstrap.hxx>
32#include <rtl/strbuf.hxx>
33#include <rtl/math.hxx>
34#include <vcl/introwin.hxx>
35#include <vcl/virdev.hxx>
36
37#define NOT_LOADED(long(-1)) (long(-1))
38#define NOT_LOADED_COLOR(Color(0xffffffff)) (Color(0xffffffff))
39
40using namespace ::com::sun::star::lang;
41using namespace ::com::sun::star::task;
42using namespace ::com::sun::star::uno;
43
44namespace {
45
46class SplashScreen;
47
48class SplashScreenWindow : public IntroWindow
49{
50public:
51 SplashScreen *pSpl;
52 ScopedVclPtr<VirtualDevice> _vdev;
53 explicit SplashScreenWindow(SplashScreen *);
54 virtual ~SplashScreenWindow() override { disposeOnce(); }
55 virtual void dispose() override;
56 // workwindow
57 virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&) override;
58 void Redraw();
59
60};
61
62class SplashScreen
63 : public ::cppu::WeakImplHelper< XStatusIndicator, XInitialization, XServiceInfo >
64{
65 friend class SplashScreenWindow;
66private:
67 VclPtr<SplashScreenWindow> pWindow;
68
69 DECL_LINK( AppEventListenerHdl, VclSimpleEvent&, void )static void LinkStubAppEventListenerHdl(void *, VclSimpleEvent
&); void AppEventListenerHdl(VclSimpleEvent&);
70 virtual ~SplashScreen() override;
71 void loadConfig();
72 void updateStatus();
73 void SetScreenBitmap(BitmapEx &rBitmap);
74 static void determineProgressRatioValues( double& rXRelPos, double& rYRelPos, double& rRelWidth, double& rRelHeight );
75
76 static osl::Mutex _aMutex;
77
78 BitmapEx _aIntroBmp;
79 Color _cProgressFrameColor;
80 Color _cProgressBarColor;
81 Color _cProgressTextColor;
82 bool _bNativeProgress;
83 OUString _sAppName;
84 OUString _sProgressText;
85
86 sal_Int32 _iMax;
87 sal_Int32 _iProgress;
88 bool _bPaintProgress;
89 bool _bVisible;
90 bool _bShowLogo;
91 bool _bFullScreenSplash;
92 bool _bProgressEnd;
93 long _height, _width, _tlx, _tly, _barwidth;
94 long _barheight, _barspace, _textBaseline;
95 double _fXPos, _fYPos;
96 double _fWidth, _fHeight;
97 static constexpr long _xoffset = 12, _yoffset = 18;
98
99public:
100 SplashScreen();
101
102 // XStatusIndicator
103 virtual void SAL_CALL end() override;
104 virtual void SAL_CALL reset() override;
105 virtual void SAL_CALL setText(const OUString& aText) override;
106 virtual void SAL_CALL setValue(sal_Int32 nValue) override;
107 virtual void SAL_CALL start(const OUString& aText, sal_Int32 nRange) override;
108
109 // XInitialize
110 virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any>& aArguments ) override;
111
112 virtual OUString SAL_CALL getImplementationName() override
113 { return "com.sun.star.office.comp.SplashScreen"; }
114
115 virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
116 { return cppu::supportsService(this, ServiceName); }
117
118 virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override
119 { return { "com.sun.star.office.SplashScreen" }; }
120};
121
122SplashScreenWindow::SplashScreenWindow(SplashScreen *pSplash)
123 : IntroWindow()
124 , pSpl( pSplash )
125 , _vdev(VclPtr<VirtualDevice>::Create(*this))
126{
127 _vdev->EnableRTL(IsRTLEnabled());
128}
129
130void SplashScreenWindow::dispose()
131{
132 pSpl = nullptr;
133 IntroWindow::dispose();
134}
135
136void SplashScreenWindow::Redraw()
137{
138 Invalidate();
139 // Trigger direct painting too - otherwise the splash screen won't be
140 // shown in some cases (when the idle timer won't be hit).
141 Paint(*this, tools::Rectangle());
142 Flush();
143}
144
145SplashScreen::SplashScreen()
146 : pWindow( VclPtr<SplashScreenWindow>::Create(this) )
147 , _cProgressFrameColor(NOT_LOADED_COLOR(Color(0xffffffff)))
148 , _cProgressBarColor(NOT_LOADED_COLOR(Color(0xffffffff)))
149 , _cProgressTextColor(NOT_LOADED_COLOR(Color(0xffffffff)))
150 , _bNativeProgress(true)
151 , _iMax(100)
152 , _iProgress(0)
153 , _bPaintProgress(false)
154 , _bVisible(true)
155 , _bShowLogo(true)
156 , _bFullScreenSplash(false)
157 , _bProgressEnd(false)
158 , _height(0)
159 , _width(0)
160 , _tlx(NOT_LOADED(long(-1)))
161 , _tly(NOT_LOADED(long(-1)))
162 , _barwidth(NOT_LOADED(long(-1)))
163 , _barheight(NOT_LOADED(long(-1)))
164 , _barspace(2)
165 , _textBaseline(NOT_LOADED(long(-1)))
166 , _fXPos(-1.0)
167 , _fYPos(-1.0)
168 , _fWidth(-1.0)
169 , _fHeight(-1.0)
170{
171 loadConfig();
172}
173
174SplashScreen::~SplashScreen()
175{
176 Application::RemoveEventListener(
177 LINK( this, SplashScreen, AppEventListenerHdl )::tools::detail::makeLink( ::tools::detail::castTo<SplashScreen
*>(this), &SplashScreen::LinkStubAppEventListenerHdl) );
178 pWindow->Hide();
179 pWindow.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
180}
181
182void SAL_CALL SplashScreen::start(const OUString&, sal_Int32 nRange)
183{
184 _iMax = nRange;
185 if (_bVisible) {
186 _bProgressEnd = false;
187 SolarMutexGuard aSolarGuard;
188 pWindow->Show();
189 pWindow->Redraw();
190 }
191}
192
193void SAL_CALL SplashScreen::end()
194{
195 _iProgress = _iMax;
196 if (_bVisible )
197 {
198 pWindow->Hide();
199 }
200 _bProgressEnd = true;
201}
202
203void SAL_CALL SplashScreen::reset()
204{
205 _iProgress = 0;
206 if (_bVisible && !_bProgressEnd )
207 {
208 pWindow->Show();
209 updateStatus();
210 }
211}
212
213void SAL_CALL SplashScreen::setText(const OUString& rText)
214{
215 SolarMutexGuard aSolarGuard;
216 if ( _sProgressText != rText )
217 {
218 _sProgressText = rText;
219
220 if (_bVisible && !_bProgressEnd)
221 {
222 pWindow->Show();
223 updateStatus();
224 }
225 }
226}
227
228void SAL_CALL SplashScreen::setValue(sal_Int32 nValue)
229{
230 SAL_INFO( "desktop.splash", "setValue: " << nValue )do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "desktop.splash")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break
; case SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "setValue: " <<
nValue) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("desktop.splash"), ("/home/maarten/src/libreoffice/core/desktop/source/splash/splash.cxx"
":" "230" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "setValue: " << nValue), 0); } else
{ ::std::ostringstream sal_detail_stream; sal_detail_stream <<
"setValue: " << nValue; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("desktop.splash"), ("/home/maarten/src/libreoffice/core/desktop/source/splash/splash.cxx"
":" "230" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "setValue: " << nValue) == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_INFO), ("desktop.splash"), ("/home/maarten/src/libreoffice/core/desktop/source/splash/splash.cxx"
":" "230" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "setValue: " << nValue), 0); } else
{ ::std::ostringstream sal_detail_stream; sal_detail_stream <<
"setValue: " << nValue; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("desktop.splash"), ("/home/maarten/src/libreoffice/core/desktop/source/splash/splash.cxx"
":" "230" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
231
232 SolarMutexGuard aSolarGuard;
233 if (_bVisible && !_bProgressEnd) {
234 pWindow->Show();
235 if (nValue >= _iMax)
236 _iProgress = _iMax;
237 else
238 _iProgress = nValue;
239 updateStatus();
240 }
241}
242
243// XInitialize
244void SAL_CALL
245SplashScreen::initialize( const css::uno::Sequence< css::uno::Any>& aArguments )
246{
247 osl::MutexGuard aGuard( _aMutex );
248 if (!aArguments.hasElements())
249 return;
250
251 aArguments[0] >>= _bVisible;
252 if (aArguments.getLength() > 1 )
253 aArguments[1] >>= _sAppName;
254
255 // start to determine bitmap and all other required value
256 if ( _bShowLogo )
257 SetScreenBitmap (_aIntroBmp);
258 Size aSize = _aIntroBmp.GetSizePixel();
259 pWindow->SetOutputSizePixel( aSize );
260 pWindow->_vdev->SetOutputSizePixel( aSize );
261 _height = aSize.Height();
262 _width = aSize.Width();
263 if (_width > 500)
264 {
265 Point xtopleft(212,216);
266 if ( NOT_LOADED(long(-1)) == _tlx || NOT_LOADED(long(-1)) == _tly )
267 {
268 _tlx = xtopleft.X(); // top-left x
269 _tly = xtopleft.Y(); // top-left y
270 }
271 if ( NOT_LOADED(long(-1)) == _barwidth )
272 _barwidth = 263;
273 if ( NOT_LOADED(long(-1)) == _barheight )
274 _barheight = 8;
275 }
276 else
277 {
278 if ( NOT_LOADED(long(-1)) == _barwidth )
279 _barwidth = _width - (2 * _xoffset);
280 if ( NOT_LOADED(long(-1)) == _barheight )
281 _barheight = 6;
282 if ( NOT_LOADED(long(-1)) == _tlx || NOT_LOADED(long(-1)) == _tly )
283 {
284 _tlx = _xoffset; // top-left x
285 _tly = _height - _yoffset; // top-left y
286 }
287 }
288
289 if ( NOT_LOADED(long(-1)) == _textBaseline )
290 _textBaseline = _height;
291
292 if ( NOT_LOADED_COLOR(Color(0xffffffff)) == _cProgressFrameColor )
293 _cProgressFrameColor = COL_LIGHTGRAY;
294
295 if ( NOT_LOADED_COLOR(Color(0xffffffff)) == _cProgressBarColor )
296 {
297 // progress bar: new color only for big bitmap format
298 if ( _width > 500 )
299 _cProgressBarColor = Color( 157, 202, 18 );
300 else
301 _cProgressBarColor = COL_BLUE;
302 }
303
304 if ( NOT_LOADED_COLOR(Color(0xffffffff)) == _cProgressTextColor )
305 _cProgressTextColor = COL_BLACK;
306
307 Application::AddEventListener(
308 LINK( this, SplashScreen, AppEventListenerHdl )::tools::detail::makeLink( ::tools::detail::castTo<SplashScreen
*>(this), &SplashScreen::LinkStubAppEventListenerHdl) );
309}
310
311void SplashScreen::updateStatus()
312{
313 if (!_bVisible || _bProgressEnd)
314 return;
315 if (!_bPaintProgress)
316 _bPaintProgress = true;
317 pWindow->Redraw();
318}
319
320// internal private methods
321IMPL_LINK( SplashScreen, AppEventListenerHdl, VclSimpleEvent&, inEvent, void )void SplashScreen::LinkStubAppEventListenerHdl(void * instance
, VclSimpleEvent& data) { return static_cast<SplashScreen
*>(instance)->AppEventListenerHdl(data); } void SplashScreen
::AppEventListenerHdl(VclSimpleEvent& inEvent)
322{
323 if (static_cast<VclWindowEvent&>(inEvent).GetWindow() == pWindow)
324 {
325 switch ( inEvent.GetId() )
326 {
327 case VclEventId::WindowShow:
328 pWindow->Redraw();
329 break;
330 default:
331 break;
332 }
333 }
334}
335
336// Read keys from soffice{.ini|rc}:
337OUString implReadBootstrapKey( const OUString& _rKey )
338{
339 OUString sValue;
340 rtl::Bootstrap::get(_rKey, sValue);
341 return sValue;
342}
343
344void SplashScreen::loadConfig()
345{
346 _bShowLogo = implReadBootstrapKey( "Logo" ) != "0";
347
348 OUString sProgressFrameColor = implReadBootstrapKey( "ProgressFrameColor" );
349 OUString sProgressBarColor = implReadBootstrapKey( "ProgressBarColor" );
350 OUString sProgressTextColor = implReadBootstrapKey( "ProgressTextColor" );
351 OUString sProgressTextBaseline = implReadBootstrapKey( "ProgressTextBaseline" );
352 OUString sSize = implReadBootstrapKey( "ProgressSize" );
353 OUString sPosition = implReadBootstrapKey( "ProgressPosition" );
354 OUString sFullScreenSplash = implReadBootstrapKey( "FullScreenSplash" );
355 OUString sNativeProgress = implReadBootstrapKey( "NativeProgress" );
356
357
358 // Determine full screen splash mode
359 _bFullScreenSplash = (( !sFullScreenSplash.isEmpty() ) &&
360 ( sFullScreenSplash != "0" ));
361
362 // Try to retrieve the relative values for the progress bar. The current
363 // schema uses the screen ratio to retrieve the associated values.
364 if ( _bFullScreenSplash )
365 determineProgressRatioValues( _fXPos, _fYPos, _fWidth, _fHeight );
366
367 if ( !sProgressFrameColor.isEmpty() )
368 {
369 sal_uInt8 nRed = 0;
370 sal_Int32 idx = 0;
371 sal_Int32 temp = sProgressFrameColor.getToken( 0, ',', idx ).toInt32();
372 if ( idx != -1 )
373 {
374 nRed = static_cast< sal_uInt8 >( temp );
375 temp = sProgressFrameColor.getToken( 0, ',', idx ).toInt32();
376 }
377 if ( idx != -1 )
378 {
379 sal_uInt8 nGreen = static_cast< sal_uInt8 >( temp );
380 sal_uInt8 nBlue = static_cast< sal_uInt8 >( sProgressFrameColor.getToken( 0, ',', idx ).toInt32() );
381 _cProgressFrameColor = Color( nRed, nGreen, nBlue );
382 }
383 }
384
385 if ( !sProgressBarColor.isEmpty() )
386 {
387 sal_uInt8 nRed = 0;
388 sal_Int32 idx = 0;
389 sal_Int32 temp = sProgressBarColor.getToken( 0, ',', idx ).toInt32();
390 if ( idx != -1 )
391 {
392 nRed = static_cast< sal_uInt8 >( temp );
393 temp = sProgressBarColor.getToken( 0, ',', idx ).toInt32();
394 }
395 if ( idx != -1 )
396 {
397 sal_uInt8 nGreen = static_cast< sal_uInt8 >( temp );
398 sal_uInt8 nBlue = static_cast< sal_uInt8 >( sProgressBarColor.getToken( 0, ',', idx ).toInt32() );
399 _cProgressBarColor = Color( nRed, nGreen, nBlue );
400 }
401 }
402
403 if ( !sProgressTextColor.isEmpty() )
404 {
405 sal_uInt8 nRed = 0;
406 sal_Int32 idx = 0;
407 sal_Int32 temp = sProgressTextColor.getToken( 0, ',', idx ).toInt32();
408 if ( idx != -1 )
409 {
410 nRed = static_cast< sal_uInt8 >( temp );
411 temp = sProgressTextColor.getToken( 0, ',', idx ).toInt32();
412 }
413 if ( idx != -1 )
414 {
415 sal_uInt8 nGreen = static_cast< sal_uInt8 >( temp );
416 sal_uInt8 nBlue = static_cast< sal_uInt8 >( sProgressTextColor.getToken( 0, ',', idx ).toInt32() );
417 _cProgressTextColor = Color( nRed, nGreen, nBlue );
418 }
419 }
420
421 if ( !sProgressTextBaseline.isEmpty() )
422 {
423 _textBaseline = sProgressTextBaseline.toInt32();
424 }
425
426 if( !sNativeProgress.isEmpty() )
427 {
428 _bNativeProgress = sNativeProgress.toBoolean();
429 }
430
431 if ( !sSize.isEmpty() )
432 {
433 sal_Int32 idx = 0;
434 sal_Int32 temp = sSize.getToken( 0, ',', idx ).toInt32();
435 if ( idx != -1 )
436 {
437 _barwidth = temp;
438 _barheight = sSize.getToken( 0, ',', idx ).toInt32();
439 }
440 }
441
442 if ( _barheight >= 10 )
443 _barspace = 3; // more space between frame and bar
444
445 if ( !sPosition.isEmpty() )
446 {
447 sal_Int32 idx = 0;
448 sal_Int32 temp = sPosition.getToken( 0, ',', idx ).toInt32();
449 if ( idx != -1 )
450 {
451 _tlx = temp;
452 _tly = sPosition.getToken( 0, ',', idx ).toInt32();
453 }
454 }
455}
456
457void SplashScreen::SetScreenBitmap(BitmapEx &rBitmap)
458{
459 sal_Int32 nWidth( 0 );
460 sal_Int32 nHeight( 0 );
461
462 // determine desktop resolution
463 sal_uInt32 nCount = Application::GetScreenCount();
464 if ( nCount > 0 )
465 {
466 // retrieve size from first screen
467 tools::Rectangle aScreenArea = Application::GetScreenPosSizePixel(static_cast<unsigned int>(0));
468 nWidth = aScreenArea.GetWidth();
469 nHeight = aScreenArea.GetHeight();
470 }
471
472 // create file name from screen resolution information
473 OStringBuffer aStrBuf( 128 );
474 aStrBuf.append( "intro_" );
475 if ( !_sAppName.isEmpty() )
476 {
477 aStrBuf.append( OUStringToOString(_sAppName, RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76))) );
478 aStrBuf.append( "_" );
479 }
480 OString aResBuf = OString::number( nWidth ) + "x" + OString::number( nHeight );
481
482 aStrBuf.append( aResBuf.getStr() );
483 if (Application::LoadBrandBitmap (aStrBuf.makeStringAndClear().getStr(), rBitmap))
484 return;
485
486 aStrBuf.append( "intro_" );
487 aStrBuf.append( aResBuf.getStr() );
488 if (Application::LoadBrandBitmap (aResBuf.getStr(), rBitmap))
489 return;
490
491 (void)Application::LoadBrandBitmap ("intro", rBitmap);
492}
493
494void SplashScreen::determineProgressRatioValues(
495 double& rXRelPos, double& rYRelPos,
496 double& rRelWidth, double& rRelHeight )
497{
498 sal_Int32 nScreenRatio( 0 );
499
500 // determine desktop resolution
501 sal_uInt32 nCount = Application::GetScreenCount();
502 if ( nCount > 0 )
503 {
504 // retrieve size from first screen
505 tools::Rectangle aScreenArea = Application::GetScreenPosSizePixel(static_cast<unsigned int>(0));
506 sal_Int32 nWidth = aScreenArea.GetWidth();
507 sal_Int32 nHeight = aScreenArea.GetHeight();
508 nScreenRatio = nHeight ? sal_Int32( rtl::math::round( double( nWidth ) / double( nHeight ), 2 ) * 100 ) : 0;
509 }
510
511 char szFullScreenProgressRatio[] = "FullScreenProgressRatio0";
512 char szFullScreenProgressPos[] = "FullScreenProgressPos0";
513 char szFullScreenProgressSize[] = "FullScreenProgressSize0";
514 for ( sal_Int32 i = 0; i <= 9; i++ )
515 {
516 char cNum = '0' + char( i );
517 szFullScreenProgressRatio[23] = cNum;
518 szFullScreenProgressPos[21] = cNum;
519 szFullScreenProgressSize[22] = cNum;
520
521 OUString sFullScreenProgressRatio = implReadBootstrapKey(
522 OUString::createFromAscii( szFullScreenProgressRatio ) );
523
524 if ( !sFullScreenProgressRatio.isEmpty() )
525 {
526 double fRatio = sFullScreenProgressRatio.toDouble();
527 sal_Int32 nRatio = sal_Int32( rtl::math::round( fRatio, 2 ) * 100 );
528 if ( nRatio == nScreenRatio )
529 {
530 OUString sFullScreenProgressPos = implReadBootstrapKey(
531 OUString::createFromAscii( szFullScreenProgressPos ) );
532 OUString sFullScreenProgressSize = implReadBootstrapKey(
533 OUString::createFromAscii( szFullScreenProgressSize ) );
534
535 if ( !sFullScreenProgressPos.isEmpty() )
536 {
537 sal_Int32 idx = 0;
538 double temp = sFullScreenProgressPos.getToken( 0, ',', idx ).toDouble();
539 if ( idx != -1 )
540 {
541 rXRelPos = temp;
542 rYRelPos = sFullScreenProgressPos.getToken( 0, ',', idx ).toDouble();
543 }
544 }
545
546 if ( !sFullScreenProgressSize.isEmpty() )
547 {
548 sal_Int32 idx = 0;
549 double temp = sFullScreenProgressSize.getToken( 0, ',', idx ).toDouble();
550 if ( idx != -1 )
551 {
552 rRelWidth = temp;
553 rRelHeight = sFullScreenProgressSize.getToken( 0, ',', idx ).toDouble();
554 }
555 }
556 }
557 }
558 else
559 break;
560 }
561}
562
563void SplashScreenWindow::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&)
564{
565 if (!pSpl || !pSpl->_bVisible)
566 return;
567
568 //native drawing
569 // in case of native controls we need to draw directly to the window
570 if (pSpl->_bNativeProgress && rRenderContext.IsNativeControlSupported(ControlType::IntroProgress, ControlPart::Entire))
571 {
572 rRenderContext.DrawBitmapEx(Point(), pSpl->_aIntroBmp);
573
574 ImplControlValue aValue( pSpl->_iProgress * pSpl->_barwidth / pSpl->_iMax);
575 tools::Rectangle aDrawRect( Point(pSpl->_tlx, pSpl->_tly), Size( pSpl->_barwidth, pSpl->_barheight));
576 tools::Rectangle aNativeControlRegion, aNativeContentRegion;
577
578 if (rRenderContext.GetNativeControlRegion(ControlType::IntroProgress, ControlPart::Entire, aDrawRect,
579 ControlState::ENABLED, aValue,
580 aNativeControlRegion, aNativeContentRegion))
581 {
582 long nProgressHeight = aNativeControlRegion.GetHeight();
583 aDrawRect.AdjustTop( -((nProgressHeight - pSpl->_barheight)/2) );
584 aDrawRect.AdjustBottom((nProgressHeight - pSpl->_barheight)/2 );
585 }
586
587 if (rRenderContext.DrawNativeControl(ControlType::IntroProgress, ControlPart::Entire, aDrawRect,
588 ControlState::ENABLED, aValue, pSpl->_sProgressText))
589 {
590 return;
591 }
592 }
593
594 // non native drawing
595 // draw bitmap
596 _vdev->DrawBitmapEx(Point(), pSpl->_aIntroBmp);
597
598 if (pSpl->_bPaintProgress) {
599 // draw progress...
600 long length = (pSpl->_iProgress * pSpl->_barwidth / pSpl->_iMax) - (2 * pSpl->_barspace);
601 if (length < 0) length = 0;
602
603 // border
604 _vdev->SetFillColor();
605 _vdev->SetLineColor( pSpl->_cProgressFrameColor );
606 _vdev->DrawRect(tools::Rectangle(pSpl->_tlx, pSpl->_tly, pSpl->_tlx+pSpl->_barwidth, pSpl->_tly+pSpl->_barheight));
607 _vdev->SetFillColor( pSpl->_cProgressBarColor );
608 _vdev->SetLineColor();
609 _vdev->DrawRect(tools::Rectangle(pSpl->_tlx+pSpl->_barspace, pSpl->_tly+pSpl->_barspace, pSpl->_tlx+pSpl->_barspace+length, pSpl->_tly+pSpl->_barheight-pSpl->_barspace));
610 vcl::Font aFont;
611 aFont.SetFontSize(Size(0, 12));
612 aFont.SetAlignment(ALIGN_BASELINE);
613 _vdev->SetFont(aFont);
614 _vdev->SetTextColor(pSpl->_cProgressTextColor);
615 _vdev->DrawText(Point(pSpl->_tlx, pSpl->_textBaseline), pSpl->_sProgressText);
616 }
617 rRenderContext.DrawOutDev(Point(), GetOutputSizePixel(), Point(), _vdev->GetOutputSizePixel(), *_vdev);
618}
619
620
621// get service instance...
622osl::Mutex SplashScreen::_aMutex;
623
624}
625
626extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface*
627desktop_SplashScreen_get_implementation(
628 css::uno::XComponentContext* , css::uno::Sequence<css::uno::Any> const&)
629{
630 return cppu::acquire(new SplashScreen());
631}
632
633
634/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

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

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
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
2.1
Field 'm_pBody' is non-null
2.1
Field 'm_pBody' is non-null
2.1
Field 'm_pBody' is non-null
2.1
Field 'm_pBody' is non-null
)
3
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
4
←
Calling 'VclReferenceBase::release'
→
8
←
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;
11
←
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)
5
←
Assuming the condition is true
→
6
←
Taking true branch
→
40 delete this;
7
←
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