INTEGRATION: CWS vcl21 (1.1.6); FILE ADDED

2004/03/18 11:23:18 pl 1.1.6.1: #112891# merge from apoc02

1 files changed, 455 insertions, 0 deletions

diff --git a/vcl/source/app/session.cxx b/vcl/source/app/session.cxx
new file mode 100644
index 000000000000..8170d0a23e20
--- /dev/null
+++ b/vcl/source/app/session.cxx
@@ -0,0 +1,455 @@
+/*************************************************************************
+ *
+ *  $RCSfile: session.cxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2004-05-18 10:53:41 $
+ *
+ *  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 EXPRESSED 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 _SV_SVAPP_HXX
+#include <svapp.hxx>
+#endif
+#ifndef _SV_SVDATA_HXX
+#include <svdata.hxx>
+#endif
+#ifndef _SV_SALINST_HXX
+#include <salinst.hxx>
+#endif
+#ifndef _VCL_SALSESSION_HXX
+#include <salsession.hxx>
+#endif
+#ifndef _CPPUHELPER_COMPBASE1_HXX_
+#include <cppuhelper/compbase1.hxx>
+#endif
+#ifndef _DEBUG_HXX
+#include <tools/debug.hxx>
+#endif
+#ifndef _OSL_MUTEX_HXX
+#include <osl/mutex.hxx>
+#endif
+#ifndef _RTL_USTRBUF_HXX
+#include <rtl/ustrbuf.hxx>
+#endif
+
+#ifndef _UNO_DISPATCHER_H_
+#include <uno/dispatcher.h> // declaration of generic uno interface
+#endif
+#ifndef _UNO_MAPPING_HXX_
+#include <uno/mapping.hxx> // mapping stuff
+#endif
+#ifndef _CPPUHELPER_FACTORY_HXX_
+#include <cppuhelper/factory.hxx>
+#endif
+
+#ifndef _COM_SUN_STAR_FRAME_XSESSIONMANAGERCLIENT_HPP_
+#include <com/sun/star/frame/XSessionManagerClient.hpp>
+#endif
+#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#endif
+
+#include <list>
+
+#define SESSION_SERVICE_IMPL_NAME "com.sun.star.frame.VCLSessionManagerClient"
+#define SESSION_SERVICE_SERVICE_NAME "com.sun.star.frame.SessionManagerClient"
+
+using namespace com::sun::star::uno;
+using namespace com::sun::star::lang;
+using namespace com::sun::star::frame;
+using namespace rtl;
+
+SalSession::~SalSession()
+{
+}
+
+class VCLSession : public cppu::WeakComponentImplHelper1 < XSessionManagerClient >
+{
+    struct Listener
+    {
+        Reference< XSessionManagerListener >        m_xListener;
+        bool                                        m_bInteractionRequested;
+        bool                                        m_bInteractionDone;
+        bool                                        m_bSaveDone;
+
+        Listener( const Reference< XSessionManagerListener >& xListener )
+                : m_xListener( xListener ),
+                  m_bInteractionRequested( false ),
+                  m_bInteractionDone( false ),
+                  m_bSaveDone( false )
+        {}
+    };
+
+    std::list< Listener >                           m_aListeners;
+    SalSession*                                     m_pSession;
+    osl::Mutex                                      m_aMutex;
+    bool                                            m_bInteractionRequested;
+    bool                                            m_bInteractionGranted;
+    bool                                            m_bInteractionDone;
+    bool                                            m_bSaveDone;
+
+    static void SalSessionEventProc( SalSessionEvent* pEvent );
+    static VCLSession* pOneInstance;
+
+    void callSaveRequested( bool bShutdown, bool bCancelable );
+    void callShutdownCancelled();
+    void callInteractionGranted( bool bGranted );
+public:
+    VCLSession();
+    virtual ~VCLSession();
+
+    virtual void SAL_CALL addSessionManagerListener( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException );
+    virtual void SAL_CALL removeSessionManagerListener( const Reference< XSessionManagerListener>& xListener ) throw( RuntimeException );
+    virtual void SAL_CALL queryInteraction( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException );
+    virtual void SAL_CALL interactionDone( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException );
+    virtual void SAL_CALL saveDone( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException );
+    virtual sal_Bool SAL_CALL cancelShutdown() throw( RuntimeException );
+};
+
+VCLSession* VCLSession::pOneInstance = NULL;
+
+VCLSession::VCLSession()
+        : cppu::WeakComponentImplHelper1< XSessionManagerClient >( m_aMutex ),
+          m_bInteractionRequested( false ),
+          m_bInteractionGranted( false ),
+          m_bInteractionDone( false ),
+          m_bSaveDone( false )
+{
+    DBG_ASSERT( pOneInstance == 0, "One instance  of VCLSession only !" );
+    pOneInstance = this;
+    m_pSession = ImplGetSVData()->mpDefInst->CreateSalSession();
+    if( m_pSession )
+        m_pSession->SetCallback( SalSessionEventProc );
+}
+
+VCLSession::~VCLSession()
+{
+    DBG_ASSERT( pOneInstance == this, "Another instance of VCLSession in destructor !" );
+    pOneInstance = NULL;
+    delete m_pSession;
+}
+
+void VCLSession::callSaveRequested( bool bShutdown, bool bCancelable )
+{
+    std::list< Listener > aListeners;
+    {
+        osl::MutexGuard aGuard( m_aMutex );
+        // reset listener states
+        for( std::list< Listener >::iterator it = m_aListeners.begin();
+             it != m_aListeners.end(); ++it )
+        {
+            it->m_bSaveDone = it->m_bInteractionRequested = it->m_bInteractionDone = false;
+        }
+
+        // copy listener list since calling a listener may remove it.
+        aListeners = m_aListeners;
+        // set back interaction state
+        m_bSaveDone = false;
+        m_bInteractionDone = false;
+        // without session we assume UI is always possible,
+        // so it was reqeusted and granted
+        m_bInteractionRequested = m_bInteractionGranted = m_pSession ? false : true;
+    }
+
+    ULONG nAcquireCount = Application::ReleaseSolarMutex();
+    for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
+        it->m_xListener->doSave( bShutdown, bCancelable );
+    Application::AcquireSolarMutex( nAcquireCount );
+}
+
+void VCLSession::callInteractionGranted( bool bInteractionGranted )
+{
+    std::list< Listener > aListeners;
+    {
+        osl::MutexGuard aGuard( m_aMutex );
+        // copy listener list since calling a listener may remove it.
+        aListeners = m_aListeners;
+
+        m_bInteractionGranted = bInteractionGranted;
+    }
+
+    ULONG nAcquireCount = Application::ReleaseSolarMutex();
+    for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
+    {
+        if( it->m_bInteractionRequested )
+            it->m_xListener->approveInteraction( bInteractionGranted );
+    }
+    Application::AcquireSolarMutex( nAcquireCount );
+}
+
+void VCLSession::callShutdownCancelled()
+{
+    std::list< Listener > aListeners;
+    {
+        osl::MutexGuard aGuard( m_aMutex );
+        // copy listener list since calling a listener may remove it.
+        aListeners = m_aListeners;
+        // set back interaction state
+        m_bInteractionRequested = m_bInteractionDone = m_bInteractionGranted = false;
+    }
+
+    ULONG nAcquireCount = Application::ReleaseSolarMutex();
+    for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
+        it->m_xListener->shutdownCanceled();
+    Application::AcquireSolarMutex( nAcquireCount );
+}
+
+void VCLSession::SalSessionEventProc( SalSessionEvent* pEvent )
+{
+    switch( pEvent->m_eType )
+    {
+        case Interaction:
+        {
+            SalSessionInteractionEvent* pIEv = static_cast<SalSessionInteractionEvent*>(pEvent);
+            pOneInstance->callInteractionGranted( pIEv->m_bInteractionGranted );
+        }
+        break;
+        case SaveRequest:
+        {
+            SalSessionSaveRequestEvent* pSEv = static_cast<SalSessionSaveRequestEvent*>(pEvent);
+            pOneInstance->callSaveRequested( pSEv->m_bShutdown, pSEv->m_bCancelable );
+        }
+        break;
+        case ShutdownCancel:
+            pOneInstance->callShutdownCancelled();
+            break;
+    }
+}
+
+void SAL_CALL VCLSession::addSessionManagerListener( const Reference<XSessionManagerListener>& xListener ) throw( RuntimeException )
+{
+    osl::MutexGuard aGuard( m_aMutex );
+
+    m_aListeners.push_back( Listener( xListener ) );
+}
+
+void SAL_CALL VCLSession::removeSessionManagerListener( const Reference<XSessionManagerListener>& xListener ) throw( RuntimeException )
+{
+    osl::MutexGuard aGuard( m_aMutex );
+
+    std::list< Listener >::iterator it = m_aListeners.begin();
+    while( it != m_aListeners.end() )
+    {
+        if( it->m_xListener == xListener )
+        {
+            m_aListeners.erase( it );
+            it = m_aListeners.begin();
+        }
+        else
+            ++it;
+    }
+}
+
+void SAL_CALL VCLSession::queryInteraction( const Reference<XSessionManagerListener>& xListener ) throw( RuntimeException )
+{
+    if( m_bInteractionGranted )
+    {
+        if( m_bInteractionDone )
+            xListener->approveInteraction( false );
+        else
+            xListener->approveInteraction( true );
+        return;
+    }
+
+    osl::MutexGuard aGuard( m_aMutex );
+    if( ! m_bInteractionRequested )
+    {
+        m_pSession->queryInteraction();
+        m_bInteractionRequested = true;
+    }
+    for( std::list< Listener >::iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
+    {
+        if( it->m_xListener == xListener )
+        {
+            it->m_bInteractionRequested = true;
+            it->m_bInteractionDone      = false;
+        }
+    }
+}
+
+void SAL_CALL VCLSession::interactionDone( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException )
+{
+    osl::MutexGuard aGuard( m_aMutex );
+    int nRequested = 0, nDone = 0;
+    for( std::list< Listener >::iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
+    {
+        if( it->m_bInteractionRequested )
+        {
+            nRequested++;
+            if( xListener == it->m_xListener )
+                it->m_bInteractionDone = true;
+        }
+        if( it->m_bInteractionDone )
+            nDone++;
+    }
+    if( nDone == nRequested && nDone > 0 )
+    {
+        m_bInteractionDone = true;
+        if( m_pSession )
+            m_pSession->interactionDone();
+    }
+}
+
+void SAL_CALL VCLSession::saveDone( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException )
+{
+    osl::MutexGuard aGuard( m_aMutex );
+
+    bool bSaveDone = true;
+    for( std::list< Listener >::iterator it = m_aListeners.begin();
+         it != m_aListeners.end(); ++it )
+    {
+        if( it->m_xListener == xListener )
+            it->m_bSaveDone = true;
+        if( ! it->m_bSaveDone )
+            bSaveDone = false;
+    }
+    if( bSaveDone )
+    {
+        m_bSaveDone = true;
+        if( m_pSession )
+            m_pSession->saveDone();
+    }
+}
+
+sal_Bool SAL_CALL VCLSession::cancelShutdown() throw( RuntimeException )
+{
+    return m_pSession ? (sal_Bool)m_pSession->cancelShutdown() : sal_False;
+}
+
+// service implementation
+
+static Sequence< rtl::OUString > SAL_CALL vcl_session_getSupportedServiceNames()
+{
+    Sequence< OUString > aRet(1);
+    aRet[0] = OUString::createFromAscii(SESSION_SERVICE_SERVICE_NAME);
+    return aRet;
+}
+
+static Reference< XInterface > SAL_CALL vcl_session_createInstance( const Reference< XMultiServiceFactory > & xMultiServiceFactory )
+{
+    ImplSVData* pSVData = ImplGetSVData();
+    if( ! pSVData->xSMClient.is() )
+        pSVData->xSMClient = new VCLSession();
+
+    return Reference< XInterface >(pSVData->xSMClient, UNO_QUERY );
+}
+
+
+
+extern "C" {
+
+    void SAL_CALL component_getImplementationEnvironment(
+        const sal_Char** ppEnvTypeName,
+        uno_Environment** ppEnv )
+    {
+        *ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
+    }
+
+    sal_Bool SAL_CALL component_writeInfo( void* pServiceManager, void* pXUnoKey )
+    {
+        if( pXUnoKey )
+        {
+            try
+            {
+                Reference< ::com::sun::star::registry::XRegistryKey > xKey( reinterpret_cast< ::com::sun::star::registry::XRegistryKey* >( pXUnoKey ) );
+
+                OUStringBuffer aImplName = OUString::createFromAscii( "/" );
+                aImplName.appendAscii( SESSION_SERVICE_IMPL_NAME );
+                aImplName.appendAscii( "/UNO/SERVICES/" );
+                aImplName.appendAscii( SESSION_SERVICE_SERVICE_NAME );
+                xKey->createKey( aImplName.makeStringAndClear() );
+
+                return sal_True;
+            }
+            catch( ::com::sun::star::registry::InvalidRegistryException& )
+            {
+            }
+        }
+        return sal_False;
+    }
+
+    void* SAL_CALL component_getFactory(
+        const sal_Char* pImplementationName,
+        void* pXUnoSMgr,
+        void* pXUnoKey
+        )
+    {
+        void* pRet = 0;
+
+        rtl::OString aImplementation( pImplementationName );
+        rtl::OString aImplName( SESSION_SERVICE_IMPL_NAME );
+
+        if( pXUnoSMgr )
+        {
+            Reference< ::com::sun::star::lang::XMultiServiceFactory > xMgr(
+                reinterpret_cast< ::com::sun::star::lang::XMultiServiceFactory* >( pXUnoSMgr )
+                );
+            Reference< ::com::sun::star::lang::XSingleServiceFactory > xFactory;
+            if( aImplName.equals( aImplementation ) )
+            {
+                xFactory = ::cppu::createSingleFactory(
+                    xMgr, OUString::createFromAscii( SESSION_SERVICE_IMPL_NAME ), vcl_session_createInstance,
+                    vcl_session_getSupportedServiceNames() );
+            }
+            if( xFactory.is() )
+            {
+                xFactory->acquire();
+                pRet = xFactory.get();
+            }
+        }
+        return pRet;
+    }
+
+} /* extern "C" */