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 PresenterHelper.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 /usr/include/libxml2 -isystem /usr/include/dbus-1.0 -isystem /usr/lib64/dbus-1.0/include -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 SD_DLLIMPLEMENTATION -D SDUI_DLL_NAME="libsduilo.so" -D SYSTEM_LIBXML -D ENABLE_SDREMOTE -D ENABLE_SDREMOTE_BLUETOOTH -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -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/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/external/bluez_bluetooth/inc -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/sd/inc -I /home/maarten/src/libreoffice/core/sd/source/ui/inc -I /home/maarten/src/libreoffice/core/sd/source/ui/slidesorter/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sd/sdi -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/officecfg/registry -I /home/maarten/src/libreoffice/core/workdir/CustomTarget/oox/generated -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -I /usr/include/glib-2.0 -I /usr/lib64/glib-2.0/include -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/sd/source/ui/presenter/PresenterHelper.cxx

/home/maarten/src/libreoffice/core/sd/source/ui/presenter/PresenterHelper.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
22#include <cstddef>
23
24#include "PresenterHelper.hxx"
25#include "PresenterCanvas.hxx"
26#include <cppcanvas/vclfactory.hxx>
27#include <com/sun/star/awt/XWindowPeer.hpp>
28#include <com/sun/star/uno/XComponentContext.hpp>
29#include <toolkit/helper/vclunohelper.hxx>
30#include <vcl/window.hxx>
31#include <vcl/wrkwin.hxx>
32
33
34#include <bitmaps.hlst>
35
36using namespace ::com::sun::star;
37using namespace ::com::sun::star::uno;
38
39namespace sd::presenter {
40
41//===== PresenterHelper =======================================================
42
43PresenterHelper::PresenterHelper (
44 const Reference<XComponentContext>& rxContext)
45 : PresenterHelperInterfaceBase(m_aMutex),
46 mxComponentContext(rxContext)
47{
48}
49
50PresenterHelper::~PresenterHelper()
51{
52}
53
54//----- XInitialize -----------------------------------------------------------
55
56void SAL_CALL PresenterHelper::initialize (const Sequence<Any>&) {}
57
58//----- XPaneHelper ----------------------------------------------------
59
60Reference<awt::XWindow> SAL_CALL PresenterHelper::createWindow (
61 const Reference<awt::XWindow>& rxParentWindow,
62 sal_Bool bCreateSystemChildWindow,
63 sal_Bool bInitiallyVisible,
64 sal_Bool bEnableChildTransparentMode,
65 sal_Bool bEnableParentClip)
66{
67 VclPtr<vcl::Window> pParentWindow(VCLUnoHelper::GetWindow(rxParentWindow));
68
69 // Create a new window.
70 VclPtr<vcl::Window> pWindow;
71 if (bCreateSystemChildWindow)
1
Assuming 'bCreateSystemChildWindow' is not equal to 0
→
2
←
Taking true branch
→
72 {
73 pWindow = VclPtr<WorkWindow>::Create(pParentWindow, WB_SYSTEMCHILDWINDOW);
3
←
Calling 'VclPtr::Create'
→
5
←
Returned allocated memory
→
6
←
Calling implicit destructor for 'VclPtr<WorkWindow>'
→
7
←
Calling '~Reference'
→
14
←
Returning from '~Reference'
→
15
←
Returning from destructor for 'VclPtr<WorkWindow>'
→
74 }
75 else
76 {
77 pWindow = VclPtr<vcl::Window>::Create(pParentWindow);
78 }
79 Reference<awt::XWindow> xWindow (pWindow->GetComponentInterface(), UNO_QUERY);
16
←
Calling 'VclPtr::operator->'
→
80
81 if (bEnableChildTransparentMode)
82 {
83 // Make the frame window transparent and make the parent able to
84 // draw behind it.
85 if (pParentWindow)
86 pParentWindow->EnableChildTransparentMode();
87 }
88
89 pWindow->Show(bInitiallyVisible);
90
91 pWindow->SetMapMode(MapMode(MapUnit::MapPixel));
92 pWindow->SetBackground();
93 if ( ! bEnableParentClip)
94 {
95 pWindow->SetParentClipMode(ParentClipMode::NoClip);
96 pWindow->SetPaintTransparent(true);
97 }
98 else
99 {
100 pWindow->SetParentClipMode(ParentClipMode::Clip);
101 pWindow->SetPaintTransparent(false);
102 }
103
104 return xWindow;
105}
106
107Reference<rendering::XCanvas> SAL_CALL PresenterHelper::createSharedCanvas (
108 const Reference<rendering::XSpriteCanvas>& rxUpdateCanvas,
109 const Reference<awt::XWindow>& rxUpdateWindow,
110 const Reference<rendering::XCanvas>& rxSharedCanvas,
111 const Reference<awt::XWindow>& rxSharedWindow,
112 const Reference<awt::XWindow>& rxWindow)
113{
114 if ( ! rxSharedCanvas.is()
115 || ! rxSharedWindow.is()
116 || ! rxWindow.is())
117 {
118 throw RuntimeException("illegal argument", static_cast<XWeak*>(this));
119 }
120
121 if (rxWindow == rxSharedWindow)
122 return rxSharedCanvas;
123 else
124 return new PresenterCanvas(
125 rxUpdateCanvas,
126 rxUpdateWindow,
127 rxSharedCanvas,
128 rxSharedWindow,
129 rxWindow);
130}
131
132Reference<rendering::XCanvas> SAL_CALL PresenterHelper::createCanvas (
133 const Reference<awt::XWindow>& rxWindow,
134 sal_Int16,
135 const OUString& rsOptionalCanvasServiceName)
136{
137 // No shared window is given or an explicit canvas service name is
138 // specified. Create a new canvas.
139 VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow(rxWindow);
140 if (!pWindow)
141 throw RuntimeException();
142
143 Sequence<Any> aArg(4);
144
145 // common: first any is VCL pointer to window (for VCL canvas)
146 aArg[0] <<= reinterpret_cast<sal_Int64>(pWindow.get());
147 aArg[1] <<= css::awt::Rectangle();
148 aArg[2] <<= false;
149 aArg[3] <<= rxWindow;
150
151 Reference<lang::XMultiServiceFactory> xFactory (
152 mxComponentContext->getServiceManager(), UNO_QUERY_THROW);
153 return Reference<rendering::XCanvas>(
154 xFactory->createInstanceWithArguments(
155 !rsOptionalCanvasServiceName.isEmpty()
156 ? rsOptionalCanvasServiceName
157 : OUString("com.sun.star.rendering.Canvas.VCL"),
158 aArg),
159 UNO_QUERY);
160}
161
162void SAL_CALL PresenterHelper::toTop (
163 const Reference<awt::XWindow>& rxWindow)
164{
165 VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow(rxWindow);
166 if (pWindow)
167 {
168 pWindow->ToTop();
169 pWindow->SetZOrder(nullptr, ZOrderFlags::Last);
170 }
171}
172
173namespace {
174
175struct IdMapEntry {
176 char const * sid;
177 const char* bmpid;
178};
179
180}
181
182Reference<rendering::XBitmap> SAL_CALL PresenterHelper::loadBitmap (
183 const OUString& id,
184 const Reference<rendering::XCanvas>& rxCanvas)
185{
186 if ( ! rxCanvas.is())
187 return nullptr;
188
189 static IdMapEntry const map[] = {
190 { "bitmaps/Background.png", BMP_PRESENTERSCREEN_BACKGROUND"sd/res/presenterscreen-Background.png" },
191 { "bitmaps/Animation.png",
192 BMP_PRESENTERSCREEN_ANIMATION"sd/res/presenterscreen-Animation.png" },
193 { "bitmaps/Transition.png",
194 BMP_PRESENTERSCREEN_TRANSITION"sd/res/presenterscreen-Transition.png" },
195 { "bitmaps/BorderActiveBottom.png",
196 BMP_PRESENTERSCREEN_BORDER_ACTIVE_BOTTOM"sd/res/presenterscreen-BorderActiveBottom.png" },
197 { "bitmaps/BorderActiveBottomCallout.png",
198 BMP_PRESENTERSCREEN_BORDER_ACTIVE_BOTTOM_CALLOUT"sd/res/presenterscreen-BorderActiveBottomCallout.png" },
199 { "bitmaps/BorderActiveBottomLeft.png",
200 BMP_PRESENTERSCREEN_BORDER_ACTIVE_BOTTOM_LEFT"sd/res/presenterscreen-BorderActiveBottomLeft.png" },
201 { "bitmaps/BorderActiveBottomRight.png",
202 BMP_PRESENTERSCREEN_BORDER_ACTIVE_BOTTOM_RIGHT"sd/res/presenterscreen-BorderActiveBottomRight.png" },
203 { "bitmaps/BorderActiveLeft.png",
204 BMP_PRESENTERSCREEN_BORDER_ACTIVE_LEFT"sd/res/presenterscreen-BorderActiveLeft.png" },
205 { "bitmaps/BorderActiveRight.png",
206 BMP_PRESENTERSCREEN_BORDER_ACTIVE_RIGHT"sd/res/presenterscreen-BorderActiveRight.png" },
207 { "bitmaps/BorderActiveTop.png",
208 BMP_PRESENTERSCREEN_BORDER_ACTIVE_TOP"sd/res/presenterscreen-BorderActiveTop.png" },
209 { "bitmaps/BorderActiveTopLeft.png",
210 BMP_PRESENTERSCREEN_BORDER_ACTIVE_TOP_LEFT"sd/res/presenterscreen-BorderActiveTopLeft.png" },
211 { "bitmaps/BorderActiveTopRight.png",
212 BMP_PRESENTERSCREEN_BORDER_ACTIVE_TOP_RIGHT"sd/res/presenterscreen-BorderActiveTopRight.png" },
213 { "bitmaps/BorderBottom.png", BMP_PRESENTERSCREEN_BORDER_BOTTOM"sd/res/presenterscreen-BorderBottom.png" },
214 { "bitmaps/BorderBottomLeft.png",
215 BMP_PRESENTERSCREEN_BORDER_BOTTOM_LEFT"sd/res/presenterscreen-BorderBottomLeft.png" },
216 { "bitmaps/BorderBottomRight.png",
217 BMP_PRESENTERSCREEN_BORDER_BOTTOM_RIGHT"sd/res/presenterscreen-BorderBottomRight.png" },
218 { "bitmaps/BorderCurrentSlideBottom.png",
219 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_BOTTOM"sd/res/presenterscreen-BorderCurrentSlideBottom.png" },
220 { "bitmaps/BorderCurrentSlideBottomLeft.png",
221 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_BOTTOM_LEFT"sd/res/presenterscreen-BorderCurrentSlideBottomLeft.png" },
222 { "bitmaps/BorderCurrentSlideBottomRight.png",
223 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_BOTTOM_RIGHT"sd/res/presenterscreen-BorderCurrentSlideBottomRight.png" },
224 { "bitmaps/BorderCurrentSlideLeft.png",
225 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_LEFT"sd/res/presenterscreen-BorderCurrentSlideLeft.png" },
226 { "bitmaps/BorderCurrentSlideRight.png",
227 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_RIGHT"sd/res/presenterscreen-BorderCurrentSlideRight.png" },
228 { "bitmaps/BorderCurrentSlideTop.png",
229 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_TOP"sd/res/presenterscreen-BorderCurrentSlideTop.png" },
230 { "bitmaps/BorderCurrentSlideTopLeft.png",
231 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_TOP_LEFT"sd/res/presenterscreen-BorderCurrentSlideTopLeft.png" },
232 { "bitmaps/BorderCurrentSlideTopRight.png",
233 BMP_PRESENTERSCREEN_BORDER_CURRENT_SLIDE_TOP_RIGHT"sd/res/presenterscreen-BorderCurrentSlideTopRight.png" },
234 { "bitmaps/BorderLeft.png", BMP_PRESENTERSCREEN_BORDER_LEFT"sd/res/presenterscreen-BorderLeft.png" },
235 { "bitmaps/BorderRight.png", BMP_PRESENTERSCREEN_BORDER_RIGHT"sd/res/presenterscreen-BorderRight.png" },
236 { "bitmaps/BorderToolbarBottom.png",
237 BMP_PRESENTERSCREEN_BORDER_TOOLBAR_BOTTOM"sd/res/presenterscreen-BorderToolbarBottom.png" },
238 { "bitmaps/BorderToolbarLeft.png",
239 BMP_PRESENTERSCREEN_BORDER_TOOLBAR_LEFT"sd/res/presenterscreen-BorderToolbarLeft.png" },
240 { "bitmaps/BorderToolbarRight.png",
241 BMP_PRESENTERSCREEN_BORDER_TOOLBAR_RIGHT"sd/res/presenterscreen-BorderToolbarRight.png" },
242 { "bitmaps/BorderToolbarTop.png",
243 BMP_PRESENTERSCREEN_BORDER_TOOLBAR_TOP"sd/res/presenterscreen-BorderToolbarTop.png" },
244 { "bitmaps/BorderToolbarTopLeft.png",
245 BMP_PRESENTERSCREEN_BORDER_TOOLBAR_TOP_LEFT"sd/res/presenterscreen-BorderToolbarTopLeft.png" },
246 { "bitmaps/BorderToolbarTopRight.png",
247 BMP_PRESENTERSCREEN_BORDER_TOOLBAR_TOP_RIGHT"sd/res/presenterscreen-BorderToolbarTopRight.png" },
248 { "bitmaps/BorderTop.png", BMP_PRESENTERSCREEN_BORDER_TOP"sd/res/presenterscreen-BorderTop.png" },
249 { "bitmaps/BorderTopLeft.png", BMP_PRESENTERSCREEN_BORDER_TOP_LEFT"sd/res/presenterscreen-BorderTopLeft.png" },
250 { "bitmaps/BorderTopRight.png", BMP_PRESENTERSCREEN_BORDER_TOP_RIGHT"sd/res/presenterscreen-BorderTopRight.png" },
251 { "bitmaps/ButtonEffectNextDisabled.png",
252 BMP_PRESENTERSCREEN_BUTTON_EFFECT_NEXT_DISABLED"sd/res/presenterscreen-ButtonEffectNextDisabled.png" },
253 { "bitmaps/ButtonEffectNextMouseOver.png",
254 BMP_PRESENTERSCREEN_BUTTON_EFFECT_NEXT_MOUSE_OVER"sd/res/presenterscreen-ButtonEffectNextMouseOver.png" },
255 { "bitmaps/ButtonEffectNextNormal.png",
256 BMP_PRESENTERSCREEN_BUTTON_EFFECT_NEXT_NORMAL"sd/res/presenterscreen-ButtonEffectNextNormal.png" },
257 { "bitmaps/ButtonEffectNextSelected.png",
258 BMP_PRESENTERSCREEN_BUTTON_EFFECT_NEXT_SELECTED"sd/res/presenterscreen-ButtonEffectNextSelected.png" },
259 { "bitmaps/ButtonFrameCenterMouseOver.png",
260 BMP_PRESENTERSCREEN_BUTTON_FRAME_CENTER_MOUSE_OVER"sd/res/presenterscreen-ButtonFrameCenterMouseOver.png" },
261 { "bitmaps/ButtonFrameCenterNormal.png",
262 BMP_PRESENTERSCREEN_BUTTON_FRAME_CENTER_NORMAL"sd/res/presenterscreen-ButtonFrameCenterNormal.png" },
263 { "bitmaps/ButtonFrameLeftMouseOver.png",
264 BMP_PRESENTERSCREEN_BUTTON_FRAME_LEFT_MOUSE_OVER"sd/res/presenterscreen-ButtonFrameLeftMouseOver.png" },
265 { "bitmaps/ButtonFrameLeftNormal.png",
266 BMP_PRESENTERSCREEN_BUTTON_FRAME_LEFT_NORMAL"sd/res/presenterscreen-ButtonFrameLeftNormal.png" },
267 { "bitmaps/ButtonFrameRightMouseOver.png",
268 BMP_PRESENTERSCREEN_BUTTON_FRAME_RIGHT_MOUSE_OVER"sd/res/presenterscreen-ButtonFrameRightMouseOver.png" },
269 { "bitmaps/ButtonFrameRightNormal.png",
270 BMP_PRESENTERSCREEN_BUTTON_FRAME_RIGHT_NORMAL"sd/res/presenterscreen-ButtonFrameRightNormal.png" },
271 { "bitmaps/ButtonHelpDisabled.png",
272 BMP_PRESENTERSCREEN_BUTTON_HELP_DISABLED"sd/res/presenterscreen-ButtonHelpDisabled.png" },
273 { "bitmaps/ButtonHelpMouseOver.png",
274 BMP_PRESENTERSCREEN_BUTTON_HELP_MOUSE_OVER"sd/res/presenterscreen-ButtonHelpMouseOver.png" },
275 { "bitmaps/ButtonHelpNormal.png",
276 BMP_PRESENTERSCREEN_BUTTON_HELP_NORMAL"sd/res/presenterscreen-ButtonHelpNormal.png" },
277 { "bitmaps/ButtonHelpSelected.png",
278 BMP_PRESENTERSCREEN_BUTTON_HELP_SELECTED"sd/res/presenterscreen-ButtonHelpSelected.png" },
279 { "bitmaps/ButtonExitPresenterMouseOver.png",
280 BMP_PRESENTERSCREEN_BUTTON_EXIT_PRESENTER_MOUSE_OVER"sd/res/presenterscreen-ButtonExitPresenterMouseOver.png" },
281 { "bitmaps/ButtonExitPresenterNormal.png",
282 BMP_PRESENTERSCREEN_BUTTON_EXIT_PRESENTER_NORMAL"sd/res/presenterscreen-ButtonExitPresenterNormal.png" },
283 { "bitmaps/ButtonMinusDisabled.png",
284 BMP_PRESENTERSCREEN_BUTTON_MINUS_DISABLED"sd/res/presenterscreen-ButtonMinusDisabled.png" },
285 { "bitmaps/ButtonMinusMouseOver.png",
286 BMP_PRESENTERSCREEN_BUTTON_MINUS_MOUSE_OVER"sd/res/presenterscreen-ButtonMinusMouseOver.png" },
287 { "bitmaps/ButtonMinusNormal.png",
288 BMP_PRESENTERSCREEN_BUTTON_MINUS_NORMAL"sd/res/presenterscreen-ButtonMinusNormal.png" },
289 { "bitmaps/ButtonMinusSelected.png",
290 BMP_PRESENTERSCREEN_BUTTON_MINUS_SELECTED"sd/res/presenterscreen-ButtonMinusSelected.png" },
291 { "bitmaps/ButtonNotesDisabled.png",
292 BMP_PRESENTERSCREEN_BUTTON_NOTES_DISABLED"sd/res/presenterscreen-ButtonNotesDisabled.png" },
293 { "bitmaps/ButtonNotesMouseOver.png",
294 BMP_PRESENTERSCREEN_BUTTON_NOTES_MOUSE_OVER"sd/res/presenterscreen-ButtonNotesMouseOver.png" },
295 { "bitmaps/ButtonNotesNormal.png",
296 BMP_PRESENTERSCREEN_BUTTON_NOTES_NORMAL"sd/res/presenterscreen-ButtonNotesNormal.png" },
297 { "bitmaps/ButtonNotesSelected.png",
298 BMP_PRESENTERSCREEN_BUTTON_NOTES_SELECTED"sd/res/presenterscreen-ButtonNotesSelected.png" },
299 { "bitmaps/ButtonPlusDisabled.png",
300 BMP_PRESENTERSCREEN_BUTTON_PLUS_DISABLED"sd/res/presenterscreen-ButtonPlusDisabled.png" },
301 { "bitmaps/ButtonPlusMouseOver.png",
302 BMP_PRESENTERSCREEN_BUTTON_PLUS_MOUSE_OVER"sd/res/presenterscreen-ButtonPlusMouseOver.png" },
303 { "bitmaps/ButtonPlusNormal.png",
304 BMP_PRESENTERSCREEN_BUTTON_PLUS_NORMAL"sd/res/presenterscreen-ButtonPlusNormal.png" },
305 { "bitmaps/ButtonPlusSelected.png",
306 BMP_PRESENTERSCREEN_BUTTON_PLUS_SELECTED"sd/res/presenterscreen-ButtonPlusSelected.png" },
307 { "bitmaps/ButtonSlideNextDisabled.png",
308 BMP_PRESENTERSCREEN_BUTTON_SLIDE_NEXT_DISABLED"sd/res/presenterscreen-ButtonSlideNextDisabled.png" },
309 { "bitmaps/ButtonSlideNextMouseOver.png",
310 BMP_PRESENTERSCREEN_BUTTON_SLIDE_NEXT_MOUSE_OVER"sd/res/presenterscreen-ButtonSlideNextMouseOver.png" },
311 { "bitmaps/ButtonSlideNextNormal.png",
312 BMP_PRESENTERSCREEN_BUTTON_SLIDE_NEXT_NORMAL"sd/res/presenterscreen-ButtonSlideNextNormal.png" },
313 { "bitmaps/ButtonSlidePreviousDisabled.png",
314 BMP_PRESENTERSCREEN_BUTTON_SLIDE_PREVIOUS_DISABLED"sd/res/presenterscreen-ButtonSlidePreviousDisabled.png" },
315 { "bitmaps/ButtonSlidePreviousMouseOver.png",
316 BMP_PRESENTERSCREEN_BUTTON_SLIDE_PREVIOUS_MOUSE_OVER"sd/res/presenterscreen-ButtonSlidePreviousMouseOver.png" },
317 { "bitmaps/ButtonSlidePreviousNormal.png",
318 BMP_PRESENTERSCREEN_BUTTON_SLIDE_PREVIOUS_NORMAL"sd/res/presenterscreen-ButtonSlidePreviousNormal.png" },
319 { "bitmaps/ButtonSlidePreviousSelected.png",
320 BMP_PRESENTERSCREEN_BUTTON_SLIDE_PREVIOUS_SELECTED"sd/res/presenterscreen-ButtonSlidePreviousSelected.png" },
321 { "bitmaps/ButtonSlideSorterDisabled.png",
322 BMP_PRESENTERSCREEN_BUTTON_SLIDE_SORTER_DISABLED"sd/res/presenterscreen-ButtonSlideSorterDisabled.png" },
323 { "bitmaps/ButtonSlideSorterMouseOver.png",
324 BMP_PRESENTERSCREEN_BUTTON_SLIDE_SORTER_MOUSE_OVER"sd/res/presenterscreen-ButtonSlideSorterMouseOver.png" },
325 { "bitmaps/ButtonSlideSorterNormal.png",
326 BMP_PRESENTERSCREEN_BUTTON_SLIDE_SORTER_NORMAL"sd/res/presenterscreen-ButtonSlideSorterNormal.png" },
327 { "bitmaps/ButtonSlideSorterSelected.png",
328 BMP_PRESENTERSCREEN_BUTTON_SLIDE_SORTER_SELECTED"sd/res/presenterscreen-ButtonSlideSorterSelected.png" },
329 { "bitmaps/ButtonSwitchMonitorMouseOver.png",
330 BMP_PRESENTERSCREEN_BUTTON_SWITCH_MONITOR_MOUSE_OVER"sd/res/presenterscreen-ButtonSwitchMonitorMouseOver.png" },
331 { "bitmaps/ButtonSwitchMonitorNormal.png",
332 BMP_PRESENTERSCREEN_BUTTON_SWITCH_MONITOR_NORMAL"sd/res/presenterscreen-ButtonSwitchMonitorNormal.png" },
333 { "bitmaps/ButtonRestartTimerMouseOver.png",
334 BMP_PRESENTERSCREEN_BUTTON_RESTART_TIMER_MOUSE_OVER"sd/res/presenterscreen-ButtonRestartTimerMouseOver.png" },
335 { "bitmaps/ButtonRestartTimerNormal.png",
336 BMP_PRESENTERSCREEN_BUTTON_RESTART_TIMER_NORMAL"sd/res/presenterscreen-ButtonRestartTimerNormal.png" },
337 { "bitmaps/ButtonPauseTimerMouseOver.png",
338 BMP_PRESENTERSCREEN_BUTTON_PAUSE_TIMER_MOUSE_OVER"sd/res/presenterscreen-ButtonPauseTimerMouseOver.png" },
339 { "bitmaps/ButtonPauseTimerNormal.png",
340 BMP_PRESENTERSCREEN_BUTTON_PAUSE_TIMER_NORMAL"sd/res/presenterscreen-ButtonPauseTimerNormal.png" },
341 { "bitmaps/ButtonResumeTimerMouseOver.png",
342 BMP_PRESENTERSCREEN_BUTTON_RESUME_TIMER_MOUSE_OVER"sd/res/presenterscreen-ButtonResumeTimerMouseOver.png" },
343 { "bitmaps/ButtonResumeTimerNormal.png",
344 BMP_PRESENTERSCREEN_BUTTON_RESUME_TIMER_NORMAL"sd/res/presenterscreen-ButtonResumeTimerNormal.png" },
345 { "bitmaps/LabelMouseOverCenter.png",
346 BMP_PRESENTERSCREEN_LABEL_MOUSE_OVER_CENTER"sd/res/presenterscreen-LabelMouseOverCenter.png" },
347 { "bitmaps/LabelMouseOverLeft.png",
348 BMP_PRESENTERSCREEN_LABEL_MOUSE_OVER_LEFT"sd/res/presenterscreen-LabelMouseOverLeft.png" },
349 { "bitmaps/LabelMouseOverRight.png",
350 BMP_PRESENTERSCREEN_LABEL_MOUSE_OVER_RIGHT"sd/res/presenterscreen-LabelMouseOverRight.png" },
351 { "bitmaps/ScrollbarArrowDownDisabled.png",
352 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_DOWN_DISABLED"sd/res/presenterscreen-ScrollbarArrowDownDisabled.png" },
353 { "bitmaps/ScrollbarArrowDownMouseOver.png",
354 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_DOWN_MOUSE_OVER"sd/res/presenterscreen-ScrollbarArrowDownMouseOver.png" },
355 { "bitmaps/ScrollbarArrowDownNormal.png",
356 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_DOWN_NORMAL"sd/res/presenterscreen-ScrollbarArrowDownNormal.png" },
357 { "bitmaps/ScrollbarArrowDownSelected.png",
358 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_DOWN_SELECTED"sd/res/presenterscreen-ScrollbarArrowDownSelected.png" },
359 { "bitmaps/ScrollbarArrowUpDisabled.png",
360 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_UP_DISABLED"sd/res/presenterscreen-ScrollbarArrowUpDisabled.png" },
361 { "bitmaps/ScrollbarArrowUpMouseOver.png",
362 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_UP_MOUSE_OVER"sd/res/presenterscreen-ScrollbarArrowUpMouseOver.png" },
363 { "bitmaps/ScrollbarArrowUpNormal.png",
364 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_UP_NORMAL"sd/res/presenterscreen-ScrollbarArrowUpNormal.png" },
365 { "bitmaps/ScrollbarArrowUpSelected.png",
366 BMP_PRESENTERSCREEN_SCROLLBAR_ARROW_UP_SELECTED"sd/res/presenterscreen-ScrollbarArrowUpSelected.png" },
367 { "bitmaps/ScrollbarPagerMiddleMouseOver.png",
368 BMP_PRESENTERSCREEN_SCROLLBAR_PAGER_MIDDLE_MOUSE_OVER"sd/res/presenterscreen-ScrollbarPagerMiddleMouseOver.png" },
369 { "bitmaps/ScrollbarPagerMiddleNormal.png",
370 BMP_PRESENTERSCREEN_SCROLLBAR_PAGER_MIDDLE_NORMAL"sd/res/presenterscreen-ScrollbarPagerMiddleNormal.png" },
371 { "bitmaps/ScrollbarThumbBottomMouseOver.png",
372 BMP_PRESENTERSCREEN_SCROLLBAR_THUMB_BOTTOM_MOUSE_OVER"sd/res/presenterscreen-ScrollbarThumbBottomMouseOver.png" },
373 { "bitmaps/ScrollbarThumbBottomNormal.png",
374 BMP_PRESENTERSCREEN_SCROLLBAR_THUMB_BOTTOM_NORMAL"sd/res/presenterscreen-ScrollbarThumbBottomNormal.png" },
375 { "bitmaps/ScrollbarThumbMiddleMouseOver.png",
376 BMP_PRESENTERSCREEN_SCROLLBAR_THUMB_MIDDLE_MOUSE_OVER"sd/res/presenterscreen-ScrollbarThumbMiddleMouseOver.png" },
377 { "bitmaps/ScrollbarThumbMiddleNormal.png",
378 BMP_PRESENTERSCREEN_SCROLLBAR_THUMB_MIDDLE_NORMAL"sd/res/presenterscreen-ScrollbarThumbMiddleNormal.png" },
379 { "bitmaps/ScrollbarThumbTopMouseOver.png",
380 BMP_PRESENTERSCREEN_SCROLLBAR_THUMB_TOP_MOUSE_OVER"sd/res/presenterscreen-ScrollbarThumbTopMouseOver.png" },
381 { "bitmaps/ScrollbarThumbTopNormal.png",
382 BMP_PRESENTERSCREEN_SCROLLBAR_THUMB_TOP_NORMAL"sd/res/presenterscreen-ScrollbarThumbTopNormal.png" },
383 { "bitmaps/ViewBackground.png", BMP_PRESENTERSCREEN_VIEW_BACKGROUND"sd/res/presenterscreen-ViewBackground.png" },
384 { "bitmaps/Separator.png",
385 BMP_PRESENTERSCREEN_SEPARATOR"sd/res/presenterscreen-Separator.png" }
386 };
387 OUString bmpid;
388 for (std::size_t i = 0; i != SAL_N_ELEMENTS(map)(sizeof(sal_n_array_size(map))); ++i) {
389 if (id.equalsAscii(map[i].sid)) {
390 bmpid = OUString::createFromAscii(map[i].bmpid);
391 break;
392 }
393 }
394 if (bmpid.isEmpty()) {
395 return nullptr;
396 }
397
398 ::osl::MutexGuard aGuard (::osl::Mutex::getGlobalMutex());
399
400 const cppcanvas::CanvasSharedPtr pCanvas (
401 cppcanvas::VCLFactory::createCanvas(rxCanvas));
402
403 if (pCanvas)
404 {
405 BitmapEx aBitmapEx(bmpid);
406 cppcanvas::BitmapSharedPtr xBitmap(
407 cppcanvas::VCLFactory::createBitmap(pCanvas,
408 aBitmapEx));
409 if (!xBitmap)
410 return nullptr;
411 return xBitmap->getUNOBitmap();
412 }
413
414 return nullptr;
415}
416
417void SAL_CALL PresenterHelper::captureMouse (
418 const Reference<awt::XWindow>& rxWindow)
419{
420 ::osl::MutexGuard aGuard (::osl::Mutex::getGlobalMutex());
421
422 // Capture the mouse (if not already done.)
423 VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow(rxWindow);
424 if (pWindow && ! pWindow->IsMouseCaptured())
425 {
426 pWindow->CaptureMouse();
427 }
428}
429
430void SAL_CALL PresenterHelper::releaseMouse (const Reference<awt::XWindow>& rxWindow)
431{
432 ::osl::MutexGuard aGuard (::osl::Mutex::getGlobalMutex());
433
434 // Release the mouse (if not already done.)
435 VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow(rxWindow);
436 if (pWindow && pWindow->IsMouseCaptured())
437 {
438 pWindow->ReleaseMouse();
439 }
440}
441
442awt::Rectangle PresenterHelper::getWindowExtentsRelative (
443 const Reference<awt::XWindow>& rxChildWindow,
444 const Reference<awt::XWindow>& rxParentWindow)
445{
446 VclPtr<vcl::Window> pChildWindow = VCLUnoHelper::GetWindow(rxChildWindow);
447 VclPtr<vcl::Window> pParentWindow = VCLUnoHelper::GetWindow(rxParentWindow);
448 if (pChildWindow && pParentWindow)
449 {
450 ::tools::Rectangle aBox (pChildWindow->GetWindowExtentsRelative(pParentWindow));
451 return awt::Rectangle(aBox.Left(),aBox.Top(),aBox.GetWidth(),aBox.GetHeight());
452 }
453 else
454 return awt::Rectangle();
455}
456
457} // end of namespace ::sd::presenter
458
459
460extern "C" SAL_DLLPUBLIC_EXPORT__attribute__ ((visibility("default"))) css::uno::XInterface*
461com_sun_star_comp_Draw_PresenterHelper_get_implementation(css::uno::XComponentContext* context,
462 css::uno::Sequence<css::uno::Any> const &)
463{
464 return cppu::acquire(new sd::presenter::PresenterHelper(context));
465}
466
467
468/* 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 );
4
←
Memory is allocated
→
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
17
←
Calling 'Reference::get'
→
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__)); // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
←

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

→
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
7.1
Field 'm_pBody' is non-null
)
8
←
Taking true branch
→
113 m_pBody->release();
9
←
Calling 'VclReferenceBase::release'
→
13
←
Returning; memory was released
→
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)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
18
←
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)
10
←
Assuming the condition is true
→
11
←
Taking true branch
→
40 delete this;
12
←
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