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 mediawindow_impl.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 AVMEDIA_DLLIMPLEMENTATION -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/epoxy/include -I /home/maarten/src/libreoffice/core/external/boost/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/boost -I /home/maarten/src/libreoffice/core/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/avmedia/inc -I /home/maarten/src/libreoffice/core/avmedia/source/inc -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/udkapi/normal -I /home/maarten/src/libreoffice/core/workdir/UnoApiHeadersTarget/offapi/normal -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10 -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/x86_64-redhat-linux -internal-isystem /usr/bin/../lib/gcc/x86_64-redhat-linux/10/../../../../include/c++/10/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib64/clang/11.0.0/include -internal-externc-isystem /include -internal-externc-isystem /usr/include -O0 -Wno-missing-braces -std=c++17 -fdeprecated-macro -fdebug-compilation-dir /home/maarten/src/libreoffice/core -ferror-limit 19 -fvisibility hidden -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcxx-exceptions -fexceptions -debug-info-kind=constructor -analyzer-output=html -faddrsig -o /home/maarten/tmp/wis/scan-build-libreoffice/output/report/2020-10-07-141433-9725-1 -x c++ /home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx

/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.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 <iostream>
21#include "mediawindow_impl.hxx"
22#include "mediaevent_impl.hxx"
23#include <mediamisc.hxx>
24#include <bitmaps.hlst>
25#include <helpids.h>
26
27#include <algorithm>
28#include <string_view>
29
30#include <sal/log.hxx>
31#include <comphelper/processfactory.hxx>
32#include <tools/diagnose_ex.h>
33#include <tools/urlobj.hxx>
34#include <unotools/securityoptions.hxx>
35#include <vcl/bitmapex.hxx>
36#include <vcl/svapp.hxx>
37#include <vcl/commandevent.hxx>
38#include <vcl/event.hxx>
39#include <vcl/ptrstyle.hxx>
40
41#include <com/sun/star/awt/SystemPointer.hpp>
42#include <com/sun/star/lang/XComponent.hpp>
43#include <com/sun/star/media/XManager.hpp>
44#include <com/sun/star/uno/XComponentContext.hpp>
45using namespace ::com::sun::star;
46
47namespace avmedia::priv {
48
49MediaWindowControl::MediaWindowControl(vcl::Window* pParent)
50 : MediaControl(pParent, MediaControlStyle::MultiLine)
51{
52}
53
54void MediaWindowControl::update()
55{
56 MediaItem aItem;
57
58 static_cast< MediaWindowImpl* >( GetParent() )->updateMediaItem( aItem );
59 setState(aItem);
60}
61
62void MediaWindowControl::execute(const MediaItem& rItem)
63{
64 static_cast<MediaWindowImpl*>(GetParent())->executeMediaItem(rItem);
65}
66
67MediaChildWindow::MediaChildWindow(vcl::Window* pParent)
68 : SystemChildWindow(pParent, WB_CLIPCHILDREN)
69{
70}
71
72void MediaChildWindow::MouseMove( const MouseEvent& rMEvt )
73{
74 const MouseEvent aTransformedEvent( GetParent()->ScreenToOutputPixel( OutputToScreenPixel( rMEvt.GetPosPixel() ) ),
75 rMEvt.GetClicks(), rMEvt.GetMode(), rMEvt.GetButtons(), rMEvt.GetModifier() );
76
77 SystemChildWindow::MouseMove( rMEvt );
78 GetParent()->MouseMove( aTransformedEvent );
79}
80
81void MediaChildWindow::MouseButtonDown( const MouseEvent& rMEvt )
82{
83 const MouseEvent aTransformedEvent( GetParent()->ScreenToOutputPixel( OutputToScreenPixel( rMEvt.GetPosPixel() ) ),
84 rMEvt.GetClicks(), rMEvt.GetMode(), rMEvt.GetButtons(), rMEvt.GetModifier() );
85
86 SystemChildWindow::MouseButtonDown( rMEvt );
87 GetParent()->MouseButtonDown( aTransformedEvent );
88}
89
90void MediaChildWindow::MouseButtonUp( const MouseEvent& rMEvt )
91{
92 const MouseEvent aTransformedEvent( GetParent()->ScreenToOutputPixel( OutputToScreenPixel( rMEvt.GetPosPixel() ) ),
93 rMEvt.GetClicks(), rMEvt.GetMode(), rMEvt.GetButtons(), rMEvt.GetModifier() );
94
95 SystemChildWindow::MouseButtonUp( rMEvt );
96 GetParent()->MouseButtonUp( aTransformedEvent );
97}
98
99void MediaChildWindow::KeyInput( const KeyEvent& rKEvt )
100{
101 SystemChildWindow::KeyInput( rKEvt );
102 GetParent()->KeyInput( rKEvt );
103}
104
105void MediaChildWindow::KeyUp( const KeyEvent& rKEvt )
106{
107 SystemChildWindow::KeyUp( rKEvt );
108 GetParent()->KeyUp( rKEvt );
109}
110
111void MediaChildWindow::Command( const CommandEvent& rCEvt )
112{
113 const CommandEvent aTransformedEvent( GetParent()->ScreenToOutputPixel( OutputToScreenPixel( rCEvt.GetMousePosPixel() ) ),
114 rCEvt.GetCommand(), rCEvt.IsMouseEvent(), rCEvt.GetEventData() );
115
116 SystemChildWindow::Command( rCEvt );
117 GetParent()->Command( aTransformedEvent );
118}
119
120MediaWindowImpl::MediaWindowImpl(vcl::Window* pParent, MediaWindow* pMediaWindow, bool bInternalMediaControl)
121 : Control(pParent)
122 , DropTargetHelper(this)
123 , DragSourceHelper(this)
124 , mpMediaWindow(pMediaWindow)
125 , mpMediaWindowControl(bInternalMediaControl ? VclPtr<MediaWindowControl>::Create(this) : nullptr)
126{
127 if (mpMediaWindowControl)
128 {
129 mpMediaWindowControl->SetSizePixel(mpMediaWindowControl->GetOptimalSize());
130 mpMediaWindowControl->Show();
131 }
132}
133
134MediaWindowImpl::~MediaWindowImpl()
135{
136 disposeOnce();
137}
138
139void MediaWindowImpl::dispose()
140{
141 if (mxEvents.is())
1
Taking false branch
→
142 mxEvents->cleanUp();
143
144 if (mxPlayerWindow.is())
2
←
Taking false branch
→
145 {
146 auto pEventsIf = static_cast<cppu::OWeakObject*>(mxEvents.get());
147 mxPlayerWindow->removeKeyListener( uno::Reference< awt::XKeyListener >( pEventsIf, uno::UNO_QUERY ) );
148 mxPlayerWindow->removeMouseListener( uno::Reference< awt::XMouseListener >( pEventsIf, uno::UNO_QUERY ) );
149 mxPlayerWindow->removeMouseMotionListener( uno::Reference< awt::XMouseMotionListener >( pEventsIf, uno::UNO_QUERY ) );
150 mxPlayerWindow->dispose();
151 mxPlayerWindow.clear();
152 }
153
154 uno::Reference< lang::XComponent > xComponent( mxPlayer, uno::UNO_QUERY );
155 if (xComponent.is()) // this stops the player
3
←
Taking false branch
→
156 xComponent->dispose();
157
158 mxPlayer.clear();
159
160 mpMediaWindow = nullptr;
161
162 mpEmptyBmpEx.reset();
163 mpAudioBmpEx.reset();
164 mpMediaWindowControl.disposeAndClear();
165 mpChildWindow.disposeAndClear();
4
←
Calling 'VclPtr::disposeAndClear'
→
166
167 Control::dispose();
168}
169
170uno::Reference<media::XPlayer> MediaWindowImpl::createPlayer(const OUString& rURL, const OUString& rReferer, const OUString* pMimeType)
171{
172 uno::Reference<media::XPlayer> xPlayer;
173
174 if( rURL.isEmpty() )
175 return xPlayer;
176
177 if (SvtSecurityOptions().isUntrustedReferer(rReferer))
178 {
179 return xPlayer;
180 }
181
182 if (!pMimeType || *pMimeType == AVMEDIA_MIMETYPE_COMMON"application/vnd.sun.star.media")
183 {
184 uno::Reference<uno::XComponentContext> xContext(::comphelper::getProcessComponentContext());
185
186 static std::u16string_view aServiceManagers[] =
187 {
188 u"" AVMEDIA_MANAGER_SERVICE_PREFERRED"com.sun.star.comp.avmedia.Manager_VLC",
189 u"" AVMEDIA_MANAGER_SERVICE_NAME"com.sun.star.comp.avmedia.Manager_GStreamer",
190 };
191
192 for (const auto& rServiceName : aServiceManagers)
193 {
194 xPlayer = createPlayer(rURL, rServiceName, xContext);
195 if (xPlayer)
196 break;
197 }
198 }
199
200 return xPlayer;
201}
202
203uno::Reference< media::XPlayer > MediaWindowImpl::createPlayer(
204 const OUString& rURL, const OUString& rManagerServName,
205 const uno::Reference< uno::XComponentContext >& xContext)
206{
207 uno::Reference< media::XPlayer > xPlayer;
208 try
209 {
210 uno::Reference< media::XManager > xManager (
211 xContext->getServiceManager()->createInstanceWithContext(rManagerServName, xContext),
212 uno::UNO_QUERY );
213 if( xManager.is() )
214 xPlayer = xManager->createPlayer( rURL );
215 else
216 SAL_INFO( "avmedia", "failed to create media player service " << rManagerServName )do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "avmedia")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "failed to create media player service "
<< rManagerServName) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("avmedia"), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "216" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "failed to create media player service "
<< rManagerServName), 0); } else { ::std::ostringstream
sal_detail_stream; sal_detail_stream << "failed to create media player service "
<< rManagerServName; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("avmedia"), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "216" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "failed to create media player service " <<
rManagerServName) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("avmedia"), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "216" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "failed to create media player service "
<< rManagerServName), 0); } else { ::std::ostringstream
sal_detail_stream; sal_detail_stream << "failed to create media player service "
<< rManagerServName; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("avmedia"), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "216" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false);
217 } catch ( const uno::Exception & )
218 {
219 TOOLS_WARN_EXCEPTION( "avmedia", "couldn't create media player " << rManagerServName)do { css::uno::Any tools_warn_exception( DbgGetCaughtException
() ); do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_WARN
, "avmedia")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "couldn't create media player "
<< rManagerServName << " " << exceptionToString
(tools_warn_exception)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN
), ("avmedia"), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "219" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "couldn't create media player " <<
rManagerServName << " " << exceptionToString(tools_warn_exception
)), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "couldn't create media player " << rManagerServName
<< " " << exceptionToString(tools_warn_exception
); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("avmedia"
), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "219" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "couldn't create media player " << rManagerServName
<< " " << exceptionToString(tools_warn_exception
)) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_WARN), (
"avmedia"), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "219" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "couldn't create media player " <<
rManagerServName << " " << exceptionToString(tools_warn_exception
)), 0); } else { ::std::ostringstream sal_detail_stream; sal_detail_stream
<< "couldn't create media player " << rManagerServName
<< " " << exceptionToString(tools_warn_exception
); ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_WARN), ("avmedia"
), ("/home/maarten/src/libreoffice/core/avmedia/source/viewer/mediawindow_impl.cxx"
":" "219" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false); } while (false);
220 }
221 return xPlayer;
222}
223
224void MediaWindowImpl::setURL( const OUString& rURL,
225 OUString const& rTempURL, OUString const& rReferer)
226{
227 maReferer = rReferer;
228 if( rURL == getURL() )
229 return;
230
231 if( mxPlayer.is() )
232 mxPlayer->stop();
233
234 if( mxPlayerWindow.is() )
235 {
236 mxPlayerWindow->setVisible( false );
237 mxPlayerWindow.clear();
238 }
239
240 mxPlayer.clear();
241 mTempFileURL.clear();
242
243 if (!rTempURL.isEmpty())
244 {
245 maFileURL = rURL;
246 mTempFileURL = rTempURL;
247 }
248 else
249 {
250 INetURLObject aURL( rURL );
251
252 if (aURL.GetProtocol() != INetProtocol::NotValid)
253 maFileURL = aURL.GetMainURL(INetURLObject::DecodeMechanism::Unambiguous);
254 else
255 maFileURL = rURL;
256 }
257
258 mxPlayer = createPlayer((!mTempFileURL.isEmpty()) ? mTempFileURL : maFileURL, rReferer, &m_sMimeType );
259 onURLChanged();
260}
261
262const OUString& MediaWindowImpl::getURL() const
263{
264 return maFileURL;
265}
266
267bool MediaWindowImpl::isValid() const
268{
269 return mxPlayer.is();
270}
271
272Size MediaWindowImpl::getPreferredSize() const
273{
274 Size aRet(480, 360);
275
276 if( mxPlayer.is() )
277 {
278 awt::Size aPrefSize( mxPlayer->getPreferredPlayerWindowSize() );
279
280 aRet.setWidth( aPrefSize.Width );
281 aRet.setHeight( aPrefSize.Height );
282 }
283
284 return aRet;
285}
286
287bool MediaWindowImpl::start()
288{
289 return mxPlayer.is() && ( mxPlayer->start(), true );
290}
291
292void MediaWindowImpl::updateMediaItem( MediaItem& rItem ) const
293{
294 if( isPlaying() )
295 rItem.setState( MediaState::Play );
296 else
297 rItem.setState( ( getMediaTime() == 0.0 ) ? MediaState::Stop : MediaState::Pause );
298
299 rItem.setDuration( getDuration() );
300 rItem.setTime( getMediaTime() );
301 rItem.setLoop( mxPlayer.is() && mxPlayer->isPlaybackLoop() );
302 rItem.setMute( mxPlayer.is() && mxPlayer->isMute() );
303 rItem.setVolumeDB( mxPlayer.is() ? mxPlayer->getVolumeDB() : 0 );
304 rItem.setZoom( mxPlayerWindow.is() ? mxPlayerWindow->getZoomLevel() : media::ZoomLevel_NOT_AVAILABLE );
305 rItem.setURL( getURL(), mTempFileURL, maReferer );
306}
307
308void MediaWindowImpl::executeMediaItem( const MediaItem& rItem )
309{
310 const AVMediaSetMask nMaskSet = rItem.getMaskSet();
311
312 // set URL first
313 if (nMaskSet & AVMediaSetMask::URL)
314 {
315 m_sMimeType = rItem.getMimeType();
316 setURL(rItem.getURL(), rItem.getTempURL(), rItem.getReferer());
317 }
318
319 // set different states next
320 if (nMaskSet & AVMediaSetMask::TIME)
321 setMediaTime(std::min(rItem.getTime(), getDuration()));
322
323 if (nMaskSet & AVMediaSetMask::LOOP && mxPlayer.is() )
324 mxPlayer->setPlaybackLoop( rItem.isLoop() );
325
326 if (nMaskSet & AVMediaSetMask::MUTE && mxPlayer.is() )
327 mxPlayer->setMute( rItem.isMute() );
328
329 if (nMaskSet & AVMediaSetMask::VOLUMEDB && mxPlayer.is() )
330 mxPlayer->setVolumeDB( rItem.getVolumeDB() );
331
332 if (nMaskSet & AVMediaSetMask::ZOOM && mxPlayerWindow.is() )
333 mxPlayerWindow->setZoomLevel( rItem.getZoom() );
334
335 // set play state at last
336 if (!(nMaskSet & AVMediaSetMask::STATE))
337 return;
338
339 switch (rItem.getState())
340 {
341 case MediaState::Play:
342 {
343 if (!isPlaying())
344 start();
345 }
346 break;
347
348 case MediaState::Pause:
349 {
350 if (isPlaying())
351 stop();
352 }
353 break;
354
355 case MediaState::Stop:
356 {
357 if (isPlaying())
358 {
359 setMediaTime( 0.0 );
360 stop();
361 setMediaTime( 0.0 );
362 }
363 }
364 break;
365 }
366}
367
368void MediaWindowImpl::stop()
369{
370 if( mxPlayer.is() )
371 mxPlayer->stop();
372}
373
374bool MediaWindowImpl::isPlaying() const
375{
376 return( mxPlayer.is() && mxPlayer->isPlaying() );
377}
378
379double MediaWindowImpl::getDuration() const
380{
381 return( mxPlayer.is() ? mxPlayer->getDuration() : 0.0 );
382}
383
384void MediaWindowImpl::setMediaTime( double fTime )
385{
386 if( mxPlayer.is() )
387 mxPlayer->setMediaTime( fTime );
388}
389
390double MediaWindowImpl::getMediaTime() const
391{
392 return( mxPlayer.is() ? mxPlayer->getMediaTime() : 0.0 );
393}
394
395void MediaWindowImpl::stopPlayingInternal(bool bStop)
396{
397 if (isPlaying())
398 {
399 bStop ? mxPlayer->stop() : mxPlayer->start();
400 }
401}
402
403void MediaWindowImpl::onURLChanged()
404{
405 if (m_sMimeType == AVMEDIA_MIMETYPE_COMMON"application/vnd.sun.star.media")
406 {
407 mpChildWindow.disposeAndClear();
408 mpChildWindow.reset(VclPtr<MediaChildWindow>::Create(this));
409 }
410 if (!mpChildWindow)
411 return;
412 mpChildWindow->SetHelpId(HID_AVMEDIA_PLAYERWINDOW"AVMEDIA_HID_AVMEDIA_PLAYERWINDOW");
413 mxEvents = new MediaEventListenersImpl(*mpChildWindow);
414
415 if (mxPlayer.is())
416 {
417 Resize();
418 uno::Sequence<uno::Any> aArgs( 3 );
419 uno::Reference<media::XPlayerWindow> xPlayerWindow;
420 const Point aPoint;
421 const Size aSize(mpChildWindow->GetSizePixel());
422
423 aArgs[0] <<= mpChildWindow->GetParentWindowHandle();
424 aArgs[1] <<= awt::Rectangle(aPoint.X(), aPoint.Y(), aSize.Width(), aSize.Height());
425 aArgs[2] <<= reinterpret_cast<sal_IntPtr>(mpChildWindow.get());
426
427 try
428 {
429 xPlayerWindow = mxPlayer->createPlayerWindow( aArgs );
430 }
431 catch( const uno::RuntimeException& )
432 {
433 // happens eg, on MacOSX where Java frames cannot be created from X11 window handles
434 }
435
436 mxPlayerWindow = xPlayerWindow;
437
438 if( xPlayerWindow.is() )
439 {
440 auto pEventsIf = static_cast<cppu::OWeakObject*>(mxEvents.get());
441 xPlayerWindow->addKeyListener( uno::Reference< awt::XKeyListener >( pEventsIf, uno::UNO_QUERY ) );
442 xPlayerWindow->addMouseListener( uno::Reference< awt::XMouseListener >( pEventsIf, uno::UNO_QUERY ) );
443 xPlayerWindow->addMouseMotionListener( uno::Reference< awt::XMouseMotionListener >( pEventsIf, uno::UNO_QUERY ) );
444 xPlayerWindow->addFocusListener( uno::Reference< awt::XFocusListener >( pEventsIf, uno::UNO_QUERY ) );
445 }
446 }
447 else
448 mxPlayerWindow.clear();
449
450 if( mxPlayerWindow.is() )
451 mpChildWindow->Show();
452 else
453 mpChildWindow->Hide();
454
455 if( mpMediaWindowControl )
456 {
457 MediaItem aItem;
458
459 updateMediaItem( aItem );
460 mpMediaWindowControl->setState( aItem );
461 }
462}
463
464void MediaWindowImpl::setPosSize(const tools::Rectangle& rRect)
465{
466 SetPosSizePixel(rRect.TopLeft(), rRect.GetSize());
467}
468
469void MediaWindowImpl::setPointer(PointerStyle aPointer)
470{
471 SetPointer(aPointer);
472
473 if (mpChildWindow)
474 mpChildWindow->SetPointer(aPointer);
475
476 if (!mxPlayerWindow.is())
477 return;
478
479 long nPointer;
480
481 switch (aPointer)
482 {
483 case PointerStyle::Cross:
484 nPointer = awt::SystemPointer::CROSS;
485 break;
486 case PointerStyle::Hand:
487 nPointer = awt::SystemPointer::HAND;
488 break;
489 case PointerStyle::Move:
490 nPointer = awt::SystemPointer::MOVE;
491 break;
492 case PointerStyle::Wait:
493 nPointer = awt::SystemPointer::WAIT;
494 break;
495 default:
496 nPointer = awt::SystemPointer::ARROW;
497 break;
498 }
499
500 mxPlayerWindow->setPointerType(nPointer);
501}
502
503void MediaWindowImpl::Resize()
504{
505 const Size aCurSize(GetOutputSizePixel());
506 const sal_Int32 nOffset(mpMediaWindowControl ? AVMEDIA_CONTROLOFFSET6 : 0);
507
508 Size aPlayerWindowSize(aCurSize.Width() - (nOffset << 1),
509 aCurSize.Height() - (nOffset << 1));
510
511 if (mpMediaWindowControl)
512 {
513 const sal_Int32 nControlHeight = mpMediaWindowControl->GetSizePixel().Height();
514 const sal_Int32 nControlY = std::max(aCurSize.Height() - nControlHeight - nOffset, 0L);
515
516 aPlayerWindowSize.setHeight( nControlY - (nOffset << 1) );
517 mpMediaWindowControl->SetPosSizePixel(Point(nOffset, nControlY ), Size(aCurSize.Width() - (nOffset << 1), nControlHeight));
518 }
519 if (mpChildWindow)
520 mpChildWindow->SetPosSizePixel(Point(0, 0), aPlayerWindowSize);
521
522 if (mxPlayerWindow.is())
523 mxPlayerWindow->setPosSize(0, 0, aPlayerWindowSize.Width(), aPlayerWindowSize.Height(), 0);
524}
525
526void MediaWindowImpl::StateChanged(StateChangedType eType)
527{
528 if (!mxPlayerWindow.is())
529 return;
530
531 // stop playing when going disabled or hidden
532 switch (eType)
533 {
534 case StateChangedType::Visible:
535 {
536 stopPlayingInternal(!IsVisible());
537 mxPlayerWindow->setVisible(IsVisible());
538 }
539 break;
540
541 case StateChangedType::Enable:
542 {
543 stopPlayingInternal(!IsEnabled());
544 mxPlayerWindow->setEnable(IsEnabled());
545 }
546 break;
547
548 default:
549 break;
550 }
551}
552
553void MediaWindowImpl::Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle&)
554{
555 if (mxPlayerWindow.is())
556 mxPlayerWindow->update();
557
558 BitmapEx* pLogo = nullptr;
559
560 if (!mxPlayer.is())
561 {
562 if (!mpEmptyBmpEx)
563 mpEmptyBmpEx.reset(new BitmapEx(AVMEDIA_BMP_EMPTYLOGO"avmedia/res/avemptylogo.png"));
564
565 pLogo = mpEmptyBmpEx.get();
566 }
567 else if (!mxPlayerWindow.is())
568 {
569 if (!mpAudioBmpEx)
570 mpAudioBmpEx.reset(new BitmapEx(AVMEDIA_BMP_AUDIOLOGO"avmedia/res/avaudiologo.png"));
571
572 pLogo = mpAudioBmpEx.get();
573 }
574
575 if (!mpChildWindow)
576 return;
577
578 const Point aBasePos(mpChildWindow->GetPosPixel());
579 const tools::Rectangle aVideoRect(aBasePos, mpChildWindow->GetSizePixel());
580
581 if (!pLogo || pLogo->IsEmpty() || aVideoRect.IsEmpty())
582 return;
583
584 Size aLogoSize(pLogo->GetSizePixel());
585 const Color aBackgroundColor(67, 67, 67);
586
587 rRenderContext.SetLineColor(aBackgroundColor);
588 rRenderContext.SetFillColor(aBackgroundColor);
589 rRenderContext.DrawRect(aVideoRect);
590
591 if ((aLogoSize.Width() > aVideoRect.GetWidth() || aLogoSize.Height() > aVideoRect.GetHeight() ) &&
592 (aLogoSize.Height() > 0))
593 {
594 const double fLogoWH = double(aLogoSize.Width()) / aLogoSize.Height();
595
596 if (fLogoWH < (double(aVideoRect.GetWidth()) / aVideoRect.GetHeight()))
597 {
598 aLogoSize.setWidth( long(aVideoRect.GetHeight() * fLogoWH) );
599 aLogoSize.setHeight( aVideoRect.GetHeight() );
600 }
601 else
602 {
603 aLogoSize.setWidth( aVideoRect.GetWidth() );
604 aLogoSize.setHeight( long(aVideoRect.GetWidth() / fLogoWH) );
605 }
606 }
607
608 Point aPoint(aBasePos.X() + ((aVideoRect.GetWidth() - aLogoSize.Width()) >> 1),
609 aBasePos.Y() + ((aVideoRect.GetHeight() - aLogoSize.Height()) >> 1));
610
611 rRenderContext.DrawBitmapEx(aPoint, aLogoSize, *pLogo);
612}
613
614void MediaWindowImpl::GetFocus()
615{
616}
617
618void MediaWindowImpl::MouseMove(const MouseEvent& rMEvt)
619{
620 if (mpMediaWindow)
621 mpMediaWindow->MouseMove(rMEvt);
622}
623
624void MediaWindowImpl::MouseButtonDown(const MouseEvent& rMEvt)
625{
626 if (mpMediaWindow)
627 mpMediaWindow->MouseButtonDown(rMEvt);
628}
629
630void MediaWindowImpl::MouseButtonUp(const MouseEvent& rMEvt)
631{
632 if (mpMediaWindow)
633 mpMediaWindow->MouseButtonUp(rMEvt);
634}
635
636void MediaWindowImpl::KeyInput(const KeyEvent& rKEvt)
637{
638 if (mpMediaWindow)
639 mpMediaWindow->KeyInput(rKEvt);
640}
641
642void MediaWindowImpl::KeyUp(const KeyEvent& rKEvt)
643{
644 if (mpMediaWindow)
645 mpMediaWindow->KeyUp(rKEvt);
646}
647
648void MediaWindowImpl::Command(const CommandEvent& rCEvt)
649{
650 if (mpMediaWindow)
651 mpMediaWindow->Command(rCEvt);
652}
653
654sal_Int8 MediaWindowImpl::AcceptDrop(const AcceptDropEvent& rEvt)
655{
656 return (mpMediaWindow ? mpMediaWindow->AcceptDrop(rEvt) : 0);
657}
658
659sal_Int8 MediaWindowImpl::ExecuteDrop(const ExecuteDropEvent& rEvt)
660{
661 return (mpMediaWindow ? mpMediaWindow->ExecuteDrop(rEvt) : 0);
662}
663
664void MediaWindowImpl::StartDrag(sal_Int8 nAction, const Point& rPosPixel)
665{
666 if (mpMediaWindow)
667 mpMediaWindow->StartDrag(nAction, rPosPixel);
668}
669
670} // namespace
671
672/* 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);
5
←
Calling copy constructor for 'Reference<avmedia::priv::MediaChildWindow>'
→
8
←
Returning from copy constructor for 'Reference<avmedia::priv::MediaChildWindow>'
→
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
9
←
Calling 'Reference::clear'
→
16
←
Returning; memory was released
→
205 if (aTmp.get()) {
17
←
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)
6
←
Assuming field 'm_pBody' is non-null
→
7
←
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
9.1
Field 'm_pBody' is non-null
9.1
Field 'm_pBody' is non-null
9.1
Field 'm_pBody' is non-null
9.1
Field 'm_pBody' is non-null
)
10
←
Taking true branch
→
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
11
←
Calling 'VclReferenceBase::release'
→
15
←
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;
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)
12
←
Assuming the condition is true
→
13
←
Taking true branch
→
40 delete this;
14
←
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