sd/source/ui/tools/SdGlobalResourceContainer.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 <tools/SdGlobalResourceContainer.hxx>
  21
  22 #include <../cache/SlsCacheConfiguration.hxx>
  23
  24 #include <comphelper/processfactory.hxx>
  25 #include <comphelper/unique_disposing_ptr.hxx>
  26
  27 #include <com/sun/star/frame/Desktop.hpp>
  28
  29 #include <o3tl/deleter.hxx>
  30 #include <rtl/instance.hxx>
  31 #include <sal/log.hxx>
  32 #include <tools/debug.hxx>
  33
  34 #include <algorithm>
  35 #include <memory>
  36 #include <vector>
  37
  38 using namespace ::com::sun::star;
  39 using namespace ::com::sun::star::uno;
  40
  41 namespace sd {
  42
  43 class SdGlobalResourceContainerInstance
  44     : public comphelper::unique_disposing_solar_mutex_reset_ptr<SdGlobalResourceContainer>
  45 {
  46 public:
  47     SdGlobalResourceContainerInstance()
  48         : comphelper::unique_disposing_solar_mutex_reset_ptr<SdGlobalResourceContainer>(
  49             uno::Reference<lang::XComponent>(frame::Desktop::create(comphelper::getProcessComponentContext()), uno::UNO_QUERY_THROW),
  50             new SdGlobalResourceContainer, true)
  51     {
  52     }
  53 };
  54
  55 namespace {
  56
  57 struct theSdGlobalResourceContainerInstance : public rtl::Static<SdGlobalResourceContainerInstance, theSdGlobalResourceContainerInstance> {};
  58
  59 } // namespace
  60
  61 //===== SdGlobalResourceContainer::Implementation =============================
  62
  63 class SdGlobalResourceContainer::Implementation
  64 {
  65 private:
  66     friend class SdGlobalResourceContainer;
  67
  68     ::osl::Mutex maMutex;
  69
  70     /** All instances of SdGlobalResource in this vector are owned by the
  71         container and will be destroyed when the container is destroyed.
  72     */
  73     std::vector<std::unique_ptr<SdGlobalResource>> maResources;
  74
  75     typedef ::std::vector<std::shared_ptr<SdGlobalResource> > SharedResourceList;
  76     SharedResourceList maSharedResources;
  77
  78     typedef ::std::vector<Reference<XInterface> > XInterfaceResourceList;
  79     XInterfaceResourceList maXInterfaceResources;
  80 };
  81
  82 // static
  83 SdGlobalResourceContainer& SdGlobalResourceContainer::Instance()
  84 {
  85     SdGlobalResourceContainer *const pRet(theSdGlobalResourceContainerInstance::get().get());
  86     assert(pRet); // error if it has been deleted and is null
  87     return *pRet;
  88 }
  89
  90 //===== SdGlobalResourceContainer =============================================
  91
  92 void SdGlobalResourceContainer::AddResource (
  93     ::std::unique_ptr<SdGlobalResource> pResource)
  94 {
  95     ::osl::MutexGuard aGuard (mpImpl->maMutex);
  96
  97     assert( std::none_of(
  98                 mpImpl->maResources.begin(),
  99                 mpImpl->maResources.end(),
 100                 [&](const std::unique_ptr<SdGlobalResource>& p) { return p == pResource; })
 101             && "duplicate resource?");
 102
 103     mpImpl->maResources.push_back(std::move(pResource));
 104 }
 105
 106 void SdGlobalResourceContainer::AddResource (
 107     const std::shared_ptr<SdGlobalResource>& pResource)
 108 {
 109     ::osl::MutexGuard aGuard (mpImpl->maMutex);
 110
 111     Implementation::SharedResourceList::iterator iResource = ::std::find (
 112         mpImpl->maSharedResources.begin(),
 113         mpImpl->maSharedResources.end(),
 114         pResource);
 115     if (iResource == mpImpl->maSharedResources.end())
 116         mpImpl->maSharedResources.push_back(pResource);
 117     else
 118     {
 119         SAL_WARN ("sd.tools",
 120             "SdGlobalResourceContainer:AddResource(): Resource added twice.");
 121     }
 122 }
 123
 124 void SdGlobalResourceContainer::AddResource (const Reference<XInterface>& rxResource)
 125 {
 126     ::osl::MutexGuard aGuard (mpImpl->maMutex);
 127
 128     Implementation::XInterfaceResourceList::iterator iResource = ::std::find (
 129         mpImpl->maXInterfaceResources.begin(),
 130         mpImpl->maXInterfaceResources.end(),
 131         rxResource);
 132     if (iResource == mpImpl->maXInterfaceResources.end())
 133         mpImpl->maXInterfaceResources.push_back(rxResource);
 134     else
 135     {
 136         SAL_WARN ("sd.tools",
 137             "SdGlobalResourceContainer:AddResource(): Resource added twice.");
 138     }
 139 }
 140
 141 SdGlobalResourceContainer::SdGlobalResourceContainer()
 142     : mpImpl (new SdGlobalResourceContainer::Implementation)
 143 {
 144 }
 145
 146 SdGlobalResourceContainer::~SdGlobalResourceContainer()
 147 {
 148     ::osl::MutexGuard aGuard (mpImpl->maMutex);
 149
 150     // Release the resources in reversed order of their addition to the
 151     // container.  This is because a resource A added before resource B
 152     // may have been created due to a request of B.  Thus B depends on A and
 153     // should be destroyed first.
 154     for (auto iResource = mpImpl->maResources.rbegin();
 155          iResource != mpImpl->maResources.rend();
 156          ++iResource)
 157     {
 158         iResource->reset();
 159     }
 160
 161
 162     // The SharedResourceList has not to be released manually.  We just
 163     // assert resources that are still held by someone other than us.
 164     Implementation::SharedResourceList::reverse_iterator iSharedResource;
 165     for (iSharedResource = mpImpl->maSharedResources.rbegin();
 166          iSharedResource != mpImpl->maSharedResources.rend();
 167          ++iSharedResource)
 168     {
 169         if (iSharedResource->use_count() > 1)
 170         {
 171             SdGlobalResource* pResource = iSharedResource->get();
 172             SAL_INFO(
 173                 "sd.tools", pResource << " " << iSharedResource->use_count());
 174             DBG_ASSERT(iSharedResource->use_count() == 1,
 175                 "SdGlobalResource still held in ~SdGlobalResourceContainer");
 176         }
 177     }
 178
 179     Implementation::XInterfaceResourceList::reverse_iterator iXInterfaceResource;
 180     for (iXInterfaceResource = mpImpl->maXInterfaceResources.rbegin();
 181          iXInterfaceResource != mpImpl->maXInterfaceResources.rend();
 182          ++iXInterfaceResource)
 183     {
 184         Reference<lang::XComponent> xComponent (*iXInterfaceResource, UNO_QUERY);
 185         *iXInterfaceResource = nullptr;
 186         if (xComponent.is())
 187             xComponent->dispose();
 188     }
 189
 190     sd::slidesorter::cache::CacheConfiguration::Shutdown();
 191 }
 192
 193 } // end of namespace sd
 194
 195 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */