xref: /trunk/main/chart2/source/inc/ServiceMacros.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef _APPHELPER_SERVICEMACROS_HXX
28*cdf0e10cSrcweir #define _APPHELPER_SERVICEMACROS_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir /*
31*cdf0e10cSrcweir to use these macros the supported services and the implementation name needs to be static
32*cdf0e10cSrcweir especially you need to implement (declaration is contained in macro already):
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir static com::sun::star::uno::Sequence< rtl::OUString >
35*cdf0e10cSrcweir     Class::getSupportedServiceNames_Static();
36*cdf0e10cSrcweir */
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir //=========================================================================
39*cdf0e10cSrcweir //
40*cdf0e10cSrcweir // XServiceInfo decl
41*cdf0e10cSrcweir //
42*cdf0e10cSrcweir //=========================================================================
43*cdf0e10cSrcweir namespace apphelper
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir #define APPHELPER_XSERVICEINFO_DECL()                                                   \
47*cdf0e10cSrcweir     virtual ::rtl::OUString SAL_CALL                                        \
48*cdf0e10cSrcweir         getImplementationName()                                             \
49*cdf0e10cSrcweir             throw( ::com::sun::star::uno::RuntimeException );               \
50*cdf0e10cSrcweir     virtual sal_Bool SAL_CALL                                               \
51*cdf0e10cSrcweir         supportsService( const ::rtl::OUString& ServiceName )               \
52*cdf0e10cSrcweir             throw( ::com::sun::star::uno::RuntimeException );               \
53*cdf0e10cSrcweir     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL     \
54*cdf0e10cSrcweir         getSupportedServiceNames()                                          \
55*cdf0e10cSrcweir             throw( ::com::sun::star::uno::RuntimeException );               \
56*cdf0e10cSrcweir                                                                             \
57*cdf0e10cSrcweir     static ::rtl::OUString getImplementationName_Static();                  \
58*cdf0e10cSrcweir     static ::com::sun::star::uno::Sequence< ::rtl::OUString >               \
59*cdf0e10cSrcweir         getSupportedServiceNames_Static();
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir //=========================================================================
62*cdf0e10cSrcweir //
63*cdf0e10cSrcweir // XServiceInfo impl
64*cdf0e10cSrcweir //
65*cdf0e10cSrcweir //=========================================================================
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir #define APPHELPER_XSERVICEINFO_IMPL( Class, ImplName )                              \
68*cdf0e10cSrcweir ::rtl::OUString SAL_CALL Class::getImplementationName()                     \
69*cdf0e10cSrcweir     throw( ::com::sun::star::uno::RuntimeException )                        \
70*cdf0e10cSrcweir {                                                                           \
71*cdf0e10cSrcweir     return getImplementationName_Static();                                  \
72*cdf0e10cSrcweir }                                                                           \
73*cdf0e10cSrcweir                                                                             \
74*cdf0e10cSrcweir ::rtl::OUString Class::getImplementationName_Static()                       \
75*cdf0e10cSrcweir {                                                                           \
76*cdf0e10cSrcweir     return ImplName;                                                        \
77*cdf0e10cSrcweir }                                                                           \
78*cdf0e10cSrcweir                                                                             \
79*cdf0e10cSrcweir sal_Bool SAL_CALL                                                           \
80*cdf0e10cSrcweir Class::supportsService( const ::rtl::OUString& ServiceName )                \
81*cdf0e10cSrcweir     throw( ::com::sun::star::uno::RuntimeException )                        \
82*cdf0e10cSrcweir {                                                                           \
83*cdf0e10cSrcweir     ::com::sun::star::uno::Sequence< ::rtl::OUString > aSNL =               \
84*cdf0e10cSrcweir                                         getSupportedServiceNames();         \
85*cdf0e10cSrcweir     const ::rtl::OUString* pArray = aSNL.getArray();                        \
86*cdf0e10cSrcweir     for( sal_Int32 i = 0; i < aSNL.getLength(); i++ )                       \
87*cdf0e10cSrcweir     {                                                                       \
88*cdf0e10cSrcweir         if( pArray[ i ] == ServiceName )                                    \
89*cdf0e10cSrcweir             return sal_True;                                                \
90*cdf0e10cSrcweir     }                                                                       \
91*cdf0e10cSrcweir                                                                             \
92*cdf0e10cSrcweir     return sal_False;                                                       \
93*cdf0e10cSrcweir }                                                                           \
94*cdf0e10cSrcweir                                                                             \
95*cdf0e10cSrcweir ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL                 \
96*cdf0e10cSrcweir Class::getSupportedServiceNames()                                           \
97*cdf0e10cSrcweir     throw( ::com::sun::star::uno::RuntimeException )                        \
98*cdf0e10cSrcweir {                                                                           \
99*cdf0e10cSrcweir     return getSupportedServiceNames_Static();                               \
100*cdf0e10cSrcweir }
101*cdf0e10cSrcweir 
102*cdf0e10cSrcweir //=========================================================================
103*cdf0e10cSrcweir //
104*cdf0e10cSrcweir // Service factory helper decl+impl
105*cdf0e10cSrcweir //
106*cdf0e10cSrcweir //to use this macro you need to provide a constructor:
107*cdf0e10cSrcweir //class( Reference< XComponentContext > const & xContext )
108*cdf0e10cSrcweir //and implement OWeakObject
109*cdf0e10cSrcweir //=========================================================================
110*cdf0e10cSrcweir 
111*cdf0e10cSrcweir #define APPHELPER_SERVICE_FACTORY_HELPER(Class)                                     \
112*cdf0e10cSrcweir static ::com::sun::star::uno::Reference<                                    \
113*cdf0e10cSrcweir                             ::com::sun::star::uno::XInterface > SAL_CALL    \
114*cdf0e10cSrcweir     create( ::com::sun::star::uno::Reference<                               \
115*cdf0e10cSrcweir                ::com::sun::star::uno::XComponentContext > const & xContext) \
116*cdf0e10cSrcweir     throw(::com::sun::star::uno::Exception)                                 \
117*cdf0e10cSrcweir {                                                                           \
118*cdf0e10cSrcweir     return (::cppu::OWeakObject *)new Class( xContext );                    \
119*cdf0e10cSrcweir }
120*cdf0e10cSrcweir 
121*cdf0e10cSrcweir /** This macro contains the default implementation for getImplementationId().
122*cdf0e10cSrcweir     Note, that you have to include the header necessary for rtl_createUuid.
123*cdf0e10cSrcweir     Insert the following into your file:
124*cdf0e10cSrcweir 
125*cdf0e10cSrcweir     <code>
126*cdf0e10cSrcweir #include <rtl/uuid.h>
127*cdf0e10cSrcweir     </code>
128*cdf0e10cSrcweir 
129*cdf0e10cSrcweir     @param Class the Class-Name for which getImplementationId() should be
130*cdf0e10cSrcweir     implemented
131*cdf0e10cSrcweir  */
132*cdf0e10cSrcweir #define APPHELPER_GETIMPLEMENTATIONID_IMPL(Class) \
133*cdf0e10cSrcweir ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL Class::getImplementationId() \
134*cdf0e10cSrcweir     throw (::com::sun::star::uno::RuntimeException) \
135*cdf0e10cSrcweir { \
136*cdf0e10cSrcweir     static ::com::sun::star::uno::Sequence< sal_Int8 > aId; \
137*cdf0e10cSrcweir     if( aId.getLength() == 0 ) \
138*cdf0e10cSrcweir     { \
139*cdf0e10cSrcweir         aId.realloc( 16 ); \
140*cdf0e10cSrcweir         rtl_createUuid( (sal_uInt8 *)aId.getArray(), 0, sal_True ); \
141*cdf0e10cSrcweir     } \
142*cdf0e10cSrcweir     return aId; \
143*cdf0e10cSrcweir }
144*cdf0e10cSrcweir 
145*cdf0e10cSrcweir }//end namespace apphelper
146*cdf0e10cSrcweir #endif
147