extensions/source/inc/componentmodule.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _EXTENSIONS_COMPONENT_MODULE_HXX_
  30 #define _EXTENSIONS_COMPONENT_MODULE_HXX_
  31
  32 /** you may find this file helpfull if you implement a component (in it's own library) which can't use
  33     the usual infrastructure.<br/>
  34     More precise, you find helper classes to ease the use of resources and the registration of services.
  35     <p>
  36     You need to define a preprocessor variable COMPMOD_NAMESPACE in order to use this file. Set it to a string
  37     which should be used as namespace for the classes defined herein.</p>
  38 */
  39
  40 #include <osl/mutex.hxx>
  41 #include <tools/resid.hxx>
  42 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  43 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  44 #include <com/sun/star/uno/Sequence.hxx>
  45 #include <com/sun/star/registry/XRegistryKey.hpp>
  46 #include <cppuhelper/factory.hxx>
  47 #include <rtl/string.hxx>
  48
  49 class ResMgr;
  50
  51 //.........................................................................
  52 namespace COMPMOD_NAMESPACE
  53 {
  54 //.........................................................................
  55
  56 typedef ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory > (SAL_CALL *FactoryInstantiation)
  57         (
  58             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rServiceManager,
  59             const ::rtl::OUString & _rComponentName,
  60             ::cppu::ComponentInstantiation _pCreateFunction,
  61             const ::com::sun::star::uno::Sequence< ::rtl::OUString > & _rServiceNames,
  62             rtl_ModuleCount* _pModuleCounter
  63         );
  64
  65     //=========================================================================
  66     //= OModule
  67     //=========================================================================
  68     class OModuleImpl;
  69     class OModule
  70     {
  71         friend class OModuleResourceClient;
  72
  73     private:
  74         OModule();
  75             // not implemented. OModule is a static class
  76
  77     protected:
  78         // resource administration
  79         static ::osl::Mutex     s_aMutex;       /// access safety
  80         static sal_Int32        s_nClients;     /// number of registered clients
  81         static OModuleImpl*     s_pImpl;        /// impl class. lives as long as at least one client for the module is registered
  82         static ::rtl::OString   s_sResPrefix;
  83
  84         // auto registration administration
  85         static  ::com::sun::star::uno::Sequence< ::rtl::OUString >*
  86             s_pImplementationNames;
  87         static  ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::rtl::OUString > >*
  88             s_pSupportedServices;
  89         static  ::com::sun::star::uno::Sequence< sal_Int64 >*
  90             s_pCreationFunctionPointers;
  91         static  ::com::sun::star::uno::Sequence< sal_Int64 >*
  92             s_pFactoryFunctionPointers;
  93
  94     public:
  95         // cna be set as long as no resource has been accessed ...
  96         static void     setResourceFilePrefix(const ::rtl::OString& _rPrefix);
  97
  98         /// get the vcl res manager of the module
  99         static ResMgr*  getResManager();
 100
 101         /** register a component implementing a service with the given data.
 102             @param  _rImplementationName
 103                         the implementation name of the component
 104             @param  _rServiceNames
 105                         the services the component supports
 106             @param  _pCreateFunction
 107                         a function for creating an instance of the component
 108             @param  _pFactoryFunction
 109                         a function for creating a factory for that component
 110             @see revokeComponent
 111         */
 112         static void registerComponent(
 113             const ::rtl::OUString& _rImplementationName,
 114             const ::com::sun::star::uno::Sequence< ::rtl::OUString >& _rServiceNames,
 115             ::cppu::ComponentInstantiation _pCreateFunction,
 116             FactoryInstantiation _pFactoryFunction);
 117
 118         /** revoke the registration for the specified component
 119             @param  _rImplementationName
 120                 the implementation name of the component
 121         */
 122         static void revokeComponent(
 123             const ::rtl::OUString& _rImplementationName);
 124
 125         /** creates a Factory for the component with the given implementation name.
 126             <p>Usually used from within component_getFactory.<p/>
 127             @param  _rxServiceManager
 128                         a pointer to an XMultiServiceFactory interface as got in component_getFactory
 129             @param  _pImplementationName
 130                         the implementation name of the component
 131             @return
 132                         the XInterface access to a factory for the component
 133         */
 134         static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getComponentFactory(
 135             const ::rtl::OUString& _rImplementationName,
 136             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxServiceManager
 137             );
 138
 139     protected:
 140         /// register a client for the module
 141         static void registerClient();
 142         /// revoke a client for the module
 143         static void revokeClient();
 144
 145     private:
 146         /** ensure that the impl class exists
 147             @precond m_aMutex is guarded when this method gets called
 148         */
 149         static void ensureImpl();
 150     };
 151
 152     //=========================================================================
 153     //= OModuleResourceClient
 154     //=========================================================================
 155     /** base class for objects which uses any global module-specific ressources
 156     */
 157     class OModuleResourceClient
 158     {
 159     public:
 160         OModuleResourceClient()     { OModule::registerClient(); }
 161         ~OModuleResourceClient()    { OModule::revokeClient(); }
 162     };
 163
 164     //=========================================================================
 165     //= ModuleRes
 166     //=========================================================================
 167     /** specialized ResId, using the ressource manager provided by the global module
 168     */
 169     class ModuleRes : public ::ResId
 170     {
 171     public:
 172         ModuleRes(sal_uInt16 _nId) : ResId(_nId, *OModule::getResManager()) { }
 173     };
 174
 175     //==========================================================================
 176     //= OMultiInstanceAutoRegistration
 177     //==========================================================================
 178     template <class TYPE>
 179     class OMultiInstanceAutoRegistration
 180     {
 181     public:
 182         /** automatically registeres a multi instance component
 183             <p>Assumed that the template argument has the three methods
 184                 <ul>
 185                     <li><code>static ::rtl::OUString getImplementationName_Static()</code><li/>
 186                     <li><code>static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static()</code><li/>
 187                     <li><code>static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
 188                         Create(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >&)</code>
 189                         </li>
 190                 <ul/>
 191             the instantiation of this object will automatically register the class via <method>OModule::registerComponent</method>.
 192             <p/>
 193             The factory creation function used is <code>::cppu::createSingleFactory</code>.
 194             @see OOneInstanceAutoRegistration
 195         */
 196         OMultiInstanceAutoRegistration();
 197         ~OMultiInstanceAutoRegistration();
 198     };
 199
 200     template <class TYPE>
 201     OMultiInstanceAutoRegistration<TYPE>::OMultiInstanceAutoRegistration()
 202     {
 203         OModule::registerComponent(
 204             TYPE::getImplementationName_Static(),
 205             TYPE::getSupportedServiceNames_Static(),
 206             TYPE::Create,
 207             ::cppu::createSingleFactory
 208             );
 209     }
 210
 211     template <class TYPE>
 212     OMultiInstanceAutoRegistration<TYPE>::~OMultiInstanceAutoRegistration()
 213     {
 214         OModule::revokeComponent(TYPE::getImplementationName_Static());
 215     }
 216
 217     //==========================================================================
 218     //= OOneInstanceAutoRegistration
 219     //==========================================================================
 220     template <class TYPE>
 221     class OOneInstanceAutoRegistration
 222     {
 223     public:
 224         /** automatically registeres a single instance component
 225             <p>Assumed that the template argument has the three methods
 226                 <ul>
 227                     <li><code>static ::rtl::OUString getImplementationName_Static()</code><li/>
 228                     <li><code>static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static()</code><li/>
 229                     <li><code>static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
 230                         Create(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >&)</code>
 231                         </li>
 232                 <ul/>
 233             the instantiation of this object will automatically register the class via <method>OModule::registerComponent</method>.
 234             <p/>
 235             The factory creation function used is <code>::cppu::createOneInstanceFactory</code>.
 236             @see OOneInstanceAutoRegistration
 237         */
 238         OOneInstanceAutoRegistration();
 239         ~OOneInstanceAutoRegistration();
 240     };
 241
 242     template <class TYPE>
 243     OOneInstanceAutoRegistration<TYPE>::OOneInstanceAutoRegistration()
 244     {
 245         OModule::registerComponent(
 246             TYPE::getImplementationName_Static(),
 247             TYPE::getSupportedServiceNames_Static(),
 248             TYPE::Create,
 249             ::cppu::createOneInstanceFactory
 250             );
 251     }
 252
 253     template <class TYPE>
 254     OOneInstanceAutoRegistration<TYPE>::~OOneInstanceAutoRegistration()
 255     {
 256         OModule::revokeComponent(TYPE::getImplementationName_Static());
 257     }
 258
 259 //.........................................................................
 260 }   // namespace COMPMOD_NAMESPACE
 261 //.........................................................................
 262
 263 #endif // _EXTENSIONS_COMPONENT_MODULE_HXX_
 264
 265 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */