cppuhelper/source/servicemanager.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
  10 #ifndef INCLUDED_CPPUHELPER_SOURCE_SERVICEMANAGER_HXX
  11 #define INCLUDED_CPPUHELPER_SOURCE_SERVICEMANAGER_HXX
  12
  13 #include <sal/config.h>
  14
  15 #include <cassert>
  16 #include <map>
  17 #include <memory>
  18 #include <vector>
  19
  20 #include <com/sun/star/beans/XPropertySet.hpp>
  21 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  22 #include <com/sun/star/container/XContentEnumerationAccess.hpp>
  23 #include <com/sun/star/container/XSet.hpp>
  24 #include <com/sun/star/lang/XEventListener.hpp>
  25 #include <com/sun/star/lang/XInitialization.hpp>
  26 #include <com/sun/star/lang/XMultiComponentFactory.hpp>
  27 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  28 #include <com/sun/star/lang/XServiceInfo.hpp>
  29 #include <com/sun/star/uno/Reference.hxx>
  30 #include <cppuhelper/basemutex.hxx>
  31 #include <cppuhelper/compbase.hxx>
  32 #include <osl/mutex.hxx>
  33 #include <rtl/ustring.hxx>
  34
  35 namespace com { namespace sun { namespace star { namespace lang {
  36     class XSingleComponentFactory;
  37 } } } }
  38 namespace cppu { struct ContextEntry_Init; }
  39 namespace com :: sun :: star :: lang { class XSingleServiceFactory; }
  40 namespace com :: sun :: star :: uno { class XComponentContext; }
  41
  42 class RegistryKey;
  43
  44 namespace cppuhelper {
  45
  46 extern "C" {
  47
  48 typedef css::uno::XInterface * ImplementationConstructorFn(
  49     css::uno::XComponentContext *, css::uno::Sequence<css::uno::Any> const &);
  50
  51 }
  52
  53 typedef std::function<css::uno::XInterface * (css::uno::XComponentContext *, css::uno::Sequence<css::uno::Any> const&)> WrapperConstructorFn;
  54
  55 typedef cppu::WeakComponentImplHelper<
  56     css::lang::XServiceInfo, css::lang::XMultiServiceFactory,
  57     css::lang::XMultiComponentFactory, css::container::XSet,
  58     css::container::XContentEnumerationAccess, css::beans::XPropertySet,
  59     css::beans::XPropertySetInfo, css::lang::XEventListener,
  60     css::lang::XInitialization>
  61 ServiceManagerBase;
  62
  63 class ServiceManager:
  64     private cppu::BaseMutex, public ServiceManagerBase
  65 {
  66 public:
  67     struct Data {
  68         Data() = default;
  69         Data(const Data&) = delete;
  70         const Data& operator=(const Data&) = delete;
  71
  72         struct ImplementationInfo {
  73             ImplementationInfo(
  74                 OUString const & theName, OUString const & theLoader,
  75                 OUString const & theUri,
  76                 OUString const & theEnvironment,
  77                 OUString const & theConstructor,
  78                 OUString const & thePrefix,
  79                 css::uno::Reference< css::uno::XComponentContext > const &
  80                     theAlienContext,
  81                 OUString const & theRdbFile):
  82                 name(theName), loader(theLoader), uri(theUri),
  83                 environment(theEnvironment), constructor(theConstructor),
  84                 prefix(thePrefix), alienContext(theAlienContext),
  85                 rdbFile(theRdbFile)
  86             {}
  87
  88             explicit ImplementationInfo(OUString const & theName):
  89                 name(theName) {}
  90
  91             ImplementationInfo(const ImplementationInfo&) = delete;
  92             const ImplementationInfo& operator=(const ImplementationInfo&) = delete;
  93
  94             OUString const name;
  95             OUString const loader;
  96             OUString const uri;
  97             OUString const environment;
  98             OUString const constructor;
  99             OUString const prefix;
 100             css::uno::Reference< css::uno::XComponentContext > const
 101                 alienContext;
 102             OUString const rdbFile;
 103             std::vector< OUString > services;
 104             std::vector< OUString > singletons;
 105         };
 106
 107         struct Implementation {
 108             Implementation(
 109                 OUString const & name, OUString const & loader,
 110                 OUString const & uri, OUString const & environment,
 111                 OUString const & constructorName,
 112                 OUString const & prefix,
 113                 css::uno::Reference< css::uno::XComponentContext > const &
 114                     alienContext,
 115                 OUString const & rdbFile):
 116                 info(
 117                     new ImplementationInfo(
 118                         name, loader, uri, environment, constructorName, prefix,
 119                         alienContext, rdbFile)),
 120                 constructor(nullptr), status(STATUS_NEW), dispose(true)
 121             {}
 122
 123             Implementation(
 124                 OUString const & name,
 125                 css::uno::Reference< css::lang::XSingleComponentFactory >
 126                     const & theFactory1,
 127                 css::uno::Reference< css::lang::XSingleServiceFactory > const &
 128                     theFactory2,
 129                 css::uno::Reference< css::lang::XComponent > const &
 130                     theComponent):
 131                 info(new ImplementationInfo(name)), constructor(nullptr),
 132                 factory1(theFactory1), factory2(theFactory2),
 133                 component(theComponent), status(STATUS_LOADED), dispose(true)
 134             { assert(theFactory1.is() || theFactory2.is()); }
 135
 136             Implementation(const Implementation&) = delete;
 137             const Implementation& operator=(const Implementation&) = delete;
 138
 139             css::uno::Reference<css::uno::XInterface> createInstance(
 140                 css::uno::Reference<css::uno::XComponentContext> const &
 141                     context,
 142                 bool singletonRequest);
 143
 144             css::uno::Reference<css::uno::XInterface>
 145             createInstanceWithArguments(
 146                 css::uno::Reference<css::uno::XComponentContext> const &
 147                     context,
 148                 bool singletonRequest,
 149                 css::uno::Sequence<css::uno::Any> const & arguments);
 150
 151             enum Status { STATUS_NEW, STATUS_WRAPPER, STATUS_LOADED };
 152
 153             // Logically, exactly one of constructor, factory1, factory2 should
 154             // be set.  However, there are two exceptions:  For one, when
 155             // constructor is set, ServiceManager::createContentEnumeration will
 156             // store the necessary ImplementationWrapper in factory1 (so that
 157             // multiple calls to createContentEnumeration will return the same
 158             // wrapper).  For another, when factory1 should be set but status is
 159             // STATUS_NEW, factory1 is not yet set (and when status is
 160             // STATUS_WRAPPER, factory1 is merely set to an
 161             // ImplementationWrapper---also due to a
 162             // ServiceManager::createContentEnumeration call---and will be
 163             // loaded later).
 164             std::shared_ptr< ImplementationInfo > info;
 165             WrapperConstructorFn constructor;
 166             css::uno::Reference< css::lang::XSingleComponentFactory > factory1;
 167             css::uno::Reference< css::lang::XSingleServiceFactory > factory2;
 168             css::uno::Reference< css::lang::XComponent > component;
 169             Status status;
 170
 171             osl::Mutex mutex;
 172             css::uno::Reference< css::lang::XComponent > disposeSingleton;
 173             bool dispose;
 174
 175         private:
 176             void updateDisposeSingleton(
 177                 bool singletonRequest,
 178                 css::uno::Reference<css::uno::XInterface> const & instance);
 179         };
 180
 181         typedef std::map< OUString, std::shared_ptr< Implementation > >
 182             NamedImplementations;
 183
 184         typedef
 185             std::map<
 186                 css::uno::Reference< css::lang::XServiceInfo >,
 187                 std::shared_ptr< Implementation > >
 188             DynamicImplementations;
 189
 190         typedef
 191             std::map<
 192                 OUString,
 193                 std::vector< std::shared_ptr< Implementation > > >
 194             ImplementationMap;
 195
 196         NamedImplementations namedImplementations;
 197         DynamicImplementations dynamicImplementations;
 198         ImplementationMap services;
 199         ImplementationMap singletons;
 200     };
 201
 202     ServiceManager(): ServiceManagerBase(m_aMutex) {}
 203
 204     ServiceManager(const ServiceManager&) = delete;
 205     const ServiceManager& operator=(const ServiceManager&) = delete;
 206
 207     using ServiceManagerBase::acquire;
 208     using ServiceManagerBase::release;
 209
 210     void init(OUString const & rdbUris);
 211
 212     void setContext(
 213         css::uno::Reference< css::uno::XComponentContext > const & context)
 214     {
 215         assert(context.is());
 216         assert(!context_.is());
 217         context_ = context;
 218     }
 219
 220     void addSingletonContextEntries(
 221         std::vector< cppu::ContextEntry_Init > * entries);
 222
 223     css::uno::Reference< css::uno::XComponentContext > const & getContext()
 224         const
 225     {
 226         assert(context_.is());
 227         return context_;
 228     }
 229
 230     void loadImplementation(
 231         css::uno::Reference< css::uno::XComponentContext > const & context,
 232         std::shared_ptr< Data::Implementation > const & implementation);
 233
 234 private:
 235     virtual ~ServiceManager() override;
 236
 237     virtual void SAL_CALL disposing() override;
 238
 239     virtual OUString SAL_CALL getImplementationName() override;
 240
 241     virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override;
 242
 243     virtual css::uno::Sequence< OUString > SAL_CALL
 244     getSupportedServiceNames() override;
 245
 246     virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstance(
 247         OUString const & aServiceSpecifier) override;
 248
 249     virtual css::uno::Reference< css::uno::XInterface > SAL_CALL
 250     createInstanceWithArguments(
 251         OUString const & ServiceSpecifier,
 252         css::uno::Sequence< css::uno::Any > const & Arguments) override;
 253
 254     virtual css::uno::Sequence< OUString > SAL_CALL
 255     getAvailableServiceNames() override;
 256
 257     virtual css::uno::Reference< css::uno::XInterface > SAL_CALL
 258     createInstanceWithContext(
 259         OUString const & aServiceSpecifier,
 260         css::uno::Reference< css::uno::XComponentContext > const & Context) override;
 261
 262     virtual css::uno::Reference< css::uno::XInterface > SAL_CALL
 263     createInstanceWithArgumentsAndContext(
 264         OUString const & ServiceSpecifier,
 265         css::uno::Sequence< css::uno::Any > const & Arguments,
 266         css::uno::Reference< css::uno::XComponentContext > const & Context) override;
 267
 268     virtual css::uno::Type SAL_CALL getElementType() override;
 269
 270     virtual sal_Bool SAL_CALL hasElements() override;
 271
 272     virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL
 273     createEnumeration() override;
 274
 275     virtual sal_Bool SAL_CALL has(css::uno::Any const & aElement) override;
 276
 277     virtual void SAL_CALL insert(css::uno::Any const & aElement) override;
 278
 279     virtual void SAL_CALL remove(css::uno::Any const & aElement) override;
 280
 281     virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL
 282     createContentEnumeration(OUString const & aServiceName) override;
 283
 284     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL
 285     getPropertySetInfo() override;
 286
 287     virtual void SAL_CALL setPropertyValue(
 288         OUString const & aPropertyName, css::uno::Any const & aValue) override;
 289
 290     virtual css::uno::Any SAL_CALL getPropertyValue(
 291         OUString const & PropertyName) override;
 292
 293     virtual void SAL_CALL addPropertyChangeListener(
 294         OUString const & aPropertyName,
 295         css::uno::Reference< css::beans::XPropertyChangeListener > const &
 296             xListener) override;
 297
 298     virtual void SAL_CALL removePropertyChangeListener(
 299         OUString const & aPropertyName,
 300         css::uno::Reference< css::beans::XPropertyChangeListener > const &
 301             aListener) override;
 302
 303     virtual void SAL_CALL addVetoableChangeListener(
 304         OUString const & PropertyName,
 305         css::uno::Reference< css::beans::XVetoableChangeListener > const &
 306             aListener) override;
 307
 308     virtual void SAL_CALL removeVetoableChangeListener(
 309         OUString const & PropertyName,
 310         css::uno::Reference< css::beans::XVetoableChangeListener > const &
 311             aListener) override;
 312
 313     virtual css::uno::Sequence< css::beans::Property > SAL_CALL getProperties() override;
 314
 315     virtual css::beans::Property SAL_CALL getPropertyByName(
 316         OUString const & aName) override;
 317
 318     virtual sal_Bool SAL_CALL hasPropertyByName(OUString const & Name) override;
 319
 320     virtual void SAL_CALL disposing(css::lang::EventObject const & Source) override;
 321
 322     virtual void SAL_CALL initialize(
 323         css::uno::Sequence<css::uno::Any> const & aArguments)
 324         override;
 325
 326     // needs to be called with rBHelper.rMutex locked:
 327     bool isDisposed() const { return rBHelper.bDisposed || rBHelper.bInDispose; }
 328
 329     void removeEventListenerFromComponent(
 330         css::uno::Reference< css::lang::XComponent > const & component);
 331
 332     void readRdbDirectory(OUString const & uri, bool optional);
 333
 334     void readRdbFile(OUString const & uri, bool optional);
 335
 336     bool readLegacyRdbFile(OUString const & uri);
 337
 338     OUString readLegacyRdbString(
 339         OUString const & uri, RegistryKey & key,
 340         OUString const & path);
 341
 342     void readLegacyRdbStrings(
 343         OUString const & uri, RegistryKey & key,
 344         OUString const & path, std::vector< OUString > * strings);
 345
 346     void insertRdbFiles(
 347         std::vector< OUString > const & uris,
 348         css::uno::Reference< css::uno::XComponentContext > const &
 349             alientContext);
 350
 351     void insertLegacyFactory(
 352         css::uno::Reference< css::lang::XServiceInfo > const & factoryInfo);
 353
 354     bool insertExtraData(Data const & extra);
 355
 356     void removeRdbFiles(std::vector< OUString > const & uris);
 357
 358     bool removeLegacyFactory(
 359         css::uno::Reference< css::lang::XServiceInfo > const & factoryInfo,
 360         bool removeListener);
 361
 362     void removeImplementation(const OUString & name);
 363
 364     std::shared_ptr< Data::Implementation > findServiceImplementation(
 365         css::uno::Reference< css::uno::XComponentContext > const & context,
 366         OUString const & specifier);
 367
 368     void preloadImplementations();
 369
 370     css::uno::Reference< css::uno::XComponentContext > context_;
 371     Data data_;
 372 };
 373
 374 }
 375
 376 #endif
 377
 378 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */