source/misc/atom.cxx

/**************************************************************
 *
 * 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.
 *
 *************************************************************/


// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_unotools.hxx"

#include <unotools/atom.hxx>

using namespace utl;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::util;
#define NMSP_UTIL ::com::sun::star::util

AtomProvider::AtomProvider()
{
	m_nAtoms = 1;
}

AtomProvider::~AtomProvider()
{
}

int AtomProvider::getAtom( const ::rtl::OUString& rString, sal_Bool bCreate )
{
	::std::hash_map< ::rtl::OUString, int, ::rtl::OUStringHash >::iterator it = m_aAtomMap.find( rString );
	if( it != m_aAtomMap.end() )
		return it->second;
	if( ! bCreate )
		return INVALID_ATOM;
	m_aAtomMap[ rString ] = m_nAtoms;
	m_aStringMap[ m_nAtoms ] = rString;
	m_nAtoms++;
	return m_nAtoms-1;
}

void AtomProvider::getAll( ::std::list< ::utl::AtomDescription >& atoms )
{
	atoms.clear();
	::std::hash_map< ::rtl::OUString, int, ::rtl::OUStringHash >::const_iterator it = m_aAtomMap.begin();

	::utl::AtomDescription aDesc;
	while( it != m_aAtomMap.end() )
	{
		aDesc.atom			= it->second;
		aDesc.description	= it->first;
		atoms.push_back( aDesc );
		++it;
	}
}

void AtomProvider::getRecent( int atom, ::std::list< ::utl::AtomDescription >& atoms )
{
	atoms.clear();

	::std::hash_map< ::rtl::OUString, int, ::rtl::OUStringHash >::const_iterator it = m_aAtomMap.begin();

	::utl::AtomDescription aDesc;
	while( it != m_aAtomMap.end() )
	{
		if( it->second > atom )
		{
			aDesc.atom			= it->second;
			aDesc.description	= it->first;
			atoms.push_back( aDesc );
		}
		++it;
	}
}

const ::rtl::OUString& AtomProvider::getString( int nAtom ) const
{
	static ::rtl::OUString aEmpty;
	::std::hash_map< int, ::rtl::OUString, ::std::hash< int > >::const_iterator it = m_aStringMap.find( nAtom );

	return it == m_aStringMap.end() ? aEmpty : it->second;
}

void AtomProvider::overrideAtom( int atom, const ::rtl::OUString& description )
{
	m_aAtomMap[ description ] = atom;
	m_aStringMap[ atom ] = description;
	if( m_nAtoms <= atom )
		m_nAtoms=atom+1;
}

sal_Bool AtomProvider::hasAtom( int atom ) const
{
	return m_aStringMap.find( atom ) != m_aStringMap.end() ? sal_True : sal_False;
}

// -----------------------------------------------------------------------

MultiAtomProvider::MultiAtomProvider()
{
}

MultiAtomProvider::~MultiAtomProvider()
{
	for( ::std::hash_map< int, AtomProvider*, ::std::hash< int > >::iterator it = m_aAtomLists.begin(); it != m_aAtomLists.end(); ++it )
		delete it->second;
}


sal_Bool MultiAtomProvider::insertAtomClass( int atomClass )
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::iterator it =
		  m_aAtomLists.find( atomClass );
	if( it != m_aAtomLists.end() )
		return sal_False;
	m_aAtomLists[ atomClass ] = new AtomProvider();
	return sal_True;
}

int MultiAtomProvider::getAtom( int atomClass, const ::rtl::OUString& rString, sal_Bool bCreate )
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::iterator it =
		  m_aAtomLists.find( atomClass );
	if( it != m_aAtomLists.end() )
		return it->second->getAtom( rString, bCreate );

	if( bCreate )
	{
		AtomProvider* pNewClass;
		m_aAtomLists[ atomClass ] = pNewClass = new AtomProvider();
		return pNewClass->getAtom( rString, bCreate );
	}
	return INVALID_ATOM;
}

int MultiAtomProvider::getLastAtom( int atomClass ) const
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::const_iterator it =
		  m_aAtomLists.find( atomClass );

	return it != m_aAtomLists.end() ? it->second->getLastAtom() : INVALID_ATOM;
}

