sd/source/ui/framework/configuration/ChangeRequestQueueProcessor.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ChangeRequestQueueProcessor.cxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #include "precompiled_sd.hxx"
  32
  33 #include "ChangeRequestQueueProcessor.hxx"
  34 #include "ConfigurationTracer.hxx"
  35
  36 #include "framework/ConfigurationController.hxx"
  37 #include "ConfigurationUpdater.hxx"
  38
  39 #include <vcl/svapp.hxx>
  40 #include <com/sun/star/container/XNamed.hpp>
  41 #include <com/sun/star/drawing/framework/XConfiguration.hpp>
  42 #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.hpp>
  43
  44 using namespace ::com::sun::star;
  45 using namespace ::com::sun::star::uno;
  46 using namespace ::com::sun::star::drawing::framework;
  47
  48 #undef VERBOSE
  49 //#define VERBOSE 1
  50
  51 namespace {
  52
  53 #ifdef VERBOSE
  54
  55 void TraceRequest (const Reference<XConfigurationChangeRequest>& rxRequest)
  56 {
  57     Reference<container::XNamed> xNamed (rxRequest, UNO_QUERY);
  58     if (xNamed.is())
  59         OSL_TRACE("    %s\n",
  60             ::rtl::OUStringToOString(xNamed->getName(), RTL_TEXTENCODING_UTF8).getStr());
  61 }
  62
  63 #endif
  64
  65 } // end of anonymous namespace
  66
  67
  68 namespace sd { namespace framework {
  69
  70 ChangeRequestQueueProcessor::ChangeRequestQueueProcessor (
  71     const ::rtl::Reference<ConfigurationController>& rpConfigurationController,
  72     const ::boost::shared_ptr<ConfigurationUpdater>& rpConfigurationUpdater)
  73     : maMutex(),
  74       maQueue(),
  75       mnUserEventId(0),
  76       mxConfiguration(),
  77       mpConfigurationController(rpConfigurationController),
  78       mpConfigurationUpdater(rpConfigurationUpdater)
  79 {
  80 }
  81
  82
  83
  84
  85 ChangeRequestQueueProcessor::~ChangeRequestQueueProcessor (void)
  86 {
  87     if (mnUserEventId != 0)
  88         Application::RemoveUserEvent(mnUserEventId);
  89 }
  90
  91
  92
  93
  94 void ChangeRequestQueueProcessor::SetConfiguration (
  95     const Reference<XConfiguration>& rxConfiguration)
  96 {
  97     ::osl::MutexGuard aGuard (maMutex);
  98
  99     mxConfiguration = rxConfiguration;
 100     StartProcessing();
 101 }
 102
 103
 104
 105
 106 void ChangeRequestQueueProcessor::AddRequest (
 107     const Reference<XConfigurationChangeRequest>& rxRequest)
 108 {
 109     ::osl::MutexGuard aGuard (maMutex);
 110
 111 #ifdef VERBOSE
 112     if (maQueue.empty())
 113     {
 114         OSL_TRACE("Adding requests to empty queue\n");
 115         ConfigurationTracer::TraceConfiguration(
 116             mxConfiguration, "current configuration of queue processor");
 117     }
 118     OSL_TRACE("Adding request\n");
 119     TraceRequest(rxRequest);
 120 #endif
 121
 122     maQueue.push_back(rxRequest);
 123     StartProcessing();
 124 }
 125
 126
 127
 128
 129 void ChangeRequestQueueProcessor::StartProcessing (void)
 130 {
 131     ::osl::MutexGuard aGuard (maMutex);
 132
 133     if (mnUserEventId == 0
 134         && mxConfiguration.is()
 135         && ! maQueue.empty())
 136     {
 137 #ifdef VERBOSE
 138         OSL_TRACE("ChangeRequestQueueProcessor scheduling processing\n");
 139 #endif
 140         mnUserEventId = Application::PostUserEvent(
 141             LINK(this,ChangeRequestQueueProcessor,ProcessEvent));
 142     }
 143 }
 144
 145
 146
 147
 148 IMPL_LINK(ChangeRequestQueueProcessor, ProcessEvent, void*, pUnused)
 149 {
 150     (void)pUnused;
 151
 152     ::osl::MutexGuard aGuard (maMutex);
 153
 154     mnUserEventId = 0;
 155
 156     ProcessOneEvent();
 157
 158     if ( ! maQueue.empty())
 159     {
 160         // Schedule the processing of the next event.
 161         StartProcessing();
 162     }
 163
 164     return 0;
 165 }
 166
 167
 168
 169
 170 void ChangeRequestQueueProcessor::ProcessOneEvent (void)
 171 {
 172     ::osl::MutexGuard aGuard (maMutex);
 173
 174 #ifdef VERBOSE
 175     OSL_TRACE("ProcessOneEvent\n");
 176 #endif
 177
 178     if (mxConfiguration.is()
 179         && ! maQueue.empty())
 180     {
 181         // Get and remove the first entry from the queue.
 182         Reference<XConfigurationChangeRequest> xRequest (maQueue.front());
 183         maQueue.pop_front();
 184
 185         // Execute the change request.
 186         if (xRequest.is())
 187         {
 188 #ifdef VERBOSE
 189             TraceRequest(xRequest);
 190 #endif
 191             xRequest->execute(mxConfiguration);
 192         }
 193
 194         if (maQueue.empty())
 195         {
 196 #ifdef VERBOSE
 197             OSL_TRACE("All requests are processed\n");
 198 #endif
 199             // The queue is empty so tell the ConfigurationManager to update
 200             // its state.
 201             if (mpConfigurationUpdater.get() != NULL)
 202             {
 203                 ConfigurationTracer::TraceConfiguration (
 204                     mxConfiguration, "updating to configuration");
 205
 206                 mpConfigurationUpdater->RequestUpdate(mxConfiguration);
 207             }
 208         }
 209     }
 210 }
 211
 212
 213
 214
 215 bool ChangeRequestQueueProcessor::IsEmpty (void) const
 216 {
 217     return maQueue.empty();
 218 }
 219
 220
 221
 222
 223 void ChangeRequestQueueProcessor::ProcessUntilEmpty (void)
 224 {
 225     while ( ! IsEmpty())
 226         ProcessOneEvent();
 227 }
 228
 229
 230
 231
 232 void ChangeRequestQueueProcessor::Clear (void)
 233 {
 234     ::osl::MutexGuard aGuard (maMutex);
 235     maQueue.clear();
 236 }
 237
 238
 239 } } // end of namespace sd::framework::configuration