fd743a4b2a
2007/05/30 08:41:17 fs 1.1.2.5: more/better assertions 2007/02/28 07:17:27 fs 1.1.2.4: #i10000# 2006/10/16 07:34:59 fs 1.1.2.3: #i10000# 2006/10/05 11:30:13 fs 1.1.2.2: #i10000# 2005/03/07 08:02:52 fs 1.1.2.1: #i44293# accessing A11Y components provided by an external factory
316 lines
12 KiB
C++
316 lines
12 KiB
C++
/*************************************************************************
|
|
*
|
|
* $RCSfile: accessibilityclient.cxx,v $
|
|
*
|
|
* $Revision: 1.2 $
|
|
*
|
|
* last change: $Author: hr $ $Date: 2007-06-27 15:16:02 $
|
|
*
|
|
* 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): _______________________________________
|
|
*
|
|
*
|
|
************************************************************************/
|
|
|
|
// MARKER(update_precomp.py): autogen include statement, do not remove
|
|
#include "precompiled_toolkit.hxx"
|
|
|
|
#ifndef TOOLKIT_HELPER_ACCESSIBILITY_CLIENT_HXX
|
|
#include <toolkit/helper/accessibilityclient.hxx>
|
|
#endif
|
|
|
|
#ifndef TOOLKIT_HELPER_ACCESSIBLE_FACTORY_HXX
|
|
#include <toolkit/helper/accessiblefactory.hxx>
|
|
#endif
|
|
#ifndef _OSL_MODULE_H_
|
|
#include <osl/module.h>
|
|
#endif
|
|
#ifndef _OSL_DIAGNOSE_H_
|
|
#include <osl/diagnose.h>
|
|
#endif
|
|
#ifndef _SOLAR_H
|
|
#include <tools/solar.h>
|
|
#endif
|
|
|
|
// #define UNLOAD_ON_LAST_CLIENT_DYING
|
|
// this is not recommended currently. If enabled, the implementation will log
|
|
// the number of active clients, and unload the acc library when the last client
|
|
// goes away.
|
|
// Sounds like a good idea, unfortunately, there's no guarantee that all objects
|
|
// implemented in this library are already dead.
|
|
// Iow, just because an object implementing an XAccessible (implemented in this lib
|
|
// here) died, it's not said that everybody released all references to the
|
|
// XAccessibleContext used by this component, and implemented in the acc lib.
|
|
// So we cannot really unload the lib.
|
|
//
|
|
// Alternatively, if the lib would us own "usage counting", i.e. every component
|
|
// implemented therein would affect a static ref count, the acc lib could care
|
|
// for unloading itself.
|
|
|
|
//........................................................................
|
|
namespace toolkit
|
|
{
|
|
//........................................................................
|
|
|
|
using namespace ::com::sun::star::uno;
|
|
using namespace ::com::sun::star::accessibility;
|
|
|
|
namespace
|
|
{
|
|
#ifdef UNLOAD_ON_LAST_CLIENT_DYING
|
|
static oslInterlockedCount s_nAccessibilityClients = 0;
|
|
#endif // UNLOAD_ON_LAST_CLIENT_DYING
|
|
static oslModule s_hAccessibleImplementationModule = NULL;
|
|
static GetStandardAccComponentFactory s_pAccessibleFactoryFunc = NULL;
|
|
static ::rtl::Reference< IAccessibleFactory > s_pFactory;
|
|
}
|
|
|
|
//====================================================================
|
|
//= AccessibleDummyFactory
|
|
//====================================================================
|
|
class AccessibleDummyFactory : public IAccessibleFactory
|
|
{
|
|
public:
|
|
AccessibleDummyFactory();
|
|
|
|
protected:
|
|
virtual ~AccessibleDummyFactory();
|
|
|
|
private:
|
|
AccessibleDummyFactory( const AccessibleDummyFactory& ); // never implemented
|
|
AccessibleDummyFactory& operator=( const AccessibleDummyFactory& ); // never implemented
|
|
|
|
oslInterlockedCount m_refCount;
|
|
|
|
public:
|
|
// IReference
|
|
virtual oslInterlockedCount SAL_CALL acquire();
|
|
virtual oslInterlockedCount SAL_CALL release();
|
|
|
|
// IAccessibleFactory
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXButton* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXCheckBox* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXRadioButton* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXListBox* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXFixedText* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXScrollBar* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXEdit* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXComboBox* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXToolBox* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext >
|
|
createAccessibleContext( VCLXWindow* /*_pXWindow*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >
|
|
createAccessible( Menu* /*_pMenu*/, sal_Bool /*_bIsMenuBar*/ )
|
|
{
|
|
return NULL;
|
|
}
|
|
};
|
|
|
|
//--------------------------------------------------------------------
|
|
AccessibleDummyFactory::AccessibleDummyFactory()
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
AccessibleDummyFactory::~AccessibleDummyFactory()
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
oslInterlockedCount SAL_CALL AccessibleDummyFactory::acquire()
|
|
{
|
|
return osl_incrementInterlockedCount( &m_refCount );
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
oslInterlockedCount SAL_CALL AccessibleDummyFactory::release()
|
|
{
|
|
if ( 0 == osl_decrementInterlockedCount( &m_refCount ) )
|
|
{
|
|
delete this;
|
|
return 0;
|
|
}
|
|
return m_refCount;
|
|
}
|
|
|
|
//====================================================================
|
|
//= AccessibilityClient
|
|
//====================================================================
|
|
//--------------------------------------------------------------------
|
|
AccessibilityClient::AccessibilityClient()
|
|
:m_bInitialized( false )
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
void AccessibilityClient::ensureInitialized()
|
|
{
|
|
if ( m_bInitialized )
|
|
return;
|
|
|
|
::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
|
|
|
|
#ifdef UNLOAD_ON_LAST_CLIENT_DYING
|
|
if ( 1 == osl_incrementInterlockedCount( &s_nAccessibilityClients ) )
|
|
{ // the first client
|
|
#endif // UNLOAD_ON_LAST_CLIENT_DYING
|
|
// load the library implementing the factory
|
|
if ( !s_pFactory.get() )
|
|
{
|
|
const ::rtl::OUString sModuleName = ::rtl::OUString::createFromAscii(
|
|
SVLIBRARY( "acc" )
|
|
);
|
|
s_hAccessibleImplementationModule = osl_loadModule( sModuleName.pData, 0 );
|
|
if ( s_hAccessibleImplementationModule != NULL )
|
|
{
|
|
const ::rtl::OUString sFactoryCreationFunc =
|
|
::rtl::OUString::createFromAscii( "getStandardAccessibleFactory" );
|
|
s_pAccessibleFactoryFunc = (GetStandardAccComponentFactory)
|
|
osl_getFunctionSymbol( s_hAccessibleImplementationModule, sFactoryCreationFunc.pData );
|
|
|
|
}
|
|
OSL_ENSURE( s_pAccessibleFactoryFunc, "AccessibilityClient::ensureInitialized: could not load the library, or not retrieve the needed symbol!" );
|
|
|
|
// get a factory instance
|
|
if ( s_pAccessibleFactoryFunc )
|
|
{
|
|
IAccessibleFactory* pFactory = static_cast< IAccessibleFactory* >( (*s_pAccessibleFactoryFunc)() );
|
|
OSL_ENSURE( pFactory, "AccessibilityClient::ensureInitialized: no factory provided by the A11Y lib!" );
|
|
if ( pFactory )
|
|
{
|
|
s_pFactory = pFactory;
|
|
pFactory->release();
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( !s_pFactory.get() )
|
|
// the attempt to load the lib, or to create the factory, failed
|
|
// -> fall back to a dummy factory
|
|
s_pFactory = new AccessibleDummyFactory;
|
|
#ifdef UNLOAD_ON_LAST_CLIENT_DYING
|
|
}
|
|
#endif
|
|
|
|
m_bInitialized = true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
AccessibilityClient::~AccessibilityClient()
|
|
{
|
|
if ( m_bInitialized )
|
|
{
|
|
::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
|
|
|
|
#ifdef UNLOAD_ON_LAST_CLIENT_DYING
|
|
if( 0 == osl_decrementInterlockedCount( &s_nAccessibilityClients ) )
|
|
{
|
|
s_pFactory = NULL;
|
|
s_pAccessibleFactoryFunc = NULL;
|
|
if ( s_hAccessibleImplementationModule )
|
|
{
|
|
osl_unloadModule( s_hAccessibleImplementationModule );
|
|
s_hAccessibleImplementationModule = NULL;
|
|
}
|
|
}
|
|
#endif // UNLOAD_ON_LAST_CLIENT_DYING
|
|
}
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
IAccessibleFactory& AccessibilityClient::getFactory()
|
|
{
|
|
ensureInitialized();
|
|
OSL_ENSURE( s_pFactory.is(), "AccessibilityClient::getFactory: at least a dummy factory should have been created!" );
|
|
return *s_pFactory;
|
|
}
|
|
|
|
//........................................................................
|
|
} // namespace toolkit
|
|
//........................................................................
|