From d36e06a5b2068ebd1fcfe271d0cb2400f0abc1fe Mon Sep 17 00:00:00 2001 From: Frank Schönheit Date: Mon, 12 Feb 2001 06:06:08 +0000 Subject: initial checkin - helper class for implementing module-functionality in SFX-less components --- extensions/source/inc/componentmodule.cxx | 390 ++++++++++++++++++++++++++++++ 1 file changed, 390 insertions(+) create mode 100644 extensions/source/inc/componentmodule.cxx (limited to 'extensions/source/inc/componentmodule.cxx') diff --git a/extensions/source/inc/componentmodule.cxx b/extensions/source/inc/componentmodule.cxx new file mode 100644 index 000000000000..b9e56f252543 --- /dev/null +++ b/extensions/source/inc/componentmodule.cxx @@ -0,0 +1,390 @@ +/************************************************************************* + * + * $RCSfile: componentmodule.cxx,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: fs $ $Date: 2001-02-12 07:06:08 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 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 + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc.. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef _EXTENSIONS_COMPONENT_MODULE_HXX_ +#include "componentmodule.hxx" +#endif + +#ifndef _TOOLS_RESMGR_HXX +#include +#endif +#ifndef _SOLAR_HRC +#include +#endif +#ifndef _COMPHELPER_SEQUENCE_HXX_ +#include +#endif +#include + +#define ENTER_MOD_METHOD() \ + ::osl::MutexGuard aGuard(s_aMutex); \ + ensureImpl() + +//......................................................................... +namespace COMPMOD_NAMESPACE +{ +//......................................................................... + + using namespace ::com::sun::star::uno; + using namespace ::com::sun::star::lang; + using namespace ::com::sun::star::registry; + using namespace ::comphelper; + using namespace ::cppu; + + //========================================================================= + //= OModuleImpl + //========================================================================= + /** implementation for OModule. not threadsafe, has to be guarded by it's owner + */ + class OModuleImpl + { + ResMgr* m_pRessources; + sal_Bool m_bInitialized; + ByteString m_sFilePrefix; + + public: + /// ctor + OModuleImpl(); + ~OModuleImpl(); + + /// get the manager for the ressources of the module + ResMgr* getResManager(); + void setResourceFilePrefix(const ::rtl::OString& _rPrefix) { m_sFilePrefix = _rPrefix; } + }; + + //------------------------------------------------------------------------- + OModuleImpl::OModuleImpl() + :m_pRessources(NULL) + ,m_bInitialized(sal_False) + { + } + + //------------------------------------------------------------------------- + OModuleImpl::~OModuleImpl() + { + if (m_pRessources) + delete m_pRessources; + } + + //------------------------------------------------------------------------- + ResMgr* OModuleImpl::getResManager() + { + // note that this method is not threadsafe, which counts for the whole class ! + if (!m_pRessources && !m_bInitialized) + { + DBG_ASSERT(m_sFilePrefix.Len(), "OModuleImpl::getResManager: no resource file prefix!"); + // create a manager with a fixed prefix + ByteString aMgrName = m_sFilePrefix; + aMgrName += ByteString::CreateFromInt32(SOLARUPD); // current build number + + m_pRessources = ResMgr::CreateResMgr(aMgrName.GetBuffer()); + DBG_ASSERT(m_pRessources, + (ByteString("OModuleImpl::getResManager: could not create the resource manager (file name: ") + += aMgrName + += ByteString(")!")).GetBuffer()); + + m_bInitialized = sal_True; + } + return m_pRessources; + } + + //========================================================================= + //= OModule + //========================================================================= + ::osl::Mutex OModule::s_aMutex; + sal_Int32 OModule::s_nClients = 0; + OModuleImpl* OModule::s_pImpl = NULL; + ::rtl::OString OModule::s_sResPrefix; + //------------------------------------------------------------------------- + ResMgr* OModule::getResManager() + { + ENTER_MOD_METHOD(); + return s_pImpl->getResManager(); + } + + //------------------------------------------------------------------------- + void OModule::setResourceFilePrefix(const ::rtl::OString& _rPrefix) + { + ::osl::MutexGuard aGuard(s_aMutex); + s_sResPrefix = _rPrefix; + if (s_pImpl) + s_pImpl->setResourceFilePrefix(_rPrefix); + } + + //------------------------------------------------------------------------- + void OModule::registerClient() + { + ::osl::MutexGuard aGuard(s_aMutex); + ++s_nClients; + } + + //------------------------------------------------------------------------- + void OModule::revokeClient() + { + ::osl::MutexGuard aGuard(s_aMutex); + if (!--s_nClients && s_pImpl) + { + delete s_pImpl; + s_pImpl = NULL; + } + } + + //------------------------------------------------------------------------- + void OModule::ensureImpl() + { + if (s_pImpl) + return; + s_pImpl = new OModuleImpl(); + s_pImpl->setResourceFilePrefix(s_sResPrefix); + } + + //-------------------------------------------------------------------------- + //- registration helper + //-------------------------------------------------------------------------- + + Sequence< ::rtl::OUString >* OModule::s_pImplementationNames = NULL; + Sequence< Sequence< ::rtl::OUString > >* OModule::s_pSupportedServices = NULL; + Sequence< sal_Int64 >* OModule::s_pCreationFunctionPointers = NULL; + Sequence< sal_Int64 >* OModule::s_pFactoryFunctionPointers = NULL; + + //-------------------------------------------------------------------------- + void OModule::registerComponent( + const ::rtl::OUString& _rImplementationName, + const Sequence< ::rtl::OUString >& _rServiceNames, + ComponentInstantiation _pCreateFunction, + FactoryInstantiation _pFactoryFunction) + { + if (!s_pImplementationNames) + { + OSL_ENSHURE(!s_pSupportedServices && !s_pCreationFunctionPointers && !s_pFactoryFunctionPointers, + "OModule::registerComponent : inconsistent state (the pointers (1)) !"); + s_pImplementationNames = new Sequence< ::rtl::OUString >; + s_pSupportedServices = new Sequence< Sequence< ::rtl::OUString > >; + s_pCreationFunctionPointers = new Sequence< sal_Int64 >; + s_pFactoryFunctionPointers = new Sequence< sal_Int64 >; + } + OSL_ENSHURE(s_pImplementationNames && s_pSupportedServices && s_pCreationFunctionPointers && s_pFactoryFunctionPointers, + "OModule::registerComponent : inconsistent state (the pointers (2)) !"); + + OSL_ENSHURE( (s_pImplementationNames->getLength() == s_pSupportedServices->getLength()) + && (s_pImplementationNames->getLength() == s_pCreationFunctionPointers->getLength()) + && (s_pImplementationNames->getLength() == s_pFactoryFunctionPointers->getLength()), + "OModule::registerComponent : inconsistent state !"); + + sal_Int32 nOldLen = s_pImplementationNames->getLength(); + s_pImplementationNames->realloc(nOldLen + 1); + s_pSupportedServices->realloc(nOldLen + 1); + s_pCreationFunctionPointers->realloc(nOldLen + 1); + s_pFactoryFunctionPointers->realloc(nOldLen + 1); + + s_pImplementationNames->getArray()[nOldLen] = _rImplementationName; + s_pSupportedServices->getArray()[nOldLen] = _rServiceNames; + s_pCreationFunctionPointers->getArray()[nOldLen] = reinterpret_cast(_pCreateFunction); + s_pFactoryFunctionPointers->getArray()[nOldLen] = reinterpret_cast(_pFactoryFunction); + } + + //-------------------------------------------------------------------------- + void OModule::revokeComponent(const ::rtl::OUString& _rImplementationName) + { + if (!s_pImplementationNames) + { + OSL_ASSERT("OModule::revokeComponent : have no class infos ! Are you sure called this method at the right time ?"); + return; + } + OSL_ENSHURE(s_pImplementationNames && s_pSupportedServices && s_pCreationFunctionPointers && s_pFactoryFunctionPointers, + "OModule::revokeComponent : inconsistent state (the pointers) !"); + OSL_ENSHURE( (s_pImplementationNames->getLength() == s_pSupportedServices->getLength()) + && (s_pImplementationNames->getLength() == s_pCreationFunctionPointers->getLength()) + && (s_pImplementationNames->getLength() == s_pFactoryFunctionPointers->getLength()), + "OModule::revokeComponent : inconsistent state !"); + + sal_Int32 nLen = s_pImplementationNames->getLength(); + const ::rtl::OUString* pImplNames = s_pImplementationNames->getConstArray(); + for (sal_Int32 i=0; iequals(_rImplementationName)) + { + removeElementAt(*s_pImplementationNames, i); + removeElementAt(*s_pSupportedServices, i); + removeElementAt(*s_pCreationFunctionPointers, i); + removeElementAt(*s_pFactoryFunctionPointers, i); + break; + } + } + + if (s_pImplementationNames->getLength() == 0) + { + delete s_pImplementationNames; s_pImplementationNames = NULL; + delete s_pSupportedServices; s_pSupportedServices = NULL; + delete s_pCreationFunctionPointers; s_pCreationFunctionPointers = NULL; + delete s_pFactoryFunctionPointers; s_pFactoryFunctionPointers = NULL; + } + } + + //-------------------------------------------------------------------------- + sal_Bool OModule::writeComponentInfos( + const Reference< XMultiServiceFactory >& /*_rxServiceManager*/, + const Reference< XRegistryKey >& _rxRootKey) + { + OSL_ENSHURE(_rxRootKey.is(), "OModule::writeComponentInfos : invalid argument !"); + + if (!s_pImplementationNames) + { + OSL_ASSERT("OModule::writeComponentInfos : have no class infos ! Are you sure called this method at the right time ?"); + return sal_True; + } + OSL_ENSHURE(s_pImplementationNames && s_pSupportedServices && s_pCreationFunctionPointers && s_pFactoryFunctionPointers, + "OModule::writeComponentInfos : inconsistent state (the pointers) !"); + OSL_ENSHURE( (s_pImplementationNames->getLength() == s_pSupportedServices->getLength()) + && (s_pImplementationNames->getLength() == s_pCreationFunctionPointers->getLength()) + && (s_pImplementationNames->getLength() == s_pFactoryFunctionPointers->getLength()), + "OModule::writeComponentInfos : inconsistent state !"); + + sal_Int32 nLen = s_pImplementationNames->getLength(); + const ::rtl::OUString* pImplName = s_pImplementationNames->getConstArray(); + const Sequence< ::rtl::OUString >* pServices = s_pSupportedServices->getConstArray(); + + ::rtl::OUString sRootKey("/", 1, RTL_TEXTENCODING_ASCII_US); + for (sal_Int32 i=0; i xNewKey( _rxRootKey->createKey(aMainKeyName) ); + + const ::rtl::OUString* pService = pServices->getConstArray(); + for (sal_Int32 j=0; jgetLength(); ++j, ++pService) + xNewKey->createKey(*pService); + } + catch(Exception&) + { + OSL_ASSERT("OModule::writeComponentInfos : something went wrong while creating the keys !"); + return sal_False; + } + } + + return sal_True; + } + + //-------------------------------------------------------------------------- + Reference< XInterface > OModule::getComponentFactory( + const ::rtl::OUString& _rImplementationName, + const Reference< XMultiServiceFactory >& _rxServiceManager) + { + OSL_ENSHURE(_rxServiceManager.is(), "OModule::getComponentFactory : invalid argument (service manager) !"); + OSL_ENSHURE(_rImplementationName.getLength(), "OModule::getComponentFactory : invalid argument (implementation name) !"); + + if (!s_pImplementationNames) + { + OSL_ASSERT("OModule::getComponentFactory : have no class infos ! Are you sure called this method at the right time ?"); + return NULL; + } + OSL_ENSHURE(s_pImplementationNames && s_pSupportedServices && s_pCreationFunctionPointers && s_pFactoryFunctionPointers, + "OModule::getComponentFactory : inconsistent state (the pointers) !"); + OSL_ENSHURE( (s_pImplementationNames->getLength() == s_pSupportedServices->getLength()) + && (s_pImplementationNames->getLength() == s_pCreationFunctionPointers->getLength()) + && (s_pImplementationNames->getLength() == s_pFactoryFunctionPointers->getLength()), + "OModule::getComponentFactory : inconsistent state !"); + + + Reference< XInterface > xReturn; + + + sal_Int32 nLen = s_pImplementationNames->getLength(); + const ::rtl::OUString* pImplName = s_pImplementationNames->getConstArray(); + const Sequence< ::rtl::OUString >* pServices = s_pSupportedServices->getConstArray(); + const sal_Int64* pComponentFunction = s_pCreationFunctionPointers->getConstArray(); + const sal_Int64* pFactoryFunction = s_pFactoryFunctionPointers->getConstArray(); + + for (sal_Int32 i=0; iequals(_rImplementationName)) + { + const FactoryInstantiation FactoryInstantiationFunction = reinterpret_cast(*pFactoryFunction); + const ComponentInstantiation ComponentInstantiationFunction = reinterpret_cast(*pComponentFunction); + + xReturn = FactoryInstantiationFunction( _rxServiceManager, *pImplName, ComponentInstantiationFunction, *pServices); + if (xReturn.is()) + { + xReturn->acquire(); + return xReturn.get(); + } + } + } + + return NULL; + } + + +//......................................................................... +} // namespace COMPMOD_NAMESPACE +//......................................................................... + +/************************************************************************* + * history: + * $Log: not supported by cvs2svn $ + * + * Revision 1.0 30.01.01 15:18:48 fs + ************************************************************************/ + -- cgit v1.2.3