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 frame2.cxx -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 2 -mframe-pointer=all -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -fno-split-dwarf-inlining -debugger-tuning=gdb -resource-dir /usr/lib64/clang/11.0.0 -isystem /usr/include/libxml2 -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 SFX2_DLLIMPLEMENTATION -D ENABLE_CUPS -D SYSTEM_LIBXML -D EXCEPTIONS_ON -D LIBO_INTERNAL_ONLY -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/liborcus/include -I /home/maarten/src/libreoffice/core/workdir/UnpackedTarball/liborcus/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/sfx2/inc -I /home/maarten/src/libreoffice/core/sfx2/source/inc -I /home/maarten/src/libreoffice/core/workdir/SdiTarget/sfx2/sdi -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/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/sfx2/source/view/frame2.cxx

/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.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
21#include "impframe.hxx"
22#include <workwin.hxx>
23
24#include <sfx2/bindings.hxx>
25#include <sfx2/dispatch.hxx>
26#include <sfx2/docfile.hxx>
27#include <sfx2/sfxsids.hrc>
28#include <sfx2/sfxuno.hxx>
29#include <sfx2/viewsh.hxx>
30
31#include <com/sun/star/awt/XWindow2.hpp>
32#include <com/sun/star/beans/XPropertySet.hpp>
33#include <com/sun/star/frame/Desktop.hpp>
34#include <com/sun/star/frame/XComponentLoader.hpp>
35#include <com/sun/star/frame/Frame.hpp>
36#include <com/sun/star/frame/XLayoutManager.hpp>
37
38#include <comphelper/namedvaluecollection.hxx>
39#include <comphelper/processfactory.hxx>
40#include <toolkit/helper/vclunohelper.hxx>
41#include <tools/diagnose_ex.h>
42#include <vcl/event.hxx>
43#include <vcl/syswin.hxx>
44#include <sal/log.hxx>
45
46using namespace ::com::sun::star;
47using namespace ::com::sun::star::uno;
48using namespace ::com::sun::star::frame;
49using namespace ::com::sun::star::util;
50using namespace ::com::sun::star::container;
51using namespace ::com::sun::star::beans;
52using ::com::sun::star::frame::XComponentLoader;
53
54class SfxFrameWindow_Impl : public vcl::Window
55{
56 DECL_LINK(ModalHierarchyHdl, bool, void)static void LinkStubModalHierarchyHdl(void *, bool); void ModalHierarchyHdl
(bool)
;
57public:
58 SfxFrame* pFrame;
59
60 SfxFrameWindow_Impl( SfxFrame* pF, vcl::Window& i_rContainerWindow );
61
62 virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
63 virtual void StateChanged( StateChangedType nStateChange ) override;
64 virtual bool PreNotify( NotifyEvent& rNEvt ) override;
65 virtual bool EventNotify( NotifyEvent& rEvt ) override;
66 virtual void Resize() override;
67 virtual void GetFocus() override;
68 virtual void dispose() override;
69 void DoResize();
70};
71
72SfxFrameWindow_Impl::SfxFrameWindow_Impl(SfxFrame* pF, vcl::Window& i_rContainerWindow)
73 : Window(&i_rContainerWindow, WB_BORDER | WB_CLIPCHILDREN | WB_NODIALOGCONTROL | WB_3DLOOK)
74 , pFrame(pF)
75{
76 i_rContainerWindow.SetModalHierarchyHdl(LINK(this, SfxFrameWindow_Impl, ModalHierarchyHdl)::tools::detail::makeLink( ::tools::detail::castTo<SfxFrameWindow_Impl
*>(this), &SfxFrameWindow_Impl::LinkStubModalHierarchyHdl
)
);
77}
78
79void SfxFrameWindow_Impl::dispose()
80{
81 GetParent()->SetModalHierarchyHdl(Link<bool, void>());
82 vcl::Window::dispose();
83}
84
85void SfxFrameWindow_Impl::DataChanged( const DataChangedEvent& rDCEvt )
86{
87 Window::DataChanged( rDCEvt );
88 // tdf#131613 the printers changing has no effect on window layout
89 if (rDCEvt.GetType() == DataChangedEventType::PRINTER)
90 return;
91 SfxWorkWindow *pWorkWin = pFrame->GetWorkWindow_Impl();
92 if ( pWorkWin )
93 pWorkWin->DataChanged_Impl();
94}
95
96bool SfxFrameWindow_Impl::EventNotify( NotifyEvent& rNEvt )
97{
98 if ( pFrame->IsClosing_Impl() || !pFrame->GetFrameInterface().is() )
99 return false;
100
101 SfxViewFrame* pView = pFrame->GetCurrentViewFrame();
102 if ( !pView || !pView->GetObjectShell() )
103 return Window::EventNotify( rNEvt );
104
105 if ( rNEvt.GetType() == MouseNotifyEvent::GETFOCUS )
106 {
107 if ( pView->GetViewShell() && !pView->GetViewShell()->GetUIActiveIPClient_Impl() && !pFrame->IsInPlace() )
108 {
109 SAL_INFO("sfx", "SfxFrame: GotFocus")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "sfx")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case SAL_DETAIL_LOG_ACTION_LOG
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "SfxFrame: GotFocus") == 1) { ::sal_detail_log( (
::SAL_DETAIL_LOG_LEVEL_INFO), ("sfx"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "109" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SfxFrame: GotFocus"), 0); } else { ::
std::ostringstream sal_detail_stream; sal_detail_stream <<
"SfxFrame: GotFocus"; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("sfx"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "109" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "SfxFrame: GotFocus") == 1) { ::sal_detail_log( (
::SAL_DETAIL_LOG_LEVEL_INFO), ("sfx"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "109" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "SfxFrame: GotFocus"), 0); } else { ::
std::ostringstream sal_detail_stream; sal_detail_stream <<
"SfxFrame: GotFocus"; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("sfx"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "109" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
;
110 pView->MakeActive_Impl( false );
111 }
112
113 // if focus was on an external window, the clipboard content might have been changed
114 pView->GetBindings().Invalidate( SID_PASTE(5000 + 712) );
115 pView->GetBindings().Invalidate( SID_PASTE_SPECIAL(5000 + 311) );
116 return true;
117 }
118 else if( rNEvt.GetType() == MouseNotifyEvent::KEYINPUT )
119 {
120 if ( pView->GetViewShell()->KeyInput( *rNEvt.GetKeyEvent() ) )
121 return true;
122 }
123
124 return Window::EventNotify( rNEvt );
125}
126
127IMPL_LINK(SfxFrameWindow_Impl, ModalHierarchyHdl, bool, bSetModal, void)void SfxFrameWindow_Impl::LinkStubModalHierarchyHdl(void * instance
, bool data) { return static_cast<SfxFrameWindow_Impl *>
(instance)->ModalHierarchyHdl(data); } void SfxFrameWindow_Impl
::ModalHierarchyHdl(bool bSetModal)
128{
129 SfxViewFrame* pView = pFrame->GetCurrentViewFrame();
130 if (!pView || !pView->GetObjectShell())
131 return;
132 pView->SetModalMode(bSetModal);
133}
134
135bool SfxFrameWindow_Impl::PreNotify( NotifyEvent& rNEvt )
136{
137 MouseNotifyEvent nType = rNEvt.GetType();
138 if ( nType == MouseNotifyEvent::KEYINPUT || nType == MouseNotifyEvent::KEYUP )
139 {
140 SfxViewFrame* pView = pFrame->GetCurrentViewFrame();
141 SfxViewShell* pShell = pView ? pView->GetViewShell() : nullptr;
142 if ( pShell && pShell->HasKeyListeners_Impl() && pShell->HandleNotifyEvent_Impl( rNEvt ) )
143 return true;
144 }
145 else if ( nType == MouseNotifyEvent::MOUSEBUTTONUP || nType == MouseNotifyEvent::MOUSEBUTTONDOWN )
146 {
147 vcl::Window* pWindow = rNEvt.GetWindow();
148 SfxViewFrame* pView = pFrame->GetCurrentViewFrame();
149 SfxViewShell* pShell = pView ? pView->GetViewShell() : nullptr;
150 if ( pShell )
151 if ( pWindow == pShell->GetWindow() || pShell->GetWindow()->IsChild( pWindow ) )
152 if ( pShell->HasMouseClickListeners_Impl() && pShell->HandleNotifyEvent_Impl( rNEvt ) )
153 return true;
154 }
155
156 if ( nType == MouseNotifyEvent::MOUSEBUTTONDOWN )
157 {
158 vcl::Window* pWindow = rNEvt.GetWindow();
159 const MouseEvent* pMEvent = rNEvt.GetMouseEvent();
160 Point aPos = pWindow->OutputToScreenPixel( pMEvent->GetPosPixel() );
161 SfxWorkWindow *pWorkWin = pFrame->GetWorkWindow_Impl();
162 if ( pWorkWin )
163 pWorkWin->EndAutoShow_Impl( aPos );
164 }
165
166 return Window::PreNotify( rNEvt );
167}
168
169void SfxFrameWindow_Impl::GetFocus()
170{
171 if ( pFrame && !pFrame->IsClosing_Impl() && pFrame->GetCurrentViewFrame() && pFrame->GetFrameInterface().is() )
172 pFrame->GetCurrentViewFrame()->MakeActive_Impl( true );
173}
174
175void SfxFrameWindow_Impl::Resize()
176{
177 if ( IsReallyVisible() || IsReallyShown() || GetOutputSizePixel().Width() )
178 DoResize();
179}
180
181void SfxFrameWindow_Impl::StateChanged( StateChangedType nStateChange )
182{
183 if ( nStateChange == StateChangedType::InitShow )
184 {
185 pFrame->pImpl->bHidden = false;
186 if ( pFrame->IsInPlace() )
187 // TODO/MBA: workaround for bug in LayoutManager: the final resize does not get through because the
188 // LayoutManager works asynchronously and between resize and time execution the DockingAcceptor was exchanged so that
189 // the resize event never is sent to the component
190 SetSizePixel( GetParent()->GetOutputSizePixel() );
191
192 DoResize();
193 SfxViewFrame* pView = pFrame->GetCurrentViewFrame();
194 if ( pView )
195 pView->GetBindings().GetWorkWindow_Impl()->ShowChildren_Impl();
196 }
197
198 Window::StateChanged( nStateChange );
199}
200
201void SfxFrameWindow_Impl::DoResize()
202{
203 if ( !pFrame->pImpl->bLockResize )
204 pFrame->Resize();
205}
206
207Reference < XFrame > SfxFrame::CreateBlankFrame()
208{
209 Reference < XFrame > xFrame;
210 try
211 {
212 Reference < XDesktop2 > xDesktop = Desktop::create( ::comphelper::getProcessComponentContext() );
213 xFrame.set( xDesktop->findFrame( "_blank", 0 ), UNO_SET_THROW );
214 }
215 catch( const Exception& )
216 {
217 DBG_UNHANDLED_EXCEPTION("sfx.view")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "217" ": ", "sfx.view" );
;
218 }
219 return xFrame;
220}
221
222SfxFrame* SfxFrame::CreateHidden( SfxObjectShell const & rDoc, vcl::Window& rWindow, SfxInterfaceId nViewId )
223{
224 SfxFrame* pFrame = nullptr;
225 try
226 {
227 // create and initialize new top level frame for this window
228 Reference < XComponentContext > xContext( ::comphelper::getProcessComponentContext() );
229 Reference < XDesktop2 > xDesktop = Desktop::create( xContext );
230 Reference < XFrame2 > xFrame = Frame::create( xContext );
231
232 Reference< awt::XWindow2 > xWin( VCLUnoHelper::GetInterface ( &rWindow ), uno::UNO_QUERY_THROW );
233 xFrame->initialize( xWin.get() );
234 xDesktop->getFrames()->append( xFrame );
235
236 if ( xWin->isActive() )
237 xFrame->activate();
238
239 // create load arguments
240 Sequence< PropertyValue > aLoadArgs;
241 TransformItems( SID_OPENDOC(5000 + 501), *rDoc.GetMedium()->GetItemSet(), aLoadArgs );
242
243 ::comphelper::NamedValueCollection aArgs( aLoadArgs );
244 aArgs.put( "Model", rDoc.GetModel() );
245 aArgs.put( "Hidden", true );
246 if ( nViewId != SFX_INTERFACE_NONE )
247 aArgs.put( "ViewId", static_cast<sal_uInt16>(nViewId) );
248
249 aLoadArgs = aArgs.getPropertyValues();
250
251 // load the doc into that frame
252 Reference< XComponentLoader > xLoader( xFrame, UNO_QUERY_THROW );
253 xLoader->loadComponentFromURL(
254 "private:object",
255 "_self",
256 0,
257 aLoadArgs
258 );
259
260 for ( pFrame = SfxFrame::GetFirst();
261 pFrame;
262 pFrame = SfxFrame::GetNext( *pFrame )
263 )
264 {
265 if ( pFrame->GetFrameInterface() == xFrame )
266 break;
267 }
268
269 OSL_ENSURE( pFrame, "SfxFrame::Create: load succeeded, but no SfxFrame was created during this!" )do { if (true && (!(pFrame))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "269" ": "), "%s", "SfxFrame::Create: load succeeded, but no SfxFrame was created during this!"
); } } while (false)
;
270 }
271 catch( const Exception& )
272 {
273 DBG_UNHANDLED_EXCEPTION("sfx.view")DbgUnhandledException( DbgGetCaughtException(), __func__, "/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "273" ": ", "sfx.view" );
;
274 }
275
276 return pFrame;
277}
278
279SfxFrame* SfxFrame::Create( const Reference < XFrame >& i_rFrame )
280{
281 // create a new TopFrame to an external XFrame object ( wrap controller )
282 ENSURE_OR_THROW( i_rFrame.is(), "NULL frame not allowed" )if( !(i_rFrame.is()) ){ do { if (true && (!(i_rFrame.
is()))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN), (
"legacy.osl"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "282" ": "), "%s", "NULL frame not allowed"); } } while (
false); throw css::uno::RuntimeException( __func__ + OUStringLiteral
(u",\n" "NULL frame not allowed"), css::uno::Reference< css
::uno::XInterface >() ); }
;
1
Taking false branch
283 VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow( i_rFrame->getContainerWindow() );
284 ENSURE_OR_THROW( pWindow, "frame without container window not allowed" )if( !(pWindow) ){ do { if (true && (!(pWindow))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "284" ": "), "%s", "frame without container window not allowed"
); } } while (false); throw css::uno::RuntimeException( __func__
+ OUStringLiteral(u",\n" "frame without container window not allowed"
), css::uno::Reference< css::uno::XInterface >() ); }
;
2
Taking false branch
285
286 SfxFrame* pFrame = new SfxFrame( *pWindow );
3
Calling constructor for 'SfxFrame'
287 pFrame->SetFrameInterface_Impl( i_rFrame );
288 return pFrame;
289}
290
291SfxFrame::SfxFrame( vcl::Window& i_rContainerWindow )
292 :SvCompatWeakBase<SfxFrame>( this )
293 ,pWindow( nullptr )
294{
295 Construct_Impl();
296
297 pImpl->bHidden = false;
298 InsertTopFrame_Impl( this );
299 pImpl->pExternalContainerWindow = &i_rContainerWindow;
300
301 pWindow = VclPtr<SfxFrameWindow_Impl>::Create( this, i_rContainerWindow );
4
Calling 'VclPtr::Create'
6
Returned allocated memory
7
Calling implicit destructor for 'VclPtr<SfxFrameWindow_Impl>'
8
Calling '~Reference'
15
Returning from '~Reference'
16
Returning from destructor for 'VclPtr<SfxFrameWindow_Impl>'
302
303 // always show pWindow, which is the ComponentWindow of the XFrame we live in
304 // nowadays, since SfxFrames can be created with an XFrame only, hiding or showing the complete XFrame
305 // is not done at level of the container window, not at SFX level. Thus, the component window can
306 // always be visible.
307 pWindow->Show();
17
Calling 'VclPtr::operator->'
308}
309
310void SfxFrame::SetPresentationMode( bool bSet )
311{
312 if ( GetCurrentViewFrame() )
313 GetCurrentViewFrame()->GetWindow().SetBorderStyle( bSet ? WindowBorderStyle::NOBORDER : WindowBorderStyle::NORMAL );
314
315 Reference< css::beans::XPropertySet > xPropSet( GetFrameInterface(), UNO_QUERY );
316 Reference< css::frame::XLayoutManager > xLayoutManager;
317
318 if ( xPropSet.is() )
319 {
320 Any aValue = xPropSet->getPropertyValue("LayoutManager");
321 aValue >>= xLayoutManager;
322 }
323
324 if ( xLayoutManager.is() )
325 xLayoutManager->setVisible( !bSet ); // we don't want to have ui in presentation mode
326
327 SetMenuBarOn_Impl( !bSet );
328 if ( GetWorkWindow_Impl() )
329 GetWorkWindow_Impl()->SetDockingAllowed( !bSet );
330 if ( GetCurrentViewFrame() )
331 GetCurrentViewFrame()->GetDispatcher()->Update_Impl( true );
332}
333
334SystemWindow* SfxFrame::GetSystemWindow() const
335{
336 return GetTopWindow_Impl();
337}
338
339SystemWindow* SfxFrame::GetTopWindow_Impl() const
340{
341 if ( pImpl->pExternalContainerWindow->IsSystemWindow() )
342 return static_cast<SystemWindow*>( pImpl->pExternalContainerWindow.get() );
343 else
344 return nullptr;
345}
346
347
348void SfxFrame::LockResize_Impl( bool bLock )
349{
350 pImpl->bLockResize = bLock;
351}
352
353void SfxFrame::SetMenuBarOn_Impl( bool bOn )
354{
355 pImpl->bMenuBarOn = bOn;
356
357 Reference< css::beans::XPropertySet > xPropSet( GetFrameInterface(), UNO_QUERY );
358 Reference< css::frame::XLayoutManager > xLayoutManager;
359
360 if ( xPropSet.is() )
361 {
362 Any aValue = xPropSet->getPropertyValue("LayoutManager");
363 aValue >>= xLayoutManager;
364 }
365
366 if ( xLayoutManager.is() )
367 {
368 OUString aMenuBarURL( "private:resource/menubar/menubar" );
369
370 if ( bOn )
371 xLayoutManager->showElement( aMenuBarURL );
372 else
373 xLayoutManager->hideElement( aMenuBarURL );
374 }
375}
376
377bool SfxFrame::IsMenuBarOn_Impl() const
378{
379 return pImpl->bMenuBarOn;
380}
381
382void SfxFrame::PrepareForDoc_Impl( SfxObjectShell& i_rDoc )
383{
384 const ::comphelper::NamedValueCollection aDocumentArgs( i_rDoc.GetModel()->getArgs() );
385
386 // hidden?
387 OSL_ENSURE( !pImpl->bHidden, "when does this happen?" )do { if (true && (!(!pImpl->bHidden))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sfx2/source/view/frame2.cxx"
":" "387" ": "), "%s", "when does this happen?"); } } while (
false)
;
388 pImpl->bHidden = aDocumentArgs.getOrDefault( "Hidden", pImpl->bHidden );
389
390 // update our descriptor
391 UpdateDescriptor( &i_rDoc );
392
393 // plugin mode
394 sal_Int16 nPluginMode = aDocumentArgs.getOrDefault( "PluginMode", sal_Int16( 0 ) );
395 if ( nPluginMode && ( nPluginMode != 2 ) )
396 pImpl->bInPlace = true;
397}
398
399bool SfxFrame::IsMarkedHidden_Impl() const
400{
401 return pImpl->bHidden;
402}
403
404/* 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 );
5
Memory is allocated
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
18
Calling 'Reference::get'
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
205 if (aTmp.get()) {
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody
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
113 m_pBody->release();
10
Calling 'VclReferenceBase::release'
14
Returning; memory was released
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody)
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
19
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