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 svmain.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/svmain.cxx

/home/maarten/src/libreoffice/core/vcl/source/app/svmain.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 <sal/config.h>
21#include <sal/log.hxx>
22
23#include <cassert>
24
25#include <osl/file.hxx>
26#include <osl/signal.h>
27
28#include <desktop/exithelper.h>
29
30#include <comphelper/processfactory.hxx>
31#include <comphelper/asyncnotification.hxx>
32#include <i18nlangtag/mslangid.hxx>
33#include <unotools/syslocaleoptions.hxx>
34#include <vcl/QueueInfo.hxx>
35#include <vcl/svapp.hxx>
36#include <vcl/vclmain.hxx>
37#include <vcl/wrkwin.hxx>
38#include <vcl/cvtgrf.hxx>
39#include <vcl/scheduler.hxx>
40#include <vcl/image.hxx>
41#include <vcl/ImageTree.hxx>
42#include <vcl/settings.hxx>
43#include <vcl/toolkit/unowrap.hxx>
44#include <configsettings.hxx>
45#include <vcl/lazydelete.hxx>
46#include <vcl/embeddedfontshelper.hxx>
47#include <vcl/toolkit/dialog.hxx>
48#include <vcl/menu.hxx>
49#include <vcl/virdev.hxx>
50#include <vcl/print.hxx>
51#include <debugevent.hxx>
52#include <scrwnd.hxx>
53
54#ifdef _WIN32
55#include <svsys.h>
56#include <process.h>
57#include <ole2.h>
58#else
59#include <stdlib.h>
60#endif
61
62#ifdef ANDROID
63#include <cppuhelper/bootstrap.hxx>
64#include <jni.h>
65#endif
66
67#include <impfontcache.hxx>
68#include <salinst.hxx>
69#include <svdata.hxx>
70#include <vcl/svmain.hxx>
71#include <dbggui.hxx>
72#include <accmgr.hxx>
73#include <PhysicalFontCollection.hxx>
74#include <print.h>
75#include <salsys.hxx>
76#include <saltimer.hxx>
77#include <displayconnectiondispatch.hxx>
78
79#include <config_features.h>
80#include <config_feature_opencl.h>
81
82#include <osl/process.h>
83#include <com/sun/star/lang/XComponent.hpp>
84#include <com/sun/star/frame/Desktop.hpp>
85
86#ifdef _WIN32
87#include <com/sun/star/datatransfer/clipboard/XClipboard.hpp>
88#endif
89
90#include <comphelper/lok.hxx>
91#include <cppuhelper/implbase.hxx>
92#include <uno/current_context.hxx>
93
94#include <opencl/OpenCLZone.hxx>
95#include <opengl/zone.hxx>
96#include <skia/zone.hxx>
97#include <watchdog.hxx>
98
99#include <basegfx/utils/systemdependentdata.hxx>
100#include <tools/diagnose_ex.h>
101
102#if OSL_DEBUG_LEVEL1 > 0
103#include <typeinfo>
104#include <rtl/strbuf.hxx>
105#endif
106
107using namespace ::com::sun::star;
108
109static bool g_bIsLeanException;
110
111static oslSignalAction VCLExceptionSignal_impl( void* /*pData*/, oslSignalInfo* pInfo)
112{
113 static volatile bool bIn = false;
114
115 // if we crash again, bail out immediately
116 if ( bIn || g_bIsLeanException)
117 return osl_Signal_ActCallNextHdl;
118
119 ExceptionCategory nVCLException = ExceptionCategory::NONE;
120
121 // UAE
122 if ( (pInfo->Signal == osl_Signal_AccessViolation) ||
123 (pInfo->Signal == osl_Signal_IntegerDivideByZero) ||
124 (pInfo->Signal == osl_Signal_FloatDivideByZero) ||
125 (pInfo->Signal == osl_Signal_DebugBreak) )
126 {
127 nVCLException = ExceptionCategory::System;
128#if HAVE_FEATURE_OPENGL1
129 if (OpenGLZone::isInZone())
130 OpenGLZone::hardDisable();
131#endif
132#if HAVE_FEATURE_SKIA1
133 if (SkiaZone::isInZone())
134 SkiaZone::hardDisable();
135#endif
136#if HAVE_FEATURE_OPENCL1
137 if (OpenCLZone::isInZone())
138 {
139 OpenCLZone::hardDisable();
140#ifdef _WIN32
141 if (OpenCLInitialZone::isInZone())
142 TerminateProcess(GetCurrentProcess(), EXITHELPER_NORMAL_RESTART);
143#endif
144 }
145#endif
146 }
147
148 // DISPLAY-Unix
149 if ((pInfo->Signal == osl_Signal_User) &&
150 (pInfo->UserSignal == OSL_SIGNAL_USER_X11SUBSYSTEMERROR(0 - 2)) )
151 nVCLException = ExceptionCategory::UserInterface;
152
153 if ( nVCLException != ExceptionCategory::NONE )
154 {
155 bIn = true;
156
157 vcl::SolarMutexTryAndBuyGuard aLock;
158 if( aLock.isAcquired())
159 {
160 // do not stop timer because otherwise the UAE-Box will not be painted as well
161 ImplSVData* pSVData = ImplGetSVData();
162 if ( pSVData->mpApp )
163 {
164 SystemWindowFlags nOldMode = Application::GetSystemWindowMode();
165 Application::SetSystemWindowMode( nOldMode & ~SystemWindowFlags::NOAUTOMODE );
166 pSVData->mpApp->Exception( nVCLException );
167 Application::SetSystemWindowMode( nOldMode );
168 }
169 }
170 bIn = false;
171 }
172
173 return osl_Signal_ActCallNextHdl;
174
175}
176
177int ImplSVMain()
178{
179 // The 'real' SVMain()
180 ImplSVData* pSVData = ImplGetSVData();
181
182 SAL_WARN_IF( !pSVData->mpApp, "vcl", "no instance of class Application" )do { if (true && (!pSVData->mpApp)) { 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() << "no instance of class Application"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"
), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "182" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "no instance of class Application"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "no instance of class Application"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "182" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "no instance of class Application") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "182" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "no instance of class Application"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "no instance of class Application"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "182" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
2
←
Assuming field 'mpApp' is non-null
→
3
←
Taking false branch
→
4
←
Loop condition is false. Exiting loop
→
183
184 int nReturn = EXIT_FAILURE1;
185
186 const bool bWasInitVCL = IsVCLInit();
187 const bool bInit = bWasInitVCL
4.1
'bWasInitVCL' is false
4.1
'bWasInitVCL' is false
4.1
'bWasInitVCL' is false
4.1
'bWasInitVCL' is false
 || InitVCL();
188 int nRet = 0;
189 if (!bWasInitVCL
4.2
'bWasInitVCL' is false
4.2
'bWasInitVCL' is false
4.2
'bWasInitVCL' is false
4.2
'bWasInitVCL' is false
 && bInit
4.3
'bInit' is false
4.3
'bInit' is false
4.3
'bInit' is false
4.3
'bInit' is false
 && pSVData->mpDefInst->SVMainHook(&nRet))
190 return nRet;
191
192 if( bInit
4.4
'bInit' is false
4.4
'bInit' is false
4.4
'bInit' is false
4.4
'bInit' is false
 )
5
←
Taking false branch
→
193 {
194 // call application main
195 pSVData->maAppData.mbInAppMain = true;
196 nReturn = pSVData->mpApp->Main();
197 pSVData->maAppData.mbInAppMain = false;
198 }
199
200 if( pSVData->mxDisplayConnection.is() )
6
←
Taking false branch
→
201 {
202 pSVData->mxDisplayConnection->terminate();
203 pSVData->mxDisplayConnection.clear();
204 }
205
206 // This is a hack to work around the problem of the asynchronous nature
207 // of bridging accessibility through Java: on shutdown there might still
208 // be some events in the AWT EventQueue, which need the SolarMutex which
209 // - on the other hand - is destroyed in DeInitVCL(). So empty the queue
210 // here ..
211 if( pSVData->mxAccessBridge.is() )
7
←
Taking false branch
→
212 {
213 {
214 SolarMutexReleaser aReleaser;
215 pSVData->mxAccessBridge->dispose();
216 }
217 pSVData->mxAccessBridge.clear();
218 }
219
220 WatchdogThread::stop();
221 DeInitVCL();
8
←
Calling 'DeInitVCL'
→
222
223 return nReturn;
224}
225
226int SVMain()
227{
228 return ImplSVMain();
1
Calling 'ImplSVMain'
→
229}
230
231// This variable is set when no Application object has been instantiated
232// before InitVCL is called
233static Application * pOwnSvApp = nullptr;
234
235// Exception handler. pExceptionHandler != NULL => VCL already inited
236static oslSignalHandler pExceptionHandler = nullptr;
237
238namespace {
239
240class DesktopEnvironmentContext: public cppu::WeakImplHelper< css::uno::XCurrentContext >
241{
242public:
243 explicit DesktopEnvironmentContext( const css::uno::Reference< css::uno::XCurrentContext > & ctx)
244 : m_xNextContext( ctx ) {}
245
246 // XCurrentContext
247 virtual css::uno::Any SAL_CALL getValueByName( const OUString& Name ) override;
248
249private:
250 css::uno::Reference< css::uno::XCurrentContext > m_xNextContext;
251};
252
253}
254
255uno::Any SAL_CALL DesktopEnvironmentContext::getValueByName( const OUString& Name)
256{
257 uno::Any retVal;
258
259 if ( Name == "system.desktop-environment" )
260 {
261 retVal <<= Application::GetDesktopEnvironment();
262 }
263 else if( m_xNextContext.is() )
264 {
265 // Call next context in chain if found
266 retVal = m_xNextContext->getValueByName( Name );
267 }
268 return retVal;
269}
270
271bool IsVCLInit()
272{
273 ImplSVData* pSVData = ImplGetSVData();
274 return pExceptionHandler != nullptr &&
275 pSVData->mpApp != nullptr &&
276 pSVData->mpDefInst != nullptr;
277}
278
279#ifdef DBG_UTIL
280namespace vclmain
281{
282 bool isAlive()
283 {
284 return ImplGetSVData()->mpDefInst;
285 }
286}
287#endif
288
289
290bool InitVCL()
291{
292 if (IsVCLInit())
293 {
294 SAL_INFO("vcl.app", "Double initialization of vcl")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "vcl.app")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "Double initialization of vcl"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.app"
), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "294" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Double initialization of vcl"), 0); }
else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "Double initialization of vcl"; ::sal::detail::log(
(::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.app"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "294" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "Double initialization of vcl") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.app"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "294" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Double initialization of vcl"), 0); }
else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "Double initialization of vcl"; ::sal::detail::log(
(::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.app"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "294" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
295 return true;
296 }
297
298 if( pExceptionHandler != nullptr )
299 return false;
300
301 EmbeddedFontsHelper::clearTemporaryFontFiles();
302
303 if( !ImplGetSVData()->mpApp )
304 {
305 pOwnSvApp = new Application();
306 }
307
308 ImplSVData* pSVData = ImplGetSVData();
309
310 // remember Main-Thread-Id
311 pSVData->mnMainThreadId = ::osl::Thread::getCurrentIdentifier();
312
313 // Initialize Sal
314 pSVData->mpDefInst = CreateSalInstance();
315 if ( !pSVData->mpDefInst )
316 return false;
317
318 // Desktop Environment context (to be able to get value of "system.desktop-environment" as soon as possible)
319 css::uno::setCurrentContext(
320 new DesktopEnvironmentContext( css::uno::getCurrentContext() ) );
321
322 // Initialize application instance (should be done after initialization of VCL SAL part)
323 if (pSVData->mpApp)
324 {
325 // call init to initialize application class
326 // soffice/sfx implementation creates the global service manager
327 pSVData->mpApp->Init();
328 }
329
330 try
331 {
332 //Now that uno has been bootstrapped we can ask the config what the UI language is so that we can
333 //force that in as $LANGUAGE. That way we can get gtk to render widgets RTL
334 //if we have a RTL UI in an otherwise LTR locale and get gettext using externals (e.g. python)
335 //to match their translations to our preferred UI language
336 OUString aLocaleString(SvtSysLocaleOptions().GetRealUILanguageTag().getGlibcLocaleString(".UTF-8"));
337 if (!aLocaleString.isEmpty())
338 {
339 MsLangId::getSystemUILanguage(); //call this now to pin what the system UI really was
340 OUString envVar("LANGUAGE");
341 osl_setEnvironment(envVar.pData, aLocaleString.pData);
342 }
343 }
344 catch (const uno::Exception &)
345 {
346 TOOLS_INFO_EXCEPTION("vcl.app", "Unable to get ui language:")do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "vcl.app")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "Unable to get ui language:"
<< " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO), (
"vcl.app"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "346" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Unable to get ui language:" << " "
<< exceptionToString(tools_warn_exception)), 0); } else
{ ::std::ostringstream sal_detail_stream; sal_detail_stream <<
"Unable to get ui language:" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("vcl.app"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "346" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "Unable to get ui language:" << " " <<
exceptionToString(tools_warn_exception)) == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.app"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "346" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Unable to get ui language:" << " "
<< exceptionToString(tools_warn_exception)), 0); } else
{ ::std::ostringstream sal_detail_stream; sal_detail_stream <<
"Unable to get ui language:" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("vcl.app"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "346" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false);
347 }
348
349 pSVData->mpDefInst->AfterAppInit();
350
351 // Fetch AppFileName and make it absolute before the workdir changes...
352 OUString aExeFileName;
353 osl_getExecutableFile( &aExeFileName.pData );
354
355 // convert path to native file format
356 OUString aNativeFileName;
357 osl::FileBase::getSystemPathFromFileURL( aExeFileName, aNativeFileName );
358 pSVData->maAppData.mxAppFileName = aNativeFileName;
359
360 // Initialize global data
361 pSVData->maGDIData.mxScreenFontList = std::make_shared<PhysicalFontCollection>();
362 pSVData->maGDIData.mxScreenFontCache = std::make_shared<ImplFontCache>();
363 pSVData->maGDIData.mpGrfConverter = new GraphicConverter;
364
365 g_bIsLeanException = getenv("LO_LEAN_EXCEPTION") != nullptr;
366 // Set exception handler
367 pExceptionHandler = osl_addSignalHandler(VCLExceptionSignal_impl, nullptr);
368
369#ifndef NDEBUG
370 DbgGUIInitSolarMutexCheck();
371#endif
372
373#if OSL_DEBUG_LEVEL1 > 0
374 DebugEventInjector::getCreate();
375#endif
376
377#ifndef _WIN32
378 // Clear startup notification details for child processes
379 // See https://bugs.freedesktop.org/show_bug.cgi?id=11375 for discussion
380 unsetenv("DESKTOP_STARTUP_ID");
381#endif
382
383 return true;
384}
385
386namespace
387{
388
389/** Serves for destroying the VCL UNO wrapper as late as possible. This avoids
390 crash at exit in some special cases when a11y is enabled (e.g., when
391 a bundled extension is registered/deregistered during startup, forcing exit
392 while the app is still in splash screen.)
393 */
394class VCLUnoWrapperDeleter : public cppu::WeakImplHelper<css::lang::XEventListener>
395{
396 virtual void SAL_CALL disposing(lang::EventObject const& rSource) override;
397};
398
399void
400VCLUnoWrapperDeleter::disposing(lang::EventObject const& /* rSource */)
401{
402 ImplSVData* const pSVData = ImplGetSVData();
403 if (pSVData && pSVData->mpUnoWrapper)
404 {
405 pSVData->mpUnoWrapper->Destroy();
406 pSVData->mpUnoWrapper = nullptr;
407 }
408}
409
410}
411
412void DeInitVCL()
413{
414 // The LOK Windows map container should be empty
415 assert(vcl::Window::IsLOKWindowsEmpty())(static_cast <bool> (vcl::Window::IsLOKWindowsEmpty()) ?
void (0) : __assert_fail ("vcl::Window::IsLOKWindowsEmpty()"
, "/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
, 415, __extension__ __PRETTY_FUNCTION__));
9
←
Assuming the condition is true
→
10
←
'?' condition is true
→
416
417 //rhbz#1444437, when using LibreOffice like a library you can't realistically
418 //tear everything down and recreate them on the next call, there's too many
419 //(c++) singletons that point to stuff that gets deleted during shutdown
420 //which won't be recreated on restart.
421 if (comphelper::LibreOfficeKit::isActive())
11
←
Assuming the condition is false
→
12
←
Taking false branch
→
422 return;
423
424 {
425 SolarMutexReleaser r; // unblock threads blocked on that so we can join
426 ::comphelper::JoinAsyncEventNotifiers();
427 }
428 ImplSVData* pSVData = ImplGetSVData();
429
430 // lp#1560328: clear cache before disposing rest of VCL
431 if(pSVData->mpBlendFrameCache)
13
←
Taking true branch
→
432 pSVData->mpBlendFrameCache->m_aLastResult.Clear();
433 pSVData->mbDeInit = true;
434
435 vcl::DeleteOnDeinitBase::ImplDeleteOnDeInit();
436
437#if OSL_DEBUG_LEVEL1 > 0
438 OStringBuffer aBuf( 256 );
439 aBuf.append( "DeInitVCL: some top Windows are still alive\n" );
440 long nTopWindowCount = Application::GetTopWindowCount();
441 long nBadTopWindows = nTopWindowCount;
442 for( long i = 0; i < nTopWindowCount; i++ )
14
←
Assuming 'i' is >= 'nTopWindowCount'
→
15
←
Loop condition is false. Execution continues on line 460
→
443 {
444 vcl::Window* pWin = Application::GetTopWindow( i );
445 // default window will be destroyed further down
446 // but may still be useful during deinit up to that point
447 if( pWin == pSVData->mpDefaultWin )
448 nBadTopWindows--;
449 else
450 {
451 aBuf.append( "text = \"" );
452 aBuf.append( OUStringToOString( pWin->GetText(), osl_getThreadTextEncoding() ) );
453 aBuf.append( "\" type = \"" );
454 aBuf.append( typeid(*pWin).name() );
455 aBuf.append( "\", ptr = 0x" );
456 aBuf.append( reinterpret_cast<sal_Int64>( pWin ), 16 );
457 aBuf.append( "\n" );
458 }
459 }
460 SAL_WARN_IF( nBadTopWindows!=0, "vcl", aBuf.getStr() )do { if (true && (nBadTopWindows!=0)) { 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() << aBuf.getStr
()) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "460" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << aBuf.getStr()), 0); } else { ::std::ostringstream
sal_detail_stream; sal_detail_stream << aBuf.getStr();
::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), (
"/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "460" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << aBuf.getStr()) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl"), ("/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "460" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << aBuf.getStr()), 0); } else { ::std::ostringstream
sal_detail_stream; sal_detail_stream << aBuf.getStr();
::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl"), (
"/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
":" "460" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
16
←
Assuming 'nBadTopWindows' is equal to 0
→
17
←
Taking false branch
→
18
←
Loop condition is false. Exiting loop
→
461#endif
462
463 ImageTree::get().shutdown();
464
465 osl_removeSignalHandler( pExceptionHandler);
466 pExceptionHandler = nullptr;
467
468 // free global data
469 if (pSVData->maGDIData.mpGrfConverter)
19
←
Assuming field 'mpGrfConverter' is null
→
20
←
Taking false branch
→
470 {
471 delete pSVData->maGDIData.mpGrfConverter;
472 pSVData->maGDIData.mpGrfConverter = nullptr;
473 }
474
475 pSVData->mpSettingsConfigItem.reset();
476
477 // prevent unnecessary painting during Scheduler shutdown
478 // as this processes all pending events in debug builds.
479 ImplGetSystemDependentDataManager().flushAll();
480
481 Scheduler::ImplDeInitScheduler();
482
483 pSVData->mpWinData->maMsgBoxImgList.clear();
484 pSVData->maCtrlData.maCheckImgList.clear();
485 pSVData->maCtrlData.maRadioImgList.clear();
486 pSVData->maCtrlData.mpDisclosurePlus.reset();
487 pSVData->maCtrlData.mpDisclosureMinus.reset();
488 pSVData->mpDefaultWin.disposeAndClear();
21
←
Calling 'VclPtr::disposeAndClear'
→
489
490#if defined _WIN32
491 // See GetSystemClipboard (vcl/source/treelist/transfer2.cxx):
492 if (auto const comp = css::uno::Reference<css::lang::XComponent>(
493 pSVData->m_xSystemClipboard, css::uno::UNO_QUERY))
494 {
495 SolarMutexReleaser r; // unblock pending "clipboard content changed" notifications
496 comp->dispose(); // will use CWinClipbImpl::s_aMutex
497 }
498 pSVData->m_xSystemClipboard.clear();
499#endif
500
501#ifndef NDEBUG
502 DbgGUIDeInitSolarMutexCheck();
503#endif
504
505 if ( pSVData->mpUnoWrapper )
506 {
507 try
508 {
509 uno::Reference<frame::XDesktop2> const xDesktop = frame::Desktop::create(
510 comphelper::getProcessComponentContext() );
511 xDesktop->addEventListener(new VCLUnoWrapperDeleter);
512 }
513 catch (uno::Exception const&)
514 {
515 // ignore
516 }
517 }
518
519 if( pSVData->mpApp || pSVData->maDeInitHook.IsSet() )
520 {
521 SolarMutexReleaser aReleaser;
522 // call deinit to deinitialize application class
523 // soffice/sfx implementation disposes the global service manager
524 // Warning: After this call you can't call uno services
525 if( pSVData->mpApp )
526 {
527 pSVData->mpApp->DeInit();
528 }
529 if( pSVData->maDeInitHook.IsSet() )
530 {
531 pSVData->maDeInitHook.Call(nullptr);
532 }
533 }
534
535 if ( pSVData->maAppData.mpSettings )
536 {
537 if ( pSVData->maAppData.mpCfgListener )
538 {
539 pSVData->maAppData.mpSettings->GetSysLocale().GetOptions().RemoveListener( pSVData->maAppData.mpCfgListener );
540 delete pSVData->maAppData.mpCfgListener;
541 }
542
543 pSVData->maAppData.mpSettings.reset();
544 }
545 if ( pSVData->maAppData.mpAccelMgr )
546 {
547 delete pSVData->maAppData.mpAccelMgr;
548 pSVData->maAppData.mpAccelMgr = nullptr;
549 }
550 pSVData->maAppData.maKeyListeners.clear();
551 pSVData->mpBlendFrameCache.reset();
552
553 ImplDeletePrnQueueList();
554
555 // destroy all Sal interfaces before destroying the instance
556 // and thereby unloading the plugin
557 pSVData->mpSalSystem.reset();
558 assert( !pSVData->maSchedCtx.mpSalTimer )(static_cast <bool> (!pSVData->maSchedCtx.mpSalTimer
) ? void (0) : __assert_fail ("!pSVData->maSchedCtx.mpSalTimer"
, "/home/maarten/src/libreoffice/core/vcl/source/app/svmain.cxx"
, 558, __extension__ __PRETTY_FUNCTION__));
559 delete pSVData->maSchedCtx.mpSalTimer;
560 pSVData->maSchedCtx.mpSalTimer = nullptr;
561
562 pSVData->mpDefaultWin = nullptr;
563 pSVData->mpIntroWindow = nullptr;
564 pSVData->maAppData.mpActivePopupMenu = nullptr;
565 pSVData->maAppData.mpWheelWindow = nullptr;
566 pSVData->maGDIData.mpFirstWinGraphics = nullptr;
567 pSVData->maGDIData.mpLastWinGraphics = nullptr;
568 pSVData->maGDIData.mpFirstVirGraphics = nullptr;
569 pSVData->maGDIData.mpLastVirGraphics = nullptr;
570 pSVData->maGDIData.mpFirstPrnGraphics = nullptr;
571 pSVData->maGDIData.mpLastPrnGraphics = nullptr;
572 pSVData->maGDIData.mpFirstVirDev = nullptr;
573 pSVData->maGDIData.mpFirstPrinter = nullptr;
574 pSVData->maFrameData.mpFirstFrame = nullptr;
575 pSVData->maFrameData.mpAppWin = nullptr;
576 pSVData->maFrameData.mpActiveApplicationFrame = nullptr;
577 pSVData->mpWinData->mpCaptureWin = nullptr;
578 pSVData->mpWinData->mpLastDeacWin = nullptr;
579 pSVData->mpWinData->mpFirstFloat = nullptr;
580 pSVData->mpWinData->mpExecuteDialogs.clear();
581 pSVData->mpWinData->mpExtTextInputWin = nullptr;
582 pSVData->mpWinData->mpTrackWin = nullptr;
583 pSVData->mpWinData->mpAutoScrollWin = nullptr;
584 pSVData->mpWinData->mpLastWheelWindow = nullptr;
585
586 pSVData->maGDIData.mxScreenFontList.reset();
587 pSVData->maGDIData.mxScreenFontCache.reset();
588 pSVData->maGDIData.maScaleCache.remove_if([](const lru_scale_cache::key_value_pair_t&)
589 { return true; });
590
591 pSVData->maGDIData.maThemeDrawCommandsCache.clear();
592 pSVData->maGDIData.maThemeImageCache.clear();
593
594 // Deinit Sal
595 if (pSVData->mpDefInst)
596 {
597 DestroySalInstance( pSVData->mpDefInst );
598 pSVData->mpDefInst = nullptr;
599 }
600
601 if( pOwnSvApp )
602 {
603 delete pOwnSvApp;
604 pOwnSvApp = nullptr;
605 }
606
607 EmbeddedFontsHelper::clearTemporaryFontFiles();
608}
609
610namespace {
611
612// only one call is allowed
613struct WorkerThreadData
614{
615 oslWorkerFunction pWorker;
616 void * pThreadData;
617 WorkerThreadData( oslWorkerFunction pWorker_, void * pThreadData_ )
618 : pWorker( pWorker_ )
619 , pThreadData( pThreadData_ )
620 {
621 }
622};
623
624}
625
626#ifdef _WIN32
627static HANDLE hThreadID = nullptr;
628static unsigned __stdcall threadmain( void *pArgs )
629{
630 OleInitialize( nullptr );
631 static_cast<WorkerThreadData*>(pArgs)->pWorker( static_cast<WorkerThreadData*>(pArgs)->pThreadData );
632 delete static_cast<WorkerThreadData*>(pArgs);
633 OleUninitialize();
634 hThreadID = nullptr;
635 return 0;
636}
637#else
638static oslThread hThreadID = nullptr;
639extern "C"
640{
641static void MainWorkerFunction( void* pArgs )
642{
643 static_cast<WorkerThreadData*>(pArgs)->pWorker( static_cast<WorkerThreadData*>(pArgs)->pThreadData );
644 delete static_cast<WorkerThreadData*>(pArgs);
645 hThreadID = nullptr;
646}
647} // extern "C"
648#endif
649
650void CreateMainLoopThread( oslWorkerFunction pWorker, void * pThreadData )
651{
652#ifdef _WIN32
653 // sal thread always call CoInitializeEx, so a system dependent implementation is necessary
654
655 unsigned uThreadID;
656 hThreadID = reinterpret_cast<HANDLE>(_beginthreadex(
657 nullptr, // no security handle
658 0, // stacksize 0 means default
659 threadmain, // thread worker function
660 new WorkerThreadData( pWorker, pThreadData ), // arguments for worker function
661 0, // 0 means: create immediately otherwise use CREATE_SUSPENDED
662 &uThreadID )); // thread id to fill
663#else
664 hThreadID = osl_createThread( MainWorkerFunction, new WorkerThreadData( pWorker, pThreadData ) );
665#endif
666}
667
668void JoinMainLoopThread()
669{
670 if( hThreadID )
671 {
672#ifdef _WIN32
673 WaitForSingleObject(hThreadID, INFINITE);
674#else
675 osl_joinWithThread(hThreadID);
676 osl_destroyThread( hThreadID );
677#endif
678 }
679}
680
681/* 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);
22
←
Calling copy constructor for 'Reference<WorkWindow>'
→
25
←
Returning from copy constructor for 'Reference<WorkWindow>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
26
←
Calling 'Reference::clear'
→
33
←
Returning; memory was released
→
205 if (aTmp.get()) {
34
←
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)
23
←
Assuming field 'm_pBody' is non-null
→
24
←
Taking true branch
→
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
26.1
Field 'm_pBody' is non-null
26.1
Field 'm_pBody' is non-null
26.1
Field 'm_pBody' is non-null
26.1
Field 'm_pBody' is non-null
)
27
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
28
←
Calling 'VclReferenceBase::release'
→
32
←
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;
35
←
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)
29
←
Assuming the condition is true
→
30
←
Taking true branch
→
40 delete this;
31
←
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