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

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

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-unknown-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name dockwin.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/dialog/dockwin.cxx

/home/maarten/src/libreoffice/core/sfx2/source/dialog/dockwin.cxx

→

1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
*   Licensed to the Apache Software Foundation (ASF) under one or more
*   contributor license agreements. See the NOTICE file distributed
*   with this work for additional information regarding copyright
*   ownership. The ASF licenses this file to you under the Apache
*   License, Version 2.0 (the "License"); you may not use this file
*   except in compliance with the License. You may obtain a copy of
*   the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/

20#include <svl/eitem.hxx>
21#include <svl/solar.hrc>
22#include <vcl/event.hxx>
23#include <vcl/layout.hxx>
24#include <vcl/settings.hxx>

26#include <vcl/svapp.hxx>
27#include <vcl/timer.hxx>
28#include <vcl/idle.hxx>
29#include <o3tl/safeint.hxx>
30#include <osl/diagnose.h>
31#include <rtl/instance.hxx>
32#include <toolkit/helper/vclunohelper.hxx>
33#include <tools/debug.hxx>
34#include <comphelper/processfactory.hxx>
35#include <comphelper/propertysequence.hxx>

37#include <sfx2/dockwin.hxx>
38#include <sfx2/bindings.hxx>
39#include <sfx2/viewfrm.hxx>
40#include <sfx2/dispatch.hxx>
41#include <workwin.hxx>
42#include <splitwin.hxx>
43#include <sfx2/viewsh.hxx>

45#include <com/sun/star/beans/UnknownPropertyException.hpp>
46#include <com/sun/star/lang/XSingleComponentFactory.hpp>
47#include <com/sun/star/awt/XWindow.hpp>
48#include <com/sun/star/uno/XComponentContext.hpp>
49#include <com/sun/star/frame/ModuleManager.hpp>
50#include <com/sun/star/container/XNameAccess.hpp>
51#include <com/sun/star/ui/theWindowStateConfiguration.hpp>
52#include <com/sun/star/ui/theWindowContentFactoryManager.hpp>

54#define MAX_TOGGLEAREA_WIDTH20        20
55#define MAX_TOGGLEAREA_HEIGHT20       20

57using namespace ::com::sun::star;

59// If you want to change the number you also have to:
60// - Add new slot ids to sfxsids.hrc
61// - Add new slots to frmslots.sdi
62// - Add new slot definitions to sfx.sdi
63const int NUM_OF_DOCKINGWINDOWS = 10;

65namespace {

67class SfxTitleDockingWindow : public SfxDockingWindow
68{
  VclPtr<vcl::Window>   m_pWrappedWindow;

71public:
                      SfxTitleDockingWindow(
                          SfxBindings* pBindings ,
                          SfxChildWindow* pChildWin ,
                          vcl::Window* pParent ,
                          WinBits nBits);
  virtual             ~SfxTitleDockingWindow() override;
  virtual void        dispose() override;

  vcl::Window*        GetWrappedWindow() const { return m_pWrappedWindow; }
  void                SetWrappedWindow(vcl::Window* const pWindow);

  virtual void        StateChanged( StateChangedType nType ) override;
  virtual void        Resize() override;
  virtual void        Resizing( Size& rSize ) override;
86};

  struct WindowState
  {
      OUString sTitle;
  };
92}

94static bool lcl_getWindowState( const uno::Reference< container::XNameAccess >& xWindowStateMgr, const OUString& rResourceURL, WindowState& rWindowState )
95{
  bool bResult = false;

  try
  {
      uno::Any a;
      uno::Sequence< beans::PropertyValue > aWindowState;
      a = xWindowStateMgr->getByName( rResourceURL );
      if ( a >>= aWindowState )
      {
          for ( const auto& rProp : std::as_const(aWindowState) )
          {
              if ( rProp.Name == "UIName" )
              {
                  rProp.Value >>= rWindowState.sTitle;
              }
          }
      }

      bResult = true;
  }
  catch ( container::NoSuchElementException& )
  {
      bResult = false;
  }

  return bResult;
122}

124SfxDockingWrapper::SfxDockingWrapper( vcl::Window* pParentWnd ,
                                    sal_uInt16 nId ,
                                    SfxBindings* pBindings ,
                                    SfxChildWinInfo* pInfo )
                  : SfxChildWindow( pParentWnd , nId )
129{
  uno::Reference< uno::XComponentContext > xContext = ::comphelper::getProcessComponentContext();

  VclPtr<SfxTitleDockingWindow> pTitleDockWindow = VclPtr<SfxTitleDockingWindow>::Create( pBindings, this, pParentWnd,
      WB_STDDOCKWIN | WB_CLIPCHILDREN | WB_SIZEABLE | WB_3DLOOK | WB_ROLLABLE);
  SetWindow( pTitleDockWindow );

  // Use factory manager to retrieve XWindow factory. That can be used to instantiate
  // the real window factory.
  uno::Reference< lang::XSingleComponentFactory > xFactoryMgr = ui::theWindowContentFactoryManager::get(xContext);

  SfxDispatcher* pDispatcher = pBindings->GetDispatcher();
  uno::Reference< frame::XFrame > xFrame = pDispatcher->GetFrame()->GetFrame().GetFrameInterface();
  // create a resource URL from the nId provided by the sfx2
  OUString aResourceURL =  "private:resource/dockingwindow/" + OUString::number(nId);
  uno::Sequence<uno::Any> aArgs(comphelper::InitAnyPropertySequence(
  {
      {"Frame", uno::Any(xFrame)},
      {"ResourceURL", uno::Any(aResourceURL)},
  }));

  uno::Reference< awt::XWindow > xWindow;
  try
  {
      xWindow.set(
          xFactoryMgr->createInstanceWithArgumentsAndContext( aArgs, xContext ),
          uno::UNO_QUERY );

      static uno::WeakReference< frame::XModuleManager2 >  s_xModuleManager;

      uno::Reference< frame::XModuleManager2 > xModuleManager( s_xModuleManager );
      if ( !xModuleManager.is() )
      {
          xModuleManager = frame::ModuleManager::create(xContext);
          s_xModuleManager = xModuleManager;
      }

      static uno::WeakReference< container::XNameAccess > s_xWindowStateConfiguration;

      uno::Reference< container::XNameAccess > xWindowStateConfiguration( s_xWindowStateConfiguration );
      if ( !xWindowStateConfiguration.is() )
      {
          xWindowStateConfiguration = ui::theWindowStateConfiguration::get( xContext );
          s_xWindowStateConfiguration = xWindowStateConfiguration;
      }

      OUString sModuleIdentifier = xModuleManager->identify( xFrame );

      uno::Reference< container::XNameAccess > xModuleWindowState(
                                                  xWindowStateConfiguration->getByName( sModuleIdentifier ),
                                                  uno::UNO_QUERY );
      if ( xModuleWindowState.is() )
      {
          WindowState aDockWinState;
          if ( lcl_getWindowState( xModuleWindowState, aResourceURL, aDockWinState ))
              pTitleDockWindow->SetText( aDockWinState.sTitle );
      }
  }
  catch ( beans::UnknownPropertyException& )
  {
  }
  catch ( uno::RuntimeException& )
  {
  }
  catch ( uno::Exception& )
  {
  }

  VclPtr<vcl::Window> pContentWindow = VCLUnoHelper::GetWindow(xWindow);
  if ( pContentWindow )
      pContentWindow->SetStyle( pContentWindow->GetStyle() | WB_DIALOGCONTROL | WB_CHILDDLGCTRL );
  pTitleDockWindow->SetWrappedWindow(pContentWindow);

  GetWindow()->SetOutputSizePixel( Size( 270, 240 ) );

  static_cast<SfxDockingWindow*>( GetWindow() )->Initialize( pInfo );
  SetHideNotDelete( true );
206}

208std::unique_ptr<SfxChildWindow> SfxDockingWrapper::CreateImpl(vcl::Window *pParent, sal_uInt16 nId,
                                            SfxBindings *pBindings, SfxChildWinInfo* pInfo)
210{
  return std::make_unique<SfxDockingWrapper>(pParent, nId, pBindings, pInfo);
212}

214void SfxDockingWrapper::RegisterChildWindow (bool bVis, SfxModule *pMod, SfxChildWindowFlags nFlags)
215{
  // pre-register a couple of docking windows
  for (int i=0; i < NUM_OF_DOCKINGWINDOWS; i++ )
  {
      sal_uInt16 nID = sal_uInt16(SID_DOCKWIN_START9800+i);
      auto pFact = std::make_unique<SfxChildWinFactory>( SfxDockingWrapper::CreateImpl, nID, 0xffff );
      pFact->aInfo.nFlags |= nFlags;
      pFact->aInfo.bVisible = bVis;
      SfxChildWindow::RegisterChildWindow(pMod, std::move(pFact));
  }
225}

227SfxChildWinInfo  SfxDockingWrapper::GetInfo() const
228{
  SfxChildWinInfo aInfo = SfxChildWindow::GetInfo();
  static_cast<SfxDockingWindow*>(GetWindow())->FillInfo( aInfo );
  return aInfo;
232};

234SfxTitleDockingWindow::SfxTitleDockingWindow(SfxBindings* pBind, SfxChildWindow* pChildWin,
                                           vcl::Window* pParent, WinBits nBits)
  : SfxDockingWindow(pBind, pChildWin, pParent, nBits)
  , m_pWrappedWindow(nullptr)
238{
239}

241SfxTitleDockingWindow::~SfxTitleDockingWindow()
242{
  disposeOnce();
244}

246void SfxTitleDockingWindow::dispose()
247{
  m_pWrappedWindow.disposeAndClear();
  SfxDockingWindow::dispose();
250}

252void SfxTitleDockingWindow::SetWrappedWindow( vcl::Window* const pWindow )
253{
  m_pWrappedWindow = pWindow;
  if (m_pWrappedWindow)
  {
      m_pWrappedWindow->SetParent(this);
      m_pWrappedWindow->SetSizePixel( GetOutputSizePixel() );
      m_pWrappedWindow->Show();
  }
261}

263void SfxTitleDockingWindow::StateChanged( StateChangedType nType )
264{
  if ( nType == StateChangedType::InitShow )
  {
      vcl::Window* pWindow = GetWrappedWindow();
      if ( pWindow )
      {
          pWindow->SetSizePixel( GetOutputSizePixel() );
          pWindow->Show();
      }
  }

  SfxDockingWindow::StateChanged(nType);
276}

278void SfxTitleDockingWindow::Resize()
279{
  SfxDockingWindow::Resize();
  if (m_pWrappedWindow)
      m_pWrappedWindow->SetSizePixel( GetOutputSizePixel() );
283}

285void SfxTitleDockingWindow::Resizing( Size &rSize )
286{
  SfxDockingWindow::Resizing( rSize );
  if (m_pWrappedWindow)
      m_pWrappedWindow->SetSizePixel( GetOutputSizePixel() );
290}

292namespace
293{
  struct ChildrenRegisteredMap : public rtl::Static< bool, ChildrenRegisteredMap > {};
295}

297static bool lcl_checkDockingWindowID( sal_uInt16 nID )
298{
  return nID >= SID_DOCKWIN_START9800 && nID < o3tl::make_unsigned(SID_DOCKWIN_START9800+NUM_OF_DOCKINGWINDOWS);
300}

302static SfxWorkWindow* lcl_getWorkWindowFromXFrame( const uno::Reference< frame::XFrame >& rFrame )
303{
  // We need to find the corresponding SfxFrame of our XFrame
  SfxFrame* pFrame  = SfxFrame::GetFirst();
  SfxFrame* pXFrame = nullptr;
  while ( pFrame )
  {
      uno::Reference< frame::XFrame > xViewShellFrame( pFrame->GetFrameInterface() );
      if ( xViewShellFrame == rFrame )
      {
          pXFrame = pFrame;
          break;
      }
      else
          pFrame = SfxFrame::GetNext( *pFrame );
  }

  // If we have a SfxFrame we can retrieve the work window (Sfx layout manager for docking windows)
  if ( pXFrame )
      return pXFrame->GetWorkWindow_Impl();
  else
      return nullptr;
324}

326/** Factory function used by the framework layout manager to "create" a docking window with a special name.
  The string rDockingWindowName MUST BE a valid ID! The ID is pre-defined by a certain slot range located
  in sfxsids.hrc (currently SID_DOCKWIN_START = 9800).
329*/
330void SfxDockingWindowFactory( const uno::Reference< frame::XFrame >& rFrame, const OUString& rDockingWindowName )
331{
  SolarMutexGuard aGuard;
  sal_uInt16 nID = sal_uInt16(rDockingWindowName.toInt32());

  // Check the range of the provided ID otherwise nothing will happen
  if ( !lcl_checkDockingWindowID( nID ))
      return;

  SfxWorkWindow* pWorkWindow = lcl_getWorkWindowFromXFrame( rFrame );
  if ( pWorkWindow )
  {
      SfxChildWindow* pChildWindow = pWorkWindow->GetChildWindow_Impl(nID);
      if ( !pChildWindow )
      {
          // Register window at the workwindow child window list
          pWorkWindow->SetChildWindow_Impl( nID, true, false );
      }
  }
349}

351/** Function used by the framework layout manager to determine the visibility state of a docking window with
  a special name. The string rDockingWindowName MUST BE a valid ID! The ID is pre-defined by a certain slot
  range located in sfxsids.hrc (currently SID_DOCKWIN_START = 9800).
354*/
355bool IsDockingWindowVisible( const uno::Reference< frame::XFrame >& rFrame, const OUString& rDockingWindowName )
356{
  SolarMutexGuard aGuard;

  sal_uInt16 nID = sal_uInt16(rDockingWindowName.toInt32());

  // Check the range of the provided ID otherwise nothing will happen
  if ( lcl_checkDockingWindowID( nID ))
  {
      SfxWorkWindow* pWorkWindow = lcl_getWorkWindowFromXFrame( rFrame );
      if ( pWorkWindow )
      {
          SfxChildWindow* pChildWindow = pWorkWindow->GetChildWindow_Impl(nID);
          if ( pChildWindow )
              return true;
      }
  }

  return false;
374}

376class SfxDockingWindow_Impl
377{
378friend class SfxDockingWindow;

  SfxChildAlignment   eLastAlignment;
  SfxChildAlignment   eDockAlignment;
  bool                bConstructed;
  Size                aMinSize;
  VclPtr<SfxSplitWindow>  pSplitWin;
  Idle                aMoveIdle;

  // The following members are only valid in the time from startDocking to
  // EndDocking:
  Size                aSplitSize;
  long                nHorizontalSize;
  long                nVerticalSize;
  sal_uInt16          nLine;
  sal_uInt16          nPos;
  sal_uInt16          nDockLine;
  sal_uInt16          nDockPos;
  bool                bNewLine;
  bool                bDockingPrevented;
  OString             aWinState;

  explicit            SfxDockingWindow_Impl(SfxDockingWindow *pBase);
  SfxChildAlignment   GetLastAlignment() const
                      { return eLastAlignment; }
  void                SetLastAlignment(SfxChildAlignment eAlign)
                      { eLastAlignment = eAlign; }
  SfxChildAlignment   GetDockAlignment() const
                      { return eDockAlignment; }
  void                SetDockAlignment(SfxChildAlignment eAlign)
                      { eDockAlignment = eAlign; }
409};

411SfxDockingWindow_Impl::SfxDockingWindow_Impl(SfxDockingWindow* pBase)
  :eLastAlignment(SfxChildAlignment::NOALIGNMENT)
  ,eDockAlignment(SfxChildAlignment::NOALIGNMENT)
  ,bConstructed(false)
  ,pSplitWin(nullptr)
  ,nHorizontalSize(0)
  ,nVerticalSize(0)
  ,nLine(0)
  ,nPos(0)
  ,nDockLine(0)
  ,nDockPos(0)
  ,bNewLine(false)
  ,bDockingPrevented(false)
424{
  aMoveIdle.SetPriority(TaskPriority::RESIZE);
  aMoveIdle.SetInvokeHandler(LINK(pBase,SfxDockingWindow,TimerHdl)::tools::detail::makeLink( ::tools::detail::castTo<SfxDockingWindow
 *>(pBase), &SfxDockingWindow::LinkStubTimerHdl));
  aMoveIdle.SetDebugName( "sfx::SfxDockingWindow_Impl aMoveIdle" );
428}

430/*  [Description]

  This virtual method of the class FloatingWindow keeps track of changes in
  FloatingSize. If this method is overridden by a derived class,
  then the FloatingWindow: Resize() must also be called.
435*/
436void SfxDockingWindow::Resize()
437{
  DockingWindow::Resize();
  Invalidate();
  if ( !pImpl || !pImpl->bConstructed || !pMgr )
      return;

  if ( IsFloatingMode() )
  {
      // start timer for saving window status information
      pImpl->aMoveIdle.Start();
  }
  else
  {
      Size aSize( GetSizePixel() );
      switch ( pImpl->GetDockAlignment() )
      {
          case SfxChildAlignment::LEFT:
          case SfxChildAlignment::FIRSTLEFT:
          case SfxChildAlignment::LASTLEFT:
          case SfxChildAlignment::RIGHT:
          case SfxChildAlignment::FIRSTRIGHT:
          case SfxChildAlignment::LASTRIGHT:
              pImpl->nHorizontalSize = aSize.Width();
              pImpl->aSplitSize = aSize;
              break;
          case SfxChildAlignment::TOP:
          case SfxChildAlignment::LOWESTTOP:
          case SfxChildAlignment::HIGHESTTOP:
          case SfxChildAlignment::BOTTOM:
          case SfxChildAlignment::HIGHESTBOTTOM:
          case SfxChildAlignment::LOWESTBOTTOM:
              pImpl->nVerticalSize = aSize.Height();
              pImpl->aSplitSize = aSize;
              break;
          default:
              break;
      }
  }
475}

477/*  [Description]

  This virtual method of the class DockingWindow makes it possible to
  intervene in the switching of the floating mode.
  If this method is overridden by a derived class,
  then the SfxDockingWindow::PrepareToggleFloatingMode() must be called
  afterwards, if not FALSE is returned.
484*/
485bool SfxDockingWindow::PrepareToggleFloatingMode()
486{
  if (!pImpl || !pImpl->bConstructed)
      return true;

  if ( (Application::IsInModalMode() && IsFloatingMode()) || !pMgr )
      return false;

  if ( pImpl->bDockingPrevented )
      return false;

  if (!IsFloatingMode())
  {
      // Test, if FloatingMode is permitted.
      if ( CheckAlignment(GetAlignment(),SfxChildAlignment::NOALIGNMENT) != SfxChildAlignment::NOALIGNMENT )
          return false;

      if ( pImpl->pSplitWin )
      {
          // The DockingWindow is inside a SplitWindow and will be teared of.
          pImpl->pSplitWin->RemoveWindow(this/*, sal_False*/);
          pImpl->pSplitWin = nullptr;
      }
  }
  else if ( pMgr )
  {
      pImpl->aWinState = GetFloatingWindow()->GetWindowState();

      // Test if it is allowed to dock,
      if (CheckAlignment(GetAlignment(),pImpl->GetLastAlignment()) == SfxChildAlignment::NOALIGNMENT)
          return false;

      // Test, if the Workwindow allows for docking at the moment.
      SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();
      if ( !pWorkWin->IsDockingAllowed() || !pWorkWin->IsInternalDockingAllowed() )
          return false;
  }

  return true;
524}

526/*  [Description]

  This virtual method of the DockingWindow class sets the internal data of
  the SfxDockingWindow and ensures the correct alignment on the parent window.
  Through PrepareToggleFloatMode and Initialize it is ensured that
  pImpl-> GetLastAlignment() always delivers an allowed alignment. If this
  method is overridden by a derived class, then first the
  SfxDockingWindow::ToggleFloatingMode() must be called.
534*/
535void SfxDockingWindow::ToggleFloatingMode()
536{
  if ( !pImpl || !pImpl->bConstructed || !pMgr )
      return;                                 // No Handler call

  // Remember old alignment and then switch.
  // SV has already switched, but the alignment SfxDockingWindow is still
  // the old one. What I was before?
  SfxChildAlignment eLastAlign = GetAlignment();

  SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();

  if (IsFloatingMode())
  {
      SetAlignment(SfxChildAlignment::NOALIGNMENT);
      if ( !pImpl->aWinState.isEmpty() )
          GetFloatingWindow()->SetWindowState( pImpl->aWinState );
      else
          GetFloatingWindow()->SetOutputSizePixel( GetFloatingSize() );
  }
  else
  {
      if (pImpl->GetDockAlignment() == eLastAlign)
      {
          // If ToggleFloatingMode was called, but the DockAlignment still
          // is unchanged, then this means that it must have been a toggling
          // through DClick, so use last alignment
          SetAlignment (pImpl->GetLastAlignment());
      }
      else
      {

          // Toggling was triggered by dragging
          pImpl->nLine = pImpl->nDockLine;
          pImpl->nPos = pImpl->nDockPos;
          SetAlignment (pImpl->GetDockAlignment());
      }

      // The DockingWindow is now in a SplitWindow
      pImpl->pSplitWin = pWorkWin->GetSplitWindow_Impl(GetAlignment());

      // The LastAlignment is still the last docked
      SfxSplitWindow *pSplit = pWorkWin->GetSplitWindow_Impl(pImpl->GetLastAlignment());

      DBG_ASSERT( pSplit, "LastAlignment is not correct!" )do { if (true && (!(pSplit))) { sal_detail_logFormat(
(SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.tools"), ("/home/maarten/src/libreoffice/core/sfx2/source/dialog/dockwin.cxx"
 ":" "579" ": "), "%s", "LastAlignment is not correct!"); } }
 while (false);
      if ( pSplit && pSplit != pImpl->pSplitWin )
          pSplit->ReleaseWindow_Impl(this);
      if ( pImpl->GetDockAlignment() == eLastAlign )
          pImpl->pSplitWin->InsertWindow( this, pImpl->aSplitSize );
      else
          pImpl->pSplitWin->InsertWindow( this, pImpl->aSplitSize, pImpl->nLine, pImpl->nPos, pImpl->bNewLine );
      if ( !pImpl->pSplitWin->IsFadeIn() )
          pImpl->pSplitWin->FadeIn();
  }

  // Keep the old alignment for the next toggle; set it only now due to the
  // unregister SplitWindow!
  pImpl->SetLastAlignment(eLastAlign);

  // Reset DockAlignment, if EndDocking is still called
  pImpl->SetDockAlignment(GetAlignment());

  // Dock or undock SfxChildWindow correctly.
  pWorkWin->ConfigChild_Impl( SfxChildIdentifier::SPLITWINDOW, SfxDockingConfig::TOGGLEFLOATMODE, pMgr->GetType() );
599}

601/*  [Description]

  This virtual method of the DockingWindow class takes the inner and outer
  docking rectangle from the parent window. If this method is overridden by
  a derived class, then SfxDockingWindow:StartDocking() has to be called at
  the end.
607*/
608void SfxDockingWindow::StartDocking()
609{
  if ( !pImpl || !pImpl->bConstructed || !pMgr )
      return;
  SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();
  pWorkWin->ConfigChild_Impl( SfxChildIdentifier::SPLITWINDOW, SfxDockingConfig::SETDOCKINGRECTS, pMgr->GetType() );
  pImpl->SetDockAlignment(GetAlignment());

  if ( pImpl->pSplitWin )
  {
      // Get the current docking data
      pImpl->pSplitWin->GetWindowPos(this, pImpl->nLine, pImpl->nPos);
      pImpl->nDockLine = pImpl->nLine;
      pImpl->nDockPos = pImpl->nPos;
      pImpl->bNewLine = false;
  }
624}

626/*  [Description]

  This virtual method of the DockingWindow class calculates the current
  tracking rectangle. For this purpose the method CalcAlignment(RPOs, rRect)
  is used, the behavior can be influenced by the derived classes (see below).
  This method should if possible not be overwritten.
632*/
633bool SfxDockingWindow::Docking( const Point& rPos, tools::Rectangle& rRect )
634{
  if ( Application::IsInModalMode() )
      return true;

  if ( !pImpl || !pImpl->bConstructed || !pMgr )
  {
      rRect.SetSize( Size() );
      return IsFloatingMode();
  }

  SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();
  if ( pImpl->bDockingPrevented || !pWorkWin->IsInternalDockingAllowed() )
      return false;

  bool bFloatMode = false;

  if ( GetOuterRect().IsInside( rPos ) )
  {
      // Mouse within OuterRect: calculate Alignment and Rectangle
      SfxChildAlignment eAlign = CalcAlignment(rPos, rRect);
      if (eAlign == SfxChildAlignment::NOALIGNMENT)
          bFloatMode = true;
      pImpl->SetDockAlignment(eAlign);
  }
  else
  {
      // Mouse is not within OuterRect: must be FloatingWindow
      // Is this allowed?
      if (CheckAlignment(pImpl->GetDockAlignment(),SfxChildAlignment::NOALIGNMENT) != SfxChildAlignment::NOALIGNMENT)
          return false;
      bFloatMode = true;
      if ( SfxChildAlignment::NOALIGNMENT != pImpl->GetDockAlignment() )
      {
          // Due to a bug the rRect may only be changed when the
          // alignment is changed!
          pImpl->SetDockAlignment(SfxChildAlignment::NOALIGNMENT);
          rRect.SetSize(CalcDockingSize(SfxChildAlignment::NOALIGNMENT));
      }
  }

  return bFloatMode;
675}

677/** Virtual method of the DockingWindow class ensures the correct alignment on
  the parent window. If this method is overridden by a derived class, then
  SfxDockingWindow::EndDocking() must be called first.
680*/
681void SfxDockingWindow::EndDocking( const tools::Rectangle& rRect, bool bFloatMode )
682{
  if ( !pImpl || !pImpl->bConstructed || IsDockingCanceled() || !pMgr )
      return;

  SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();

  // If the alignment changes and the window is in a docked state in a
  // SplitWindow, then it must be re-registered. If it is docked again,
  // PrepareToggleFloatingMode() and ToggleFloatingMode() perform the
  // re-registered
  bool bReArrange = !bFloatMode;

  if ( bReArrange )
  {
      if ( GetAlignment() != pImpl->GetDockAlignment() )
      {
          // before Show() is called must the reassignment have been made,
          // therefore the base class can not be called
          if ( IsFloatingMode() )
              Show( false, ShowFlags::NoFocusChange );

          // Set the size for toggling.
          pImpl->aSplitSize = rRect.GetSize();
          if ( IsFloatingMode() )
          {
              SetFloatingMode( bFloatMode );
              if ( IsFloatingMode() )
                  Show( true, ShowFlags::NoFocusChange );
          }
          else
          {
              pImpl->pSplitWin->RemoveWindow(this,false);
              pImpl->nLine = pImpl->nDockLine;
              pImpl->nPos = pImpl->nDockPos;
              pImpl->pSplitWin->ReleaseWindow_Impl(this);
              pImpl->pSplitWin = pWorkWin->GetSplitWindow_Impl(pImpl->GetDockAlignment());
              pImpl->pSplitWin->InsertWindow( this, pImpl->aSplitSize, pImpl->nDockLine, pImpl->nDockPos, pImpl->bNewLine );
              if ( !pImpl->pSplitWin->IsFadeIn() )
                  pImpl->pSplitWin->FadeIn();
          }
      }
      else if ( pImpl->nLine != pImpl->nDockLine || pImpl->nPos != pImpl->nDockPos || pImpl->bNewLine )
      {
          // Moved within Splitwindows
          if ( pImpl->nLine != pImpl->nDockLine )
              pImpl->aSplitSize = rRect.GetSize();
          pImpl->pSplitWin->MoveWindow( this, pImpl->aSplitSize, pImpl->nDockLine, pImpl->nDockPos, pImpl->bNewLine );
      }
  }
  else
  {
      DockingWindow::EndDocking(rRect, bFloatMode);
  }

  SetAlignment( IsFloatingMode() ? SfxChildAlignment::NOALIGNMENT : pImpl->GetDockAlignment() );
737}

739/*  [Description]

  Virtual method of the DockingWindow class. Here, the interactive resize in
  FloatingMode can be influenced, for example by only allowing for discrete
  values for width and / or height. The base implementation prevents that the
  output size is smaller than one set with SetMinOutputSizePixel().
745*/
746void SfxDockingWindow::Resizing( Size& /*rSize*/ )
747{

749}

751/*  [Description]

  Constructor for the SfxDockingWindow class. A SfxChildWindow will be
  required because the docking is implemented in Sfx through SfxChildWindows.
755*/
756SfxDockingWindow::SfxDockingWindow( SfxBindings *pBindinx, SfxChildWindow *pCW,
  vcl::Window* pParent, WinBits nWinBits) :
  DockingWindow (pParent, nWinBits),
  pBindings(pBindinx),
  pMgr(pCW)
761{
  pImpl.reset(new SfxDockingWindow_Impl(this));
763}

765/** Constructor for the SfxDockingWindow class. A SfxChildWindow will be
  required because the docking is implemented in Sfx through SfxChildWindows.
767*/
768SfxDockingWindow::SfxDockingWindow( SfxBindings *pBindinx, SfxChildWindow *pCW,
  vcl::Window* pParent, const OString& rID, const OUString& rUIXMLDescription)
  : DockingWindow(pParent, "DockingWindow", "sfx/ui/dockingwindow.ui")
  , pBindings(pBindinx)
  , pMgr(pCW)
773{
  m_xVclContentArea = VclPtr<VclVBox>::Create(this);
1
Calling 'VclPtr::Create'→
3
←
Returned allocated memory→
4
←
Calling implicit destructor for 'VclPtr<VclVBox>'→
5
←
Calling '~Reference'→
12
←
Returning from '~Reference'→
13
←
Returning from destructor for 'VclPtr<VclVBox>'→
  m_xVclContentArea->Show();
14
←
Calling 'VclPtr::operator->'→
  m_xBuilder.reset(Application::CreateInterimBuilder(m_xVclContentArea, rUIXMLDescription, true));
  m_xContainer = m_xBuilder->weld_container(rID);

  pImpl.reset(new SfxDockingWindow_Impl(this));
780}

782/** Initialization of the SfxDockingDialog class via a SfxChildWinInfo.
  The initialization is done only in a 2nd step after the constructor, this
  constructor should be called from the derived class or from the
  SfxChildWindows.
786*/
787void SfxDockingWindow::Initialize(SfxChildWinInfo *pInfo)
788{
  if ( !pMgr )
  {
      pImpl->SetDockAlignment( SfxChildAlignment::NOALIGNMENT );
      pImpl->bConstructed = true;
      return;
  }

  if (pInfo && (pInfo->nFlags & SfxChildWindowFlags::FORCEDOCK))
      pImpl->bDockingPrevented = true;

  pImpl->aSplitSize = GetOutputSizePixel();
  if ( !GetFloatingSize().Width() )
  {
      Size aMinSize( GetMinOutputSizePixel() );
      SetFloatingSize( pImpl->aSplitSize );
      if ( pImpl->aSplitSize.Width() < aMinSize.Width() )
          pImpl->aSplitSize.setWidth( aMinSize.Width() );
      if ( pImpl->aSplitSize.Height() < aMinSize.Height() )
          pImpl->aSplitSize.setHeight( aMinSize.Height() );
  }

  bool bVertHorzRead( false );
  if (pInfo && !pInfo->aExtraString.isEmpty())
  {
      // get information about alignment, split size and position in SplitWindow
      OUString aStr;
      sal_Int32 nPos = pInfo->aExtraString.indexOf("AL:");
      if ( nPos != -1 )
      {
          // alignment information
          sal_Int32 n1 = pInfo->aExtraString.indexOf('(', nPos);
          if ( n1 != -1 )
          {
              sal_Int32 n2 = pInfo->aExtraString.indexOf(')', n1);
              if ( n2 != -1 )
              {
                  // extract alignment information from extrastring
                  aStr = pInfo->aExtraString.copy(nPos, n2 - nPos + 1);
                  pInfo->aExtraString = pInfo->aExtraString.replaceAt(nPos, n2 - nPos + 1, "");
                  aStr = aStr.replaceAt(nPos, n1-nPos+1, "");
              }
          }
      }

      if ( !aStr.isEmpty() )
      {
          // accept window state only if alignment is also set
          pImpl->aWinState = pInfo->aWinState;

          // check for valid alignment
          SfxChildAlignment eLocalAlignment = static_cast<SfxChildAlignment>(static_cast<sal_uInt16>(aStr.toInt32()));
          bool bIgnoreFloatConfig = (eLocalAlignment == SfxChildAlignment::NOALIGNMENT &&
                                     !StyleSettings::GetDockingFloatsSupported());
          if (pImpl->bDockingPrevented || bIgnoreFloatConfig)
              // docking prevented, ignore old configuration and take alignment from default
              aStr.clear();
          else
              SetAlignment( eLocalAlignment );

          SfxChildAlignment eAlign = CheckAlignment(GetAlignment(),GetAlignment());
          if ( eAlign != GetAlignment() )
          {
              OSL_FAIL("Invalid Alignment!")do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sfx2/source/dialog/dockwin.cxx"
 ":" "851" ": "), "%s", "Invalid Alignment!"); } } while (false
);
              SetAlignment( eAlign );
              aStr.clear();
          }

          // get last alignment (for toggling)
          nPos = aStr.indexOf(',');
          if ( nPos != -1 )
          {
              aStr = aStr.copy(nPos+1);
              pImpl->SetLastAlignment( static_cast<SfxChildAlignment>(static_cast<sal_uInt16>(aStr.toInt32())) );
          }

          nPos = aStr.indexOf(',');
          if ( nPos != -1 )
          {
              // get split size and position in SplitWindow
              Point aPos;
              aStr = aStr.copy(nPos+1);
              if ( GetPosSizeFromString( aStr, aPos, pImpl->aSplitSize ) )
              {
                  pImpl->nLine = pImpl->nDockLine = static_cast<sal_uInt16>(aPos.X());
                  pImpl->nPos  = pImpl->nDockPos  = static_cast<sal_uInt16>(aPos.Y());
                  pImpl->nVerticalSize = pImpl->aSplitSize.Height();
                  pImpl->nHorizontalSize = pImpl->aSplitSize.Width();
                  if ( GetSplitSizeFromString( aStr, pImpl->aSplitSize ))
                      bVertHorzRead = true;
              }
          }
      }
      else {
          OSL_FAIL( "Information is missing!" )do { if (true && (((sal_Bool)1))) { sal_detail_logFormat
((SAL_DETAIL_LOG_LEVEL_WARN), ("legacy.osl"), ("/home/maarten/src/libreoffice/core/sfx2/source/dialog/dockwin.cxx"
 ":" "882" ": "), "%s", "Information is missing!"); } } while
 (false);
      }
  }

  if ( !bVertHorzRead )
  {
      pImpl->nVerticalSize = pImpl->aSplitSize.Height();
      pImpl->nHorizontalSize = pImpl->aSplitSize.Width();
  }

  SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();
  if ( GetAlignment() != SfxChildAlignment::NOALIGNMENT )
  {
      // check if SfxWorkWindow is able to allow docking at its border
      if (
          !pWorkWin->IsDockingAllowed() ||
          !pWorkWin->IsInternalDockingAllowed() ||
          ( (GetFloatStyle() & WB_STANDALONE) && Application::IsInModalMode()) )
      {
          SetAlignment( SfxChildAlignment::NOALIGNMENT );
      }
  }

  // detect floating mode
  // toggling mode will not execute code in handlers, because pImpl->bConstructed is not set yet
  bool bFloatMode = IsFloatingMode();
  if ( bFloatMode != (GetAlignment() == SfxChildAlignment::NOALIGNMENT) )
  {
      bFloatMode = !bFloatMode;
      SetFloatingMode( bFloatMode );
      if ( bFloatMode )
      {
          if ( !pImpl->aWinState.isEmpty() )
              GetFloatingWindow()->SetWindowState( pImpl->aWinState );
          else
              GetFloatingWindow()->SetOutputSizePixel( GetFloatingSize() );
      }
  }

  if ( IsFloatingMode() )
  {
      // validate last alignment
      SfxChildAlignment eLastAlign = pImpl->GetLastAlignment();
      if ( eLastAlign == SfxChildAlignment::NOALIGNMENT)
          eLastAlign = CheckAlignment(eLastAlign, SfxChildAlignment::LEFT);
      if ( eLastAlign == SfxChildAlignment::NOALIGNMENT)
          eLastAlign = CheckAlignment(eLastAlign, SfxChildAlignment::RIGHT);
      if ( eLastAlign == SfxChildAlignment::NOALIGNMENT)
          eLastAlign = CheckAlignment(eLastAlign, SfxChildAlignment::TOP);
      if ( eLastAlign == SfxChildAlignment::NOALIGNMENT)
          eLastAlign = CheckAlignment(eLastAlign, SfxChildAlignment::BOTTOM);
      pImpl->SetLastAlignment(eLastAlign);
  }
  else
  {
      // docked window must have NOALIGNMENT as last alignment
      pImpl->SetLastAlignment(SfxChildAlignment::NOALIGNMENT);

      pImpl->pSplitWin = pWorkWin->GetSplitWindow_Impl(GetAlignment());
      pImpl->pSplitWin->InsertWindow(this, pImpl->aSplitSize);
  }

  // save alignment
  pImpl->SetDockAlignment( GetAlignment() );
946}

948void SfxDockingWindow::Initialize_Impl()
949{
  if ( !pMgr )
  {
      pImpl->bConstructed = true;
      return;
  }

  FloatingWindow* pFloatWin = GetFloatingWindow();
  bool bSet = false;
  if ( pFloatWin )
  {
      bSet = !pFloatWin->IsDefaultPos();
  }
  else
  {
      Point aPos = GetFloatingPos();
      if ( aPos != Point() )
          bSet = true;
  }

  if ( !bSet)
  {
      SfxViewFrame *pFrame = pBindings->GetDispatcher_Impl()->GetFrame();
      vcl::Window* pEditWin = pFrame->GetViewShell()->GetWindow();
      Point aPos = pEditWin->OutputToScreenPixel( pEditWin->GetPosPixel() );
      aPos = GetParent()->ScreenToOutputPixel( aPos );
      SetFloatingPos( aPos );
  }

  if ( pFloatWin )
  {
      // initialize floating window
      if ( pImpl->aWinState.isEmpty() )
          // window state never set before, get if from defaults
          pImpl->aWinState = pFloatWin->GetWindowState();

      // trick: use VCL method SetWindowState to adjust position and size
      pFloatWin->SetWindowState( pImpl->aWinState );
      Size aSize(pFloatWin->GetSizePixel());

      // remember floating size for calculating alignment and tracking rectangle
      SetFloatingSize(aSize);

  }

  // allow calling of docking handlers
  pImpl->bConstructed = true;
996}

