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

/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.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 <config_features.h>
21
22#include <tools/diagnose_ex.h>
23
24#include <sal/log.hxx>
25#include <vcl/canvastools.hxx>
26#include <vcl/syschild.hxx>
27#include <vcl/window.hxx>
28#include <vcl/graph.hxx>
29
30#include <basegfx/utils/canvastools.hxx>
31#include <basegfx/matrix/b2dhommatrixtools.hxx>
32#include <basegfx/point/b2dpoint.hxx>
33#include <basegfx/matrix/b2dhommatrix.hxx>
34#include <basegfx/range/b2irange.hxx>
35#include <canvas/canvastools.hxx>
36#include <cppcanvas/canvas.hxx>
37#include <avmedia/mediawindow.hxx>
38
39#include <com/sun/star/awt/XWindow.hpp>
40#include <com/sun/star/beans/XPropertySet.hpp>
41#include <com/sun/star/lang/XComponent.hpp>
42#include <com/sun/star/lang/NoSupportException.hpp>
43#include <com/sun/star/media/XPlayer.hpp>
44#include <com/sun/star/media/XPlayerWindow.hpp>
45#include <com/sun/star/presentation/XSlideShowView.hpp>
46#include <com/sun/star/rendering/XCanvas.hpp>
47
48#include "viewmediashape.hxx"
49#include <tools.hxx>
50#include <unoview.hxx>
51
52using namespace ::com::sun::star;
53
54namespace slideshow::internal
55{
56 ViewMediaShape::ViewMediaShape( const ViewLayerSharedPtr& rViewLayer,
57 const uno::Reference< drawing::XShape >& rxShape,
58 const uno::Reference< uno::XComponentContext >& rxContext ) :
59 mpViewLayer( rViewLayer ),
60 maWindowOffset( 0, 0 ),
61 maBounds(),
62 mxShape( rxShape ),
63 mxPlayer(),
64 mxPlayerWindow(),
65 mxComponentContext( rxContext ),
66 mbIsSoundEnabled(true)
67 {
68 ENSURE_OR_THROW( mxShape.is(), "ViewMediaShape::ViewMediaShape(): Invalid Shape" )if( !(mxShape.is()) ){ do { if (true && (!(mxShape.is
()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "68" ": "), "%s", "ViewMediaShape::ViewMediaShape(): Invalid Shape"
); } } while (false); throw css::uno::RuntimeException( __func__
+ OUStringLiteral(u",\n" "ViewMediaShape::ViewMediaShape(): Invalid Shape"
), css::uno::Reference< css::uno::XInterface >() ); }
;
69 ENSURE_OR_THROW( mpViewLayer, "ViewMediaShape::ViewMediaShape(): Invalid View" )if( !(mpViewLayer) ){ do { if (true && (!(mpViewLayer
))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"
), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "69" ": "), "%s", "ViewMediaShape::ViewMediaShape(): Invalid View"
); } } while (false); throw css::uno::RuntimeException( __func__
+ OUStringLiteral(u",\n" "ViewMediaShape::ViewMediaShape(): Invalid View"
), css::uno::Reference< css::uno::XInterface >() ); }
;
70 ENSURE_OR_THROW( mpViewLayer->getCanvas(), "ViewMediaShape::ViewMediaShape(): Invalid ViewLayer canvas" )if( !(mpViewLayer->getCanvas()) ){ do { if (true &&
(!(mpViewLayer->getCanvas()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "70" ": "), "%s", "ViewMediaShape::ViewMediaShape(): Invalid ViewLayer canvas"
); } } while (false); throw css::uno::RuntimeException( __func__
+ OUStringLiteral(u",\n" "ViewMediaShape::ViewMediaShape(): Invalid ViewLayer canvas"
), css::uno::Reference< css::uno::XInterface >() ); }
;
71 ENSURE_OR_THROW( mxComponentContext.is(), "ViewMediaShape::ViewMediaShape(): Invalid component context" )if( !(mxComponentContext.is()) ){ do { if (true && (!
(mxComponentContext.is()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "71" ": "), "%s", "ViewMediaShape::ViewMediaShape(): Invalid component context"
); } } while (false); throw css::uno::RuntimeException( __func__
+ OUStringLiteral(u",\n" "ViewMediaShape::ViewMediaShape(): Invalid component context"
), css::uno::Reference< css::uno::XInterface >() ); }
;
72
73 UnoViewSharedPtr xUnoView(std::dynamic_pointer_cast<UnoView>(rViewLayer));
74 if (xUnoView)
75 {
76 mbIsSoundEnabled = xUnoView->isSoundEnabled();
77 }
78 }
79
80 ViewMediaShape::~ViewMediaShape()
81 {
82 try
83 {
84 endMedia();
1
Calling 'ViewMediaShape::endMedia'
85 }
86 catch (const uno::Exception &)
87 {
88 TOOLS_WARN_EXCEPTION("slideshow", "")do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "slideshow")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "" << " " <<
exceptionToString(tools_warn_exception)) == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "88" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "88" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "" << " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "88" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "88" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false)
;
89 }
90 }
91
92 const ViewLayerSharedPtr& ViewMediaShape::getViewLayer() const
93 {
94 return mpViewLayer;
95 }
96
97 void ViewMediaShape::startMedia()
98 {
99 if( !mxPlayer.is() )
100 implInitialize( maBounds );
101
102 if (mxPlayer.is())
103 mxPlayer->start();
104 }
105
106 void ViewMediaShape::endMedia()
107 {
108 // shutdown player window
109 if( mxPlayerWindow.is() )
2
Taking false branch
110 {
111 mxPlayerWindow->dispose();
112 mxPlayerWindow.clear();
113 }
114
115 mpMediaWindow.disposeAndClear();
3
Calling 'VclPtr::disposeAndClear'
116
117 // shutdown player
118 if( mxPlayer.is() )
119 {
120 mxPlayer->stop();
121
122 uno::Reference< lang::XComponent > xComponent( mxPlayer, uno::UNO_QUERY );
123
124 if( xComponent.is() )
125 xComponent->dispose();
126
127 mxPlayer.clear();
128 }
129 }
130
131 void ViewMediaShape::pauseMedia()
132 {
133 if (mxPlayer.is())
134 mxPlayer->stop();
135 }
136
137 void ViewMediaShape::setMediaTime(double fTime)
138 {
139 if (mxPlayer.is())
140 mxPlayer->setMediaTime(fTime);
141 }
142
143 bool ViewMediaShape::render( const ::basegfx::B2DRectangle& rBounds ) const
144 {
145#if !HAVE_FEATURE_AVMEDIA1
146 (void) rBounds;
147#else
148 ::cppcanvas::CanvasSharedPtr pCanvas = mpViewLayer->getCanvas();
149
150 if( !pCanvas )
151 return false;
152
153 if( !mpMediaWindow && !mxPlayerWindow.is() )
154 {
155 uno::Reference< graphic::XGraphic > xGraphic;
156 uno::Reference< beans::XPropertySet > xPropSet( mxShape, uno::UNO_QUERY );
157 if (xPropSet.is())
158 {
159 xPropSet->getPropertyValue("FallbackGraphic") >>= xGraphic;
160 }
161
162 Graphic aGraphic(xGraphic);
163 const BitmapEx aBmp = aGraphic.GetBitmapEx();
164
165 uno::Reference< rendering::XBitmap > xBitmap(vcl::unotools::xBitmapFromBitmapEx(aBmp));
166
167 rendering::ViewState aViewState;
168 aViewState.AffineTransform = pCanvas->getViewState().AffineTransform;
169
170 rendering::RenderState aRenderState;
171 ::canvas::tools::initRenderState( aRenderState );
172
173 const ::Size aBmpSize( aBmp.GetSizePixel() );
174
175 const ::basegfx::B2DVector aScale( rBounds.getWidth() / aBmpSize.Width(),
176 rBounds.getHeight() / aBmpSize.Height() );
177 const basegfx::B2DHomMatrix aTranslation(basegfx::utils::createScaleTranslateB2DHomMatrix(
178 aScale, rBounds.getMinimum()));
179 ::canvas::tools::setRenderStateTransform( aRenderState, aTranslation );
180
181 pCanvas->getUNOCanvas()->drawBitmap( xBitmap,
182 aViewState,
183 aRenderState );
184 }
185#endif
186 return true;
187 }
188
189 bool ViewMediaShape::resize( const ::basegfx::B2DRectangle& rNewBounds ) const
190 {
191 maBounds = rNewBounds;
192
193 ::cppcanvas::CanvasSharedPtr pCanvas = mpViewLayer->getCanvas();
194
195 if( !pCanvas )
196 return false;
197
198 if( !mxPlayerWindow.is() )
199 return true;
200
201 uno::Reference< beans::XPropertySet > xPropSet( pCanvas->getUNOCanvas()->getDevice(),
202 uno::UNO_QUERY );
203
204 uno::Reference< awt::XWindow > xParentWindow;
205 if( xPropSet.is() &&
206 getPropertyValue( xParentWindow,
207 xPropSet,
208 "Window") )
209 {
210 const awt::Rectangle aRect( xParentWindow->getPosSize() );
211
212 maWindowOffset.X = aRect.X;
213 maWindowOffset.Y = aRect.Y;
214 }
215
216 ::basegfx::B2DRange aTmpRange;
217 ::canvas::tools::calcTransformedRectBounds( aTmpRange,
218 rNewBounds,
219 mpViewLayer->getTransformation() );
220 const ::basegfx::B2IRange& rRangePix(
221 ::basegfx::unotools::b2ISurroundingRangeFromB2DRange( aTmpRange ));
222
223 mxPlayerWindow->setEnable( !rRangePix.isEmpty() );
224
225 if( rRangePix.isEmpty() )
226 return true;
227
228 awt::Rectangle aCanvasArea;
229 UnoViewSharedPtr xUnoView(std::dynamic_pointer_cast<UnoView>(mpViewLayer));
230 if (xUnoView)
231 aCanvasArea = xUnoView->getUnoView()->getCanvasArea();
232
233 const Point aPosPixel( rRangePix.getMinX() + maWindowOffset.X + aCanvasArea.X,
234 rRangePix.getMinY() + maWindowOffset.Y + aCanvasArea.Y );
235 const Size aSizePixel( rRangePix.getMaxX() - rRangePix.getMinX(),
236 rRangePix.getMaxY() - rRangePix.getMinY() );
237
238 if( mpMediaWindow )
239 {
240 mpMediaWindow->SetPosSizePixel( aPosPixel, aSizePixel );
241 mxPlayerWindow->setPosSize( 0, 0,
242 aSizePixel.Width(), aSizePixel.Height(),
243 0 );
244 }
245 else
246 {
247 mxPlayerWindow->setPosSize( aPosPixel.X(), aPosPixel.Y(),
248 aSizePixel.Width(), aSizePixel.Height(),
249 0 );
250 }
251
252 return true;
253 }
254
255
256 bool ViewMediaShape::implInitialize( const ::basegfx::B2DRectangle& rBounds )
257 {
258 if( !mxPlayer.is() && mxShape.is() )
259 {
260 ENSURE_OR_RETURN_FALSE( mpViewLayer->getCanvas(),if( !(mpViewLayer->getCanvas()) ) { do { if (true &&
(!(mpViewLayer->getCanvas()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "261" ": "), "%s", "ViewMediaShape::implInitialize(): Invalid layer canvas"
); } } while (false); return false; }
261 "ViewMediaShape::implInitialize(): Invalid layer canvas" )if( !(mpViewLayer->getCanvas()) ) { do { if (true &&
(!(mpViewLayer->getCanvas()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "261" ": "), "%s", "ViewMediaShape::implInitialize(): Invalid layer canvas"
); } } while (false); return false; }
;
262
263 uno::Reference< rendering::XCanvas > xCanvas( mpViewLayer->getCanvas()->getUNOCanvas() );
264
265 if( xCanvas.is() )
266 {
267 uno::Reference< beans::XPropertySet > xPropSet;
268 try
269 {
270 xPropSet.set( mxShape, uno::UNO_QUERY );
271 OUString sMimeType;
272
273 // create Player
274 if (xPropSet.is())
275 {
276 OUString aURL;
277 xPropSet->getPropertyValue("MediaMimeType") >>= sMimeType;
278 if ((xPropSet->getPropertyValue("PrivateTempFileURL") >>= aURL)
279 && !aURL.isEmpty())
280 {
281 implInitializeMediaPlayer( aURL, sMimeType );
282 }
283 else if (xPropSet->getPropertyValue("MediaURL") >>= aURL)
284 {
285 implInitializeMediaPlayer( aURL, sMimeType );
286 }
287 }
288
289 // create visible object
290 uno::Sequence< uno::Any > aDeviceParams;
291
292 if( ::canvas::tools::getDeviceInfo( xCanvas, aDeviceParams ).getLength() > 1 )
293 {
294 implInitializePlayerWindow( rBounds, aDeviceParams, sMimeType );
295 }
296
297 // set player properties
298 implSetMediaProperties( xPropSet );
299 }
300 catch( uno::RuntimeException& )
301 {
302 throw;
303 }
304 catch( uno::Exception& )
305 {
306 TOOLS_WARN_EXCEPTION( "slideshow", "" )do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "slideshow")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "" << " " <<
exceptionToString(tools_warn_exception)) == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "306" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "306" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "" << " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "306" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "306" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false)
;
307 }
308 }
309 }
310
311 return mxPlayer.is() || mxPlayerWindow.is();
312 }
313
314
315 void ViewMediaShape::implSetMediaProperties( const uno::Reference< beans::XPropertySet >& rxProps )
316 {
317 if( !mxPlayer.is() )
318 return;
319
320 mxPlayer->setMediaTime( 0.0 );
321
322 if( !rxProps.is() )
323 return;
324
325 bool bLoop( false );
326 getPropertyValue( bLoop,
327 rxProps,
328 "Loop");
329 mxPlayer->setPlaybackLoop( bLoop );
330
331 bool bMute( false );
332 getPropertyValue( bMute,
333 rxProps,
334 "Mute");
335 mxPlayer->setMute( bMute || !mbIsSoundEnabled);
336
337 sal_Int16 nVolumeDB(0);
338 getPropertyValue( nVolumeDB,
339 rxProps,
340 "VolumeDB");
341 mxPlayer->setVolumeDB( nVolumeDB );
342
343 if( mxPlayerWindow.is() )
344 {
345 media::ZoomLevel eZoom(media::ZoomLevel_FIT_TO_WINDOW);
346 getPropertyValue( eZoom,
347 rxProps,
348 "Zoom");
349 mxPlayerWindow->setZoomLevel( eZoom );
350 }
351 }
352
353
354 void ViewMediaShape::implInitializeMediaPlayer( const OUString& rMediaURL, const OUString& rMimeType )
355 {
356#if !HAVE_FEATURE_AVMEDIA1
357 (void) rMediaURL;
358 (void) rMimeType;
359#else
360 if( mxPlayer.is() )
361 return;
362
363 try
364 {
365 if( !rMediaURL.isEmpty() )
366 {
367 mxPlayer = avmedia::MediaWindow::createPlayer( rMediaURL, ""/*TODO!*/, &rMimeType );
368 }
369 }
370 catch( uno::RuntimeException& )
371 {
372 throw;
373 }
374 catch( const uno::Exception& )
375 {
376 throw lang::NoSupportException( "No video support for " + rMediaURL );
377 }
378#endif
379 }
380
381
382 void ViewMediaShape::implInitializePlayerWindow( const ::basegfx::B2DRectangle& rBounds,
383 const uno::Sequence< uno::Any >& rVCLDeviceParams,
384 const OUString& )
385 {
386 SAL_INFO("slideshow", "ViewMediaShape::implInitializePlayerWindow" )do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "slideshow")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "ViewMediaShape::implInitializePlayerWindow"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("slideshow"
), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "386" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "ViewMediaShape::implInitializePlayerWindow"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "ViewMediaShape::implInitializePlayerWindow"; ::sal
::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("slideshow"), (
"/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "386" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "ViewMediaShape::implInitializePlayerWindow") == 1
) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("slideshow"
), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "386" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "ViewMediaShape::implInitializePlayerWindow"
), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "ViewMediaShape::implInitializePlayerWindow"; ::sal
::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("slideshow"), (
"/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "386" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
;
387 if( mpMediaWindow || rBounds.isEmpty() )
388 return;
389
390 try
391 {
392 sal_Int64 aVal=0;
393
394 rVCLDeviceParams[ 1 ] >>= aVal;
395
396 vcl::Window* pWindow = reinterpret_cast< vcl::Window* >( aVal );
397
398 if( pWindow )
399 {
400 ::basegfx::B2DRange aTmpRange;
401 ::canvas::tools::calcTransformedRectBounds( aTmpRange,
402 rBounds,
403 mpViewLayer->getTransformation() );
404 const ::basegfx::B2IRange& rRangePix(
405 ::basegfx::unotools::b2ISurroundingRangeFromB2DRange( aTmpRange ));
406
407 if( !rRangePix.isEmpty() )
408 {
409 uno::Sequence< uno::Any > aArgs( 3 );
410 awt::Rectangle aAWTRect( rRangePix.getMinX(),
411 rRangePix.getMinY(),
412 rRangePix.getMaxX() - rRangePix.getMinX(),
413 rRangePix.getMaxY() - rRangePix.getMinY() );
414 {
415 mpMediaWindow.disposeAndClear();
416 mpMediaWindow = VclPtr<SystemChildWindow>::Create( pWindow, WB_CLIPCHILDREN );
417 UnoViewSharedPtr xUnoView(std::dynamic_pointer_cast<UnoView>(mpViewLayer));
418 if (xUnoView)
419 {
420 awt::Rectangle aCanvasArea = xUnoView->getUnoView()->getCanvasArea();
421 aAWTRect.X += aCanvasArea.X;
422 aAWTRect.Y += aCanvasArea.Y;
423 }
424 mpMediaWindow->SetPosSizePixel( Point( aAWTRect.X, aAWTRect.Y ),
425 Size( aAWTRect.Width, aAWTRect.Height ) );
426 }
427 mpMediaWindow->SetBackground( COL_BLACK );
428 mpMediaWindow->SetParentClipMode( ParentClipMode::NoClip );
429 mpMediaWindow->EnableEraseBackground( false );
430 mpMediaWindow->SetForwardKey( true );
431 mpMediaWindow->SetMouseTransparent( true );
432 mpMediaWindow->Show();
433
434 if( mxPlayer.is() )
435 {
436 aArgs[ 0 ] <<=
437 sal::static_int_cast< sal_IntPtr >( mpMediaWindow->GetParentWindowHandle() );
438
439 aAWTRect.X = aAWTRect.Y = 0;
440 aArgs[ 1 ] <<= aAWTRect;
441 aArgs[ 2 ] <<= reinterpret_cast< sal_IntPtr >( mpMediaWindow.get() );
442
443 mxPlayerWindow.set( mxPlayer->createPlayerWindow( aArgs ) );
444
445 if( mxPlayerWindow.is() )
446 {
447 mxPlayerWindow->setVisible( true );
448 mxPlayerWindow->setEnable( true );
449 }
450 }
451
452 if( !mxPlayerWindow.is() )
453 {
454 //if there was no playerwindow, then clear the mpMediaWindow too
455 //so that we can draw a placeholder instead in that space
456 mpMediaWindow.disposeAndClear();
457 }
458 }
459 }
460 }
461 catch( uno::RuntimeException& )
462 {
463 throw;
464 }
465 catch( uno::Exception& )
466 {
467 TOOLS_WARN_EXCEPTION( "slideshow", "" )do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "slideshow")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "" << " " <<
exceptionToString(tools_warn_exception)) == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_WARN), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "467" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "467" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "" << " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "467" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "" << " " << exceptionToString
(tools_warn_exception)), 0); } else { ::std::ostringstream sal_detail_stream
; sal_detail_stream << "" << " " << exceptionToString
(tools_warn_exception); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("slideshow"), ("/home/maarten/src/libreoffice/core/slideshow/source/engine/shapes/viewmediashape.cxx"
":" "467" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false)
;
468 }
469 }
470}
471
472/* 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);
4
Calling copy constructor for 'Reference<SystemChildWindow>'
7
Returning from copy constructor for 'Reference<SystemChildWindow>'
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
8
Calling 'Reference::clear'
15
Returning; memory was released
205 if (aTmp.get()) {
16
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)
5
Assuming field 'm_pBody' is non-null
6
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
8.1
Field 'm_pBody' is non-null
8.1
Field 'm_pBody' is non-null
8.1
Field 'm_pBody' is non-null
8.1
Field 'm_pBody' is non-null
)
9
Taking true branch
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
10
Calling 'VclReferenceBase::release'
14
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;
17
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)
11
Assuming the condition is true
12
Taking true branch
40 delete this;
13
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