292 lines
27 KiB
C++
292 lines
27 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: xserviceinfo.hxx,v $
|
|
*
|
|
* $Revision: 1.5 $
|
|
*
|
|
* last change: $Author: rt $ $Date: 2005-09-09 00:24:50 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
|
|
#define __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// my own includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#ifndef __FRAMEWORK_GENERAL_H_
|
|
#include <general.h>
|
|
#endif
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// interface includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_EXCEPTION_HPP_
|
|
#include <com/sun/star/uno/Exception.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_RUNTIMEEXCEPTION_HPP_
|
|
#include <com/sun/star/uno/RuntimeException.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XSINGLESERVICEFACTORY_HPP_
|
|
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
|
|
#include <com/sun/star/lang/XServiceInfo.hpp>
|
|
#endif
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// other includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_ANY_HXX_
|
|
#include <com/sun/star/uno/Any.hxx>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_TYPE_HXX_
|
|
#include <com/sun/star/uno/Type.hxx>
|
|
#endif
|
|
|
|
#ifndef _CPPUHELPER_FACTORY_HXX_
|
|
#include <cppuhelper/factory.hxx>
|
|
#endif
|
|
|
|
#ifndef _RTL_USTRING_
|
|
#include <rtl/ustring.hxx>
|
|
#endif
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// namespace
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
namespace framework{
|
|
|
|
/*_________________________________________________________________________________________________________________
|
|
|
|
macros for declaration and definition of XServiceInfo
|
|
Please use follow public macros only!
|
|
|
|
1) DECLARE_XSERVICEINFO => use it to declare XServiceInfo in your header
|
|
2) DEFINE_XSERVICEINFO_MULTISERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) => use it to define XServiceInfo for multi service mode
|
|
3) DEFINE_XSERVICEINFO_ONEINSTANCESERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) => use it to define XServiceInfo for one instance service mode
|
|
4) DEFINE_INIT_SERVICE( CLASS ) => use it to implement your own impl_initService() method, which is neccessary for initializeing object by using his own reference!
|
|
|
|
_________________________________________________________________________________________________________________*/
|
|
|
|
//*****************************************************************************************************************
|
|
// private
|
|
// implementation of XServiceInfo and helper functions
|
|
//*****************************************************************************************************************
|
|
#define PRIVATE_DEFINE_XSERVICEINFO( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
|
|
/*===========================================================================================================*/ \
|
|
/* XServiceInfo */ \
|
|
/*===========================================================================================================*/ \
|
|
::rtl::OUString SAL_CALL CLASS::getImplementationName() throw( css::uno::RuntimeException ) \
|
|
{ \
|
|
return impl_getStaticImplementationName(); \
|
|
} \
|
|
\
|
|
/*===========================================================================================================*/ \
|
|
/* XServiceInfo */ \
|
|
/*===========================================================================================================*/ \
|
|
sal_Bool SAL_CALL CLASS::supportsService( const ::rtl::OUString& sServiceName ) throw( css::uno::RuntimeException ) \
|
|
{ \
|
|
/* Set default return value. */ \
|
|
sal_Bool bReturn = sal_False ; \
|
|
/* Get names of all supported servicenames. */ \
|
|
css::uno::Sequence< ::rtl::OUString > seqServiceNames = getSupportedServiceNames(); \
|
|
const ::rtl::OUString* pArray = seqServiceNames.getConstArray(); \
|
|
sal_Int32 nCounter = 0; \
|
|
sal_Int32 nLength = seqServiceNames.getLength(); \
|
|
/* Search for right name in list. */ \
|
|
while ( \
|
|
( nCounter < nLength ) && \
|
|
( bReturn == sal_False ) \
|
|
) \
|
|
{ \
|
|
/* Is name was found, say "YES, SERVICE IS SUPPORTED." and break loop. */ \
|
|
if ( pArray[nCounter] == sServiceName ) \
|
|
{ \
|
|
bReturn = sal_True ; \
|
|
} \
|
|
/* Else step to next element in list. */ \
|
|
++nCounter; \
|
|
} \
|
|
/* Return state of search. */ \
|
|
return bReturn; \
|
|
} \
|
|
\
|
|
/*===========================================================================================================*/ \
|
|
/* XServiceInfo */ \
|
|
/*===========================================================================================================*/ \
|
|
css::uno::Sequence< ::rtl::OUString > SAL_CALL CLASS::getSupportedServiceNames() throw( css::uno::RuntimeException ) \
|
|
{ \
|
|
return impl_getStaticSupportedServiceNames(); \
|
|
} \
|
|
\
|
|
/*===========================================================================================================*/ \
|
|
/* Helper for XServiceInfo */ \
|
|
/*===========================================================================================================*/ \
|
|
css::uno::Sequence< ::rtl::OUString > CLASS::impl_getStaticSupportedServiceNames() \
|
|
{ \
|
|
css::uno::Sequence< ::rtl::OUString > seqServiceNames( 1 ); \
|
|
seqServiceNames.getArray() [0] = SERVICENAME ; \
|
|
return seqServiceNames; \
|
|
} \
|
|
\
|
|
/*===========================================================================================================*/ \
|
|
/* Helper for XServiceInfo */ \
|
|
/*===========================================================================================================*/ \
|
|
::rtl::OUString CLASS::impl_getStaticImplementationName() \
|
|
{ \
|
|
return IMPLEMENTATIONNAME ; \
|
|
} \
|
|
\
|
|
/*===========================================================================================================*/ \
|
|
/* Helper for registry */ \
|
|
/* Attention: To avoid against wrong ref counts during our own initialize procedure, we must */ \
|
|
/* use right EXTERNAL handling of them. That's why you should do nothing in your ctor, which could*/ \
|
|
/* work on your ref count! All other things are allowed. Do work with your own reference - please */ \
|
|
/* use "impl_initService()" method. */ \
|
|
/*===========================================================================================================*/ \
|
|
css::uno::Reference< css::uno::XInterface > SAL_CALL CLASS::impl_createInstance( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) throw( css::uno::Exception ) \
|
|
{ \
|
|
/* create new instance of service */ \
|
|
CLASS* pClass = new CLASS( xServiceManager ); \
|
|
/* hold it alive by increasing his ref count!!! */ \
|
|
css::uno::Reference< css::uno::XInterface > xService( static_cast< XINTERFACECAST* >(pClass), css::uno::UNO_QUERY ); \
|
|
/* initialize new service instance ... he can use his own refcount ... we hold it! */ \
|
|
pClass->impl_initService(); \
|
|
/* return new created service as reference */ \
|
|
return xService; \
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// private
|
|
// definition of helper function createFactory() for multiple services
|
|
//*****************************************************************************************************************
|
|
#define PRIVATE_DEFINE_SINGLEFACTORY( CLASS ) \
|
|
css::uno::Reference< css::lang::XSingleServiceFactory > CLASS::impl_createFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) \
|
|
{ \
|
|
css::uno::Reference< css::lang::XSingleServiceFactory > xReturn ( cppu::createSingleFactory ( xServiceManager , \
|
|
CLASS::impl_getStaticImplementationName() , \
|
|
CLASS::impl_createInstance , \
|
|
CLASS::impl_getStaticSupportedServiceNames() \
|
|
) \
|
|
); \
|
|
return xReturn; \
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// private
|
|
// definition of helper function createFactory() for one instance services
|
|
//*****************************************************************************************************************
|
|
#define PRIVATE_DEFINE_ONEINSTANCEFACTORY( CLASS ) \
|
|
css::uno::Reference< css::lang::XSingleServiceFactory > CLASS::impl_createFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) \
|
|
{ \
|
|
css::uno::Reference< css::lang::XSingleServiceFactory > xReturn ( cppu::createOneInstanceFactory ( xServiceManager , \
|
|
CLASS::impl_getStaticImplementationName() , \
|
|
CLASS::impl_createInstance , \
|
|
CLASS::impl_getStaticSupportedServiceNames() \
|
|
) \
|
|
); \
|
|
return xReturn; \
|
|
}
|
|
|
|
//*****************************************************************************************************************
|
|
// public
|
|
// declaration of XServiceInfo and helper functions
|
|
//*****************************************************************************************************************
|
|
#define DECLARE_XSERVICEINFO \
|
|
/* interface XServiceInfo */ \
|
|
virtual ::rtl::OUString SAL_CALL getImplementationName ( ) throw( css::uno::RuntimeException ); \
|
|
virtual sal_Bool SAL_CALL supportsService ( const ::rtl::OUString& sServiceName ) throw( css::uno::RuntimeException ); \
|
|
virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames ( ) throw( css::uno::RuntimeException ); \
|
|
/* Helper for XServiceInfo */ \
|
|
static css::uno::Sequence< ::rtl::OUString > SAL_CALL impl_getStaticSupportedServiceNames( ); \
|
|
static ::rtl::OUString SAL_CALL impl_getStaticImplementationName ( ); \
|
|
/* Helper for registry */ \
|
|
static css::uno::Reference< css::uno::XInterface > SAL_CALL impl_createInstance ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) throw( css::uno::Exception ); \
|
|
static css::uno::Reference< css::lang::XSingleServiceFactory > SAL_CALL impl_createFactory ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ); \
|
|
/* Helper for initialization of service by using own reference! */ \
|
|
virtual void SAL_CALL impl_initService ( ); \
|
|
|
|
//*****************************************************************************************************************
|
|
// public
|
|
// implementation of XServiceInfo
|
|
//*****************************************************************************************************************
|
|
#define DEFINE_XSERVICEINFO_MULTISERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
|
|
PRIVATE_DEFINE_XSERVICEINFO( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
|
|
PRIVATE_DEFINE_SINGLEFACTORY( CLASS )
|
|
|
|
#define DEFINE_XSERVICEINFO_ONEINSTANCESERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
|
|
PRIVATE_DEFINE_XSERVICEINFO( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
|
|
PRIVATE_DEFINE_ONEINSTANCEFACTORY( CLASS )
|
|
|
|
//*****************************************************************************************************************
|
|
// public
|
|
// implementation of service initialize!
|
|
// example of using: DEFINE_INIT_SERVICE( MyClassName,
|
|
// {
|
|
// ...
|
|
// Reference< XInterface > xThis( this, UNO_QUERY );
|
|
// myMember* pMember = new myMember( xThis );
|
|
// ...
|
|
// }
|
|
// )
|
|
//*****************************************************************************************************************
|
|
#define DEFINE_INIT_SERVICE( CLASS, FUNCTIONBODY ) \
|
|
void SAL_CALL CLASS::impl_initService() \
|
|
{ \
|
|
FUNCTIONBODY \
|
|
}
|
|
|
|
#define DEFINE_INIT_SERVICE_WITH_BASECLASS( CLASS, BASECLASS, FUNCTIONBODY ) \
|
|
void SAL_CALL CLASS::impl_initService() \
|
|
{ \
|
|
BASECLASS::impl_initService(); \
|
|
{ \
|
|
FUNCTIONBODY \
|
|
} \
|
|
}
|
|
|
|
} // namespace framework
|
|
|
|
#endif // #ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
|