998/** Fills a SfxChildWinInfo with specific data from SfxDockingWindow,
  so that it can be written in the INI file. It is assumed that rinfo
  receives all other possible relevant data in the ChildWindow class.
  Insertions are marked with size and the ZoomIn flag.
  If this method is overridden, the base implementation must be called first.
1003*/
1004void SfxDockingWindow::FillInfo(SfxChildWinInfo& rInfo) const
1005{
  if (!pMgr || !pImpl)
      return;

  if (GetFloatingWindow() && pImpl->bConstructed)
      pImpl->aWinState = GetFloatingWindow()->GetWindowState();

  rInfo.aWinState = pImpl->aWinState;
  rInfo.aExtraString = "AL:(";
  rInfo.aExtraString += OUString::number(static_cast<sal_uInt16>(GetAlignment()));
  rInfo.aExtraString += ",";
  rInfo.aExtraString += OUString::number (static_cast<sal_uInt16>(pImpl->GetLastAlignment()));

  Point aPos(pImpl->nLine, pImpl->nPos);
  rInfo.aExtraString += ",";
  rInfo.aExtraString += OUString::number( aPos.X() );
  rInfo.aExtraString += "/";
  rInfo.aExtraString += OUString::number( aPos.Y() );
  rInfo.aExtraString += "/";
  rInfo.aExtraString += OUString::number( pImpl->nHorizontalSize );
  rInfo.aExtraString += "/";
  rInfo.aExtraString += OUString::number( pImpl->nVerticalSize );
  rInfo.aExtraString += ",";
  rInfo.aExtraString += OUString::number( pImpl->aSplitSize.Width() );
  rInfo.aExtraString += ";";
  rInfo.aExtraString += OUString::number( pImpl->aSplitSize.Height() );

  rInfo.aExtraString += ")";
1033}

1035SfxDockingWindow::~SfxDockingWindow()
1036{
  disposeOnce();
1038}

1040void SfxDockingWindow::dispose()
1041{
  ReleaseChildWindow_Impl();
  pImpl.reset();
  m_xContainer.reset();
  m_xBuilder.reset();
  m_xVclContentArea.disposeAndClear();
  DockingWindow::dispose();
1048}

1050void SfxDockingWindow::ReleaseChildWindow_Impl()
1051{
  if ( pMgr && pMgr->GetFrame() == pBindings->GetActiveFrame() )
      pBindings->SetActiveFrame( nullptr );

  if ( pMgr && pImpl->pSplitWin && pImpl->pSplitWin->IsItemValid( GetType() ) )
      pImpl->pSplitWin->RemoveWindow(this);

  pMgr=nullptr;
1059}

1061/** This method calculates a resulting alignment for the given mouse position
  and tracking rectangle. When changing the alignment it can also be that
  the tracking rectangle is changed, so that an altered rectangle is
  returned. The user of this class can influence behaviour of this method,
  and thus the behavior of his DockinWindow class when docking where the
  called virtual method:

  SfxDockingWindow::CalcDockingSize (SfxChildAlignment eAlign)

  is overridden (see below).
1071*/
1072SfxChildAlignment SfxDockingWindow::CalcAlignment(const Point& rPos, tools::Rectangle& rRect)
1073{
  // calculate hypothetical sizes for different modes
  Size aFloatingSize(CalcDockingSize(SfxChildAlignment::NOALIGNMENT));

  // check if docking is permitted
  SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();
  if ( !pWorkWin->IsDockingAllowed() )
  {
      rRect.SetSize( aFloatingSize );
      return pImpl->GetDockAlignment();
  }

  // calculate borders to shrink inner area before checking for intersection with tracking rectangle
  long nLRBorder, nTBBorder;

  // take the smaller size of docked and floating mode
  Size aBorderTmp = pImpl->aSplitSize;
  if ( GetFloatingSize().Height() < aBorderTmp.Height() )
      aBorderTmp.setHeight( GetFloatingSize().Height() );
  if ( GetFloatingSize().Width() < aBorderTmp.Width() )
      aBorderTmp.setWidth( GetFloatingSize().Width() );

  nLRBorder = aBorderTmp.Width();
  nTBBorder = aBorderTmp.Height();

  // limit border to predefined constant values
  if ( nLRBorder > MAX_TOGGLEAREA_WIDTH20 )
      nLRBorder = MAX_TOGGLEAREA_WIDTH20;
  if ( nTBBorder > MAX_TOGGLEAREA_WIDTH20 )
      nTBBorder = MAX_TOGGLEAREA_WIDTH20;

  // shrink area for floating mode if possible
  tools::Rectangle aInRect = GetInnerRect();
  if ( aInRect.GetWidth() > nLRBorder )
      aInRect.AdjustLeft(nLRBorder/2 );
  if ( aInRect.GetWidth() > nLRBorder )
      aInRect.AdjustRight( -(nLRBorder/2) );
  if ( aInRect.GetHeight() > nTBBorder )
      aInRect.AdjustTop(nTBBorder/2 );
  if ( aInRect.GetHeight() > nTBBorder )
      aInRect.AdjustBottom( -(nTBBorder/2) );

  // calculate alignment resulting from docking rectangle
  bool bBecomesFloating = false;
  SfxChildAlignment eDockAlign = pImpl->GetDockAlignment();
  tools::Rectangle aDockingRect( rRect );
  if ( !IsFloatingMode() )
  {
      // don't use tracking rectangle for alignment check, because it will be too large
      // to get a floating mode as result - switch to floating size
      // so the calculation only depends on the position of the rectangle, not the current
      // docking state of the window
      aDockingRect.SetSize( GetFloatingSize() );

      // in this mode docking is never done by keyboard, so it's OK to use the mouse position
      aDockingRect.SetPos( pWorkWin->GetWindow()->OutputToScreenPixel( pWorkWin->GetWindow()->GetPointerPosPixel() ) );
  }

  Point aPos = aDockingRect.TopLeft();
  tools::Rectangle aIntersect = GetOuterRect().GetIntersection( aDockingRect );
  if ( aIntersect.IsEmpty() )
      // docking rectangle completely outside docking area -> floating mode
      bBecomesFloating = true;
  else
  {
      // create a small test rect around the mouse position and use this one
      // instead of the passed rRect to not dock too easily or by accident
      tools::Rectangle aSmallDockingRect;
      aSmallDockingRect.SetSize( Size( MAX_TOGGLEAREA_WIDTH20, MAX_TOGGLEAREA_HEIGHT20 ) );
      Point aNewPos(rPos);
      aNewPos.AdjustX( -(aSmallDockingRect.GetWidth()/2) );
      aNewPos.AdjustY( -(aSmallDockingRect.GetHeight()/2) );
      aSmallDockingRect.SetPos(aNewPos);
      tools::Rectangle aIntersectRect = aInRect.GetIntersection( aSmallDockingRect );
      if ( aIntersectRect == aSmallDockingRect )
          // docking rectangle completely inside (shrunk) inner area -> floating mode
          bBecomesFloating = true;
  }

  if ( bBecomesFloating )
  {
      eDockAlign = CheckAlignment(pImpl->GetDockAlignment(),SfxChildAlignment::NOALIGNMENT);
  }
  else
  {
      // docking rectangle is in the "sensible area"
      Point aInPosTL( aPos.X()-aInRect.Left(), aPos.Y()-aInRect.Top() );
      Point aInPosBR( aPos.X()-aInRect.Left() + aDockingRect.GetWidth(), aPos.Y()-aInRect.Top() + aDockingRect.GetHeight() );
      Size  aInSize = aInRect.GetSize();
      bool  bNoChange = false;

      // check if alignment is still unchanged
      switch ( GetAlignment() )
      {
          case SfxChildAlignment::LEFT:
          case SfxChildAlignment::FIRSTLEFT:
          case SfxChildAlignment::LASTLEFT:
              if (aInPosTL.X() <= 0)
              {
                  eDockAlign = GetAlignment();
                  bNoChange = true;
              }
              break;
          case SfxChildAlignment::TOP:
          case SfxChildAlignment::LOWESTTOP:
          case SfxChildAlignment::HIGHESTTOP:
              if ( aInPosTL.Y() <= 0)
              {
                  eDockAlign = GetAlignment();
                  bNoChange = true;
              }
              break;
          case SfxChildAlignment::RIGHT:
          case SfxChildAlignment::FIRSTRIGHT:
          case SfxChildAlignment::LASTRIGHT:
              if ( aInPosBR.X() >= aInSize.Width())
              {
                  eDockAlign = GetAlignment();
                  bNoChange = true;
              }
              break;
          case SfxChildAlignment::BOTTOM:
          case SfxChildAlignment::LOWESTBOTTOM:
          case SfxChildAlignment::HIGHESTBOTTOM:
              if ( aInPosBR.Y() >= aInSize.Height())
              {
                  eDockAlign = GetAlignment();
                  bNoChange = true;
              }
              break;
          default:
              break;
      }

      if ( !bNoChange )
      {
          // alignment will change, test alignment according to distance of the docking rectangles edges
          bool bForbidden = true;
          if ( aInPosTL.X() <= 0)
          {
              eDockAlign = CheckAlignment(pImpl->GetDockAlignment(),SfxChildAlignment::LEFT);
              bForbidden = ( eDockAlign != SfxChildAlignment::LEFT &&
                             eDockAlign != SfxChildAlignment::FIRSTLEFT &&
                             eDockAlign != SfxChildAlignment::LASTLEFT );
          }

          if ( bForbidden && aInPosTL.Y() <= 0)
          {
              eDockAlign = CheckAlignment(pImpl->GetDockAlignment(),SfxChildAlignment::TOP);
              bForbidden = ( eDockAlign != SfxChildAlignment::TOP &&
                             eDockAlign != SfxChildAlignment::HIGHESTTOP &&
                             eDockAlign != SfxChildAlignment::LOWESTTOP );
          }

          if ( bForbidden && aInPosBR.X() >= aInSize.Width())
          {
              eDockAlign = CheckAlignment(pImpl->GetDockAlignment(),SfxChildAlignment::RIGHT);
              bForbidden = ( eDockAlign != SfxChildAlignment::RIGHT &&
                             eDockAlign != SfxChildAlignment::FIRSTRIGHT &&
                             eDockAlign != SfxChildAlignment::LASTRIGHT );
          }

          if ( bForbidden && aInPosBR.Y() >= aInSize.Height())
          {
              eDockAlign = CheckAlignment(pImpl->GetDockAlignment(),SfxChildAlignment::BOTTOM);
              bForbidden = ( eDockAlign != SfxChildAlignment::BOTTOM &&
                             eDockAlign != SfxChildAlignment::HIGHESTBOTTOM &&
                             eDockAlign != SfxChildAlignment::LOWESTBOTTOM );
          }

          // the calculated alignment was rejected by the window -> take floating mode
          if ( bForbidden )
              eDockAlign = CheckAlignment(pImpl->GetDockAlignment(),SfxChildAlignment::NOALIGNMENT);
      }
  }

  if ( eDockAlign == SfxChildAlignment::NOALIGNMENT )
  {
      // In the FloatingMode the tracking rectangle will get the floating
      // size. Due to a bug the rRect may only be changed when the
      // alignment is changed!
      if ( eDockAlign != pImpl->GetDockAlignment() )
          aDockingRect.SetSize( aFloatingSize );
  }
  else
  {
      sal_uInt16 nLine, nPos;
      SfxSplitWindow *pSplitWin = pWorkWin->GetSplitWindow_Impl(eDockAlign);
      aPos = pSplitWin->ScreenToOutputPixel( aPos );
      if ( pSplitWin->GetWindowPos( aPos, nLine, nPos ) )
      {
          // mouse over splitwindow, get line and position
          pImpl->nDockLine = nLine;
          pImpl->nDockPos = nPos;
          pImpl->bNewLine = false;
      }
      else
      {
          // mouse touches inner border -> create new line
          if ( eDockAlign == GetAlignment() && pImpl->pSplitWin &&
               pImpl->nLine == pImpl->pSplitWin->GetLineCount()-1 && pImpl->pSplitWin->GetWindowCount(pImpl->nLine) == 1 )
          {
              // if this window is the only one in the last line, it can't be docked as new line in the same splitwindow
              pImpl->nDockLine = pImpl->nLine;
              pImpl->nDockPos = pImpl->nPos;
              pImpl->bNewLine = false;
          }
          else
          {
              // create new line
              pImpl->nDockLine = pSplitWin->GetLineCount();
              pImpl->nDockPos = 0;
              pImpl->bNewLine = true;
          }
      }

      bool bChanged = pImpl->nLine != pImpl->nDockLine || pImpl->nPos != pImpl->nDockPos || eDockAlign != GetAlignment();
      if ( !bChanged && !IsFloatingMode() )
      {
          // window only slightly moved, no change of any property
          rRect.SetSize( pImpl->aSplitSize );
          rRect.SetPos( aDockingRect.TopLeft() );
          return eDockAlign;
      }

      // calculate new size and position
      Size aSize;
      Point aPoint = aDockingRect.TopLeft();
      Size aInnerSize = GetInnerRect().GetSize();
      if ( eDockAlign == SfxChildAlignment::LEFT || eDockAlign == SfxChildAlignment::RIGHT )
      {
          if ( pImpl->bNewLine )
          {
              // set height to height of free area
              aSize.setHeight( aInnerSize.Height() );
              aSize.setWidth( pImpl->nHorizontalSize );
              if ( eDockAlign == SfxChildAlignment::LEFT )
              {
                  aPoint = aInnerRect.TopLeft();
              }
              else
              {
                  aPoint = aInnerRect.TopRight();
                  aPoint.AdjustX( -(aSize.Width()) );
              }
          }
          else
          {
              // get width from splitwindow
              aSize.setWidth( pSplitWin->GetLineSize(nLine) );
              aSize.setHeight( pImpl->aSplitSize.Height() );
          }
      }
      else
      {
          if ( pImpl->bNewLine )
          {
              // set width to width of free area
              aSize.setWidth( aInnerSize.Width() );
              aSize.setHeight( pImpl->nVerticalSize );
              if ( eDockAlign == SfxChildAlignment::TOP )
              {
                  aPoint = aInnerRect.TopLeft();
              }
              else
              {
                  aPoint = aInnerRect.BottomLeft();
                  aPoint.AdjustY( -(aSize.Height()) );
              }
          }
          else
          {
              // get height from splitwindow
              aSize.setHeight( pSplitWin->GetLineSize(nLine) );
              aSize.setWidth( pImpl->aSplitSize.Width() );
          }
      }

      aDockingRect.SetSize( aSize );
      aDockingRect.SetPos( aPoint );
  }

  rRect = aDockingRect;
  return eDockAlign;
1357}

