sd/source/ui/framework/configuration/Configuration.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: Configuration.cxx,v $
  10  * $Revision: 1.4 $
  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 "framework/Configuration.hxx"
  34
  35 #include "framework/FrameworkHelper.hxx"
  36 #include <comphelper/stl_types.hxx>
  37
  38
  39
  40 using namespace ::com::sun::star;
  41 using namespace ::com::sun::star::uno;
  42 using namespace ::com::sun::star::drawing::framework;
  43 using ::sd::framework::FrameworkHelper;
  44 using ::rtl::OUString;
  45
  46 #undef VERBOSE
  47
  48 namespace {
  49 /** Use the XResourceId::compareTo() method to implement a compare operator
  50     for STL containers.
  51 */
  52 class XResourceIdLess
  53     :   public ::std::binary_function <Reference<XResourceId>, Reference<XResourceId>, bool>
  54 {
  55 public:
  56     bool operator () (const Reference<XResourceId>& rId1, const Reference<XResourceId>& rId2) const
  57     {
  58         return rId1->compareTo(rId2) == -1;
  59     }
  60 };
  61
  62 } // end of anonymous namespace
  63
  64
  65
  66
  67 namespace sd { namespace framework {
  68
  69
  70 class Configuration::ResourceContainer
  71     : public ::std::set<Reference<XResourceId>, XResourceIdLess>
  72 {
  73 public:
  74     ResourceContainer (void) {}
  75 };
  76
  77
  78
  79
  80 //----- Service ---------------------------------------------------------------
  81
  82 Reference<XInterface> SAL_CALL Configuration_createInstance (
  83     const Reference<XComponentContext>& rxContext)
  84 {
  85     (void)rxContext;
  86     return Reference<XInterface>(static_cast<XWeak*>(new Configuration(NULL,false)));
  87 }
  88
  89
  90
  91
  92 OUString Configuration_getImplementationName (void) throw(RuntimeException)
  93 {
  94     return OUString(RTL_CONSTASCII_USTRINGPARAM(
  95         "com.sun.star.comp.Draw.framework.configuration.Configuration"));
  96 }
  97
  98
  99
 100
 101 Sequence<rtl::OUString> SAL_CALL Configuration_getSupportedServiceNames (void)
 102     throw (RuntimeException)
 103 {
 104     static const OUString sServiceName(OUString::createFromAscii(
 105         "com.sun.star.drawing.framework.Configuration"));
 106     return Sequence<rtl::OUString>(&sServiceName, 1);
 107 }
 108
 109
 110
 111
 112 //===== Configuration =========================================================
 113
 114 Configuration::Configuration (
 115     const Reference<XConfigurationControllerBroadcaster>& rxBroadcaster,
 116     bool bBroadcastRequestEvents)
 117     : ConfigurationInterfaceBase(MutexOwner::maMutex),
 118       mpResourceContainer(new ResourceContainer()),
 119       mxBroadcaster(rxBroadcaster),
 120       mbBroadcastRequestEvents(bBroadcastRequestEvents)
 121 {
 122 }
 123
 124
 125
 126 Configuration::Configuration (
 127     const Reference<XConfigurationControllerBroadcaster>& rxBroadcaster,
 128     bool bBroadcastRequestEvents,
 129     const ResourceContainer& rResourceContainer)
 130     : ConfigurationInterfaceBase(MutexOwner::maMutex),
 131       mpResourceContainer(new ResourceContainer(rResourceContainer)),
 132       mxBroadcaster(rxBroadcaster),
 133       mbBroadcastRequestEvents(bBroadcastRequestEvents)
 134 {
 135 }
 136
 137
 138
 139
 140 Configuration::~Configuration (void)
 141 {
 142 }
 143
 144
 145
 146
 147 void SAL_CALL Configuration::disposing (void)
 148 {
 149     ::osl::MutexGuard aGuard (maMutex);
 150     mpResourceContainer->clear();
 151     mxBroadcaster = NULL;
 152 }
 153
 154
 155
 156
 157 //----- XConfiguration --------------------------------------------------------
 158
 159 void SAL_CALL Configuration::addResource (const Reference<XResourceId>& rxResourceId)
 160     throw (RuntimeException)
 161 {
 162     ThrowIfDisposed();
 163
 164     if ( ! rxResourceId.is() || rxResourceId->getResourceURL().getLength()==0)
 165         throw ::com::sun::star::lang::IllegalArgumentException();
 166
 167     if (mpResourceContainer->find(rxResourceId) == mpResourceContainer->end())
 168     {
 169 #ifdef VERBOSE
 170     OSL_TRACE("Configuration::addResource() %s",
 171         OUStringToOString(
 172             FrameworkHelper::ResourceIdToString(rxResourceId), RTL_TEXTENCODING_UTF8).getStr());
 173 #endif
 174         mpResourceContainer->insert(rxResourceId);
 175         PostEvent(rxResourceId, true);
 176     }
 177 }
 178
 179
 180
 181
 182 void SAL_CALL Configuration::removeResource (const Reference<XResourceId>& rxResourceId)
 183     throw (RuntimeException)
 184 {
 185     ThrowIfDisposed();
 186
 187     if ( ! rxResourceId.is() || rxResourceId->getResourceURL().getLength()==0)
 188         throw ::com::sun::star::lang::IllegalArgumentException();
 189
 190     ResourceContainer::iterator iResource (mpResourceContainer->find(rxResourceId));
 191     if (iResource != mpResourceContainer->end())
 192     {
 193 #ifdef VERBOSE
 194     OSL_TRACE("Configuration::removeResource() %s",
 195         OUStringToOString(
 196             FrameworkHelper::ResourceIdToString(rxResourceId), RTL_TEXTENCODING_UTF8).getStr());
 197 #endif
 198         PostEvent(rxResourceId,false);
 199         mpResourceContainer->erase(iResource);
 200     }
 201 }
 202
 203
 204
 205
 206 Sequence<Reference<XResourceId> > SAL_CALL Configuration::getResources (
 207     const Reference<XResourceId>& rxAnchorId,
 208     const ::rtl::OUString& rsResourceURLPrefix,
 209     AnchorBindingMode eMode)
 210     throw (::com::sun::star::uno::RuntimeException)
 211 {
 212     ::osl::MutexGuard aGuard (maMutex);
 213     ThrowIfDisposed();
 214
 215     bool bFilterResources (rsResourceURLPrefix.getLength() > 0);
 216
 217     // Collect the matching resources in a vector.
 218     ::std::vector<Reference<XResourceId> > aResources;
 219     ResourceContainer::const_iterator iResource;
 220     for (iResource=mpResourceContainer->begin();
 221          iResource!=mpResourceContainer->end();
 222          ++iResource)
 223     {
 224         if ( ! (*iResource)->isBoundTo(rxAnchorId,eMode))
 225             continue;
 226
 227
 228         if (bFilterResources)
 229         {
 230             // Apply the given resource prefix as filter.
 231
 232             // Make sure that the resource is bound directly to the anchor.
 233             if (eMode != AnchorBindingMode_DIRECT
 234                 && ! (*iResource)->isBoundTo(rxAnchorId, AnchorBindingMode_DIRECT))
 235             {
 236                 continue;
 237             }
 238
 239             // Make sure that the resource URL matches the given prefix.
 240             if ( ! (*iResource)->getResourceURL().match(rsResourceURLPrefix))
 241             {
 242                 continue;
 243             }
 244         }
 245
 246         aResources.push_back(*iResource);
 247     }
 248
 249     // Copy the resources from the vector into a new sequence.
 250     Sequence<Reference<XResourceId> > aResult (aResources.size());
 251     for (sal_uInt32 nIndex=0; nIndex<aResources.size(); ++nIndex)
 252         aResult[nIndex] = aResources[nIndex];
 253
 254     return aResult;
 255 }
 256
 257
 258
 259
 260 sal_Bool SAL_CALL Configuration::hasResource (const Reference<XResourceId>& rxResourceId)
 261     throw (RuntimeException)
 262 {
 263     ::osl::MutexGuard aGuard (maMutex);
 264     ThrowIfDisposed();
 265
 266     return rxResourceId.is()
 267         && mpResourceContainer->find(rxResourceId) != mpResourceContainer->end();
 268 }
 269
 270
 271
 272
 273 //----- XCloneable ------------------------------------------------------------
 274
 275 Reference<util::XCloneable> SAL_CALL Configuration::createClone (void)
 276     throw (RuntimeException)
 277 {
 278     ::osl::MutexGuard aGuard (maMutex);
 279     ThrowIfDisposed();
 280
 281     Configuration* pConfiguration = new Configuration(
 282         mxBroadcaster,
 283         mbBroadcastRequestEvents,
 284         *mpResourceContainer);
 285
 286     return Reference<util::XCloneable>(pConfiguration);
 287 }
 288
 289
 290
 291
 292 //----- XNamed ----------------------------------------------------------------
 293
 294 OUString SAL_CALL Configuration::getName (void)
 295     throw (RuntimeException)
 296 {
 297     ::osl::MutexGuard aGuard (maMutex);
 298     OUString aString;
 299
 300     if (rBHelper.bDisposed || rBHelper.bInDispose)
 301         aString += OUString::createFromAscii("DISPOSED ");
 302     aString += OUString::createFromAscii("Configuration[");
 303
 304     ResourceContainer::const_iterator iResource;
 305     for (iResource=mpResourceContainer->begin();
 306          iResource!=mpResourceContainer->end();
 307          ++iResource)
 308     {
 309         if (iResource != mpResourceContainer->begin())
 310             aString += OUString::createFromAscii(", ");
 311         aString += FrameworkHelper::ResourceIdToString(*iResource);
 312     }
 313     aString += OUString::createFromAscii("]");
 314
 315     return aString;
 316 }
 317
 318
 319
 320
 321 void SAL_CALL Configuration::setName (const OUString& rsName)
 322     throw (RuntimeException)
 323 {
 324     (void)rsName; // rsName is ignored.
 325 }
 326
 327
 328
 329
 330
 331 // ----------------------------------------------------------------------------
 332
 333 void Configuration::PostEvent (
 334     const Reference<XResourceId>& rxResourceId,
 335     const bool bActivation)
 336 {
 337     OSL_ASSERT(rxResourceId.is());
 338
 339     if (mxBroadcaster.is())
 340     {
 341         ConfigurationChangeEvent aEvent;
 342         aEvent.ResourceId = rxResourceId;
 343         if (bActivation)
 344             if (mbBroadcastRequestEvents)
 345                 aEvent.Type = FrameworkHelper::msResourceActivationRequestEvent;
 346             else
 347                 aEvent.Type = FrameworkHelper::msResourceActivationEvent;
 348         else
 349             if (mbBroadcastRequestEvents)
 350                 aEvent.Type = FrameworkHelper::msResourceDeactivationRequestEvent;
 351             else
 352                 aEvent.Type = FrameworkHelper::msResourceDeactivationEvent;
 353         aEvent.Configuration = this;
 354
 355         mxBroadcaster->notifyEvent(aEvent);
 356     }
 357 }
 358
 359
 360
 361
 362 void Configuration::ThrowIfDisposed (void) const
 363     throw (::com::sun::star::lang::DisposedException)
 364 {
 365     if (rBHelper.bDisposed || rBHelper.bInDispose)
 366     {
 367         throw lang::DisposedException (
 368             OUString(RTL_CONSTASCII_USTRINGPARAM(
 369                 "Configuration object has already been disposed")),
 370             const_cast<uno::XWeak*>(static_cast<const uno::XWeak*>(this)));
 371     }
 372 }
 373
 374
 375
 376
 377 //=============================================================================
 378
 379 bool AreConfigurationsEquivalent (
 380     const Reference<XConfiguration>& rxConfiguration1,
 381     const Reference<XConfiguration>& rxConfiguration2)
 382 {
 383     if (rxConfiguration1.is() != rxConfiguration2.is())
 384         return false;
 385     if ( ! rxConfiguration1.is() && ! rxConfiguration2.is())
 386         return true;
 387
 388     // Get the lists of resources from the two given configurations.
 389     const Sequence<Reference<XResourceId> > aResources1(
 390         rxConfiguration1->getResources(
 391             NULL, OUString(), AnchorBindingMode_INDIRECT));
 392     const Sequence<Reference<XResourceId> > aResources2(
 393         rxConfiguration2->getResources(
 394             NULL, OUString(), AnchorBindingMode_INDIRECT));
 395
 396     // When the number of resources differ then the configurations can not
 397     // be equivalent.
 398     const sal_Int32 nCount (aResources1.getLength());
 399     const sal_Int32 nCount2 (aResources2.getLength());
 400     if (nCount != nCount2)
 401         return false;
 402
 403     // Comparison of the two lists of resource ids relies on their
 404     // ordering.
 405     for (sal_Int32 nIndex=0; nIndex<nCount; ++nIndex)
 406     {
 407         const Reference<XResourceId> xResource1 (aResources1[nIndex]);
 408         const Reference<XResourceId> xResource2 (aResources2[nIndex]);
 409         if (xResource1.is() && xResource2.is())
 410         {
 411             if (xResource1->compareTo(xResource2) != 0)
 412                 return false;
 413         }
 414         else if (xResource1.is() != xResource2.is())
 415         {
 416             return false;
 417         }
 418     }
 419
 420     return true;
 421 }
 422
 423 } } // end of namespace sd::framework