connectivity/source/drivers/macab/MacabDriver.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MacabDriver.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _CONNECTIVITY_MACAB_DRIVER_HXX_
  32 #define _CONNECTIVITY_MACAB_DRIVER_HXX_
  33
  34 /** === begin UNO includes === **/
  35 #include <com/sun/star/sdbc/XDriver.hpp>
  36 #include <com/sun/star/lang/XServiceInfo.hpp>
  37 #include <com/sun/star/frame/XTerminateListener.hpp>
  38 /** === end UNO includes === **/
  39 #include <cppuhelper/compbase3.hxx>
  40 #include <osl/module.h>
  41
  42 // the address book driver's version
  43 #define MACAB_DRIVER_VERSION            "0.1"
  44 #define MACAB_DRIVER_VERSION_MAJOR      0
  45 #define MACAB_DRIVER_VERSION_MINOR      1
  46
  47 namespace connectivity
  48 {
  49     namespace macab
  50     {
  51         class MacabConnection;
  52         class MacabDriver;
  53
  54         typedef void*   (SAL_CALL * ConnectionFactoryFunction)( void* _pDriver );
  55
  56         typedef std::vector< ::com::sun::star::uno::WeakReferenceHelper > OWeakRefArray;
  57
  58         // ===============================================================
  59         // = MacabImplModule
  60         // ===============================================================
  61         class MacabImplModule
  62         {
  63         private:
  64             ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
  65                                         m_xORB;
  66
  67             /// Did we already attempt to load the module and to retrieve the symbols?
  68             bool    m_bAttemptedLoadModule;
  69             oslModule                   m_hConnectorModule;
  70             ConnectionFactoryFunction   m_pConnectionFactoryFunc;
  71
  72         public:
  73             MacabImplModule( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory );
  74
  75             /** determines whether there is a mac OS present in the environment
  76             */
  77             bool isMacOSPresent();
  78
  79             /** initializes the implementation module.
  80
  81                 @raises ::com::sun::star::uno::RuntimeException
  82                     if the module could be loaded, but required symbols are missing
  83                 @raises ::com::sun::star::sdbc::SQLException
  84                     if no Mac OS was found at all
  85             */
  86             void init();
  87
  88             /** shuts down the impl module
  89             */
  90             void shutdown();
  91
  92             /** creates a new connection
  93                 @precond
  94                     <member>init</member> has been called before
  95                 @raises ::com::sun::star::uno::RuntimeException
  96                     if no connection object could be created (which is a severe error, normally impossible)
  97             */
  98             MacabConnection*  createConnection( MacabDriver* _pDriver ) const;
  99
 100         private:
 101             /** loads the implementation module and retrieves the needed symbols
 102
 103                 Save against being called multiple times.
 104
 105                 @return <TRUE/> if the module could be loaded successfully.
 106
 107                 @raises ::com::sun::star::uno::RuntimeException
 108                     if the module could be loaded, but required symbols are missing
 109             */
 110             bool    impl_loadModule();
 111
 112             /** unloads the implementation module, and resets all function pointers to <NULL/>
 113                 @precond m_hConnectorModule is not <NULL/>
 114             */
 115             void    impl_unloadModule();
 116
 117             /** throws an SQLException saying than no Mac OS installation was found
 118             */
 119             void    impl_throwNoMacOSException();
 120
 121             /** throws a generic SQL exception with SQLState S1000 and error code 0
 122             */
 123             void    impl_throwGenericSQLException( const ::rtl::OUString& _rMessage );
 124
 125         };
 126
 127         // ===============================================================
 128         // = MacabDriver
 129         // ===============================================================
 130         typedef ::cppu::WeakComponentImplHelper3<   ::com::sun::star::sdbc::XDriver,
 131                                                     ::com::sun::star::lang::XServiceInfo,
 132                                                     ::com::sun::star::frame::XTerminateListener > MacabDriver_BASE;
 133         class MacabDriver : public MacabDriver_BASE
 134         {
 135         protected:
 136             ::osl::Mutex                                m_aMutex;                       // mutex is need to control member access
 137             OWeakRefArray                               m_xConnections;         // vector containing a list of all the
 138                                                             //  MacabConnection objects for this Driver
 139             ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
 140                                         m_xMSFactory;           // the multi-service factory
 141             MacabImplModule               m_aImplModule;
 142
 143         public:
 144             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 );
 145
 146             // XServiceInfo - static versions
 147             static ::rtl::OUString getImplementationName_Static(  ) throw(::com::sun::star::uno::RuntimeException);
 148             static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_Static(  ) throw (::com::sun::star::uno::RuntimeException);
 149
 150             const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >&
 151                     getMSFactory() const { return m_xMSFactory; }
 152
 153             /** returns the driver's implementation name (being pure ASCII) for reference in various places
 154             */
 155             static const sal_Char*  impl_getAsciiImplementationName();
 156
 157             /** returns the path of our configuration settings
 158             */
 159             static ::rtl::OUString  impl_getConfigurationSettingsPath();
 160
 161         protected:
 162             MacabDriver(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory);
 163
 164             // OComponentHelper
 165             virtual void SAL_CALL disposing(void);
 166
 167             // XServiceInfo
 168             virtual ::rtl::OUString SAL_CALL getImplementationName(  ) throw(::com::sun::star::uno::RuntimeException);
 169             virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw(::com::sun::star::uno::RuntimeException);
 170             virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw(::com::sun::star::uno::RuntimeException);
 171
 172             // XDriver
 173             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);
 174             virtual sal_Bool SAL_CALL acceptsURL( const ::rtl::OUString& url ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException);
 175             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);
 176             virtual sal_Int32 SAL_CALL getMajorVersion() throw(::com::sun::star::uno::RuntimeException);
 177             virtual sal_Int32 SAL_CALL getMinorVersion() throw(::com::sun::star::uno::RuntimeException);
 178
 179             // XTerminateListener
 180             virtual void SAL_CALL queryTermination( const ::com::sun::star::lang::EventObject& Event ) throw (::com::sun::star::frame::TerminationVetoException, ::com::sun::star::uno::RuntimeException);
 181             virtual void SAL_CALL notifyTermination( const ::com::sun::star::lang::EventObject& Event ) throw (::com::sun::star::uno::RuntimeException);
 182
 183             // XEventListener
 184             virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
 185
 186         private:
 187             /** shuts down the library which contains the real implementations
 188
 189                 This method is safe against being called multiple times
 190
 191                 @precond our mutex is locked
 192             */
 193             void impl_shutdownImplementationModule();
 194         };
 195     }
 196
 197 }
 198
 199 #endif // _CONNECTIVITY_MACAB_DRIVER_HXX_