sd/source/ui/framework/factories/BasicPaneFactory.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 <sal/config.h>
  22
  23 #include <framework/factories/BasicPaneFactory.hxx>
  24
  25 #include "ChildWindowPane.hxx"
  26 #include "FrameWindowPane.hxx"
  27 #include "FullScreenPane.hxx"
  28
  29 #include <comphelper/servicehelper.hxx>
  30 #include <framework/FrameworkHelper.hxx>
  31 #include <framework/ConfigurationController.hxx>
  32 #include <PaneShells.hxx>
  33 #include <ViewShellBase.hxx>
  34 #include <PaneChildWindows.hxx>
  35 #include <DrawController.hxx>
  36 #include <com/sun/star/drawing/framework/XControllerManager.hpp>
  37
  38 using namespace ::com::sun::star;
  39 using namespace ::com::sun::star::uno;
  40 using namespace ::com::sun::star::lang;
  41 using namespace ::com::sun::star::drawing::framework;
  42
  43 using ::sd::framework::FrameworkHelper;
  44
  45 namespace {
  46     enum PaneId {
  47         CenterPaneId,
  48         FullScreenPaneId,
  49         LeftImpressPaneId,
  50         BottomImpressPaneId,
  51         LeftDrawPaneId
  52     };
  53
  54     const sal_Int32 gnConfigurationUpdateStartEvent(0);
  55     const sal_Int32 gnConfigurationUpdateEndEvent(1);
  56 }
  57
  58 namespace sd::framework {
  59
  60 /** Store URL, XPane reference and (local) PaneId for every pane factory
  61     that is registered at the PaneController.
  62 */
  63 class BasicPaneFactory::PaneDescriptor
  64 {
  65 public:
  66     OUString msPaneURL;
  67     Reference<XResource> mxPane;
  68     PaneId mePaneId;
  69     /** The mbReleased flag is set when the pane has been released.  Some
  70         panes are just hidden and destroyed.  When the pane is reused this
  71         flag is reset.
  72     */
  73     bool mbIsReleased;
  74
  75     bool CompareURL(std::u16string_view rsPaneURL) const { return msPaneURL == rsPaneURL; }
  76     bool ComparePane(const Reference<XResource>& rxPane) const { return mxPane == rxPane; }
  77 };
  78
  79 class BasicPaneFactory::PaneContainer
  80     : public ::std::vector<PaneDescriptor>
  81 {
  82 public:
  83     PaneContainer() {}
  84 };
  85
  86 //===== PaneFactory ===========================================================
  87
  88 BasicPaneFactory::BasicPaneFactory (
  89     const Reference<XComponentContext>& rxContext,
  90     const rtl::Reference<::sd::DrawController>& rxController)
  91     : mxComponentContext(rxContext),
  92       mpViewShellBase(nullptr),
  93       mpPaneContainer(new PaneContainer)
  94 {
  95     try
  96     {
  97         // Tunnel through the controller to obtain access to the ViewShellBase.
  98         mpViewShellBase = rxController->GetViewShellBase();
  99
 100         rtl::Reference<sd::framework::ConfigurationController> xCC (rxController->getConfigurationControllerImpl());
 101         mxConfigurationControllerWeak = xCC.get();
 102
 103         // Add pane factories for the two left panes (one for Impress and one for
 104         // Draw) and the center pane.
 105         if (rxController.is() && xCC.is())
 106         {
 107             PaneDescriptor aDescriptor;
 108             aDescriptor.msPaneURL = FrameworkHelper::msCenterPaneURL;
 109             aDescriptor.mePaneId = CenterPaneId;
 110             aDescriptor.mbIsReleased = false;
 111             mpPaneContainer->push_back(aDescriptor);
 112             xCC->addResourceFactory(aDescriptor.msPaneURL, this);
 113
 114             aDescriptor.msPaneURL = FrameworkHelper::msFullScreenPaneURL;
 115             aDescriptor.mePaneId = FullScreenPaneId;
 116             mpPaneContainer->push_back(aDescriptor);
 117             xCC->addResourceFactory(aDescriptor.msPaneURL, this);
 118
 119             aDescriptor.msPaneURL = FrameworkHelper::msLeftImpressPaneURL;
 120             aDescriptor.mePaneId = LeftImpressPaneId;
 121             mpPaneContainer->push_back(aDescriptor);
 122             xCC->addResourceFactory(aDescriptor.msPaneURL, this);
 123
 124             aDescriptor.msPaneURL = FrameworkHelper::msBottomImpressPaneURL;
 125             aDescriptor.mePaneId = BottomImpressPaneId;
 126             mpPaneContainer->push_back(aDescriptor);
 127             xCC->addResourceFactory(aDescriptor.msPaneURL, this);
 128
 129             aDescriptor.msPaneURL = FrameworkHelper::msLeftDrawPaneURL;
 130             aDescriptor.mePaneId = LeftDrawPaneId;
 131             mpPaneContainer->push_back(aDescriptor);
 132             xCC->addResourceFactory(aDescriptor.msPaneURL, this);
 133         }
 134
 135         // Register as configuration change listener.
 136         if (xCC.is())
 137         {
 138             xCC->addConfigurationChangeListener(
 139                 this,
 140                 FrameworkHelper::msConfigurationUpdateStartEvent,
 141                 Any(gnConfigurationUpdateStartEvent));
 142             xCC->addConfigurationChangeListener(
 143                 this,
 144                 FrameworkHelper::msConfigurationUpdateEndEvent,
 145                 Any(gnConfigurationUpdateEndEvent));
 146         }
 147     }
 148     catch (RuntimeException&)
 149     {
 150         rtl::Reference<ConfigurationController> xCC (mxConfigurationControllerWeak);
 151         if (xCC.is())
 152             xCC->removeResourceFactoryForReference(this);
 153     }
 154 }
 155
 156 BasicPaneFactory::~BasicPaneFactory()
 157 {
 158 }
 159
 160 void BasicPaneFactory::disposing(std::unique_lock<std::mutex>&)
 161 {
 162     rtl::Reference<ConfigurationController> xCC (mxConfigurationControllerWeak);
 163     if (xCC.is())
 164     {
 165         xCC->removeResourceFactoryForReference(this);
 166         xCC->removeConfigurationChangeListener(this);
 167         mxConfigurationControllerWeak.clear();
 168     }
 169
 170     for (const auto& rDescriptor : *mpPaneContainer)
 171     {
 172         if (rDescriptor.mbIsReleased)
 173         {
 174             Reference<XComponent> xComponent (rDescriptor.mxPane, UNO_QUERY);
 175             if (xComponent.is())
 176             {
 177                 xComponent->removeEventListener(this);
 178                 xComponent->dispose();
 179             }
 180         }
 181     }
 182 }
 183
 184 //===== XPaneFactory ==========================================================
 185
 186 Reference<XResource> SAL_CALL BasicPaneFactory::createResource (
 187     const Reference<XResourceId>& rxPaneId)
 188 {
 189     ThrowIfDisposed();
 190
 191     Reference<XResource> xPane;
 192
 193     // Based on the ResourceURL of the given ResourceId look up the
 194     // corresponding factory descriptor.
 195     PaneContainer::iterator iDescriptor (
 196         ::std::find_if (
 197             mpPaneContainer->begin(),
 198             mpPaneContainer->end(),
 199             [&] (PaneDescriptor const& rPane) {
 200                 return rPane.CompareURL(rxPaneId->getResourceURL());
 201             } ));
 202
 203     if (iDescriptor == mpPaneContainer->end())
 204     {
 205         // The requested pane can not be created by any of the factories
 206         // managed by the called BasicPaneFactory object.
 207         throw lang::IllegalArgumentException(u"BasicPaneFactory::createPane() called for unknown resource id"_ustr,
 208             nullptr,
 209             0);
 210     }
 211
 212     if (iDescriptor->mxPane.is())
 213     {
 214         // The pane has already been created and is still active (has
 215         // not yet been released).  This should not happen.
 216         xPane = iDescriptor->mxPane;
 217     }
 218     else
 219     {
 220         // Create a new pane.
 221         switch (iDescriptor->mePaneId)
 222         {
 223             case CenterPaneId:
 224                 xPane = CreateFrameWindowPane(rxPaneId);
 225                 break;
 226
 227             case FullScreenPaneId:
 228                 xPane = CreateFullScreenPane(mxComponentContext, rxPaneId);
 229                 break;
 230
 231             case LeftImpressPaneId:
 232             case BottomImpressPaneId:
 233             case LeftDrawPaneId:
 234                 xPane = CreateChildWindowPane(
 235                     rxPaneId,
 236                     *iDescriptor);
 237                 break;
 238         }
 239         iDescriptor->mxPane = xPane;
 240
 241         // Listen for the pane being disposed.
 242         Reference<lang::XComponent> xComponent (xPane, UNO_QUERY);
 243         if (xComponent.is())
 244             xComponent->addEventListener(this);
 245     }
 246     iDescriptor->mbIsReleased = false;
 247
 248
 249     return xPane;
 250 }
 251
 252 void SAL_CALL BasicPaneFactory::releaseResource (
 253     const Reference<XResource>& rxPane)
 254 {
 255     ThrowIfDisposed();
 256
 257     // Based on the given XPane reference look up the corresponding factory
 258     // descriptor.
 259     PaneContainer::iterator iDescriptor (
 260         ::std::find_if(
 261             mpPaneContainer->begin(),
 262             mpPaneContainer->end(),
 263             [&] (PaneDescriptor const& rPane) { return rPane.ComparePane(rxPane); } ));
 264
 265     if (iDescriptor == mpPaneContainer->end())
 266     {
 267         // The given XPane reference is either empty or the pane was not
 268         // created by any of the factories managed by the called
 269         // BasicPaneFactory object.
 270         throw lang::IllegalArgumentException(u"BasicPaneFactory::releasePane() called for pane that was not created by same factory."_ustr,
 271             nullptr,
 272             0);
 273     }
 274
 275     // The given pane was created by one of the factories.  Child
 276     // windows are just hidden and will be reused when requested later.
 277     // Other windows are disposed and their reference is reset so that
 278     // on the next createPane() call for the same pane type the pane is
 279     // created anew.
 280     ChildWindowPane* pChildWindowPane = dynamic_cast<ChildWindowPane*>(rxPane.get());
 281     if (pChildWindowPane != nullptr)
 282     {
 283         iDescriptor->mbIsReleased = true;
 284         pChildWindowPane->Hide();
 285     }
 286     else
 287     {
 288         iDescriptor->mxPane = nullptr;
 289         Reference<XComponent> xComponent (rxPane, UNO_QUERY);
 290         if (xComponent.is())
 291         {
 292             // We are disposing the pane and do not have to be informed of
 293             // that.
 294             xComponent->removeEventListener(this);
 295             xComponent->dispose();
 296         }
 297     }
 298
 299 }
 300
 301 //===== XConfigurationChangeListener ==========================================
 302
 303 void SAL_CALL BasicPaneFactory::notifyConfigurationChange (
 304     const ConfigurationChangeEvent& /* rEvent */ )
 305 {
 306     // FIXME: nothing to do
 307 }
 308
 309 //===== lang::XEventListener ==================================================
 310
 311 void SAL_CALL BasicPaneFactory::disposing (
 312     const lang::EventObject& rEventObject)
 313 {
 314     if (uno::Reference<XInterface>(cppu::getXWeak(mxConfigurationControllerWeak.get().get())) == rEventObject.Source)
 315     {
 316         mxConfigurationControllerWeak.clear();
 317     }
 318     else
 319     {
 320         // Has one of the panes been disposed?  If so, then release the
 321         // reference to that pane, but not the pane descriptor.
 322         Reference<XResource> xPane (rEventObject.Source, UNO_QUERY);
 323         PaneContainer::iterator iDescriptor (
 324             ::std::find_if (
 325                 mpPaneContainer->begin(),
 326                 mpPaneContainer->end(),
 327                 [&] (PaneDescriptor const& rPane) { return rPane.ComparePane(xPane); } ));
 328         if (iDescriptor != mpPaneContainer->end())
 329         {
 330             iDescriptor->mxPane = nullptr;
 331         }
 332     }
 333 }
 334
 335 Reference<XResource> BasicPaneFactory::CreateFrameWindowPane (
 336     const Reference<XResourceId>& rxPaneId)
 337 {
 338     Reference<XResource> xPane;
 339
 340     if (mpViewShellBase != nullptr)
 341     {
 342         xPane = new FrameWindowPane(rxPaneId, mpViewShellBase->GetViewWindow());
 343     }
 344
 345     return xPane;
 346 }
 347
 348 Reference<XResource> BasicPaneFactory::CreateFullScreenPane (
 349     const Reference<XComponentContext>& rxComponentContext,
 350     const Reference<XResourceId>& rxPaneId)
 351 {
 352     Reference<XResource> xPane (
 353         new FullScreenPane(
 354             rxComponentContext,
 355             rxPaneId,
 356             mpViewShellBase->GetViewWindow(),
 357             mpViewShellBase->GetDocShell()));
 358
 359     return xPane;
 360 }
 361
 362 Reference<XResource> BasicPaneFactory::CreateChildWindowPane (
 363     const Reference<XResourceId>& rxPaneId,
 364     const PaneDescriptor& rDescriptor)
 365 {
 366     Reference<XResource> xPane;
 367
 368     if (mpViewShellBase != nullptr)
 369     {
 370         // Create the corresponding shell and determine the id of the child window.
 371         sal_uInt16 nChildWindowId = 0;
 372         ::std::unique_ptr<SfxShell> pShell;
 373         switch (rDescriptor.mePaneId)
 374         {
 375             case LeftImpressPaneId:
 376                 pShell.reset(new LeftImpressPaneShell());
 377                 nChildWindowId = ::sd::LeftPaneImpressChildWindow::GetChildWindowId();
 378                 break;
 379
 380             case BottomImpressPaneId:
 381                 pShell.reset(new BottomImpressPaneShell());
 382                 nChildWindowId = ::sd::BottomPaneImpressChildWindow::GetChildWindowId();
 383                 break;
 384
 385             case LeftDrawPaneId:
 386                 pShell.reset(new LeftDrawPaneShell());
 387                 nChildWindowId = ::sd::LeftPaneDrawChildWindow::GetChildWindowId();
 388                 break;
 389
 390             default:
 391                 break;
 392         }
 393
 394         // With shell and child window id create the ChildWindowPane
 395         // wrapper.
 396         if (pShell != nullptr)
 397         {
 398             xPane = new ChildWindowPane(
 399                 rxPaneId,
 400                 nChildWindowId,
 401                 *mpViewShellBase,
 402                 std::move(pShell));
 403         }
 404     }
 405
 406     return xPane;
 407 }
 408
 409 void BasicPaneFactory::ThrowIfDisposed() const
 410 {
 411     if (m_bDisposed)
 412     {
 413         throw lang::DisposedException (u"BasicPaneFactory object has already been disposed"_ustr,
 414             const_cast<uno::XWeak*>(static_cast<const uno::XWeak*>(this)));
 415     }
 416 }
 417
 418 } // end of namespace sd::framework
 419
 420
 421 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */