configmgr/source/inc/serviceinfohelper.hxx

   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: serviceinfohelper.hxx,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 #ifndef CONFIGMGR_SERVICEINFOHELPER_HXX_
  32 #define CONFIGMGR_SERVICEINFOHELPER_HXX_
  33
  34 #include <com/sun/star/lang/XServiceInfo.hpp>
  35
  36 namespace configmgr
  37 {
  38 // -----------------------------------------------------------------------------
  39     namespace uno   = ::com::sun::star::uno;
  40     namespace lang  = ::com::sun::star::lang;
  41 // -----------------------------------------------------------------------------
  42
  43     /// POD struct describing the registration information of a service implementation
  44     struct ServiceRegistrationInfo
  45     {
  46         /// The implementation name of this service implementation
  47         sal_Char const * implementationName;
  48         /// The services for which this service implementation is registered
  49         sal_Char const * const * registeredServiceNames;
  50     };
  51 // -----------------------------------------------------------------------------
  52
  53     /// POD struct describing the implementation information of a service implementation
  54     struct ServiceImplementationInfo
  55     {
  56         /// The implementation name of this service implementation
  57         sal_Char const * implementationName;
  58         /// The services for which this service implementation is registered
  59         sal_Char const * const * registeredServiceNames;
  60         /// Additional services implemented by this service implementation, for which it is not registered
  61         sal_Char const * const * additionalServiceNames;
  62     };
  63 // -----------------------------------------------------------------------------
  64
  65     // ServiceImplementationInfo has a compatible initial sequence with struct ServiceRegistrationInfo
  66
  67     inline
  68     ServiceRegistrationInfo const *
  69         getRegistrationInfo(ServiceImplementationInfo const * _info)
  70     {
  71         return reinterpret_cast<ServiceRegistrationInfo const *>(_info);
  72     }
  73 // -----------------------------------------------------------------------------
  74
  75     /// POD struct describing the registration information of a singleton
  76     struct SingletonRegistrationInfo
  77     {
  78         /// The name of this singleton
  79         sal_Char const * singletonName;
  80         /// The implementation, which owns this singleton
  81         sal_Char const * implementationName;
  82         /// The service, which should be instatiated for this singleton
  83         sal_Char const * instantiatedServiceName;
  84         /// A name for a pseudo-implementation, which is mapped to this singleton
  85         ServiceRegistrationInfo const * mappedImplementation;
  86     };
  87 // -----------------------------------------------------------------------------
  88
  89     class ServiceRegistrationHelper
  90     {
  91         ServiceRegistrationInfo const*const m_info;
  92
  93     public:
  94         ServiceRegistrationHelper(ServiceRegistrationInfo const* _info)
  95         : m_info(_info)
  96         {}
  97
  98         ServiceRegistrationHelper(ServiceImplementationInfo const* _info)
  99         : m_info(getRegistrationInfo(_info))
 100         {}
 101
 102         sal_Int32 countServices() const;
 103
 104         rtl::OUString getImplementationName( ) const
 105             throw(uno::RuntimeException);
 106
 107         uno::Sequence< rtl::OUString > getRegisteredServiceNames( ) const
 108             throw(uno::RuntimeException);
 109     };
 110 // -----------------------------------------------------------------------------
 111
 112     class ServiceInfoHelper
 113     {
 114         ServiceImplementationInfo const*const m_info;
 115
 116     public:
 117         ServiceInfoHelper(ServiceImplementationInfo const* _info)
 118         : m_info(_info)
 119         {}
 120
 121         sal_Int32 countServices() const;
 122
 123         rtl::OUString getImplementationName( ) const
 124             throw(uno::RuntimeException);
 125
 126         sal_Bool supportsService( rtl::OUString const & ServiceName ) const
 127             throw(uno::RuntimeException);
 128
 129         uno::Sequence< rtl::OUString > getSupportedServiceNames( ) const
 130             throw(uno::RuntimeException);
 131     };
 132 // -----------------------------------------------------------------------------
 133
 134 } // namespace configmgr
 135
 136 #endif
 137
 138