mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5087c7f2e4261a223e6b10c20d59e37eb6409cc1
libreoffice/connectivity/source/drivers/kab/KDriver.hxx
Oliver Bolte d46329531b INTEGRATION: CWS dba202e (1.2.14); FILE MERGED 
2006/01/10 14:23:20 fs 1.2.14.1: copying fixes for #i59673# and #i60062# to this (earlier) CWS
2006-01-19 14:31:11 +00:00

244 lines
11 KiB
C++
Raw Blame History

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: KDriver.hxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: obo $ $Date: 2006-01-19 15:31:11 $
*
* 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 _CONNECTIVITY_KAB_DRIVER_HXX_
#define _CONNECTIVITY_KAB_DRIVER_HXX_
/** === begin UNO includes === **/
#ifndef _COM_SUN_STAR_SDBC_XDRIVER_HPP_
#include <com/sun/star/sdbc/XDriver.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
#include <com/sun/star/lang/XServiceInfo.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XTERMINATELISTENER_HPP_
#include <com/sun/star/frame/XTerminateListener.hpp>
#endif
/** === end UNO includes === **/
#ifndef _CPPUHELPER_COMPBASE3_HXX_
#include <cppuhelper/compbase3.hxx>
#endif
#ifndef _OSL_MODULE_H_
#include <osl/module.h>
#endif
namespace connectivity
{
namespace kab
{
class KabConnection;
class KabDriver;
typedef void* (SAL_CALL * ConnectionFactoryFunction)( void* _pDriver );
typedef void (SAL_CALL * ApplicationInitFunction)( void );
typedef void (SAL_CALL * ApplicationShutdownFunction)( void );
typedef int (SAL_CALL * KDEVersionCheckFunction)( void );
typedef std::vector< ::com::sun::star::uno::WeakReferenceHelper > OWeakRefArray;
// ===============================================================
// = KabImplModule
// ===============================================================
class KabImplModule
{
private:
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
m_xORB;
/// Did we already attempt to load the module and to retrieve the symbols?
bool m_bAttemptedLoadModule;
/// Did we already check the KDE version and initialize the impl module (or at least attempted to)?
bool m_bAttemptedInitialize;
oslModule m_hConnectorModule;
ConnectionFactoryFunction m_pConnectionFactoryFunc;
ApplicationInitFunction m_pApplicationInitFunc;
ApplicationShutdownFunction m_pApplicationShutdownFunc;
KDEVersionCheckFunction m_pKDEVersionCheckFunc;
public:
KabImplModule( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory );
/** determines whether there is a KDE present in the environment
*/
bool isKDEPresent();
enum KDEVersionType
{
eTooOld,
eSupported,
eToNew
};
/** checks whether the KDE version we're running against is supported
@precond
the module is loaded, i.e impl_loadModule has successfully been called
*/
KDEVersionType matchKDEVersion();
/** initializes the implementation module.
@raises ::com::sun::star::uno::RuntimeException
if the module could be loaded, but required symbols are missing
@raises ::com::sun::star::sdbc::SQLException
if the KDE version we're running against is not supported, or no KDE was found at all
*/
void init();
/** shuts down the impl module (and the KDE application, if we own it)
*/
void shutdown();
/** creates a new connection
@precond
<member>init</member> has been called before
@raises ::com::sun::star::uno::RuntimeException
if no connection object could be created (which is a severe error, normally impossible)
*/
KabConnection* createConnection( KabDriver* _pDriver ) const;
private:
/** loads the implementation module and retrieves the needed symbols
Save against being called multiple times.
@return <TRUE/> if the module could be loaded successfully.
@raises ::com::sun::star::uno::RuntimeException
if the module could be loaded, but required symbols are missing
*/
bool impl_loadModule();
/** unloads the implementation module, and resets all function pointers to <NULL/>
@precond m_hConnectorModule is not <NULL/>
*/
void impl_unloadModule();
/** throws an SQLException saying than no KDE installation was found
*/
void impl_throwNoKdeException();
/** throws an SQLException saying that the found KDE version is too old
*/
void impl_throwKdeTooOldException();
/** throws an SQLException saying that the found KDE version is too new
*/
void impl_throwKdeTooNewException();
/** throws a generic SQL exception with SQLState S1000 and error code 0
*/
void impl_throwGenericSQLException( const ::rtl::OUString& _rMessage );
/** determines whether it's allowed to run on a too-new (not confirmed to work) version
*/
bool impl_doAllowNewKDEVersion();
};
// ===============================================================
// = KabDriver
// ===============================================================
typedef ::cppu::WeakComponentImplHelper3< ::com::sun::star::sdbc::XDriver,
::com::sun::star::lang::XServiceInfo,
::com::sun::star::frame::XTerminateListener > KDriver_BASE;
class KabDriver : public KDriver_BASE
{
protected:
::osl::Mutex m_aMutex; // mutex is need to control member access
OWeakRefArray m_xConnections; // vector containing a list of all the
// KabConnection objects for this Driver
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
m_xMSFactory; // the multi-service factory
KabImplModule m_aImplModule;
public:
static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL Create(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory) throw( ::com::sun::star::uno::Exception );
// XServiceInfo - static versions
static ::rtl::OUString getImplementationName_Static( ) throw(::com::sun::star::uno::RuntimeException);
static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static( ) throw (::com::sun::star::uno::RuntimeException);
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >&
getMSFactory() const { return m_xMSFactory; }
/** returns the driver's implementation name (being pure ASCII) for reference in various places
*/
static const sal_Char* impl_getAsciiImplementationName();
/** returns the path of our configuration settings
*/
static ::rtl::OUString impl_getConfigurationSettingsPath();
protected:
KabDriver(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory);
// OComponentHelper
virtual void SAL_CALL disposing(void);
// XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames( ) throw(::com::sun::star::uno::RuntimeException);
// XDriver
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection > SAL_CALL connect( const ::rtl::OUString& url, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL acceptsURL( const ::rtl::OUString& url ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::sdbc::DriverPropertyInfo > SAL_CALL getPropertyInfo( const ::rtl::OUString& url, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getMajorVersion() throw(::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getMinorVersion() throw(::com::sun::star::uno::RuntimeException);
// XTerminateListener
virtual void SAL_CALL queryTermination( const ::com::sun::star::lang::EventObject& Event ) throw (::com::sun::star::frame::TerminationVetoException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL notifyTermination( const ::com::sun::star::lang::EventObject& Event ) throw (::com::sun::star::uno::RuntimeException);
// XEventListener
virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
private:
/** shuts down the library which contains the real implementations
This method is safe against being called multiple times
@precond our mutex is locked
*/
void impl_shutdownImplementationModule();
};
}
}
#endif // _CONNECTIVITY_KAB_DRIVER_HXX_
Reference in New Issue View Git Blame Copy Permalink