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 OpenGLContext.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/opengl/OpenGLContext.cxx

/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.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
10#include <chrono>
11
12#include <vcl/opengl/OpenGLContext.hxx>
13#include <vcl/opengl/OpenGLHelper.hxx>
14#include <vcl/opengl/OpenGLWrapper.hxx>
15#include <vcl/syschild.hxx>
16#include <vcl/sysdata.hxx>
17
18#include <osl/thread.hxx>
19#include <sal/log.hxx>
20
21#include <svdata.hxx>
22#include <salgdi.hxx>
23#include <salinst.hxx>
24
25#include <opengl/framebuffer.hxx>
26#include <opengl/program.hxx>
27#include <opengl/texture.hxx>
28#include <opengl/zone.hxx>
29
30#include <opengl/RenderState.hxx>
31
32#include <config_features.h>
33
34using namespace com::sun::star;
35
36#define MAX_FRAMEBUFFER_COUNT30 30
37
38static sal_Int64 nBufferSwapCounter = 0;
39
40GLWindow::~GLWindow()
41{
42}
43
44bool GLWindow::Synchronize(bool /*bOnoff*/) const
45{
46 return false;
47}
48
49OpenGLContext::OpenGLContext():
50 mpWindow(nullptr),
51 m_pChildWindow(nullptr),
52 mbInitialized(false),
53 mnRefCount(0),
54 mbRequestLegacyContext(false),
55 mbVCLOnly(false),
56 mnFramebufferCount(0),
57 mpCurrentFramebuffer(nullptr),
58 mpFirstFramebuffer(nullptr),
59 mpLastFramebuffer(nullptr),
60 mpCurrentProgram(nullptr),
61 mpRenderState(new RenderState),
62 mpPrevContext(nullptr),
63 mpNextContext(nullptr)
64{
65 VCL_GL_INFO("new context: " << this)do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "new context: "
<< this; OpenGLHelper::debugMsgStream(detail_stream); }
} while (false);
66
67 ImplSVData* pSVData = ImplGetSVData();
68 if( pSVData->maGDIData.mpLastContext )
69 {
70 pSVData->maGDIData.mpLastContext->mpNextContext = this;
71 mpPrevContext = pSVData->maGDIData.mpLastContext;
72 }
73 pSVData->maGDIData.mpLastContext = this;
74
75 // FIXME: better hope we call 'makeCurrent' soon to preserve
76 // the invariant that the last item is the current context.
77}
78
79OpenGLContext::~OpenGLContext()
80{
81 assert (mnRefCount == 0)(static_cast <bool> (mnRefCount == 0) ? void (0) : __assert_fail
("mnRefCount == 0", "/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
, 81, __extension__ __PRETTY_FUNCTION__));
82
83 mnRefCount = 1; // guard the shutdown paths.
84 VCL_GL_INFO("delete context: " << this)do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "delete context: "
<< this; OpenGLHelper::debugMsgStream(detail_stream); }
} while (false);
85
86 reset();
87
88 ImplSVData* pSVData = ImplGetSVData();
89 if( mpPrevContext )
90 mpPrevContext->mpNextContext = mpNextContext;
91 if( mpNextContext )
92 mpNextContext->mpPrevContext = mpPrevContext;
93 else
94 pSVData->maGDIData.mpLastContext = mpPrevContext;
95
96 m_pChildWindow.disposeAndClear();
97 assert (mnRefCount == 1)(static_cast <bool> (mnRefCount == 1) ? void (0) : __assert_fail
("mnRefCount == 1", "/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
, 97, __extension__ __PRETTY_FUNCTION__));
98}
99
100// release associated child-window if we have one
101void OpenGLContext::dispose()
102{
103 reset();
104 m_pChildWindow.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
→
105}
106
107rtl::Reference<OpenGLContext> OpenGLContext::Create()
108{
109 return rtl::Reference<OpenGLContext>(ImplGetSVData()->mpDefInst->CreateOpenGLContext());
110}
111
112void OpenGLContext::requestLegacyContext()
113{
114 mbRequestLegacyContext = true;
115}
116
117#ifdef DBG_UTIL
118
119namespace {
120
121const char* getSeverityString(GLenum severity)
122{
123 switch(severity)
124 {
125 case GL_DEBUG_SEVERITY_LOW0x9148:
126 return "low";
127 case GL_DEBUG_SEVERITY_MEDIUM0x9147:
128 return "medium";
129 case GL_DEBUG_SEVERITY_HIGH0x9146:
130 return "high";
131 default:
132 ;
133 }
134
135 return "unknown";
136}
137
138const char* getSourceString(GLenum source)
139{
140 switch(source)
141 {
142 case GL_DEBUG_SOURCE_API0x8246:
143 return "API";
144 case GL_DEBUG_SOURCE_SHADER_COMPILER0x8248:
145 return "shader compiler";
146 case GL_DEBUG_SOURCE_WINDOW_SYSTEM0x8247:
147 return "window system";
148 case GL_DEBUG_SOURCE_THIRD_PARTY0x8249:
149 return "third party";
150 case GL_DEBUG_SOURCE_APPLICATION0x824A:
151 return "Libreoffice";
152 case GL_DEBUG_SOURCE_OTHER0x824B:
153 return "unknown";
154 default:
155 ;
156 }
157
158 return "unknown";
159}
160
161const char* getTypeString(GLenum type)
162{
163 switch(type)
164 {
165 case GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR0x824D:
166 return "deprecated behavior";
167 case GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR0x824E:
168 return "undefined behavior";
169 case GL_DEBUG_TYPE_PERFORMANCE0x8250:
170 return "performance";
171 case GL_DEBUG_TYPE_PORTABILITY0x824F:
172 return "portability";
173 case GL_DEBUG_TYPE_MARKER0x8268:
174 return "marker";
175 case GL_DEBUG_TYPE_PUSH_GROUP0x8269:
176 return "push group";
177 case GL_DEBUG_TYPE_POP_GROUP0x826A:
178 return "pop group";
179 case GL_DEBUG_TYPE_OTHER0x8251:
180 return "other";
181 case GL_DEBUG_TYPE_ERROR0x824C:
182 return "error";
183 default:
184 ;
185 }
186
187 return "unknown";
188}
189
190extern "C" void
191#if defined _WIN32
192APIENTRY
193#endif
194debug_callback(GLenum source, GLenum type, GLuint id,
195 GLenum severity, GLsizei , const GLchar* message,
196 const GLvoid*)
197{
198 // ignore Nvidia's 131218: "Program/shader state performance warning: Fragment Shader is going to be recompiled because the shader key based on GL state mismatches."
199 // the GLSL compiler is a bit too aggressive in optimizing the state based on the current OpenGL state
200
201 // ignore 131185: "Buffer detailed info: Buffer object x (bound to GL_ARRAY_BUFFER_ARB,
202 // usage hint is GL_STATIC_DRAW) will use VIDEO memory as the source for buffer object operations."
203 if (id == 131218 || id == 131185)
204 return;
205
206 SAL_WARN("vcl.opengl", "OpenGL debug message: source: " << getSourceString(source) << ", type: "do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "vcl.opengl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "OpenGL debug message: source: "
<< getSourceString(source) << ", type: " <<
getTypeString(type) << ", id: " << id << ", severity: "
<< getSeverityString(severity) << ", with message: "
<< message) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "OpenGL debug message: source: " <<
getSourceString(source) << ", type: " << getTypeString
(type) << ", id: " << id << ", severity: " <<
getSeverityString(severity) << ", with message: " <<
message), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "OpenGL debug message: source: "
<< getSourceString(source) << ", type: " <<
getTypeString(type) << ", id: " << id << ", severity: "
<< getSeverityString(severity) << ", with message: "
<< message; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "OpenGL debug message: source: " << getSourceString
(source) << ", type: " << getTypeString(type) <<
", id: " << id << ", severity: " << getSeverityString
(severity) << ", with message: " << message) == 1
) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "OpenGL debug message: source: " <<
getSourceString(source) << ", type: " << getTypeString
(type) << ", id: " << id << ", severity: " <<
getSeverityString(severity) << ", with message: " <<
message), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "OpenGL debug message: source: "
<< getSourceString(source) << ", type: " <<
getTypeString(type) << ", id: " << id << ", severity: "
<< getSeverityString(severity) << ", with message: "
<< message; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
207 << getTypeString(type) << ", id: " << id << ", severity: " << getSeverityString(severity) << ", with message: " << message)do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "vcl.opengl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "OpenGL debug message: source: "
<< getSourceString(source) << ", type: " <<
getTypeString(type) << ", id: " << id << ", severity: "
<< getSeverityString(severity) << ", with message: "
<< message) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "OpenGL debug message: source: " <<
getSourceString(source) << ", type: " << getTypeString
(type) << ", id: " << id << ", severity: " <<
getSeverityString(severity) << ", with message: " <<
message), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "OpenGL debug message: source: "
<< getSourceString(source) << ", type: " <<
getTypeString(type) << ", id: " << id << ", severity: "
<< getSeverityString(severity) << ", with message: "
<< message; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "OpenGL debug message: source: " << getSourceString
(source) << ", type: " << getTypeString(type) <<
", id: " << id << ", severity: " << getSeverityString
(severity) << ", with message: " << message) == 1
) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "OpenGL debug message: source: " <<
getSourceString(source) << ", type: " << getTypeString
(type) << ", id: " << id << ", severity: " <<
getSeverityString(severity) << ", with message: " <<
message), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "OpenGL debug message: source: "
<< getSourceString(source) << ", type: " <<
getTypeString(type) << ", id: " << id << ", severity: "
<< getSeverityString(severity) << ", with message: "
<< message; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "207" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
208}
209
210}
211
212#endif
213
214bool OpenGLContext::init( vcl::Window* pParent )
215{
216 if(mbInitialized)
217 return true;
218
219 OpenGLZone aZone;
220
221 m_xWindow.reset(pParent ? nullptr : VclPtr<vcl::Window>::Create(nullptr, WB_NOBORDER|WB_NODIALOGCONTROL));
222 mpWindow = pParent ? pParent : m_xWindow.get();
223 if(m_xWindow)
224 m_xWindow->setPosSizePixel(0,0,0,0);
225 //tdf#108069 we may be initted twice, so dispose earlier effort
226 m_pChildWindow.disposeAndClear();
227 initWindow();
228 return ImplInit();
229}
230
231bool OpenGLContext::ImplInit()
232{
233 VCL_GL_INFO("OpenGLContext not implemented for this platform")do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "OpenGLContext not implemented for this platform"
; OpenGLHelper::debugMsgStream(detail_stream); } } while (false
);
234 return false;
235}
236
237static OUString getGLString(GLenum eGlEnum)
238{
239 OUString sString;
240 const GLubyte* pString = glGetStringepoxy_glGetString(eGlEnum);
241 if (pString)
242 {
243 sString = OUString::createFromAscii(reinterpret_cast<const char*>(pString));
244 }
245
246 CHECK_GL_ERROR()OpenGLHelper::checkGLError("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
, 246);
247 return sString;
248}
249
250bool OpenGLContext::InitGL()
251{
252 VCL_GL_INFO("OpenGLContext::ImplInit----end")do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "OpenGLContext::ImplInit----end"
; OpenGLHelper::debugMsgStream(detail_stream); } } while (false
);
253 VCL_GL_INFO("Vendor: " << getGLString(GL_VENDOR) << " Renderer: " << getGLString(GL_RENDERER) << " GL version: " << OpenGLHelper::getGLVersion())do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "Vendor: "
<< getGLString(0x1F00) << " Renderer: " <<
getGLString(0x1F01) << " GL version: " << OpenGLHelper
::getGLVersion(); OpenGLHelper::debugMsgStream(detail_stream)
; } } while (false);
254 mbInitialized = true;
255
256 // I think we need at least GL 3.0
257 if (epoxy_gl_version() < 30)
258 {
259 SAL_WARN("vcl.opengl", "We don't have at least OpenGL 3.0")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "vcl.opengl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "We don't have at least OpenGL 3.0"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "259" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "We don't have at least OpenGL 3.0"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "We don't have at least OpenGL 3.0"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "259" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "We don't have at least OpenGL 3.0") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "259" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "We don't have at least OpenGL 3.0"), 0
); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "We don't have at least OpenGL 3.0"; ::sal::detail::
log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "259" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
260 return false;
261 }
262
263 // Check that some "optional" APIs that we use unconditionally are present
264 if (!glBindFramebufferepoxy_glBindFramebuffer)
265 {
266 SAL_WARN("vcl.opengl", "We don't have glBindFramebuffer")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "vcl.opengl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "We don't have glBindFramebuffer"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "266" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "We don't have glBindFramebuffer"), 0)
; } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "We don't have glBindFramebuffer"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "266" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "We don't have glBindFramebuffer") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "266" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "We don't have glBindFramebuffer"), 0)
; } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "We don't have glBindFramebuffer"; ::sal::detail::log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "266" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
267 return false;
268 }
269
270 return true;
271}
272
273void OpenGLContext::InitGLDebugging()
274{
275#ifdef DBG_UTIL
276 // only enable debug output in dbgutil build
277 if (epoxy_has_gl_extension("GL_ARB_debug_output"))
278 {
279 OpenGLZone aZone;
280
281 if (glDebugMessageCallbackARBepoxy_glDebugMessageCallbackARB)
282 {
283 glEnableepoxy_glEnable(GL_DEBUG_OUTPUT_SYNCHRONOUS_ARB0x8242);
284 glDebugMessageCallbackARBepoxy_glDebugMessageCallbackARB(&debug_callback, nullptr);
285
286#ifdef GL_DEBUG_SEVERITY_NOTIFICATION_ARB
287 // Ignore i965’s shader compiler notification flood.
288 glDebugMessageControlARBepoxy_glDebugMessageControlARB(GL_DEBUG_SOURCE_SHADER_COMPILER_ARB0x8248, GL_DEBUG_TYPE_OTHER_ARB0x8251, GL_DEBUG_SEVERITY_NOTIFICATION_ARB, 0, nullptr, true);
289#endif
290 }
291 else if ( glDebugMessageCallbackepoxy_glDebugMessageCallback )
292 {
293 glEnableepoxy_glEnable(GL_DEBUG_OUTPUT0x92E0);
294 glDebugMessageCallbackepoxy_glDebugMessageCallback(&debug_callback, nullptr);
295
296 // Ignore i965’s shader compiler notification flood.
297 glDebugMessageControlepoxy_glDebugMessageControl(GL_DEBUG_SOURCE_SHADER_COMPILER0x8248, GL_DEBUG_TYPE_OTHER0x8251, GL_DEBUG_SEVERITY_NOTIFICATION0x826B, 0, nullptr, true);
298 }
299 }
300
301 // Test hooks for inserting tracing messages into the stream
302 VCL_GL_INFO("LibreOffice GLContext initialized")do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "LibreOffice GLContext initialized"
; OpenGLHelper::debugMsgStream(detail_stream); } } while (false
);
303#endif
304}
305
306void OpenGLContext::restoreDefaultFramebuffer()
307{
308 glBindFramebufferepoxy_glBindFramebuffer(GL_FRAMEBUFFER0x8D40, 0);
309}
310
311void OpenGLContext::setWinPosAndSize(const Point &rPos, const Size& rSize)
312{
313 if (m_xWindow)
314 m_xWindow->SetPosSizePixel(rPos, rSize);
315 if (m_pChildWindow)
316 m_pChildWindow->SetPosSizePixel(rPos, rSize);
317
318 GLWindow& rGLWin = getModifiableOpenGLWindow();
319 rGLWin.Width = rSize.Width();
320 rGLWin.Height = rSize.Height();
321 adjustToNewSize();
322}
323
324void OpenGLContext::adjustToNewSize()
325{
326 const GLWindow& rGLWin = getOpenGLWindow();
327 glViewportepoxy_glViewport(0, 0, rGLWin.Width, rGLWin.Height);
328}
329
330void OpenGLContext::InitChildWindow(SystemChildWindow *pChildWindow)
331{
332 pChildWindow->SetMouseTransparent(true);
333 pChildWindow->SetParentClipMode(ParentClipMode::Clip);
334 pChildWindow->EnableEraseBackground(false);
335 pChildWindow->SetControlForeground();
336 pChildWindow->SetControlBackground();
337}
338
339void OpenGLContext::initWindow()
340{
341}
342
343void OpenGLContext::destroyCurrentContext()
344{
345 //nothing by default
346}
347
348void OpenGLContext::reset()
349{
350 if( !mbInitialized )
351 return;
352
353 OpenGLZone aZone;
354
355 // reset the clip region
356 maClipRegion.SetEmpty();
357 mpRenderState.reset(new RenderState);
358
359 // destroy all framebuffers
360 if( mpLastFramebuffer )
361 {
362 OpenGLFramebuffer* pFramebuffer = mpLastFramebuffer;
363
364 makeCurrent();
365 while( pFramebuffer )
366 {
367 OpenGLFramebuffer* pPrevFramebuffer = pFramebuffer->mpPrevFramebuffer;
368 delete pFramebuffer;
369 pFramebuffer = pPrevFramebuffer;
370 }
371 mnFramebufferCount = 0;
372 mpFirstFramebuffer = nullptr;
373 mpLastFramebuffer = nullptr;
374 }
375
376 // destroy all programs
377 if( !maPrograms.empty() )
378 {
379 makeCurrent();
380 maPrograms.clear();
381 }
382
383 if( isCurrent() )
384 resetCurrent();
385
386 mbInitialized = false;
387
388 // destroy the context itself
389 destroyCurrentContext();
390}
391
392SystemWindowData OpenGLContext::generateWinData(vcl::Window* /*pParent*/, bool /*bRequestLegacyContext*/)
393{
394 return {};
395}
396
397bool OpenGLContext::isCurrent()
398{
399 (void) this; // loplugin:staticmethods
400 return false;
401}
402
403void OpenGLContext::makeCurrent()
404{
405 if (isCurrent())
406 return;
407
408 OpenGLZone aZone;
409
410 clearCurrent();
411
412 // by default nothing else to do
413
414 registerAsCurrent();
415}
416
417bool OpenGLContext::isAnyCurrent()
418{
419 return false;
420}
421
422bool OpenGLContext::hasCurrent()
423{
424 ImplSVData* pSVData = ImplGetSVData();
425 rtl::Reference<OpenGLContext> pCurrentCtx = pSVData->maGDIData.mpLastContext;
426 return pCurrentCtx.is() && pCurrentCtx->isAnyCurrent();
427}
428
429void OpenGLContext::clearCurrent()
430{
431 ImplSVData* pSVData = ImplGetSVData();
432
433 // release all framebuffers from the old context so we can re-attach the
434 // texture in the new context
435 rtl::Reference<OpenGLContext> pCurrentCtx = pSVData->maGDIData.mpLastContext;
436 if( pCurrentCtx.is() && pCurrentCtx->isCurrent() )
437 pCurrentCtx->ReleaseFramebuffers();
438}
439
440void OpenGLContext::prepareForYield()
441{
442 ImplSVData* pSVData = ImplGetSVData();
443
444 // release all framebuffers from the old context so we can re-attach the
445 // texture in the new context
446 rtl::Reference<OpenGLContext> pCurrentCtx = pSVData->maGDIData.mpLastContext;
447
448 if ( !pCurrentCtx.is() )
449 return; // Not using OpenGL
450
451 SAL_INFO("vcl.opengl", "Unbinding contexts in preparation for yield")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "vcl.opengl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "Unbinding contexts in preparation for yield"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "451" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Unbinding contexts in preparation for yield"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "Unbinding contexts in preparation for yield"; ::sal
::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.opengl"),
("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "451" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "Unbinding contexts in preparation for yield") ==
1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "451" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "Unbinding contexts in preparation for yield"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "Unbinding contexts in preparation for yield"; ::sal
::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("vcl.opengl"),
("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "451" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
452
453 // Find the first context that is current and reset it.
454 // Usually the last context is the current, but not in case a new
455 // OpenGLContext is created already but not yet initialized.
456 while (pCurrentCtx.is())
457 {
458 if (pCurrentCtx->isCurrent())
459 {
460 pCurrentCtx->resetCurrent();
461 break;
462 }
463
464 pCurrentCtx = pCurrentCtx->mpPrevContext;
465 }
466
467 assert (!hasCurrent())(static_cast <bool> (!hasCurrent()) ? void (0) : __assert_fail
("!hasCurrent()", "/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
, 467, __extension__ __PRETTY_FUNCTION__));
468}
469
470rtl::Reference<OpenGLContext> OpenGLContext::getVCLContext(bool bMakeIfNecessary)
471{
472 ImplSVData* pSVData = ImplGetSVData();
473 OpenGLContext *pContext = pSVData->maGDIData.mpLastContext;
474 while( pContext )
475 {
476 // check if this context is usable
477 if( pContext->isInitialized() && pContext->isVCLOnly() )
478 break;
479 pContext = pContext->mpPrevContext;
480 }
481 rtl::Reference<OpenGLContext> xContext;
482 vcl::Window* pDefWindow = !pContext && bMakeIfNecessary ? ImplGetDefaultWindow() : nullptr;
483 if (pDefWindow)
484 {
485 // create our magic fallback window context.
486#if HAVE_FEATURE_OPENGL1
487 xContext = pDefWindow->GetGraphics()->GetOpenGLContext();
488 assert(xContext.is())(static_cast <bool> (xContext.is()) ? void (0) : __assert_fail
("xContext.is()", "/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
, 488, __extension__ __PRETTY_FUNCTION__));
489#endif
490 }
491 else
492 xContext = pContext;
493
494 if( xContext.is() )
495 xContext->makeCurrent();
496
497 return xContext;
498}
499
500/*
501 * We don't care what context we have, but we want one that is live,
502 * ie. not reset underneath us, and is setup for VCL usage - ideally
503 * not swapping context at all.
504 */
505void OpenGLContext::makeVCLCurrent()
506{
507 getVCLContext();
508}
509
510void OpenGLContext::registerAsCurrent()
511{
512 ImplSVData* pSVData = ImplGetSVData();
513
514 // move the context to the end of the contexts list
515 static int nSwitch = 0;
516 VCL_GL_INFO("******* CONTEXT SWITCH " << ++nSwitch << " *********")do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "******* CONTEXT SWITCH "
<< ++nSwitch << " *********"; OpenGLHelper::debugMsgStream
(detail_stream); } } while (false);
517 if( mpNextContext )
518 {
519 if( mpPrevContext )
520 mpPrevContext->mpNextContext = mpNextContext;
521 mpNextContext->mpPrevContext = mpPrevContext;
522
523 mpPrevContext = pSVData->maGDIData.mpLastContext;
524 mpNextContext = nullptr;
525 pSVData->maGDIData.mpLastContext->mpNextContext = this;
526 pSVData->maGDIData.mpLastContext = this;
527 }
528
529 // sync the render state with the current context
530 mpRenderState->sync();
531}
532
533void OpenGLContext::resetCurrent()
534{
535 clearCurrent();
536 // by default nothing else to do
537}
538
539void OpenGLContext::swapBuffers()
540{
541 // by default nothing else to do
542 BuffersSwapped();
543}
544
545void OpenGLContext::BuffersSwapped()
546{
547 nBufferSwapCounter++;
548
549 static bool bSleep = getenv("SAL_GL_SLEEP_ON_SWAP");
550 if (bSleep)
551 {
552 // half a second.
553 osl::Thread::wait( std::chrono::milliseconds(500) );
554 }
555}
556
557
558sal_Int64 OpenGLWrapper::getBufferSwapCounter()
559{
560 return nBufferSwapCounter;
561}
562
563void OpenGLContext::sync()
564{
565 // default is nothing
566 (void) this; // loplugin:staticmethods
567}
568
569void OpenGLContext::show()
570{
571 if (m_pChildWindow)
572 m_pChildWindow->Show();
573 else if (m_xWindow)
574 m_xWindow->Show();
575}
576
577SystemChildWindow* OpenGLContext::getChildWindow()
578{
579 return m_pChildWindow;
580}
581
582const SystemChildWindow* OpenGLContext::getChildWindow() const
583{
584 return m_pChildWindow;
585}
586
587void OpenGLContext::BindFramebuffer( OpenGLFramebuffer* pFramebuffer )
588{
589 OpenGLZone aZone;
590
591 if( pFramebuffer != mpCurrentFramebuffer )
592 {
593 if( pFramebuffer )
594 pFramebuffer->Bind();
595 else
596 OpenGLFramebuffer::Unbind();
597 mpCurrentFramebuffer = pFramebuffer;
598 }
599}
600
601void OpenGLContext::AcquireDefaultFramebuffer()
602{
603 BindFramebuffer( nullptr );
604}
605
606OpenGLFramebuffer* OpenGLContext::AcquireFramebuffer( const OpenGLTexture& rTexture )
607{
608 OpenGLZone aZone;
609
610 OpenGLFramebuffer* pFramebuffer = nullptr;
611 OpenGLFramebuffer* pFreeFbo = nullptr;
612 OpenGLFramebuffer* pSameSizeFbo = nullptr;
613
614 // check if there is already a framebuffer attached to that texture
615 pFramebuffer = mpLastFramebuffer;
616 while( pFramebuffer )
617 {
618 if( pFramebuffer->IsAttached( rTexture ) )
619 break;
620 if( !pFreeFbo && pFramebuffer->IsFree() )
621 pFreeFbo = pFramebuffer;
622 if( !pSameSizeFbo &&
623 pFramebuffer->GetWidth() == rTexture.GetWidth() &&
624 pFramebuffer->GetHeight() == rTexture.GetHeight() )
625 pSameSizeFbo = pFramebuffer;
626 pFramebuffer = pFramebuffer->mpPrevFramebuffer;
627 }
628
629 // else use any framebuffer having the same size
630 if( !pFramebuffer && pSameSizeFbo )
631 pFramebuffer = pSameSizeFbo;
632
633 // else use the first free framebuffer
634 if( !pFramebuffer && pFreeFbo )
635 pFramebuffer = pFreeFbo;
636
637 // if there isn't any free one, create a new one if the limit isn't reached
638 if( !pFramebuffer && mnFramebufferCount < MAX_FRAMEBUFFER_COUNT30 )
639 {
640 mnFramebufferCount++;
641 pFramebuffer = new OpenGLFramebuffer();
642 if( mpLastFramebuffer )
643 {
644 pFramebuffer->mpPrevFramebuffer = mpLastFramebuffer;
645 mpLastFramebuffer = pFramebuffer;
646 }
647 else
648 {
649 mpFirstFramebuffer = pFramebuffer;
650 mpLastFramebuffer = pFramebuffer;
651 }
652 }
653
654 // last try, use any framebuffer
655 // TODO order the list of framebuffers as a LRU
656 if( !pFramebuffer )
657 pFramebuffer = mpFirstFramebuffer;
658
659 assert( pFramebuffer )(static_cast <bool> (pFramebuffer) ? void (0) : __assert_fail
("pFramebuffer", "/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
, 659, __extension__ __PRETTY_FUNCTION__));
660 BindFramebuffer( pFramebuffer );
661 pFramebuffer->AttachTexture( rTexture );
662
663 state().viewport(tools::Rectangle(Point(), Size(rTexture.GetWidth(), rTexture.GetHeight())));
664
665 return pFramebuffer;
666}
667
668// FIXME: this method is rather grim from a perf. perspective.
669// We should instead (eventually) use pointers to associate the
670// framebuffer and texture cleanly.
671void OpenGLContext::UnbindTextureFromFramebuffers( GLuint nTexture )
672{
673 OpenGLFramebuffer* pFramebuffer;
674
675 // see if there is a framebuffer attached to that texture
676 pFramebuffer = mpLastFramebuffer;
677 while( pFramebuffer )
678 {
679 if (pFramebuffer->IsAttached(nTexture))
680 {
681 BindFramebuffer(pFramebuffer);
682 pFramebuffer->DetachTexture();
683 }
684 pFramebuffer = pFramebuffer->mpPrevFramebuffer;
685 }
686
687 // Lets just check that no other context has a framebuffer
688 // with this texture - that would be bad ...
689 assert( !IsTextureAttachedAnywhere( nTexture ) )(static_cast <bool> (!IsTextureAttachedAnywhere( nTexture
)) ? void (0) : __assert_fail ("!IsTextureAttachedAnywhere( nTexture )"
, "/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
, 689, __extension__ __PRETTY_FUNCTION__));
690}
691
692/// Method for debugging; check texture is not already attached.
693bool OpenGLContext::IsTextureAttachedAnywhere( GLuint nTexture )
694{
695 ImplSVData* pSVData = ImplGetSVData();
696 for( auto *pCheck = pSVData->maGDIData.mpLastContext; pCheck;
697 pCheck = pCheck->mpPrevContext )
698 {
699 for( auto pBuffer = pCheck->mpLastFramebuffer; pBuffer;
700 pBuffer = pBuffer->mpPrevFramebuffer )
701 {
702 if( pBuffer->IsAttached( nTexture ) )
703 return true;
704 }
705 }
706 return false;
707}
708
709void OpenGLContext::ReleaseFramebuffer( OpenGLFramebuffer* pFramebuffer )
710{
711 if( pFramebuffer )
712 pFramebuffer->DetachTexture();
713}
714
715void OpenGLContext::ReleaseFramebuffer( const OpenGLTexture& rTexture )
716{
717 OpenGLZone aZone;
718
719 if (!rTexture) // no texture to release.
720 return;
721
722 OpenGLFramebuffer* pFramebuffer = mpLastFramebuffer;
723
724 while( pFramebuffer )
725 {
726 if( pFramebuffer->IsAttached( rTexture ) )
727 {
728 BindFramebuffer( pFramebuffer );
729 pFramebuffer->DetachTexture();
730 if (mpCurrentFramebuffer == pFramebuffer)
731 BindFramebuffer( nullptr );
732 }
733 pFramebuffer = pFramebuffer->mpPrevFramebuffer;
734 }
735}
736
737void OpenGLContext::ReleaseFramebuffers()
738{
739 OpenGLZone aZone;
740
741 OpenGLFramebuffer* pFramebuffer = mpLastFramebuffer;
742 while( pFramebuffer )
743 {
744 if (!pFramebuffer->IsFree())
745 {
746 BindFramebuffer( pFramebuffer );
747 pFramebuffer->DetachTexture();
748 }
749 pFramebuffer = pFramebuffer->mpPrevFramebuffer;
750 }
751 BindFramebuffer( nullptr );
752}
753
754OpenGLProgram* OpenGLContext::GetProgram( const OUString& rVertexShader, const OUString& rFragmentShader, const OString& preamble )
755{
756 OpenGLZone aZone;
757
758 // We cache the shader programs in a per-process run-time cache
759 // based on only the names and the preamble. We don't expect
760 // shader source files to change during the lifetime of a
761 // LibreOffice process.
762 OString aNameBasedKey = OUStringToOString(rVertexShader + "+" + rFragmentShader, RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76))) + "+" + preamble;
763 if( !aNameBasedKey.isEmpty() )
764 {
765 ProgramCollection::iterator it = maPrograms.find( aNameBasedKey );
766 if( it != maPrograms.end() )
767 return it->second.get();
768 }
769
770 // Binary shader programs are cached persistently (between
771 // LibreOffice process instances) based on a hash of their source
772 // code, as the source code can and will change between
773 // LibreOffice versions even if the shader names don't change.
774 OString aPersistentKey = OpenGLHelper::GetDigest( rVertexShader, rFragmentShader, preamble );
775 std::shared_ptr<OpenGLProgram> pProgram = std::make_shared<OpenGLProgram>();
776 if( !pProgram->Load( rVertexShader, rFragmentShader, preamble, aPersistentKey ) )
777 return nullptr;
778
779 maPrograms.insert(std::make_pair(aNameBasedKey, pProgram));
780 return pProgram.get();
781}
782
783OpenGLProgram* OpenGLContext::UseProgram( const OUString& rVertexShader, const OUString& rFragmentShader, const OString& preamble )
784{
785 OpenGLZone aZone;
786
787 OpenGLProgram* pProgram = GetProgram( rVertexShader, rFragmentShader, preamble );
788
789 if (pProgram && pProgram == mpCurrentProgram)
790 {
791 VCL_GL_INFO("Context::UseProgram: Reusing existing program " << pProgram->Id())do { if (true && OpenGLHelper::isVCLOpenGLEnabled()) {
::std::ostringstream detail_stream; detail_stream << "Context::UseProgram: Reusing existing program "
<< pProgram->Id(); OpenGLHelper::debugMsgStream(detail_stream
); } } while (false);
792 pProgram->Reuse();
793 return pProgram;
794 }
795
796 mpCurrentProgram = pProgram;
797
798 if (!mpCurrentProgram)
799 {
800 SAL_WARN("vcl.opengl", "OpenGLContext::UseProgram: mpCurrentProgram is 0")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "vcl.opengl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "OpenGLContext::UseProgram: mpCurrentProgram is 0"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "800" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "OpenGLContext::UseProgram: mpCurrentProgram is 0"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "OpenGLContext::UseProgram: mpCurrentProgram is 0";
::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "800" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "OpenGLContext::UseProgram: mpCurrentProgram is 0"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "800" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "OpenGLContext::UseProgram: mpCurrentProgram is 0"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "OpenGLContext::UseProgram: mpCurrentProgram is 0";
::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("vcl.opengl"
), ("/home/maarten/src/libreoffice/core/vcl/source/opengl/OpenGLContext.cxx"
":" "800" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
801 return nullptr;
802 }
803
804 mpCurrentProgram->Use();
805
806 return mpCurrentProgram;
807}
808
809/* 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);
2
←
Calling copy constructor for 'Reference<SystemChildWindow>'
→
5
←
Returning from copy constructor for 'Reference<SystemChildWindow>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
6
←
Calling 'Reference::clear'
→
13
←
Returning; memory was released
→
205 if (aTmp.get()) {
14
←
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)
3
←
Assuming field 'm_pBody' is non-null
→
4
←
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
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
)
7
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
8
←
Calling 'VclReferenceBase::release'
→
12
←
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;
15
←
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)
9
←
Assuming the condition is true
→
10
←
Taking true branch
→
40 delete this;
11
←
Memory is released
→
41 }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44 sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47
48
49private:
50 VclReferenceBase(const VclReferenceBase&) = delete;
51 VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52
53 bool mbDisposed : 1;
54
55protected:
56 VclReferenceBase();
57protected:
58 virtual ~VclReferenceBase();
59
60protected:
61 virtual void dispose();
62
63public:
64 void disposeOnce();
65 bool isDisposed() const { return mbDisposed; }
66
67};
68#endif