1359/** Virtual method of the SfxDockingWindow class. This method determines how
  the size of the DockingWindows changes depending on the alignment. The base
  implementation uses the floating mode, the size of the marked Floating
  Size. For horizontal alignment, the width will be the width of the outer
  DockingRectangle, with vertical alignment the height will be the height of
  the inner DockingRectangle (resulting from the order in which the SFX child
  windows are displayed). The other size is set to the current floating-size,
  this could changed by a to intervening derived class. The docking size must
  be the same for Left/Right and Top/Bottom.
1368*/
1369Size SfxDockingWindow::CalcDockingSize(SfxChildAlignment eAlign)
1370{
  // Note: if the resizing is also possible in the docked state, then the
  // Floating-size does also have to be adjusted?

  Size aSize = GetFloatingSize();
  switch (eAlign)
  {
      case SfxChildAlignment::TOP:
      case SfxChildAlignment::BOTTOM:
      case SfxChildAlignment::LOWESTTOP:
      case SfxChildAlignment::HIGHESTTOP:
      case SfxChildAlignment::LOWESTBOTTOM:
      case SfxChildAlignment::HIGHESTBOTTOM:
          aSize.setWidth( aOuterRect.Right() - aOuterRect.Left() );
          break;
      case SfxChildAlignment::LEFT:
      case SfxChildAlignment::RIGHT:
      case SfxChildAlignment::FIRSTLEFT:
      case SfxChildAlignment::LASTLEFT:
      case SfxChildAlignment::FIRSTRIGHT:
      case SfxChildAlignment::LASTRIGHT:
          aSize.setHeight( aInnerRect.Bottom() - aInnerRect.Top() );
          break;
      case SfxChildAlignment::NOALIGNMENT:
          break;
            default:
                break;
  }

  return aSize;
1400}

1402/** Virtual method of the SfxDockingWindow class. Here a derived class can
  disallow certain alignments. The base implementation does not
  prohibit alignment.
1405*/
1406SfxChildAlignment SfxDockingWindow::CheckAlignment(SfxChildAlignment,
  SfxChildAlignment eAlign)
1408{
  return eAlign;
1410}

1412/** The window is closed when the ChildWindow is destroyed by running the
  ChildWindow-slots. If this is method is overridden by a derived class
  method, then the SfxDockingDialogWindow: Close() must be called afterwards
  if the Close() was not cancelled with "return sal_False".
1416*/
1417bool SfxDockingWindow::Close()
1418{
  // Execute with Parameters, since Toggle is ignored by some ChildWindows.
  if ( !pMgr )
      return true;

  SfxBoolItem aValue( pMgr->GetType(), false);
  pBindings->GetDispatcher_Impl()->ExecuteList(
      pMgr->GetType(), SfxCallMode::RECORD | SfxCallMode::ASYNCHRON,
      { &aValue });
  return true;
1428}

1430void SfxDockingWindow::Paint(vcl::RenderContext&, const tools::Rectangle& /*rRect*/)
1431{
1432}

1434/** With this method, a minimal OutputSize be can set, that is queried in
  the Resizing()-Handler.
1436*/
1437void SfxDockingWindow::SetMinOutputSizePixel( const Size& rSize )
1438{
  pImpl->aMinSize = rSize;
  DockingWindow::SetMinOutputSizePixel( rSize );
1441}

1443/** Set the minimum size which is returned.*/
1444const Size& SfxDockingWindow::GetMinOutputSizePixel() const
1445{
  return pImpl->aMinSize;
1447}

1449bool SfxDockingWindow::EventNotify( NotifyEvent& rEvt )
1450{
  if ( !pImpl )
      return DockingWindow::EventNotify( rEvt );

  if ( rEvt.GetType() == MouseNotifyEvent::GETFOCUS )
  {
      if (pMgr != nullptr)
          pBindings->SetActiveFrame( pMgr->GetFrame() );

      if ( pImpl->pSplitWin )
          pImpl->pSplitWin->SetActiveWindow_Impl( this );
      else if (pMgr != nullptr)
          pMgr->Activate_Impl();

      // In VCL EventNotify goes first to the window itself, also call the
      // base class, otherwise the parent learns nothing
      // if ( rEvt.GetWindow() == this )  PB: #i74693# not necessary any longer
      DockingWindow::EventNotify( rEvt );
      return true;
  }
  else if( rEvt.GetType() == MouseNotifyEvent::KEYINPUT )
  {
      // First, allow KeyInput for Dialog functions
      if (!DockingWindow::EventNotify(rEvt) && SfxViewShell::Current())
      {
          // then also for valid global accelerators.
          return SfxViewShell::Current()->GlobalKeyInput_Impl( *rEvt.GetKeyEvent() );
      }
      return true;
  }
  else if ( rEvt.GetType() == MouseNotifyEvent::LOSEFOCUS && !HasChildPathFocus() )
  {
      pBindings->SetActiveFrame( nullptr );
  }

  return DockingWindow::EventNotify( rEvt );
1486}


1489void SfxDockingWindow::SetItemSize_Impl( const Size& rSize )
1490{
  pImpl->aSplitSize = rSize;

  SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();
  pWorkWin->ConfigChild_Impl( SfxChildIdentifier::SPLITWINDOW, SfxDockingConfig::ALIGNDOCKINGWINDOW, pMgr->GetType() );
1495}

1497void SfxDockingWindow::Disappear_Impl()
1498{
  if ( pImpl->pSplitWin && pImpl->pSplitWin->IsItemValid( GetType() ) )
      pImpl->pSplitWin->RemoveWindow(this);
1501}

1503void SfxDockingWindow::Reappear_Impl()
1504{
  if ( pImpl->pSplitWin && !pImpl->pSplitWin->IsItemValid( GetType() ) )
  {
      pImpl->pSplitWin->InsertWindow( this, pImpl->aSplitSize );
  }
1509}

1511bool SfxDockingWindow::IsAutoHide_Impl() const
1512{
  if ( pImpl->pSplitWin )
      return !pImpl->pSplitWin->IsFadeIn();
  else
      return false;
1517}

1519void SfxDockingWindow::AutoShow_Impl()
1520{
  if ( pImpl->pSplitWin )
  {
      pImpl->pSplitWin->FadeIn();
  }
1525}

1527void SfxDockingWindow::StateChanged( StateChangedType nStateChange )
1528{
  if ( nStateChange == StateChangedType::InitShow )
      Initialize_Impl();

  DockingWindow::StateChanged( nStateChange );
1533}

1535void SfxDockingWindow::Move()
1536{
  if ( pImpl )
      pImpl->aMoveIdle.Start();
1539}

1541IMPL_LINK_NOARG(SfxDockingWindow, TimerHdl, Timer *, void)void SfxDockingWindow::LinkStubTimerHdl(void * instance, Timer
 * data) { return static_cast<SfxDockingWindow *>(instance
)->TimerHdl(data); } void SfxDockingWindow::TimerHdl(__attribute__
 ((unused)) Timer *)
1542{
  pImpl->aMoveIdle.Stop();
  if ( IsReallyVisible() && IsFloatingMode() )
  {
      if( !GetFloatingWindow()->IsRollUp() )
          SetFloatingSize( GetOutputSizePixel() );
      pImpl->aWinState = GetFloatingWindow()->GetWindowState();
      SfxWorkWindow *pWorkWin = pBindings->GetWorkWindow_Impl();
      pWorkWin->ConfigChild_Impl( SfxChildIdentifier::SPLITWINDOW, SfxDockingConfig::ALIGNDOCKINGWINDOW, pMgr->GetType() );
  }
1552}

1554/* 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/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
*   Licensed to the Apache Software Foundation (ASF) under one or more
*   contributor license agreements. See the NOTICE file distributed
*   with this work for additional information regarding copyright
*   ownership. The ASF licenses this file to you under the Apache
*   License, Version 2.0 (the "License"); you may not use this file
*   except in compliance with the License. You may obtain a copy of
*   the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/

20#ifndef INCLUDED_VCL_PTR_HXX
21#define INCLUDED_VCL_PTR_HXX

23#include <sal/config.h>

25#include <rtl/ref.hxx>

27#include <utility>
28#include <type_traits>

30#ifdef DBG_UTIL
31#ifndef _WIN32
32#include <vcl/vclmain.hxx>
33#endif
34#endif

36class VclReferenceBase;

38namespace vcl::detail {

40template<typename>
41constexpr bool isIncompleteOrDerivedFromVclReferenceBase(...) { return true; }

43template<typename T> constexpr bool isIncompleteOrDerivedFromVclReferenceBase(
  int (*)[sizeof(T)])
45{ return std::is_base_of<VclReferenceBase, T>::value; }

47} // namespace vcl::detail

49/**
* A thin wrapper around rtl::Reference to implement the acquire and dispose semantics we want for references to vcl::Window subclasses.
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
56template <class reference_type>
57class VclPtr
58{
  static_assert(
      vcl::detail::isIncompleteOrDerivedFromVclReferenceBase<reference_type>(
          nullptr),
      "template argument type must be derived from VclReferenceBase");

  ::rtl::Reference<reference_type> m_rInnerRef;

66public:
  /** Constructor...
   */
  VclPtr()
      : m_rInnerRef()
  {}

  /** Constructor...
   */
  VclPtr (reference_type * pBody)
      : m_rInnerRef(pBody)
  {}

  /** Constructor... that doesn't take a ref.
   */
  VclPtr (reference_type * pBody, __sal_NoAcquire)
      : m_rInnerRef(pBody, SAL_NO_ACQUIRE)
  {}

  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.  For the special case of
      up-casting to Reference< XInterface >, see the corresponding conversion
      operator.

      @param rRef another reference
  */
  template< class derived_type >
  VclPtr(
      const VclPtr< derived_type > & rRef,
      typename std::enable_if<
          std::is_base_of<reference_type, derived_type>::value, int>::type
          = 0 )
      : m_rInnerRef( static_cast<reference_type*>(rRef) )
  {
  }

103#if defined(DBG_UTIL) && !defined(_WIN32)
  virtual ~VclPtr()
  {
      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__));
      // We can be one of the intermediate counts, but if we are the last
      // VclPtr keeping this object alive, then something forgot to call dispose().
      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__))
              && "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__));
  }
  VclPtr(VclPtr const &) = default;
  VclPtr(VclPtr &&) = default;
  VclPtr & operator =(VclPtr const &) = default;
  VclPtr & operator =(VclPtr &&) = default;
116#endif

  /**
   * A construction helper for VclPtr. Since VclPtr types are created
   * with a reference-count of one - to help fit into the existing
   * code-flow; this helps us to construct them easily.
   *
   * For more details on the design please see vcl/README.lifecycle
   *
   * @tparam reference_type must be a subclass of vcl::Window
   */
  template<typename... Arg> [[nodiscard]] static VclPtr< reference_type > Create(Arg &&... arg)
  {
      return VclPtr< reference_type >( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE );
2
←
Memory is allocated→
  }

  /** Probably most common used: handle->someBodyOp().
   */
  reference_type * operator->() const
  {
      return m_rInnerRef.get();
15
←
Calling 'Reference::get'→
  }

  /** Get the body. Can be used instead of operator->().
       I.e. handle->someBodyOp() and handle.get()->someBodyOp()
       are the same.
    */
  reference_type * get() const
  {
      return m_rInnerRef.get();
  }

  void set(reference_type *pBody)
  {
      m_rInnerRef.set(pBody);
  }

  void reset(reference_type *pBody)
  {
      m_rInnerRef.set(pBody);
  }

  /** Up-casting copy assignment operator.

      Does not work for up-casts to ambiguous bases.

      @param rRef another reference
  */
  template<typename derived_type>
  typename std::enable_if<
      std::is_base_of<reference_type, derived_type>::value,
      VclPtr &>::type
  operator =(VclPtr<derived_type> const & rRef)
  {
      m_rInnerRef.set(rRef.get());
      return *this;
  }

  VclPtr & operator =(reference_type * pBody)
  {
      m_rInnerRef.set(pBody);
      return *this;
  }

  operator reference_type * () const
  {
      return m_rInnerRef.get();
  }

  explicit operator bool () const
  {
      return m_rInnerRef.get() != nullptr;
  }

  void clear()
  {
      m_rInnerRef.clear();
  }

  void reset()
  {
      m_rInnerRef.clear();
  }

  void disposeAndClear()
  {
      // hold it alive for the lifetime of this method
      ::rtl::Reference<reference_type> aTmp(m_rInnerRef);
      m_rInnerRef.clear(); // we should use some 'swap' method ideally ;-)
      if (aTmp.get()) {
          aTmp->disposeOnce();
      }
  }

  /** Needed to place VclPtr's into STL collection.
   */
  bool operator< (const VclPtr<reference_type> & handle) const
  {
      return (m_rInnerRef < handle.m_rInnerRef);
  }
216}; // class VclPtr

218template<typename T1, typename T2>
219inline bool operator ==(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
  return p1.get() == p2.get();
221}

223template<typename T> inline bool operator ==(VclPtr<T> const & p1, T const * p2)
224{
  return p1.get() == p2;
226}

228template<typename T> inline bool operator ==(VclPtr<T> const & p1, T * p2) {
  return p1.get() == p2;
230}

232template<typename T> inline bool operator ==(T const * p1, VclPtr<T> const & p2)
233{
  return p1 == p2.get();
235}

237template<typename T> inline bool operator ==(T * p1, VclPtr<T> const & p2) {
  return p1 == p2.get();
239}

241template<typename T1, typename T2>
242inline bool operator !=(VclPtr<T1> const & p1, VclPtr<T2> const & p2) {
  return !(p1 == p2);
244}

246template<typename T> inline bool operator !=(VclPtr<T> const & p1, T const * p2)
247{
  return !(p1 == p2);
249}

251template<typename T> inline bool operator !=(VclPtr<T> const & p1, T * p2) {
  return !(p1 == p2);
253}

255template<typename T> inline bool operator !=(T const * p1, VclPtr<T> const & p2)
256{
  return !(p1 == p2);
258}

260template<typename T> inline bool operator !=(T * p1, VclPtr<T> const & p2) {
  return !(p1 == p2);
262}

