1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski /*************************************************************************
25*b1cdbd2cSJim Jagielski *************************************************************************
26*b1cdbd2cSJim Jagielski *
27*b1cdbd2cSJim Jagielski * service implementation: foo.Counter
28*b1cdbd2cSJim Jagielski * exported interfaces: foo.XCounter
29*b1cdbd2cSJim Jagielski *
30*b1cdbd2cSJim Jagielski * simple example component implementing a counter
31*b1cdbd2cSJim Jagielski *
32*b1cdbd2cSJim Jagielski *************************************************************************
33*b1cdbd2cSJim Jagielski *************************************************************************/
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski #include <stdio.h>
36*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx>
37*b1cdbd2cSJim Jagielski #include <cppuhelper/queryinterface.hxx> // helper for queryInterface() impl
38*b1cdbd2cSJim Jagielski #include <cppuhelper/factory.hxx> // helper for component factory
39*b1cdbd2cSJim Jagielski // generated c++ interfaces
40*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XSingleServiceFactory.hpp>
41*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XMultiServiceFactory.hpp>
42*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XServiceInfo.hpp>
43*b1cdbd2cSJim Jagielski #include <com/sun/star/registry/XRegistryKey.hpp>
44*b1cdbd2cSJim Jagielski #include <foo/XCountable.hpp>
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski #define SERVICENAME "foo.Counter"
47*b1cdbd2cSJim Jagielski #define IMPLNAME "com.sun.star.comp.example.cpp.Counter"
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski using namespace ::rtl;
50*b1cdbd2cSJim Jagielski using namespace ::osl;
51*b1cdbd2cSJim Jagielski using namespace ::cppu;
52*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::uno;
53*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::lang;
54*b1cdbd2cSJim Jagielski using namespace ::com::sun::star::registry;
55*b1cdbd2cSJim Jagielski using namespace ::foo;
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski
58*b1cdbd2cSJim Jagielski //========================================================================
59*b1cdbd2cSJim Jagielski class MyCounterImpl
60*b1cdbd2cSJim Jagielski : public XCountable
61*b1cdbd2cSJim Jagielski , public XServiceInfo
62*b1cdbd2cSJim Jagielski {
63*b1cdbd2cSJim Jagielski // to obtain other services if needed
64*b1cdbd2cSJim Jagielski Reference< XMultiServiceFactory > m_xServiceManager;
65*b1cdbd2cSJim Jagielski
66*b1cdbd2cSJim Jagielski sal_Int32 m_nRefCount;
67*b1cdbd2cSJim Jagielski sal_Int32 m_nCount;
68*b1cdbd2cSJim Jagielski
69*b1cdbd2cSJim Jagielski public:
MyCounterImpl(const Reference<XMultiServiceFactory> & xServiceManager)70*b1cdbd2cSJim Jagielski MyCounterImpl( const Reference< XMultiServiceFactory > & xServiceManager )
71*b1cdbd2cSJim Jagielski : m_xServiceManager( xServiceManager ), m_nRefCount( 0 )
72*b1cdbd2cSJim Jagielski { printf( "< MyCounterImpl ctor called >\n" ); }
~MyCounterImpl()73*b1cdbd2cSJim Jagielski ~MyCounterImpl()
74*b1cdbd2cSJim Jagielski { printf( "< MyCounterImpl dtor called >\n" ); }
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski // XInterface implementation
acquire()77*b1cdbd2cSJim Jagielski virtual void SAL_CALL acquire() throw ()
78*b1cdbd2cSJim Jagielski { ++m_nRefCount; }
release()79*b1cdbd2cSJim Jagielski virtual void SAL_CALL release() throw ()
80*b1cdbd2cSJim Jagielski { if (! --m_nRefCount) delete this; }
queryInterface(const Type & rType)81*b1cdbd2cSJim Jagielski virtual Any SAL_CALL queryInterface( const Type & rType ) throw (RuntimeException)
82*b1cdbd2cSJim Jagielski { return cppu::queryInterface(rType,
83*b1cdbd2cSJim Jagielski static_cast< XInterface* >( static_cast< XServiceInfo* >( this ) ),
84*b1cdbd2cSJim Jagielski static_cast< XCountable* >( this ),
85*b1cdbd2cSJim Jagielski static_cast< XServiceInfo* >( this ) ); }
86*b1cdbd2cSJim Jagielski
87*b1cdbd2cSJim Jagielski // XServiceInfo implementation
88*b1cdbd2cSJim Jagielski virtual OUString SAL_CALL getImplementationName( ) throw(RuntimeException);
89*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) throw(RuntimeException);
90*b1cdbd2cSJim Jagielski virtual Sequence< OUString > SAL_CALL getSupportedServiceNames( ) throw(RuntimeException);
91*b1cdbd2cSJim Jagielski static Sequence< OUString > SAL_CALL getSupportedServiceNames_Static( );
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski // XCountable implementation
getCount()94*b1cdbd2cSJim Jagielski virtual sal_Int32 SAL_CALL getCount() throw (RuntimeException)
95*b1cdbd2cSJim Jagielski { return m_nCount; }
setCount(sal_Int32 nCount)96*b1cdbd2cSJim Jagielski virtual void SAL_CALL setCount( sal_Int32 nCount ) throw (RuntimeException)
97*b1cdbd2cSJim Jagielski { m_nCount = nCount; }
increment()98*b1cdbd2cSJim Jagielski virtual sal_Int32 SAL_CALL increment() throw (RuntimeException)
99*b1cdbd2cSJim Jagielski { return (++m_nCount); }
decrement()100*b1cdbd2cSJim Jagielski virtual sal_Int32 SAL_CALL decrement() throw (RuntimeException)
101*b1cdbd2cSJim Jagielski { return (--m_nCount); }
102*b1cdbd2cSJim Jagielski };
103*b1cdbd2cSJim Jagielski
104*b1cdbd2cSJim Jagielski //*************************************************************************
getImplementationName()105*b1cdbd2cSJim Jagielski OUString SAL_CALL MyCounterImpl::getImplementationName( )
106*b1cdbd2cSJim Jagielski throw(RuntimeException)
107*b1cdbd2cSJim Jagielski {
108*b1cdbd2cSJim Jagielski return OUString( RTL_CONSTASCII_USTRINGPARAM(IMPLNAME) );
109*b1cdbd2cSJim Jagielski }
110*b1cdbd2cSJim Jagielski
111*b1cdbd2cSJim Jagielski //*************************************************************************
supportsService(const OUString & ServiceName)112*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL MyCounterImpl::supportsService( const OUString& ServiceName )
113*b1cdbd2cSJim Jagielski throw(RuntimeException)
114*b1cdbd2cSJim Jagielski {
115*b1cdbd2cSJim Jagielski Sequence< OUString > aSNL = getSupportedServiceNames();
116*b1cdbd2cSJim Jagielski const OUString * pArray = aSNL.getArray();
117*b1cdbd2cSJim Jagielski for( sal_Int32 i = 0; i < aSNL.getLength(); i++ )
118*b1cdbd2cSJim Jagielski if( pArray[i] == ServiceName )
119*b1cdbd2cSJim Jagielski return sal_True;
120*b1cdbd2cSJim Jagielski return sal_False;
121*b1cdbd2cSJim Jagielski }
122*b1cdbd2cSJim Jagielski
123*b1cdbd2cSJim Jagielski //*************************************************************************
getSupportedServiceNames()124*b1cdbd2cSJim Jagielski Sequence<OUString> SAL_CALL MyCounterImpl::getSupportedServiceNames( )
125*b1cdbd2cSJim Jagielski throw(RuntimeException)
126*b1cdbd2cSJim Jagielski {
127*b1cdbd2cSJim Jagielski return getSupportedServiceNames_Static();
128*b1cdbd2cSJim Jagielski }
129*b1cdbd2cSJim Jagielski
130*b1cdbd2cSJim Jagielski //*************************************************************************
getSupportedServiceNames_Static()131*b1cdbd2cSJim Jagielski Sequence<OUString> SAL_CALL MyCounterImpl::getSupportedServiceNames_Static( )
132*b1cdbd2cSJim Jagielski {
133*b1cdbd2cSJim Jagielski OUString aName( RTL_CONSTASCII_USTRINGPARAM(SERVICENAME) );
134*b1cdbd2cSJim Jagielski return Sequence< OUString >( &aName, 1 );
135*b1cdbd2cSJim Jagielski }
136*b1cdbd2cSJim Jagielski
137*b1cdbd2cSJim Jagielski
138*b1cdbd2cSJim Jagielski
139*b1cdbd2cSJim Jagielski
140*b1cdbd2cSJim Jagielski /**
141*b1cdbd2cSJim Jagielski * Function to create a new component instance; is needed by factory helper implementation.
142*b1cdbd2cSJim Jagielski * @param xMgr service manager to if the components needs other component instances
143*b1cdbd2cSJim Jagielski */
MyCounterImpl_create(const Reference<XMultiServiceFactory> & xMgr)144*b1cdbd2cSJim Jagielski Reference< XInterface > SAL_CALL MyCounterImpl_create(
145*b1cdbd2cSJim Jagielski const Reference< XMultiServiceFactory > & xMgr )
146*b1cdbd2cSJim Jagielski {
147*b1cdbd2cSJim Jagielski return Reference<XInterface>(static_cast<XCountable*>(new MyCounterImpl(xMgr)));
148*b1cdbd2cSJim Jagielski }
149*b1cdbd2cSJim Jagielski
150*b1cdbd2cSJim Jagielski
151*b1cdbd2cSJim Jagielski //#########################################################################
152*b1cdbd2cSJim Jagielski //#### EXPORTED ###########################################################
153*b1cdbd2cSJim Jagielski //#########################################################################
154*b1cdbd2cSJim Jagielski
155*b1cdbd2cSJim Jagielski
156*b1cdbd2cSJim Jagielski /**
157*b1cdbd2cSJim Jagielski * Gives the environment this component belongs to.
158*b1cdbd2cSJim Jagielski */
component_getImplementationEnvironment(const sal_Char ** ppEnvTypeName,uno_Environment ** ppEnv)159*b1cdbd2cSJim Jagielski extern "C" SAL_DLLPUBLIC_EXPORT void SAL_CALL component_getImplementationEnvironment(const sal_Char ** ppEnvTypeName, uno_Environment ** ppEnv)
160*b1cdbd2cSJim Jagielski {
161*b1cdbd2cSJim Jagielski *ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
162*b1cdbd2cSJim Jagielski }
163*b1cdbd2cSJim Jagielski
164*b1cdbd2cSJim Jagielski /**
165*b1cdbd2cSJim Jagielski * This function creates an implementation section in the registry and another subkey
166*b1cdbd2cSJim Jagielski *
167*b1cdbd2cSJim Jagielski * for each supported service.
168*b1cdbd2cSJim Jagielski * @param pServiceManager the service manager
169*b1cdbd2cSJim Jagielski * @param pRegistryKey the registry key
170*b1cdbd2cSJim Jagielski */
171*b1cdbd2cSJim Jagielski // extern "C" SAL_DLLPUBLIC_EXPORT sal_Bool SAL_CALL component_writeInfo(void * pServiceManager, void * pRegistryKey)
172*b1cdbd2cSJim Jagielski // {
173*b1cdbd2cSJim Jagielski // sal_Bool result = sal_False;
174*b1cdbd2cSJim Jagielski
175*b1cdbd2cSJim Jagielski // if (pRegistryKey)
176*b1cdbd2cSJim Jagielski // {
177*b1cdbd2cSJim Jagielski // try
178*b1cdbd2cSJim Jagielski // {
179*b1cdbd2cSJim Jagielski // Reference< XRegistryKey > xNewKey(
180*b1cdbd2cSJim Jagielski // reinterpret_cast< XRegistryKey * >( pRegistryKey )->createKey(
181*b1cdbd2cSJim Jagielski // OUString( RTL_CONSTASCII_USTRINGPARAM("/" IMPLNAME "/UNO/SERVICES") ) ) );
182*b1cdbd2cSJim Jagielski
183*b1cdbd2cSJim Jagielski // const Sequence< OUString > & rSNL =
184*b1cdbd2cSJim Jagielski // MyCounterImpl::getSupportedServiceNames_Static();
185*b1cdbd2cSJim Jagielski // const OUString * pArray = rSNL.getConstArray();
186*b1cdbd2cSJim Jagielski // for ( sal_Int32 nPos = rSNL.getLength(); nPos--; )
187*b1cdbd2cSJim Jagielski // xNewKey->createKey( pArray[nPos] );
188*b1cdbd2cSJim Jagielski
189*b1cdbd2cSJim Jagielski // return sal_True;
190*b1cdbd2cSJim Jagielski // }
191*b1cdbd2cSJim Jagielski // catch (InvalidRegistryException &)
192*b1cdbd2cSJim Jagielski // {
193*b1cdbd2cSJim Jagielski // // we should not ignore exceptions
194*b1cdbd2cSJim Jagielski // }
195*b1cdbd2cSJim Jagielski // }
196*b1cdbd2cSJim Jagielski // return result;
197*b1cdbd2cSJim Jagielski // }
198*b1cdbd2cSJim Jagielski
199*b1cdbd2cSJim Jagielski /**
200*b1cdbd2cSJim Jagielski * This function is called to get service factories for an implementation.
201*b1cdbd2cSJim Jagielski *
202*b1cdbd2cSJim Jagielski * @param pImplName name of implementation
203*b1cdbd2cSJim Jagielski * @param pServiceManager a service manager, need for component creation
204*b1cdbd2cSJim Jagielski * @param pRegistryKey the registry key for this component, need for persistent data
205*b1cdbd2cSJim Jagielski * @return a component factory
206*b1cdbd2cSJim Jagielski */
component_getFactory(const sal_Char * pImplName,void * pServiceManager,void * pRegistryKey)207*b1cdbd2cSJim Jagielski extern "C" SAL_DLLPUBLIC_EXPORT void * SAL_CALL component_getFactory(const sal_Char * pImplName, void * pServiceManager, void * pRegistryKey)
208*b1cdbd2cSJim Jagielski {
209*b1cdbd2cSJim Jagielski void * pRet = 0;
210*b1cdbd2cSJim Jagielski
211*b1cdbd2cSJim Jagielski if (rtl_str_compare( pImplName, IMPLNAME ) == 0)
212*b1cdbd2cSJim Jagielski {
213*b1cdbd2cSJim Jagielski Reference< XSingleServiceFactory > xFactory( createSingleFactory(
214*b1cdbd2cSJim Jagielski reinterpret_cast< XMultiServiceFactory * >( pServiceManager ),
215*b1cdbd2cSJim Jagielski OUString( RTL_CONSTASCII_USTRINGPARAM(IMPLNAME) ),
216*b1cdbd2cSJim Jagielski MyCounterImpl_create,
217*b1cdbd2cSJim Jagielski MyCounterImpl::getSupportedServiceNames_Static() ) );
218*b1cdbd2cSJim Jagielski
219*b1cdbd2cSJim Jagielski if (xFactory.is())
220*b1cdbd2cSJim Jagielski {
221*b1cdbd2cSJim Jagielski xFactory->acquire();
222*b1cdbd2cSJim Jagielski pRet = xFactory.get();
223*b1cdbd2cSJim Jagielski }
224*b1cdbd2cSJim Jagielski }
225*b1cdbd2cSJim Jagielski
226*b1cdbd2cSJim Jagielski return pRet;
227*b1cdbd2cSJim Jagielski }
228