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 childwin.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/appl/childwin.cxx

/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.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 <memory>
21#include <unotools/viewoptions.hxx>
22#include <com/sun/star/frame/XController.hpp>
23#include <com/sun/star/frame/XFrame.hpp>
24#include <com/sun/star/util/XCloseable.hpp>
25#include <com/sun/star/beans/NamedValue.hpp>
26#include <comphelper/string.hxx>
27#include <cppuhelper/implbase.hxx>
28#include <osl/diagnose.h>
29#include <sal/log.hxx>
30#include <tools/debug.hxx>
31
32#include <vcl/svapp.hxx>
33#include <sfx2/childwin.hxx>
34#include <sfx2/app.hxx>
35#include <sfx2/bindings.hxx>
36#include <sfx2/module.hxx>
37#include <sfx2/dockwin.hxx>
38#include <sfx2/dispatch.hxx>
39#include <workwin.hxx>
40#include <childwinimpl.hxx>
41
42const sal_uInt16 nVersion = 2;
43
44SfxChildWinFactory::SfxChildWinFactory( SfxChildWinCtor pTheCtor, sal_uInt16 nID,
45 sal_uInt16 n )
46 : pCtor(pTheCtor)
47 , nId( nID )
48 , nPos(n)
49{}
50
51SfxChildWinFactory::~SfxChildWinFactory()
52{
53}
54
55struct SfxChildWindow_Impl
56{
57 css::uno::Reference< css::frame::XFrame > xFrame;
58 css::uno::Reference< css::lang::XEventListener > xListener;
59 SfxChildWinFactory* pFact;
60 bool bHideNotDelete;
61 bool bVisible;
62 bool bWantsFocus;
63 SfxModule* pContextModule;
64 SfxWorkWindow* pWorkWin;
65};
66
67namespace {
68
69class DisposeListener : public ::cppu::WeakImplHelper< css::lang::XEventListener >
70{
71 public:
72 DisposeListener( SfxChildWindow* pOwner ,
73 SfxChildWindow_Impl* pData )
74 : m_pOwner( pOwner )
75 , m_pData ( pData )
76 {}
77
78 virtual void SAL_CALL disposing( const css::lang::EventObject& aSource ) override
79 {
80 css::uno::Reference< css::lang::XEventListener > xSelfHold( this );
81
82 css::uno::Reference< css::lang::XComponent > xComp( aSource.Source, css::uno::UNO_QUERY );
83 if( xComp.is() )
84 xComp->removeEventListener( this );
85
86 if( !m_pOwner || !m_pData )
87 return;
88
89 m_pData->xListener.clear();
90
91 if ( m_pData->pWorkWin )
92 {
93 // m_pOwner and m_pData will be killed
94 m_pData->xFrame.clear();
95 m_pData->pWorkWin->GetBindings().Execute( m_pOwner->GetType() );
96 }
97 else
98 {
99 delete m_pOwner;
100 }
101
102 m_pOwner = nullptr;
103 m_pData = nullptr;
104 }
105
106 private:
107 SfxChildWindow* m_pOwner;
108 SfxChildWindow_Impl* m_pData ;
109};
110
111}
112
113bool GetPosSizeFromString( const OUString& rStr, Point& rPos, Size& rSize )
114{
115 if ( comphelper::string::getTokenCount(rStr, '/') != 4 )
116 return false;
117
118 sal_Int32 nIdx = 0;
119 rPos.setX( rStr.getToken(0, '/', nIdx).toInt32() );
120 rPos.setY( rStr.getToken(0, '/', nIdx).toInt32() );
121 rSize.setWidth( rStr.getToken(0, '/', nIdx).toInt32() );
122 rSize.setHeight( rStr.getToken(0, '/', nIdx).toInt32() );
123
124 // negative sizes are invalid
125 return rSize.Width() >= 0 && rSize.Height() >= 0;
126}
127
128bool GetSplitSizeFromString( const OUString& rStr, Size& rSize )
129{
130 sal_Int32 nIndex = rStr.indexOf( ',' );
131 if ( nIndex != -1 )
132 {
133 OUString aStr = rStr.copy( nIndex+1 );
134
135 sal_Int32 nCount = comphelper::string::getTokenCount(aStr, ';');
136 if ( nCount != 2 )
137 return false;
138
139 sal_Int32 nIdx{ 0 };
140 rSize.setWidth( aStr.getToken(0, ';', nIdx ).toInt32() );
141 rSize.setHeight( aStr.getToken(0, ';', nIdx ).toInt32() );
142
143 // negative sizes are invalid
144 return rSize.Width() >= 0 && rSize.Height() >= 0;
145 }
146
147 return false;
148}
149
150
151SfxChildWindow::SfxChildWindow(vcl::Window *pParentWindow, sal_uInt16 nId)
152 : pParent(pParentWindow)
153 , nType(nId)
154 , eChildAlignment(SfxChildAlignment::NOALIGNMENT)
155 , pImpl(new SfxChildWindow_Impl)
156{
157 pImpl->pFact = nullptr;
158 pImpl->bHideNotDelete = false;
159 pImpl->bWantsFocus = true;
160 pImpl->bVisible = true;
161 pImpl->pContextModule = nullptr;
162 pImpl->pWorkWin = nullptr;
163
164 pContext = nullptr;
165}
166
167void SfxChildWindow::Destroy()
168{
169 if ( GetFrame().is() )
170 {
171 ClearWorkwin();
172 try
173 {
174 css::uno::Reference < css::util::XCloseable > xClose( GetFrame(), css::uno::UNO_QUERY );
175 if ( xClose.is() )
176 xClose->close( true );
177 else
178 GetFrame()->dispose();
179 }
180 catch (const css::uno::Exception&)
181 {
182 }
183 }
184 else
185 delete this;
186}
187
188void SfxChildWindow::ClearWorkwin()
189{
190 if (pImpl->pWorkWin)
191 {
192 if (pImpl->pWorkWin->GetActiveChild_Impl() == pWindow)
193 pImpl->pWorkWin->SetActiveChild_Impl(nullptr);
194 pImpl->pWorkWin = nullptr;
195 }
196}
197
198SfxChildWindow::~SfxChildWindow()
199{
200 pContext.reset();
201 ClearWorkwin();
202 if (xController)
203 {
204 xController->ChildWinDispose();
205 xController.reset();
206 }
207 pWindow.disposeAndClear();
208}
209
210std::unique_ptr<SfxChildWindow> SfxChildWindow::CreateChildWindow( sal_uInt16 nId,
211 vcl::Window *pParent, SfxBindings* pBindings, SfxChildWinInfo const & rInfo)
212{
213 std::unique_ptr<SfxChildWindow> pChild;
214 SfxChildWinFactory* pFact=nullptr;
215 SystemWindowFlags nOldMode = Application::GetSystemWindowMode();
216
217 // First search for ChildWindow in SDT; Overlay windows are realized
218 // by using ChildWindowContext
219 SfxApplication *pApp = SfxGetpApp();
220 {
221 SfxChildWinFactArr_Impl &rFactories = pApp->GetChildWinFactories_Impl();
222 for ( size_t nFactory = 0; nFactory < rFactories.size(); ++nFactory )
223 {
224 pFact = &rFactories[nFactory];
225 if ( pFact->nId == nId )
226 {
227 SfxChildWinInfo& rFactInfo = pFact->aInfo;
228 if ( rInfo.bVisible )
229 {
230 if ( pBindings )
231 pBindings->ENTERREGISTRATIONS()EnterRegistrations();
232 SfxChildWinInfo aInfo = rFactInfo;
233 Application::SetSystemWindowMode( SystemWindowFlags::NOAUTOMODE );
234 pChild = pFact->pCtor( pParent, nId, pBindings, &aInfo );
235 Application::SetSystemWindowMode( nOldMode );
236 if ( pBindings )
237 pBindings->LEAVEREGISTRATIONS()LeaveRegistrations();
238 }
239
240 break;
241 }
242 }
243 }
244
245 SfxDispatcher *pDisp = pBindings ? pBindings->GetDispatcher_Impl() : nullptr;
246 SfxModule *pMod = pDisp ? SfxModule::GetActiveModule( pDisp->GetFrame() ) : nullptr;
247 if (!pChild && pMod)
248 {
249 SfxChildWinFactArr_Impl *pFactories = pMod->GetChildWinFactories_Impl();
250 if ( pFactories )
251 {
252 SfxChildWinFactArr_Impl &rFactories = *pFactories;
253 for ( size_t nFactory = 0; nFactory < rFactories.size(); ++nFactory )
254 {
255 pFact = &rFactories[nFactory];
256 if ( pFact->nId == nId )
257 {
258 SfxChildWinInfo& rFactInfo = pFact->aInfo;
259 if ( rInfo.bVisible )
260 {
261 if ( pBindings )
262 pBindings->ENTERREGISTRATIONS()EnterRegistrations();
263 SfxChildWinInfo aInfo = rFactInfo;
264 Application::SetSystemWindowMode( SystemWindowFlags::NOAUTOMODE );
265 pChild = pFact->pCtor( pParent, nId, pBindings, &aInfo );
266 Application::SetSystemWindowMode( nOldMode );
267 if ( pBindings )
268 pBindings->LEAVEREGISTRATIONS()LeaveRegistrations();
269 }
270
271 break;
272 }
273 }
274 }
275 }
276
277 if ( pChild )
278 pChild->SetFactory_Impl( pFact );
279
280 DBG_ASSERT(pFact && (pChild || !rInfo.bVisible), "ChildWindow-Typ not registered!")do { if (true && (!(pFact && (pChild || !rInfo
.bVisible)))) { sal_detail_logFormat((SAL_DETAIL_LOG_LEVEL_WARN
), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "280" ": "), "%s", "ChildWindow-Typ not registered!"); }
} while (false)
;
281
282 if (pChild && (!pChild->pWindow && !pChild->xController))
283 {
284 pChild.reset();
285 SAL_INFO("sfx.appl", "ChildWindow has no Window!")do { if (true) { switch (sal_detail_log_report(::SAL_DETAIL_LOG_LEVEL_INFO
, "sfx.appl")) { case SAL_DETAIL_LOG_ACTION_IGNORE: break; case
SAL_DETAIL_LOG_ACTION_LOG: if (sizeof ::sal::detail::getResult
( ::sal::detail::StreamStart() << "ChildWindow has no Window!"
) == 1) { ::sal_detail_log( (::SAL_DETAIL_LOG_LEVEL_INFO), ("sfx.appl"
), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "285" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "ChildWindow has no Window!"), 0); } else
{ ::std::ostringstream sal_detail_stream; sal_detail_stream <<
"ChildWindow has no Window!"; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("sfx.appl"), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "285" ": "), sal_detail_stream, 0); }; break; case SAL_DETAIL_LOG_ACTION_FATAL
: if (sizeof ::sal::detail::getResult( ::sal::detail::StreamStart
() << "ChildWindow has no Window!") == 1) { ::sal_detail_log
( (::SAL_DETAIL_LOG_LEVEL_INFO), ("sfx.appl"), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "285" ": "), ::sal::detail::unwrapStream( ::sal::detail::
StreamStart() << "ChildWindow has no Window!"), 0); } else
{ ::std::ostringstream sal_detail_stream; sal_detail_stream <<
"ChildWindow has no Window!"; ::sal::detail::log( (::SAL_DETAIL_LOG_LEVEL_INFO
), ("sfx.appl"), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "285" ": "), sal_detail_stream, 0); }; std::abort(); break
; } } } while (false)
;
286 }
287
288 return pChild;
289}
290
291
292void SfxChildWindow::SaveStatus(const SfxChildWinInfo& rInfo)
293{
294 sal_uInt16 nID = GetType();
295
296 OUString aInfoVisible = rInfo.bVisible ? OUString("V") : OUString("H");
297
298 OUString aWinData = "V"
299 + OUString::number(static_cast<sal_Int32>(nVersion))
300 + ","
301 + aInfoVisible
302 + ","
303 + OUString::number(static_cast<sal_Int32>(rInfo.nFlags));
304
305 if ( !rInfo.aExtraString.isEmpty() )
306 aWinData += "," + rInfo.aExtraString;
307
308 OUString sName(OUString::number(nID));
309 //Try and save window state per-module, e.g. sidebar on in one application
310 //but off in another
311 if (!rInfo.aModule.isEmpty())
312 sName = rInfo.aModule + "/" + sName;
313 SvtViewOptions aWinOpt(EViewType::Window, sName);
314 aWinOpt.SetWindowState(OStringToOUString(rInfo.aWinState, RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76))));
315
316 css::uno::Sequence < css::beans::NamedValue > aSeq
317 { { "Data", css::uno::makeAny(aWinData) } };
318 aWinOpt.SetUserData( aSeq );
319
320 // ... but save status at runtime!
321 pImpl->pFact->aInfo = rInfo;
322}
323
324void SfxChildWindow::SetAlignment(SfxChildAlignment eAlign)
325{
326 eChildAlignment = eAlign;
327}
328
329SfxChildWinInfo SfxChildWindow::GetInfo() const
330{
331 SfxChildWinInfo aInfo(pImpl->pFact->aInfo);
332 if (xController)
333 {
334 weld::Dialog* pDialog = xController->getDialog();
335 aInfo.aPos = pDialog->get_position();
336 aInfo.aSize = pDialog->get_size();
337 WindowStateMask nMask = WindowStateMask::Pos | WindowStateMask::State;
338 if (pDialog->get_resizable())
339 nMask |= WindowStateMask::Width | WindowStateMask::Height;
340 aInfo.aWinState = pDialog->get_window_state(nMask);
341 }
342 else if (pWindow)
343 {
344 aInfo.aPos = pWindow->GetPosPixel();
345 aInfo.aSize = pWindow->GetSizePixel();
346 if ( pWindow->IsSystemWindow() )
347 {
348 WindowStateMask nMask = WindowStateMask::Pos | WindowStateMask::State;
349 if ( pWindow->GetStyle() & WB_SIZEABLE )
350 nMask |= WindowStateMask::Width | WindowStateMask::Height;
351 aInfo.aWinState = static_cast<SystemWindow*>(pWindow.get())->GetWindowState( nMask );
352 }
353 else if (DockingWindow* pDockingWindow = dynamic_cast<DockingWindow*>(pWindow.get()))
354 {
355 if (pDockingWindow->GetFloatingWindow())
356 aInfo.aWinState = pDockingWindow->GetFloatingWindow()->GetWindowState();
357 else if (SfxDockingWindow* pSfxDockingWindow = dynamic_cast<SfxDockingWindow*>(pDockingWindow))
358 {
359 SfxChildWinInfo aTmpInfo;
360 pSfxDockingWindow->FillInfo( aTmpInfo );
361 aInfo.aExtraString = aTmpInfo.aExtraString;
362 }
363 }
364 }
365
366 aInfo.bVisible = pImpl->bVisible;
367 aInfo.nFlags = SfxChildWindowFlags::NONE;
368 return aInfo;
369}
370
371sal_uInt16 SfxChildWindow::GetPosition() const
372{
373 return pImpl->pFact->nPos;
374}
375
376void SfxChildWindow::InitializeChildWinFactory_Impl(sal_uInt16 nId, SfxChildWinInfo& rInfo)
377{
378 // load configuration
379
380 std::unique_ptr<SvtViewOptions> xWinOpt;
381 // first see if a module specific id exists
382 if (rInfo.aModule.getLength())
383 xWinOpt.reset(new SvtViewOptions(EViewType::Window, rInfo.aModule + "/" + OUString::number(nId)));
384
385 // if not then try the generic id
386 if (!xWinOpt || !xWinOpt->Exists())
387 xWinOpt.reset(new SvtViewOptions(EViewType::Window, OUString::number(nId)));
388
389 if (xWinOpt->Exists() && xWinOpt->HasVisible() )
390 rInfo.bVisible = xWinOpt->IsVisible(); // set state from configuration. Can be overwritten by UserData, see below
391
392 css::uno::Sequence < css::beans::NamedValue > aSeq = xWinOpt->GetUserData();
393
394 OUString aTmp;
395 if ( aSeq.hasElements() )
396 aSeq[0].Value >>= aTmp;
397
398 OUString aWinData( aTmp );
399 rInfo.aWinState = OUStringToOString(xWinOpt->GetWindowState(), RTL_TEXTENCODING_UTF8(((rtl_TextEncoding) 76)));
400
401 if ( aWinData.isEmpty() )
402 return;
403
404 // Search for version ID
405 if ( aWinData[0] != 0x0056 ) // 'V' = 56h
406 // A version ID, so do not use
407 return;
408
409 // Delete 'V'
410 aWinData = aWinData.copy(1);
411
412 // Read version
413 char cToken = ',';
414 sal_Int32 nPos = aWinData.indexOf( cToken );
415 sal_uInt16 nActVersion = static_cast<sal_uInt16>(aWinData.copy( 0, nPos + 1 ).toInt32());
416 if ( nActVersion != nVersion )
417 return;
418
419 aWinData = aWinData.copy(nPos+1);
420
421 // Load Visibility: is coded as a char
422 rInfo.bVisible = (aWinData[0] == 0x0056); // 'V' = 56h
423 aWinData = aWinData.copy(1);
424 nPos = aWinData.indexOf( cToken );
425 if (nPos == -1)
426 return;
427
428 sal_Int32 nNextPos = aWinData.indexOf( cToken, 2 );
429 if ( nNextPos != -1 )
430 {
431 // there is extra information
432 rInfo.nFlags = static_cast<SfxChildWindowFlags>(static_cast<sal_uInt16>(aWinData.copy( nPos+1, nNextPos - nPos - 1 ).toInt32()));
433 aWinData = aWinData.replaceAt( nPos, nNextPos-nPos+1, "" );
434 rInfo.aExtraString = aWinData;
435 }
436 else
437 rInfo.nFlags = static_cast<SfxChildWindowFlags>(static_cast<sal_uInt16>(aWinData.copy( nPos+1 ).toInt32()));
438}
439
440void SfxChildWindow::CreateContext( sal_uInt16 nContextId, SfxBindings& rBindings )
441{
442 std::unique_ptr<SfxChildWindowContext> pCon;
443 SfxChildWinFactory* pFact=nullptr;
444 SfxApplication *pApp = SfxGetpApp();
445 SfxDispatcher *pDisp = rBindings.GetDispatcher_Impl();
446 SfxModule *pMod = pDisp ? SfxModule::GetActiveModule( pDisp->GetFrame() ) :nullptr;
447 if ( pMod )
448 {
449 SfxChildWinFactArr_Impl *pFactories = pMod->GetChildWinFactories_Impl();
450 if ( pFactories )
451 {
452 SfxChildWinFactArr_Impl &rFactories = *pFactories;
453 for ( size_t nFactory = 0; nFactory < rFactories.size(); ++nFactory )
454 {
455 pFact = &rFactories[nFactory];
456 if ( pFact->nId == GetType() )
457 {
458 DBG_ASSERT( pFact->pArr, "No context registered!" )do { if (true && (!(pFact->pArr))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "458" ": "), "%s", "No context registered!"); } } while (
false)
;
459 if ( !pFact->pArr )
460 break;
461
462 for ( size_t n=0; n<pFact->pArr->size(); ++n )
463 {
464 SfxChildWinContextFactory *pConFact = &(*pFact->pArr)[n];
465 rBindings.ENTERREGISTRATIONS()EnterRegistrations();
466 if ( pConFact->nContextId == nContextId )
467 {
468 SfxChildWinInfo aInfo = pFact->aInfo;
469 pCon = pConFact->pCtor( GetWindow(), &rBindings, &aInfo );
470 pCon->nContextId = pConFact->nContextId;
471 pImpl->pContextModule = pMod;
472 }
473 rBindings.LEAVEREGISTRATIONS()LeaveRegistrations();
474 }
475 break;
476 }
477 }
478 }
479 }
480
481 if ( !pCon )
482 {
483 SfxChildWinFactArr_Impl &rFactories = pApp->GetChildWinFactories_Impl();
484 for ( size_t nFactory = 0; nFactory < rFactories.size(); ++nFactory )
485 {
486 pFact = &rFactories[nFactory];
487 if ( pFact->nId == GetType() )
488 {
489 DBG_ASSERT( pFact->pArr, "No context registered!" )do { if (true && (!(pFact->pArr))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "489" ": "), "%s", "No context registered!"); } } while (
false)
;
490 if ( !pFact->pArr )
491 break;
492
493 for ( size_t n=0; n<pFact->pArr->size(); ++n )
494 {
495 SfxChildWinContextFactory *pConFact = &(*pFact->pArr)[n];
496 rBindings.ENTERREGISTRATIONS()EnterRegistrations();
497 if ( pConFact->nContextId == nContextId )
498 {
499 SfxChildWinInfo aInfo = pFact->aInfo;
500 pCon = pConFact->pCtor( GetWindow(), &rBindings, &aInfo );
501 pCon->nContextId = pConFact->nContextId;
502 pImpl->pContextModule = nullptr;
503 }
504 rBindings.LEAVEREGISTRATIONS()LeaveRegistrations();
505 }
506 break;
507 }
508 }
509 }
510
511 if ( !pCon )
512 {
513 OSL_FAIL( "No suitable context found! ")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sfx2/source/appl/childwin.cxx"
":" "513" ": "), "%s", "No suitable context found! "); } } while
(false)
;
514 return;
515 }
516
517 pContext = std::move(pCon);
518 pContext->GetWindow()->SetSizePixel( pWindow->GetOutputSizePixel() );
519 pContext->GetWindow()->Show();
520}
521
522SfxChildWindowContext::SfxChildWindowContext( sal_uInt16 nId )
523 : nContextId( nId )
524{
525}
526
527SfxChildWindowContext::~SfxChildWindowContext()
528{
529 pWindow.disposeAndClear();
1
Calling 'VclPtr::disposeAndClear'
530}
531
532FloatingWindow* SfxChildWindowContext::GetFloatingWindow(vcl::Window *pParent)
533{
534 if (pParent->GetType() == WindowType::DOCKINGWINDOW || pParent->GetType() == WindowType::TOOLBOX)
535 {
536 return static_cast<DockingWindow*>(pParent)->GetFloatingWindow();
537 }
538 if (pParent->GetType() == WindowType::FLOATINGWINDOW)
539 {
540 return static_cast<FloatingWindow*>(pParent);
541 }
542 return nullptr;
543}
544
545void SfxChildWindow::SetFactory_Impl( SfxChildWinFactory *pF )
546{
547 pImpl->pFact = pF;
548}
549
550void SfxChildWindow::SetHideNotDelete( bool bOn )
551{
552 pImpl->bHideNotDelete = bOn;
553}
554
555bool SfxChildWindow::IsHideNotDelete() const
556{
557 return pImpl->bHideNotDelete;
558}
559
560void SfxChildWindow::SetWantsFocus( bool bSet )
561{
562 pImpl->bWantsFocus = bSet;
563}
564
565bool SfxChildWindow::WantsFocus() const
566{
567 return pImpl->bWantsFocus;
568}
569
570bool SfxChildWinInfo::GetExtraData_Impl
571(
572 SfxChildAlignment *pAlign
573) const
574{
575 // invalid?
576 if ( aExtraString.isEmpty() )
577 return false;
578 OUString aStr;
579 sal_Int32 nPos = aExtraString.indexOf("AL:");
580 if ( nPos == -1 )
581 return false;
582
583 // Try to read the alignment string "ALIGN :(...)", but if
584 // it is not present, then use an older version
585 sal_Int32 n1 = aExtraString.indexOf('(', nPos);
586 if ( n1 != -1 )
587 {
588 sal_Int32 n2 = aExtraString.indexOf(')', n1);
589 if ( n2 != -1 )
590 {
591 // Cut out Alignment string
592 aStr = aExtraString.copy(nPos, n2 - nPos + 1);
593 aStr = aStr.replaceAt(nPos, n1-nPos+1, "");
594 }
595 }
596
597 // First extract the Alignment
598 if ( aStr.isEmpty() )
599 return false;
600 if ( pAlign )
601 *pAlign = static_cast<SfxChildAlignment>(static_cast<sal_uInt16>(aStr.toInt32()));
602
603 // then the LastAlignment
604 nPos = aStr.indexOf(',');
605 if ( nPos == -1 )
606 return false;
607 aStr = aStr.copy(nPos+1);
608
609 // Then the splitting information
610 nPos = aStr.indexOf(',');
611 if ( nPos == -1 )
612 // No docking in a Splitwindow
613 return true;
614 aStr = aStr.copy(nPos+1);
615 Point aChildPos;
616 Size aChildSize;
617 return GetPosSizeFromString( aStr, aChildPos, aChildSize );
618}
619
620bool SfxChildWindow::IsVisible() const
621{
622 return pImpl->bVisible;
623}
624
625void SfxChildWindow::SetVisible_Impl( bool bVis )
626{
627 pImpl->bVisible = bVis;
628}
629
630void SfxChildWindow::Hide()
631{
632 if (xController)
633 xController->EndDialog();
634 else
635 pWindow->Hide();
636}
637
638void SfxChildWindow::Show( ShowFlags nFlags )
639{
640 if (xController)
641 {
642 if (!xController->getDialog()->get_visible())
643 {
644 weld::DialogController::runAsync(xController,
645 [this](sal_Int32 /*nResult*/){ xController->Close(); });
646 }
647 }
648 else
649 pWindow->Show(true, nFlags);
650}
651
652vcl::Window* SfxChildWindow::GetContextWindow( SfxModule const *pModule ) const
653{
654 return pModule == pImpl->pContextModule && pContext ? pContext->GetWindow(): nullptr;
655}
656
657void SfxChildWindow::SetWorkWindow_Impl( SfxWorkWindow* pWin )
658{
659 pImpl->pWorkWin = pWin;
660 if (pWin)
661 {
662 if ( (xController && xController->getDialog()->has_toplevel_focus()) ||
663 (pWindow && pWindow->HasChildPathFocus()) )
664 {
665 pImpl->pWorkWin->SetActiveChild_Impl( pWindow );
666 }
667 }
668}
669
670void SfxChildWindow::Activate_Impl()
671{
672 if(pImpl->pWorkWin!=nullptr)
673 pImpl->pWorkWin->SetActiveChild_Impl( pWindow );
674}
675
676bool SfxChildWindow::QueryClose()
677{
678 bool bAllow = true;
679
680 if ( pImpl->xFrame.is() )
681 {
682 css::uno::Reference< css::frame::XController > xCtrl = pImpl->xFrame->getController();
683 if ( xCtrl.is() )
684 bAllow = xCtrl->suspend( true );
685 }
686
687 if ( bAllow )
688 {
689 if (GetController())
690 {
691 weld::Dialog* pDialog = GetController()->getDialog();
692 bAllow = !pDialog->get_visible() || !pDialog->get_modal();
693 }
694 else if (GetWindow())
695 bAllow = !GetWindow()->IsInModalMode();
696 }
697
698 return bAllow;
699}
700
701const css::uno::Reference< css::frame::XFrame >& SfxChildWindow::GetFrame() const
702{
703 return pImpl->xFrame;
704}
705
706void SfxChildWindow::SetFrame( const css::uno::Reference< css::frame::XFrame > & rFrame )
707{
708 // Do nothing if nothing will be changed ...
709 if( pImpl->xFrame == rFrame )
710 return;
711
712 // ... but stop listening on old frame, if connection exist!
713 if( pImpl->xFrame.is() )
714 pImpl->xFrame->removeEventListener( pImpl->xListener );
715
716 // If new frame is not NULL -> we must guarantee valid listener for disposing events.
717 // Use already existing or create new one.
718 if( rFrame.is() )
719 if( !pImpl->xListener.is() )
720 pImpl->xListener.set( new DisposeListener( this, pImpl.get() ) );
721
722 // Set new frame in data container
723 // and build new listener connection, if necessary.
724 pImpl->xFrame = rFrame;
725 if( pImpl->xFrame.is() )
726 pImpl->xFrame->addEventListener( pImpl->xListener );
727}
728
729void SfxChildWindowContext::RegisterChildWindowContext(SfxModule* pMod, sal_uInt16 nId, std::unique_ptr<SfxChildWinContextFactory> pFact)
730{
731 SfxGetpApp()->RegisterChildWindowContext_Impl( pMod, nId, std::move(pFact) );
732}
733
734void SfxChildWindow::RegisterChildWindow(SfxModule* pMod, std::unique_ptr<SfxChildWinFactory> pFact)
735{
736 SfxGetpApp()->RegisterChildWindow_Impl( pMod, std::move(pFact) );
737}
738
739/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX
22
23#include <sal/config.h>
24
25#include <rtl/ref.hxx>
26
27#include <utility>
28#include <type_traits>
29
30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif
35
36class VclReferenceBase;
37
38namespace vcl::detail {
39
40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }
42
43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
44 int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }
46
47} // namespace vcl::detail
48
49/**
50 * A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
51 *
52 * For more details on the design please see vcl/README.lifecycle
53 *
54 * @param reference_type must be a subclass of vcl::Window
55 */
56template <class reference_type>
57class VclPtr
58{
59 static_assert(
60 vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
61 nullptr),
62 "template argument type must be derived from VclReferenceBase");
63
64 ::rtl::Reference<reference_type> m_rInnerRef;
65
66public:
67 /** Constructor...
68 */
69 VclPtr()
70 : m_rInnerRef()
71 {}
72
73 /** Constructor...
74 */
75 VclPtr (reference_type * pBody)
76 : m_rInnerRef(pBody)
77 {}
78
79 /** Constructor... that doesn't take a ref.
80 */
81 VclPtr (reference_type * pBody, __sal_NoAcquire)
82 : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
83 {}
84
85 /** Up-casting conversion constructor: Copies interface reference.
86
87 Does not work for up-casts to ambiguous bases. For the special case of
88 up-casting to Reference< XInterface >, see the corresponding conversion
89 operator.
90
91 @param rRef another reference
92 */
93 template< class derived_type >
94 VclPtr(
95 const VclPtr< derived_type > & rRef,
96 typename std::enable_if<
97 std::is_base_of<reference_type, derived_type>::value, int>::type
98 = 0 )
99 : m_rInnerRef( static_cast<reference_type*>(rRef) )
100 {
101 }
102
103#if defined(DBG_UTIL) && !defined(_WIN32)
104 virtual ~VclPtr()
105 {
106 assert(m_rInnerRef.get() == nullptr || vclmain::isAlive())(static_cast <bool> (m_rInnerRef.get() == nullptr || vclmain
::isAlive()) ? void (0) : __assert_fail ("m_rInnerRef.get() == nullptr || vclmain::isAlive()"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 106, __extension__ __PRETTY_FUNCTION__))
;
107 // We can be one of the intermediate counts, but if we are the last
108 // VclPtr keeping this object alive, then something forgot to call dispose().
109 assert((!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1)(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
110 && "someone forgot to call dispose()")(static_cast <bool> ((!m_rInnerRef.get() || m_rInnerRef
->isDisposed() || m_rInnerRef->getRefCount() > 1) &&
"someone forgot to call dispose()") ? void (0) : __assert_fail
("(!m_rInnerRef.get() || m_rInnerRef->isDisposed() || m_rInnerRef->getRefCount() > 1) && \"someone forgot to call dispose()\""
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 110, __extension__ __PRETTY_FUNCTION__))
;
111 }
112 VclPtr(VclPtr const &) = default;
113 VclPtr(VclPtr &&) = default;
114 VclPtr & operator =(VclPtr const &) = default;
115 VclPtr & operator =(VclPtr &&) = default;
116#endif
117
118 /**
119 * A construction helper for VclPtr. Since VclPtr types are created
120 * with a reference-count of one - to help fit into the existing
121 * code-flow; this helps us to construct them easily.
122 *
123 * For more details on the design please see vcl/README.lifecycle
124 *
125 * @tparam reference_type must be a subclass of vcl::Window
126 */
127 template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
128 {
129 return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
130 }
131
132 /** Probably most common used: handle->someBodyOp().
133 */
134 reference_type * operator->() const
135 {
136 return m_rInnerRef.get();
137 }
138
139 /** Get the body. Can be used instead of operator->().
140 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
141 are the same.
142 */
143 reference_type * get() const
144 {
145 return m_rInnerRef.get();
146 }
147
148 void set(reference_type *pBody)
149 {
150 m_rInnerRef.set(pBody);
151 }
152
153 void reset(reference_type *pBody)
154 {
155 m_rInnerRef.set(pBody);
156 }
157
158 /** Up-casting copy assignment operator.
159
160 Does not work for up-casts to ambiguous bases.
161
162 @param rRef another reference
163 */
164 template<typename derived_type>
165 typename std::enable_if<
166 std::is_base_of<reference_type, derived_type>::value,
167 VclPtr &>::type
168 operator =(VclPtr<derived_type> const & rRef)
169 {
170 m_rInnerRef.set(rRef.get());
171 return *this;
172 }
173
174 VclPtr & operator =(reference_type * pBody)
175 {
176 m_rInnerRef.set(pBody);
177 return *this;
178 }
179
180 operator reference_type * () const
181 {
182 return m_rInnerRef.get();
183 }
184
185 explicit operator bool () const
186 {
187 return m_rInnerRef.get() != nullptr;
188 }
189
190 void clear()
191 {
192 m_rInnerRef.clear();
193 }
194
195 void reset()
196 {
197 m_rInnerRef.clear();
198 }
199
200 void disposeAndClear()
201 {
202 // hold it alive for the lifetime of this method
203 ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
2
Calling copy constructor for 'Reference<vcl::Window>'
5
Returning from copy constructor for 'Reference<vcl::Window>'
204 m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
6
Calling 'Reference::clear'
13
Returning; memory was released
205 if (aTmp.get()) {
14
Calling 'Reference::get'
206 aTmp->disposeOnce();
207 }
208 }
209
210 /** Needed to place VclPtr's into STL collection.
211 */
212 bool operator< (const VclPtr<reference_type> & handle) const
213 {
214 return (m_rInnerRef < handle.m_rInnerRef);
215 }
216}; // class VclPtr
217
218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
220 return p1.get() == p2.get();
221}
222
223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
225 return p1.get() == p2;
226}
227
228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
229 return p1.get() == p2;
230}
231
232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
234 return p1 == p2.get();
235}
236
237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
238 return p1 == p2.get();
239}
240
241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
243 return !(p1 == p2);
244}
245
246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
248 return !(p1 == p2);
249}
250
251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
252 return !(p1 == p2);
253}
254
255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
257 return !(p1 == p2);
258}
259
260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
261 return !(p1 == p2);
262}
263
264/**
265 * A construction helper for a temporary VclPtr. Since VclPtr types
266 * are created with a reference-count of one - to help fit into
267 * the existing code-flow; this helps us to construct them easily.
268 * see also VclPtr::Create and ScopedVclPtr
269 *
270 * For more details on the design please see vcl/README.lifecycle
271 *
272 * @param reference_type must be a subclass of vcl::Window
273 */
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
278 template<typename... Arg> VclPtrInstance(Arg &&... arg)
279 : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
280 {
281 }
282
283 /**
284 * Override and disallow this, to prevent people accidentally calling it and actually
285 * getting VclPtr::Create and getting a naked VclPtr<> instance
286 */
287 template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};
289
290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
294 /** Constructor...
295 */
296 ScopedVclPtr()
297 : VclPtr<reference_type>()
298 {}
299
300 /** Constructor
301 */
302 ScopedVclPtr (reference_type * pBody)
303 : VclPtr<reference_type>(pBody)
304 {}
305
306 /** Copy constructor...
307 */
308 ScopedVclPtr (const VclPtr<reference_type> & handle)
309 : VclPtr<reference_type>(handle)
310 {}
311
312 /**
313 Assignment that releases the last reference.
314 */
315 void disposeAndReset(reference_type *pBody)
316 {
317 if (pBody != this->get()) {
318 VclPtr<reference_type>::disposeAndClear();
319 VclPtr<reference_type>::set(pBody);
320 }
321 }
322
323 /**
324 Assignment that releases the last reference.
325 */
326 ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
327 {
328 disposeAndReset(pBody);
329 return *this;
330 }
331
332 /** Up-casting conversion constructor: Copies interface reference.
333
334 Does not work for up-casts to ambiguous bases. For the special case of
335 up-casting to Reference< XInterface >, see the corresponding conversion
336 operator.
337
338 @param rRef another reference
339 */
340 template< class derived_type >
341 ScopedVclPtr(
342 const VclPtr< derived_type > & rRef,
343 typename std::enable_if<
344 std::is_base_of<reference_type, derived_type>::value, int>::type
345 = 0 )
346 : VclPtr<reference_type>( rRef )
347 {
348 }
349
350 /** Up-casting assignment operator.
351
352 Does not work for up-casts to ambiguous bases.
353
354 @param rRef another VclPtr
355 */
356 template<typename derived_type>
357 typename std::enable_if<
358 std::is_base_of<reference_type, derived_type>::value,
359 ScopedVclPtr &>::type
360 operator =(VclPtr<derived_type> const & rRef)
361 {
362 disposeAndReset(rRef.get());
363 return *this;
364 }
365
366 /**
367 * Override and disallow this, to prevent people accidentally calling it and actually
368 * getting VclPtr::Create and getting a naked VclPtr<> instance
369 */
370 template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;
371
372 ~ScopedVclPtr()
373 {
374 VclPtr<reference_type>::disposeAndClear();
375 assert(VclPtr<reference_type>::get() == nullptr)(static_cast <bool> (VclPtr<reference_type>::get(
) == nullptr) ? void (0) : __assert_fail ("VclPtr<reference_type>::get() == nullptr"
, "/home/maarten/src/libreoffice/core/include/vcl/vclptr.hxx"
, 375, __extension__ __PRETTY_FUNCTION__))
; // make sure there are no lingering references
376 }
377
378private:
379 // Most likely we don't want this default copy-constructor.
380 ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
381 // And certainly we don't want a default assignment operator.
382 ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
383 // And disallow reset as that doesn't call disposeAndClear on the original reference
384 void reset() = delete;
385 void reset(reference_type *pBody) = delete;
386
387protected:
388 ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
389 : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
390 {}
391};
392
393/**
394 * A construction helper for ScopedVclPtr. Since VclPtr types are created
395 * with a reference-count of one - to help fit into the existing
396 * code-flow; this helps us to construct them easily.
397 *
398 * For more details on the design please see vcl/README.lifecycle
399 *
400 * @param reference_type must be a subclass of vcl::Window
401 */
402#if defined _MSC_VER
403#pragma warning(push)
404#pragma warning(disable: 4521) // " multiple copy constructors specified"
405#endif
406template <class reference_type>
407class SAL_WARN_UNUSED__attribute__((warn_unused)) ScopedVclPtrInstance final : public ScopedVclPtr<reference_type>
408{
409public:
410 template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
411 : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
412 {
413 }
414
415 /**
416 * Override and disallow this, to prevent people accidentally calling it and actually
417 * getting VclPtr::Create and getting a naked VclPtr<> instance
418 */
419 template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;
420
421private:
422 // Prevent the above perfect forwarding ctor from hijacking (accidental)
423 // attempts at ScopedVclPtrInstance copy construction (where the hijacking
424 // would typically lead to somewhat obscure error messages); both non-const
425 // and const variants are needed here, as the ScopedVclPtr base class has a
426 // const--variant copy ctor, so the implicitly declared copy ctor for
427 // ScopedVclPtrInstance would also be the const variant, so non-const copy
428 // construction attempts would be hijacked by the perfect forwarding ctor;
429 // but if we only declared a non-const variant here, the const variant would
430 // no longer be implicitly declared (as there would already be an explicitly
431 // declared copy ctor), so const copy construction attempts would then be
432 // hijacked by the perfect forwarding ctor:
433 ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
434 ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif
439
440#endif // INCLUDED_VCL_PTR_HXX
441
442/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

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

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX
22
23#include "sal/config.h"
24
25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif
31
32#include "sal/types.h"
33
34namespace rtl
35{
36
37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
42 /** The <b>reference_type</b> body pointer.
43 */
44 reference_type * m_pBody;
45
46
47public:
48 /** Constructor...
49 */
50 Reference()
51 : m_pBody (NULL__null)
52 {}
53
54
55 /** Constructor...
56 */
57 Reference (reference_type * pBody, __sal_NoAcquire)
58 : m_pBody (pBody)
59 {
60 }
61
62 /** Constructor...
63 */
64 Reference (reference_type * pBody)
65 : m_pBody (pBody)
66 {
67 if (m_pBody)
68 m_pBody->acquire();
69 }
70
71 /** Copy constructor...
72 */
73 Reference (const Reference<reference_type> & handle)
74 : m_pBody (handle.m_pBody)
75 {
76 if (m_pBody)
3
Assuming field 'm_pBody' is non-null
4
Taking true branch
77 m_pBody->acquire();
78 }
79
80#ifdef LIBO_INTERNAL_ONLY1
81 /** Move constructor...
82 */
83 Reference (Reference<reference_type> && handle) noexcept
84 : m_pBody (handle.m_pBody)
85 {
86 handle.m_pBody = nullptr;
87 }
88#endif
89
90#if defined LIBO_INTERNAL_ONLY1
91 /** Up-casting conversion constructor: Copies interface reference.
92
93 Does not work for up-casts to ambiguous bases.
94
95 @param rRef another reference
96 */
97 template< class derived_type >
98 inline Reference(
99 const Reference< derived_type > & rRef,
100 std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
101 : m_pBody (rRef.get())
102 {
103 if (m_pBody)
104 m_pBody->acquire();
105 }
106#endif
107
108 /** Destructor...
109 */
110 ~Reference() COVERITY_NOEXCEPT_FALSE
111 {
112 if (m_pBody)
113 m_pBody->release();
114 }
115
116 /** Set...
117 Similar to assignment.
118 */
119 Reference<reference_type> &
120 SAL_CALL set (reference_type * pBody)
121 {
122 if (pBody)
123 pBody->acquire();
124 reference_type * const pOld = m_pBody;
125 m_pBody = pBody;
126 if (pOld)
127 pOld->release();
128 return *this;
129 }
130
131 /** Assignment.
132 Unbinds this instance from its body (if bound) and
133 bind it to the body represented by the handle.
134 */
135 Reference<reference_type> &
136 SAL_CALL operator= (const Reference<reference_type> & handle)
137 {
138 return set( handle.m_pBody );
139 }
140
141#ifdef LIBO_INTERNAL_ONLY1
142 /** Assignment.
143 * Unbinds this instance from its body (if bound),
144 * bind it to the body represented by the handle, and
145 * set the body represented by the handle to nullptr.
146 */
147 Reference<reference_type> &
148 operator= (Reference<reference_type> && handle)
149 {
150 // self-movement guts ourself
151 if (m_pBody)
152 m_pBody->release();
153 m_pBody = handle.m_pBody;
154 handle.m_pBody = nullptr;
155 return *this;
156 }
157#endif
158
159 /** Assignment...
160 */
161 Reference<reference_type> &
162 SAL_CALL operator= (reference_type * pBody)
163 {
164 return set( pBody );
165 }
166
167 /** Unbind the body from this handle.
168 Note that for a handle representing a large body,
169 "handle.clear().set(new body());" _might_
170 perform a little bit better than "handle.set(new body());",
171 since in the second case two large objects exist in memory
172 (the old body and the new body).
173 */
174 Reference<reference_type> & SAL_CALL clear()
175 {
176 if (m_pBody
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
6.1
Field 'm_pBody' is non-null
)
7
Taking true branch
177 {
178 reference_type * const pOld = m_pBody;
179 m_pBody = NULL__null;
180 pOld->release();
8
Calling 'VclReferenceBase::release'
12
Returning; memory was released
181 }
182 return *this;
183 }
184
185
186 /** Get the body. Can be used instead of operator->().
187 I.e. handle->someBodyOp() and handle.get()->someBodyOp()
188 are the same.
189 */
190 reference_type * SAL_CALL get() const
191 {
192 return m_pBody;
15
Use of memory after it is freed
193 }
194
195
196 /** Probably most common used: handle->someBodyOp().
197 */
198 reference_type * SAL_CALL operator->() const
199 {
200 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 200, __extension__ __PRETTY_FUNCTION__))
;
201 return m_pBody;
202 }
203
204
205 /** Allows (*handle).someBodyOp().
206 */
207 reference_type & SAL_CALL operator*() const
208 {
209 assert(m_pBody != NULL)(static_cast <bool> (m_pBody != __null) ? void (0) : __assert_fail
("m_pBody != NULL", "/home/maarten/src/libreoffice/core/include/rtl/ref.hxx"
, 209, __extension__ __PRETTY_FUNCTION__))
;
210 return *m_pBody;
211 }
212
213
214 /** Returns True if the handle does point to a valid body.
215 */
216 bool SAL_CALL is() const
217 {
218 return (m_pBody != NULL__null);
219 }
220
221#if defined LIBO_INTERNAL_ONLY1
222 /** Returns True if the handle does point to a valid body.
223 */
224 explicit operator bool() const
225 {
226 return is();
227 }
228#endif
229
230 /** Returns True if this points to pBody.
231 */
232 bool SAL_CALL operator== (const reference_type * pBody) const
233 {
234 return (m_pBody == pBody);
235 }
236
237
238 /** Returns True if handle points to the same body.
239 */
240 bool
241 SAL_CALL operator== (const Reference<reference_type> & handle) const
242 {
243 return (m_pBody == handle.m_pBody);
244 }
245
246
247 /** Needed to place References into STL collection.
248 */
249 bool
250 SAL_CALL operator!= (const Reference<reference_type> & handle) const
251 {
252 return (m_pBody != handle.m_pBody);
253 }
254
255
256 /** Needed to place References into STL collection.
257 */
258 bool
259 SAL_CALL operator< (const Reference<reference_type> & handle) const
260 {
261 return (m_pBody < handle.m_pBody);
262 }
263
264
265 /** Needed to place References into STL collection.
266 */
267 bool
268 SAL_CALL operator> (const Reference<reference_type> & handle) const
269 {
270 return (m_pBody > handle.m_pBody);
271 }
272};
273
274} // namespace rtl
275
276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{
279
280/// @cond INTERNAL
281/**
282 Make rtl::Reference hashable by default for use in STL containers.
283
284 @since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
289 std::size_t operator()(::rtl::Reference<T> const & s) const
290 { return std::size_t(s.get()); }
291};
292/// @endcond
293
294}
295
296#endif
297
298#endif /* ! INCLUDED_RTL_REF_HXX */
299
300/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

/home/maarten/src/libreoffice/core/include/vcl/vclreferencebase.hxx

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef INCLUDED_VCL_Reference_HXX
20#define INCLUDED_VCL_Reference_HXX
21
22#include <vcl/dllapi.h>
23#include <osl/interlck.h>
24
25class VCL_DLLPUBLIC__attribute__ ((visibility("default"))) VclReferenceBase
26{
27 mutable oslInterlockedCount mnRefCnt;
28
29 template<typename T> friend class VclPtr;
30
31public:
32 void acquire() const
33 {
34 osl_atomic_increment(&mnRefCnt)__sync_add_and_fetch((&mnRefCnt), 1);
35 }
36
37 void release() const
38 {
39 if (osl_atomic_decrement(&mnRefCnt)__sync_sub_and_fetch((&mnRefCnt), 1) == 0)
9
Assuming the condition is true
10
Taking true branch
40 delete this;
11
Memory is released
41 }
42#ifdef DBG_UTIL
43#ifndef _WIN32
44 sal_Int32 getRefCount() const { return mnRefCnt; }
45#endif
46#endif
47
48
49private:
50 VclReferenceBase(const VclReferenceBase&) = delete;
51 VclReferenceBase& operator=(const VclReferenceBase&) = delete;
52
53 bool mbDisposed : 1;
54
55protected:
56 VclReferenceBase();
57protected:
58 virtual ~VclReferenceBase();
59
60protected:
61 virtual void dispose();
62
63public:
64 void disposeOnce();
65 bool isDisposed() const { return mbDisposed; }
66
67};
68#endif