void MultiAtomProvider::getRecent( int atomClass, int atom, ::std::list< ::utl::AtomDescription >& atoms )
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::const_iterator it =
		  m_aAtomLists.find( atomClass );
	if( it != m_aAtomLists.end() )
		it->second->getRecent( atom, atoms );
	else
		atoms.clear();
}

const ::rtl::OUString& MultiAtomProvider::getString( int atomClass, int atom ) const
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::const_iterator it =
		  m_aAtomLists.find( atomClass );
	if( it != m_aAtomLists.end() )
		return it->second->getString( atom );

	static ::rtl::OUString aEmpty;
	return aEmpty;
}

sal_Bool MultiAtomProvider::hasAtom( int atomClass, int atom ) const
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::const_iterator it = m_aAtomLists.find( atomClass );
	return it != m_aAtomLists.end() ? it->second->hasAtom( atom ) : sal_False;
}

void MultiAtomProvider::getClass( int atomClass, ::std::list< ::utl::AtomDescription >& atoms) const
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::const_iterator it = m_aAtomLists.find( atomClass );

	if( it != m_aAtomLists.end() )
		it->second->getAll( atoms );
	else
		atoms.clear();
}

void MultiAtomProvider::overrideAtom( int atomClass, int atom, const ::rtl::OUString& description )
{
	::std::hash_map< int, AtomProvider*, ::std::hash< int > >::const_iterator it = m_aAtomLists.find( atomClass );
	if( it == m_aAtomLists.end() )
		m_aAtomLists[ atomClass ] = new AtomProvider();
	m_aAtomLists[ atomClass ]->overrideAtom( atom, description );
}

// -----------------------------------------------------------------------

AtomServer::AtomServer()
{
}

AtomServer::~AtomServer()
{
}

sal_Int32 AtomServer::getAtom( sal_Int32 atomClass, const ::rtl::OUString& description, sal_Bool create ) throw()
{
	::osl::Guard< ::osl::Mutex > guard( m_aMutex );

	return m_aProvider.getAtom( atomClass, description, create );
}

Sequence< Sequence< NMSP_UTIL::AtomDescription > > AtomServer::getClasses( const Sequence< sal_Int32 >& atomClasses ) throw()
{
	::osl::Guard< ::osl::Mutex > guard( m_aMutex );

	Sequence< Sequence< NMSP_UTIL::AtomDescription > > aRet( atomClasses.getLength() );
	for( int i = 0; i < atomClasses.getLength(); i++ )
	{
		aRet.getArray()[i] = getClass( atomClasses.getConstArray()[i] );
	}
	return aRet;
}

Sequence< NMSP_UTIL::AtomDescription > AtomServer::getClass( sal_Int32 atomClass ) throw()
{
	::osl::Guard< ::osl::Mutex > guard( m_aMutex );

	::std::list< ::utl::AtomDescription > atoms;
	m_aProvider.getClass( atomClass, atoms );

	Sequence< NMSP_UTIL::AtomDescription > aRet( atoms.size() );
	for( int i = aRet.getLength()-1; i >= 0; i-- )
	{
		aRet.getArray()[i].atom			= atoms.back().atom;
		aRet.getArray()[i].description	= atoms.back().description;
		atoms.pop_back();
	}

	return aRet;
}

Sequence< NMSP_UTIL::AtomDescription > AtomServer::getRecentAtoms( sal_Int32 atomClass, sal_Int32 atom ) throw()
{
	::osl::Guard< ::osl::Mutex > guard( m_aMutex );

	::std::list< ::utl::AtomDescription > atoms;
	m_aProvider.getRecent( atomClass, atom, atoms );

	Sequence< NMSP_UTIL::AtomDescription > aRet( atoms.size() );
	for( int i = aRet.getLength()-1; i >= 0; i-- )
	{
		aRet.getArray()[i].atom			= atoms.back().atom;
		aRet.getArray()[i].description	= atoms.back().description;
		atoms.pop_back();
	}

	return aRet;
}

