odk/examples/DevelopersGuide/Components/Addons/ProtocolHandlerAddon_cpp/component.cxx

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: component.cxx,v $
   4  *
   5  *  $Revision: 1.6 $
   6  *
   7  *  last change: $Author: rt $ $Date: 2008-04-10 16:28:46 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40
  41 #include <stdio.h>
  42 #include <rtl/ustring.hxx>
  43 #include <cppuhelper/queryinterface.hxx> // helper for queryInterface() impl
  44 #include <cppuhelper/factory.hxx> // helper for component factory
  45 // generated c++ interfaces
  46 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  47 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  48 #include <com/sun/star/lang/XServiceInfo.hpp>
  49 #include <com/sun/star/registry/XRegistryKey.hpp>
  50
  51 // include our specific addon header to get access to functions and definitions
  52 #include <addon.hxx>
  53
  54 using namespace ::rtl;
  55 using namespace ::osl;
  56 using namespace ::cppu;
  57 using namespace ::com::sun::star::uno;
  58 using namespace ::com::sun::star::lang;
  59 using namespace ::com::sun::star::registry;
  60
  61 //##################################################################################################
  62 //#### EXPORTED ####################################################################################
  63 //##################################################################################################
  64
  65
  66 /**
  67  * Gives the environment this component belongs to.
  68  */
  69 extern "C" void SAL_CALL component_getImplementationEnvironment(const sal_Char ** ppEnvTypeName, uno_Environment ** ppEnv)
  70 {
  71     *ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
  72 }
  73
  74 /**
  75  * This function creates an implementation section in the registry and another subkey
  76  *
  77  * for each supported service.
  78  * @param pServiceManager   the service manager
  79  * @param pRegistryKey      the registry key
  80  */
  81 extern "C" sal_Bool SAL_CALL component_writeInfo(void * pServiceManager, void * pRegistryKey)
  82 {
  83     sal_Bool result = sal_False;
  84
  85     if (pRegistryKey)
  86     {
  87         try
  88         {
  89             Reference< XRegistryKey > xNewKey(
  90                 reinterpret_cast< XRegistryKey * >( pRegistryKey )->createKey(
  91                     OUString( RTL_CONSTASCII_USTRINGPARAM("/" IMPLEMENTATION_NAME "/UNO/SERVICES") ) ) );
  92
  93             const Sequence< OUString > & rSNL =
  94                 Addon_getSupportedServiceNames();
  95             const OUString * pArray = rSNL.getConstArray();
  96             for ( sal_Int32 nPos = rSNL.getLength(); nPos--; )
  97                 xNewKey->createKey( pArray[nPos] );
  98
  99             return sal_True;
 100         }
 101         catch (InvalidRegistryException &)
 102         {
 103             // we should not ignore exceptions
 104         }
 105     }
 106     return result;
 107 }
 108
 109 /**
 110  * This function is called to get service factories for an implementation.
 111  *
 112  * @param pImplName       name of implementation
 113  * @param pServiceManager a service manager, need for component creation
 114  * @param pRegistryKey    the registry key for this component, need for persistent data
 115  * @return a component factory
 116  */
 117 extern "C" void * SAL_CALL component_getFactory(const sal_Char * pImplName, void * pServiceManager, void * pRegistryKey)
 118 {
 119     void * pRet = 0;
 120
 121     if (rtl_str_compare( pImplName, IMPLEMENTATION_NAME ) == 0)
 122     {
 123         Reference< XSingleServiceFactory > xFactory( createSingleFactory(
 124             reinterpret_cast< XMultiServiceFactory * >( pServiceManager ),
 125             OUString( RTL_CONSTASCII_USTRINGPARAM( IMPLEMENTATION_NAME ) ),
 126             Addon_createInstance,
 127             Addon_getSupportedServiceNames() ) );
 128
 129         if (xFactory.is())
 130         {
 131             xFactory->acquire();
 132             pRet = xFactory.get();
 133         }
 134     }
 135
 136     return pRet;
 137 }