AOO410/main/extensions/source/bibliography/loadlisteneradapter.hxx

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef EXTENSIONS_BIB_LOADLISTENERADAPTER_HXX
#define EXTENSIONS_BIB_LOADLISTENERADAPTER_HXX

#include <osl/mutex.hxx>
#include <com/sun/star/lang/XComponent.hpp>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/form/XLoadable.hpp>

//.........................................................................
namespace bib
{
//.........................................................................

	class OComponentAdapterBase;

	//=====================================================================
	//= OComponentListener
	//=====================================================================
	class OComponentListener
	{
		friend class OComponentAdapterBase;

	private:
		OComponentAdapterBase*	m_pAdapter;
		::osl::Mutex&			m_rMutex;
	protected:
		OComponentListener( ::osl::Mutex& _rMutex )
			:m_pAdapter( NULL )
            ,m_rMutex( _rMutex )
		{
		}

		virtual ~OComponentListener();

		// XEventListener equivalents
		virtual void _disposing( const ::com::sun::star::lang::EventObject& _rSource ) throw( ::com::sun::star::uno::RuntimeException );

	protected:
		void setAdapter( OComponentAdapterBase* _pAdapter );
	};

	//=====================================================================
	//= OComponentAdapterBase
	//=====================================================================
	class OComponentAdapterBase
	{
		friend class OComponentListener;

	private:
		::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >
											m_xComponent;
		OComponentListener*					m_pListener;
		sal_Int32							m_nLockCount;
		sal_Bool							m_bListening	: 1;
		sal_Bool							m_bAutoRelease	: 1;

		// impl method for dispose - virtual, 'cause you at least need to remove the listener from the broadcaster
		virtual void disposing() = 0;

	protected:
		// attribute access for derivees
		const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >&
								getComponent() const	{ return m_xComponent; }
		OComponentListener*		getListener()			{ return m_pListener; }

		// to be called by derivees which started listening at the component
		virtual	void	startComponentListening() = 0;

		virtual ~OComponentAdapterBase();

	public:
		OComponentAdapterBase(
			const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >& _rxComp,
			sal_Bool _bAutoRelease = sal_True
		);

		// late construction
		// can be called from within you ctor, to have you're object fully initialized at the moment of
		// the call (which would not be the case when calling this ctor)
		void Init( OComponentListener* _pListener );

	// base for ref-counting, implemented by OComponentAdapter
		virtual void SAL_CALL acquire(  ) throw () = 0;
		virtual void SAL_CALL release(  ) throw () = 0;

	// helper
		/// get the lock count
		sal_Int32	locked() const { return m_nLockCount; }

		/// dispose the object - stop listening and such
		void dispose();

	protected:
	// XEventListener
		virtual void SAL_CALL disposing( const  ::com::sun::star::lang::EventObject& Source ) throw( ::com::sun::star::uno::RuntimeException);
	};

	//=====================================================================
	//= OLoadListener
	//=====================================================================
	class OLoadListener : public OComponentListener
	{
		friend class OLoadListenerAdapter;

	protected:
		OLoadListener( ::osl::Mutex& _rMutex ) : OComponentListener( _rMutex ) { }

	// XLoadListener equivalents
		virtual void _loaded( const ::com::sun::star::lang::EventObject& aEvent ) = 0;
		virtual void _unloading( const ::com::sun::star::lang::EventObject& aEvent ) = 0;
		virtual void _unloaded( const ::com::sun::star::lang::EventObject& aEvent ) = 0;
		virtual void _reloading( const ::com::sun::star::lang::EventObject& aEvent ) = 0;
		virtual void _reloaded( const ::com::sun::star::lang::EventObject& aEvent ) = 0;
	};

	//=====================================================================
	//= OLoadListenerAdapter
	//=====================================================================
	typedef	::cppu::WeakImplHelper1< ::com::sun::star::form::XLoadListener >	OLoadListenerAdapter_Base;
	class OLoadListenerAdapter
		:public OLoadListenerAdapter_Base
		,public OComponentAdapterBase
	{
	protected:
		OLoadListener*		getLoadListener( )	{ return static_cast< OLoadListener* >( getListener() ); }

	protected:
		virtual void	disposing();
		virtual	void	startComponentListening();

	public:
		OLoadListenerAdapter(
			const ::com::sun::star::uno::Reference< ::com::sun::star::form::XLoadable >& _rxLoadable,
			sal_Bool _bAutoRelease = sal_True
		);


		virtual void SAL_CALL acquire(  ) throw ();
		virtual void SAL_CALL release(  ) throw ();

	protected:
	// XEventListener
		virtual void SAL_CALL disposing( const  ::com::sun::star::lang::EventObject& _rSource ) throw( ::com::sun::star::uno::RuntimeException);

	// XLoadListener
		virtual void SAL_CALL loaded( const ::com::sun::star::lang::EventObject& aEvent ) throw (::com::sun::star::uno::RuntimeException);
		virtual void SAL_CALL unloading( const ::com::sun::star::lang::EventObject& aEvent ) throw (::com::sun::star::uno::RuntimeException);
		virtual void SAL_CALL unloaded( const ::com::sun::star::lang::EventObject& aEvent ) throw (::com::sun::star::uno::RuntimeException);
		virtual void SAL_CALL reloading( const ::com::sun::star::lang::EventObject& aEvent ) throw (::com::sun::star::uno::RuntimeException);
		virtual void SAL_CALL reloaded( const ::com::sun::star::lang::EventObject& aEvent ) throw (::com::sun::star::uno::RuntimeException);
	};

//.........................................................................
}	// namespace bib
//.........................................................................

#endif // EXTENSIONS_BIB_LOADLISTENERADAPTER_HXX