264/**
* A construction helper for a temporary VclPtr. Since VclPtr types
* are created with a reference-count of one - to help fit into
* the existing code-flow; this helps us to construct them easily.
* see also VclPtr::Create and ScopedVclPtr
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
274template <class reference_type>
275class SAL_WARN_UNUSED__attribute__((warn_unused)) VclPtrInstance final : public VclPtr<reference_type>
276{
277public:
  template<typename... Arg> VclPtrInstance(Arg &&... arg)
      : VclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
  {
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static VclPtrInstance< reference_type > Create(Arg &&... ) = delete;
288};

290template <class reference_type>
291class ScopedVclPtr : public VclPtr<reference_type>
292{
293public:
  /** Constructor...
   */
  ScopedVclPtr()
      : VclPtr<reference_type>()
  {}

  /** Constructor
   */
  ScopedVclPtr (reference_type * pBody)
      : VclPtr<reference_type>(pBody)
  {}

  /** Copy constructor...
   */
  ScopedVclPtr (const VclPtr<reference_type> & handle)
      : VclPtr<reference_type>(handle)
  {}

  /**
     Assignment that releases the last reference.
   */
  void disposeAndReset(reference_type *pBody)
  {
      if (pBody != this->get()) {
          VclPtr<reference_type>::disposeAndClear();
          VclPtr<reference_type>::set(pBody);
      }
  }

  /**
     Assignment that releases the last reference.
   */
  ScopedVclPtr<reference_type>& operator = (reference_type * pBody)
  {
      disposeAndReset(pBody);
      return *this;
  }

  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.  For the special case of
      up-casting to Reference< XInterface >, see the corresponding conversion
      operator.

      @param rRef another reference
  */
  template< class derived_type >
  ScopedVclPtr(
      const VclPtr< derived_type > & rRef,
      typename std::enable_if<
          std::is_base_of<reference_type, derived_type>::value, int>::type
          = 0 )
      : VclPtr<reference_type>( rRef )
  {
  }

  /** Up-casting assignment operator.

      Does not work for up-casts to ambiguous bases.

      @param rRef another VclPtr
  */
  template<typename derived_type>
  typename std::enable_if<
      std::is_base_of<reference_type, derived_type>::value,
      ScopedVclPtr &>::type
  operator =(VclPtr<derived_type> const & rRef)
  {
      disposeAndReset(rRef.get());
      return *this;
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static ScopedVclPtr< reference_type > Create(Arg &&... ) = delete;

  ~ScopedVclPtr()
  {
      VclPtr<reference_type>::disposeAndClear();
      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
  }

378private:
  // Most likely we don't want this default copy-constructor.
  ScopedVclPtr (const ScopedVclPtr<reference_type> &) = delete;
  // And certainly we don't want a default assignment operator.
  ScopedVclPtr<reference_type>& operator = (const ScopedVclPtr<reference_type> &) = delete;
  // And disallow reset as that doesn't call disposeAndClear on the original reference
  void reset() = delete;
  void reset(reference_type *pBody) = delete;

387protected:
  ScopedVclPtr (reference_type * pBody, __sal_NoAcquire)
      : VclPtr<reference_type>(pBody, SAL_NO_ACQUIRE)
  {}
391};

393/**
* A construction helper for ScopedVclPtr. Since VclPtr types are created
* with a reference-count of one - to help fit into the existing
* code-flow; this helps us to construct them easily.
*
* For more details on the design please see vcl/README.lifecycle
*
* @param reference_type must be a subclass of vcl::Window
*/
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:
  template<typename... Arg> ScopedVclPtrInstance(Arg &&... arg)
      : ScopedVclPtr<reference_type>( new reference_type(std::forward<Arg>(arg)...), SAL_NO_ACQUIRE )
  {
  }

  /**
   * Override and disallow this, to prevent people accidentally calling it and actually
   * getting VclPtr::Create and getting a naked VclPtr<> instance
   */
  template<typename... Arg> static ScopedVclPtrInstance< reference_type > Create(Arg &&...) = delete;

421private:
  // Prevent the above perfect forwarding ctor from hijacking (accidental)
  // attempts at ScopedVclPtrInstance copy construction (where the hijacking
  // would typically lead to somewhat obscure error messages); both non-const
  // and const variants are needed here, as the ScopedVclPtr base class has a
  // const--variant copy ctor, so the implicitly declared copy ctor for
  // ScopedVclPtrInstance would also be the const variant, so non-const copy
  // construction attempts would be hijacked by the perfect forwarding ctor;
  // but if we only declared a non-const variant here, the const variant would
  // no longer be implicitly declared (as there would already be an explicitly
  // declared copy ctor), so const copy construction attempts would then be
  // hijacked by the perfect forwarding ctor:
  ScopedVclPtrInstance(ScopedVclPtrInstance &) = delete;
  ScopedVclPtrInstance(ScopedVclPtrInstance const &) = delete;
435};
436#if defined _MSC_VER
437#pragma warning(pop)
438#endif

440#endif // INCLUDED_VCL_PTR_HXX

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/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
*   Licensed to the Apache Software Foundation (ASF) under one or more
*   contributor license agreements. See the NOTICE file distributed
*   with this work for additional information regarding copyright
*   ownership. The ASF licenses this file to you under the Apache
*   License, Version 2.0 (the "License"); you may not use this file
*   except in compliance with the License. You may obtain a copy of
*   the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/

20#ifndef INCLUDED_RTL_REF_HXX
21#define INCLUDED_RTL_REF_HXX

23#include "sal/config.h"

25#include <cassert>
26#include <cstddef>
27#include <functional>
28#ifdef LIBO_INTERNAL_ONLY1
29#include <type_traits>
30#endif

32#include "sal/types.h"

34namespace rtl
35{

37/** Template reference class for reference type.
38*/
39template <class reference_type>
40class Reference
41{
  /** The <b>reference_type</b> body pointer.
   */
  reference_type * m_pBody;


47public:
  /** Constructor...
   */
  Reference()
      : m_pBody (NULL__null)
  {}


  /** Constructor...
   */
  Reference (reference_type * pBody, __sal_NoAcquire)
      : m_pBody (pBody)
  {
  }

  /** Constructor...
   */
  Reference (reference_type * pBody)
      : m_pBody (pBody)
  {
      if (m_pBody)
          m_pBody->acquire();
  }

  /** Copy constructor...
   */
  Reference (const Reference<reference_type> & handle)
      : m_pBody (handle.m_pBody)
  {
      if (m_pBody)
          m_pBody->acquire();
  }

80#ifdef LIBO_INTERNAL_ONLY1
  /** Move constructor...
   */
  Reference (Reference<reference_type> && handle) noexcept
      : m_pBody (handle.m_pBody)
  {
      handle.m_pBody = nullptr;
  }
88#endif

90#if defined LIBO_INTERNAL_ONLY1
  /** Up-casting conversion constructor: Copies interface reference.

      Does not work for up-casts to ambiguous bases.

      @param rRef another reference
  */
  template< class derived_type >
  inline Reference(
      const Reference< derived_type > & rRef,
      std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
      : m_pBody (rRef.get())
  {
      if (m_pBody)
          m_pBody->acquire();
  }
106#endif

  /** Destructor...
   */
  ~Reference() COVERITY_NOEXCEPT_FALSE
  {
      if (m_pBody5.1
Field 'm_pBody' is non-null
1
Field 'm_pBody' is non-null
1
Field 'm_pBody' is non-null
1
Field 'm_pBody' is non-null
)
6
←
Taking true branch→
          m_pBody->release();
7
←
Calling 'VclReferenceBase::release'→
11
←
Returning; memory was released→
  }

  /** Set...
       Similar to assignment.
   */
  Reference<reference_type> &
  SAL_CALL set (reference_type * pBody)
  {
      if (pBody)
          pBody->acquire();
      reference_type * const pOld = m_pBody;
      m_pBody = pBody;
      if (pOld)
          pOld->release();
      return *this;
  }

  /** Assignment.
       Unbinds this instance from its body (if bound) and
       bind it to the body represented by the handle.
   */
  Reference<reference_type> &
  SAL_CALL operator= (const Reference<reference_type> & handle)
  {
      return set( handle.m_pBody );
  }

141#ifdef LIBO_INTERNAL_ONLY1
  /** Assignment.
   *   Unbinds this instance from its body (if bound),
   *   bind it to the body represented by the handle, and
   *   set the body represented by the handle to nullptr.
   */
  Reference<reference_type> &
  operator= (Reference<reference_type> && handle)
  {
      // self-movement guts ourself
      if (m_pBody)
          m_pBody->release();
      m_pBody = handle.m_pBody;
      handle.m_pBody = nullptr;
      return *this;
  }
157#endif

  /** Assignment...
   */
  Reference<reference_type> &
  SAL_CALL operator= (reference_type * pBody)
  {
      return set( pBody );
  }

  /** Unbind the body from this handle.
       Note that for a handle representing a large body,
       "handle.clear().set(new body());" _might_
       perform a little bit better than "handle.set(new body());",
       since in the second case two large objects exist in memory
       (the old body and the new body).
   */
  Reference<reference_type> & SAL_CALL clear()
  {
      if (m_pBody)
      {
          reference_type * const pOld = m_pBody;
          m_pBody = NULL__null;
          pOld->release();
      }
      return *this;
  }


  /** Get the body. Can be used instead of operator->().
       I.e. handle->someBodyOp() and handle.get()->someBodyOp()
       are the same.
   */
  reference_type * SAL_CALL get() const
  {
      return m_pBody;
16
←
Use of memory after it is freed
  }


  /** Probably most common used: handle->someBodyOp().
   */
  reference_type * SAL_CALL operator->() const
  {
      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__));
      return m_pBody;
  }


  /** Allows (*handle).someBodyOp().
  */
  reference_type & SAL_CALL operator*() const
  {
      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__));
      return *m_pBody;
  }


  /** Returns True if the handle does point to a valid body.
   */
  bool SAL_CALL is() const
  {
      return (m_pBody != NULL__null);
  }

221#if defined LIBO_INTERNAL_ONLY1
  /** Returns True if the handle does point to a valid body.
   */
  explicit operator bool() const
  {
      return is();
  }
228#endif

  /** Returns True if this points to pBody.
   */
  bool SAL_CALL operator== (const reference_type * pBody) const
  {
      return (m_pBody == pBody);
  }


  /** Returns True if handle points to the same body.
   */
  bool
  SAL_CALL operator== (const Reference<reference_type> & handle) const
  {
      return (m_pBody == handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator!= (const Reference<reference_type> & handle) const
  {
      return (m_pBody != handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator< (const Reference<reference_type> & handle) const
  {
      return (m_pBody < handle.m_pBody);
  }


  /** Needed to place References into STL collection.
   */
  bool
  SAL_CALL operator> (const Reference<reference_type> & handle) const
  {
      return (m_pBody > handle.m_pBody);
  }
272};

274} // namespace rtl

276#if defined LIBO_INTERNAL_ONLY1
277namespace std
278{

280/// @cond INTERNAL
281/**
Make rtl::Reference hashable by default for use in STL containers.

@since LibreOffice 6.3
285*/
286template<typename T>
287struct hash<::rtl::Reference<T>>
288{
  std::size_t operator()(::rtl::Reference<T> const & s) const
  { return std::size_t(s.get()); }
291};
292/// @endcond

294}

296#endif

298#endif /* ! INCLUDED_RTL_REF_HXX */

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)
8
←
Assuming the condition is true→
9
←
Taking true branch→
40            delete this;
10
←
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