Sequence< ::rtl::OUString > AtomServer::getAtomDescriptions( const Sequence< AtomClassRequest >& atoms ) throw()
{
	::osl::Guard< ::osl::Mutex > guard( m_aMutex );

	int nStrings = 0, i;
	for( i = 0; i < atoms.getLength(); i++ )
		nStrings += atoms.getConstArray()[ i ].atoms.getLength();
	Sequence< ::rtl::OUString > aRet( nStrings );
	for( i = 0, nStrings = 0; i < atoms.getLength(); i++ )
	{
		const AtomClassRequest& rRequest = atoms.getConstArray()[i];
		for( int n = 0; n < rRequest.atoms.getLength(); n++ )
			aRet.getArray()[ nStrings++ ] = m_aProvider.getString( rRequest.atomClass, rRequest.atoms.getConstArray()[ n ] );
	}
	return aRet;
}

// -----------------------------------------------------------------------

AtomClient::AtomClient( const Reference< XAtomServer >& xServer ) :
		m_xServer( xServer )
{
}

AtomClient::~AtomClient()
{
}

int AtomClient::getAtom( int atomClass, const ::rtl::OUString& description, sal_Bool bCreate )
{
	int nAtom = m_aProvider.getAtom( atomClass, description, sal_False );
	if( nAtom == INVALID_ATOM && bCreate )
	{
        try
        {
		    nAtom = m_xServer->getAtom( atomClass, description, bCreate );
        }
        catch( RuntimeException& )
        {
            return INVALID_ATOM;
        }
		if( nAtom != INVALID_ATOM )
			m_aProvider.overrideAtom( atomClass, nAtom, description );
	}
	return nAtom;
}

const ::rtl::OUString& AtomClient::getString( int atomClass, int atom )
{
    static ::rtl::OUString aEmpty;

	if( ! m_aProvider.hasAtom( atomClass, atom ) )
	{
		Sequence< NMSP_UTIL::AtomDescription > aSeq;
        try
        {
		    aSeq = m_xServer->getRecentAtoms( atomClass, m_aProvider.getLastAtom( atomClass ) );
        }
        catch( RuntimeException& )
        {
            return aEmpty;
        }
		const NMSP_UTIL::AtomDescription* pDescriptions = aSeq.getConstArray();
		for( int i = 0; i < aSeq.getLength(); i++ )
			m_aProvider.overrideAtom( atomClass,
									  pDescriptions[i].atom,
									  pDescriptions[i].description
									  );

		if( ! m_aProvider.hasAtom( atomClass, atom ) )
		{
			// holes may occur by the above procedure!
			Sequence< AtomClassRequest > aReq( 1 );
			aReq.getArray()[0].atomClass = atomClass;
			aReq.getArray()[0].atoms.realloc( 1 );
			aReq.getArray()[0].atoms.getArray()[0] = atom;
            Sequence< ::rtl::OUString > aRet;
            try
            {
			    aRet = m_xServer->getAtomDescriptions( aReq );
            }
            catch( RuntimeException& )
            {
                return aEmpty;
            }
			if( aRet.getLength() == 1 )
				m_aProvider.overrideAtom( atomClass, atom, aRet.getConstArray()[0] );
		}
	}
	return m_aProvider.getString( atomClass, atom );
}

void AtomClient::updateAtomClasses( const Sequence< sal_Int32 >& atomClasses )
{
	Sequence< Sequence< NMSP_UTIL::AtomDescription > > aUpdate;
    try
    {
        aUpdate = m_xServer->getClasses( atomClasses );
    }
    catch( RuntimeException& )
    {
        return;
    }
	for( int i = 0; i < atomClasses.getLength(); i++ )
	{
		int nClass = atomClasses.getConstArray()[i];
		const Sequence< NMSP_UTIL::AtomDescription >& rClass = aUpdate.getConstArray()[i];
		const NMSP_UTIL::AtomDescription* pDesc = rClass.getConstArray();
		for( int n = 0; n < rClass.getLength(); n++, pDesc++ )
			m_aProvider.overrideAtom( nClass, pDesc->atom, pDesc->description );
	}
}